WHO SMART Guideline: Surveillance and Outbreak Toolkit
0.2.1 - CI Build International flag

WHO SMART Guideline: Surveillance and Outbreak Toolkit, published by WHO. This is not an authorized publication; it is the continuous build for version 0.2.1. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-ot and changes regularly. See the Directory of published versions

Logical Model: SOTT1ClinicalRespiratory - Detailed Descriptions

Draft as of 2023-11-07

Definitions for the SOTT1ClinicalRespiratory logical model.

Guidance on how to interpret the contents of this table can be found here

0. SOTT1ClinicalRespiratory
ShortSurveillance & Outbreak Toolkit T1 Clinical - Respiratory
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SOTT1ClinicalRespiratory.RespiratoryRate
Definition

Number of breaths during one minute

ShortRespiratory rate (per min)
Control0..1
TypeQuantity
4. SOTT1ClinicalRespiratory.O2Sat
Definition

in proportion

ShortO2 saturation room air
Control0..1
TypeQuantity
6. SOTT1ClinicalRespiratory.respiratorySigns
Definition

If yes describe

ShortObserved respiratory signs
Control0..1
BindingThe codes SHALL be taken from SOT Yes No
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SOTT1ClinicalRespiratory.intenseCough
Definition

[Intense] coughing, including dry .

ShortNon-productive cough
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTT1ClinicalRespiratory.expectoration
Definition

When coughing the patient produces phlegm or mucus/sputum or bloody sputum

ShortProductive cough (expectoration)
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. SOTT1ClinicalRespiratory.shortBreath
Definition

Difficulty breathing (dyspnoea), abnormal shortness of breath or intense tightening of the chest while resting or during light physical activity (e.g. normal walking), noisy respiration

ShortShortness of breath
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTT1ClinicalRespiratory.respiratoryDistress
Definition

Include following signs: increased breath rate, lower chest wall indrawing, throacic retraction, flapping of the wings of the nose

ShortRespiratory distress
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTT1ClinicalRespiratory.cyanosis
Definition

Blue coloration of nail, of lips

ShortCyanosis
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTT1ClinicalRespiratory.auscultation
Definition

Result of stethoscop auscultation of the lungs, (precise if murur or other/localised or global signs)

ShortAbnormal auscultation
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTT1ClinicalRespiratory.pneumonia
Definition

signs evocating pneumonia of viral or bacterial origin

Shortpneumonia
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTT1ClinicalRespiratory.pneumothorax
Definition

Colapsed lungs on auscultation

Shortpneumothorax
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SOTT1ClinicalRespiratory.otherRespSigns
Definition

Describe respiratory signs not reported above

ShortOther respiratory signs:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SOTT1ClinicalRespiratory
Definition

Base definition for all elements that are defined inside a resource - but not those in a data type.

ShortSurveillance & Outbreak Toolkit T1 Clinical - RespiratoryBase for elements defined inside a resource
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SOTT1ClinicalRespiratory.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
4. SOTT1ClinicalRespiratory.RespiratoryRate
Definition

Number of breaths during one minute

ShortRespiratory rate (per min)
Control0..1
TypeQuantity
6. SOTT1ClinicalRespiratory.O2Sat
Definition

in proportion

ShortO2 saturation room air
Control0..1
TypeQuantity
8. SOTT1ClinicalRespiratory.respiratorySigns
Definition

If yes describe

ShortObserved respiratory signs
Control0..1
BindingThe codes SHALL be taken from SOT Yes No
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTT1ClinicalRespiratory.intenseCough
Definition

[Intense] coughing, including dry .

ShortNon-productive cough
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. SOTT1ClinicalRespiratory.expectoration
Definition

When coughing the patient produces phlegm or mucus/sputum or bloody sputum

ShortProductive cough (expectoration)
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTT1ClinicalRespiratory.shortBreath
Definition

Difficulty breathing (dyspnoea), abnormal shortness of breath or intense tightening of the chest while resting or during light physical activity (e.g. normal walking), noisy respiration

ShortShortness of breath
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTT1ClinicalRespiratory.respiratoryDistress
Definition

Include following signs: increased breath rate, lower chest wall indrawing, throacic retraction, flapping of the wings of the nose

ShortRespiratory distress
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTT1ClinicalRespiratory.cyanosis
Definition

Blue coloration of nail, of lips

ShortCyanosis
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTT1ClinicalRespiratory.auscultation
Definition

Result of stethoscop auscultation of the lungs, (precise if murur or other/localised or global signs)

ShortAbnormal auscultation
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTT1ClinicalRespiratory.pneumonia
Definition

signs evocating pneumonia of viral or bacterial origin

Shortpneumonia
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SOTT1ClinicalRespiratory.pneumothorax
Definition

Colapsed lungs on auscultation

Shortpneumothorax
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. SOTT1ClinicalRespiratory.otherRespSigns
Definition

Describe respiratory signs not reported above

ShortOther respiratory signs:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension

Guidance on how to interpret the contents of this table can be found here

0. SOTT1ClinicalRespiratory
Definition

Base definition for all elements that are defined inside a resource - but not those in a data type.

ShortSurveillance & Outbreak Toolkit T1 Clinical - Respiratory
Control0..*
This element is affected by the following invariants: ele-1
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
2. SOTT1ClinicalRespiratory.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
4. SOTT1ClinicalRespiratory.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on SOTT1ClinicalRespiratory.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators:
  • value @ url
6. SOTT1ClinicalRespiratory.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

ShortExtensions that cannot be ignored even if unrecognized
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Summarytrue
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Alternate Namesextensions, user content, modifiers
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
8. SOTT1ClinicalRespiratory.RespiratoryRate
Definition

Number of breaths during one minute

ShortRespiratory rate (per min)
Control0..1
TypeQuantity
10. SOTT1ClinicalRespiratory.O2Sat
Definition

in proportion

ShortO2 saturation room air
Control0..1
TypeQuantity
12. SOTT1ClinicalRespiratory.respiratorySigns
Definition

If yes describe

ShortObserved respiratory signs
Control0..1
BindingThe codes SHALL be taken from SOT Yes No
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTT1ClinicalRespiratory.intenseCough
Definition

[Intense] coughing, including dry .

ShortNon-productive cough
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTT1ClinicalRespiratory.expectoration
Definition

When coughing the patient produces phlegm or mucus/sputum or bloody sputum

ShortProductive cough (expectoration)
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTT1ClinicalRespiratory.shortBreath
Definition

Difficulty breathing (dyspnoea), abnormal shortness of breath or intense tightening of the chest while resting or during light physical activity (e.g. normal walking), noisy respiration

ShortShortness of breath
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTT1ClinicalRespiratory.respiratoryDistress
Definition

Include following signs: increased breath rate, lower chest wall indrawing, throacic retraction, flapping of the wings of the nose

ShortRespiratory distress
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTT1ClinicalRespiratory.cyanosis
Definition

Blue coloration of nail, of lips

ShortCyanosis
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SOTT1ClinicalRespiratory.auscultation
Definition

Result of stethoscop auscultation of the lungs, (precise if murur or other/localised or global signs)

ShortAbnormal auscultation
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. SOTT1ClinicalRespiratory.pneumonia
Definition

signs evocating pneumonia of viral or bacterial origin

Shortpneumonia
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. SOTT1ClinicalRespiratory.pneumothorax
Definition

Colapsed lungs on auscultation

Shortpneumothorax
Control0..1
BindingThe codes SHALL be taken from Yes No Unknown
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. SOTT1ClinicalRespiratory.otherRespSigns
Definition

Describe respiratory signs not reported above

ShortOther respiratory signs:
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension