WHO SMART Guideline: Surveillance and Outbreak Toolkit
0.2.1 - CI Build
WHO SMART Guideline: Surveillance and Outbreak Toolkit
0.2.1 - CI Build
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
| Draft as of 2023-11-07 |
Definitions for the SOTT1ExposureAnimal logical model.
Guidance on how to interpret the contents of this table can be found here
| 0. SOTT1ExposureAnimal | |
| Short | Surveillance & Outbreak Toolkit T1 Exposure - Animal |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. SOTT1ExposureAnimal.animalContact | |
| Definition | Indicates if the respondent has been in close proximity to, or had direct contact with, any domestic animals, dead or alive, in the XX weeks/months prior to symptom onset |
| Short | Were you in close proximity to any animals in the XX week/months prior to symptom onset? |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Yes No Unknown |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 4. SOTT1ExposureAnimal.animalContactType | |
| Definition | Provides a coded list of the types of interaction the respondent had with the animals they listed in response to the question above |
| Short | Type of animal contact |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Animal Contact Type |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. SOTT1ExposureAnimal.animalExposureDetails | |
| Definition | Details of animal exposure |
| Short | Details of animal exposure |
| Control | 0..* |
| Type | BackboneElement |
| 8. SOTT1ExposureAnimal.animalExposureDetails.animalDescription | |
| Definition | Provides a list of the types of domestic animals, dead or alive, the respondent had contact with in the XX weeks/months prior to symptom onset |
| Short | Animal species (name) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. SOTT1ExposureAnimal.animalExposureDetails.domesticatedWild | |
| Definition | Was the animal domesticated or wild |
| Short | Was the animal domesticated or wild |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Domesticated or Wild |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. SOTT1ExposureAnimal.animalExposureDetails.animalCondition | |
| Definition | Was the animal dead, sick, miscarrying or aborting |
| Short | Was the animal dead, sick, miscarrying or aborting |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Yes No Unknown |
| Type | code |
| Primitive Value | This 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. SOTT1ExposureAnimal | |
| Definition | Base definition for all elements that are defined inside a resource - but not those in a data type. |
| Short | Surveillance & Outbreak Toolkit T1 Exposure - AnimalBase for elements defined inside a resource |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. SOTT1ExposureAnimal.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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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. SOTT1ExposureAnimal.animalContact | |
| Definition | Indicates if the respondent has been in close proximity to, or had direct contact with, any domestic animals, dead or alive, in the XX weeks/months prior to symptom onset |
| Short | Were you in close proximity to any animals in the XX week/months prior to symptom onset? |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Yes No Unknown |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 6. SOTT1ExposureAnimal.animalContactType | |
| Definition | Provides a coded list of the types of interaction the respondent had with the animals they listed in response to the question above |
| Short | Type of animal contact |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Animal Contact Type |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 8. SOTT1ExposureAnimal.animalExposureDetails | |
| Definition | Details of animal exposure |
| Short | Details of animal exposure |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 10. SOTT1ExposureAnimal.animalExposureDetails.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). |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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()) |
| 12. SOTT1ExposureAnimal.animalExposureDetails.animalDescription | |
| Definition | Provides a list of the types of domestic animals, dead or alive, the respondent had contact with in the XX weeks/months prior to symptom onset |
| Short | Animal species (name) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 14. SOTT1ExposureAnimal.animalExposureDetails.domesticatedWild | |
| Definition | Was the animal domesticated or wild |
| Short | Was the animal domesticated or wild |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Domesticated or Wild |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 16. SOTT1ExposureAnimal.animalExposureDetails.animalCondition | |
| Definition | Was the animal dead, sick, miscarrying or aborting |
| Short | Was the animal dead, sick, miscarrying or aborting |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Yes No Unknown |
| Type | code |
| Primitive Value | This 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. SOTT1ExposureAnimal | |
| Definition | Base definition for all elements that are defined inside a resource - but not those in a data type. |
| Short | Surveillance & Outbreak Toolkit T1 Exposure - Animal |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 2. SOTT1ExposureAnimal.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 4. SOTT1ExposureAnimal.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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on SOTT1ExposureAnimal.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 6. SOTT1ExposureAnimal.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. |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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. SOTT1ExposureAnimal.animalContact | |
| Definition | Indicates if the respondent has been in close proximity to, or had direct contact with, any domestic animals, dead or alive, in the XX weeks/months prior to symptom onset |
| Short | Were you in close proximity to any animals in the XX week/months prior to symptom onset? |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Yes No Unknown |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 10. SOTT1ExposureAnimal.animalContactType | |
| Definition | Provides a coded list of the types of interaction the respondent had with the animals they listed in response to the question above |
| Short | Type of animal contact |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Animal Contact Type |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 12. SOTT1ExposureAnimal.animalExposureDetails | |
| Definition | Details of animal exposure |
| Short | Details of animal exposure |
| Control | 0..* |
| Type | BackboneElement |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count())) |
| 14. SOTT1ExposureAnimal.animalExposureDetails.id | |
| Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
| Short | Unique id for inter-element referencing |
| Control | 0..1 |
| Type | string |
| Is Modifier | false |
| XML Format | In the XML format, this property is represented as an attribute. |
| Summary | false |
| 16. SOTT1ExposureAnimal.animalExposureDetails.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. |
| Short | Additional 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | false |
| Summary | false |
| Alternate Names | extensions, user content |
| Invariants | ele-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()) |
| Slicing | This element introduces a set of slices on SOTT1ExposureAnimal.animalExposureDetails.extension. The slices are unordered and Open, and can be differentiated using the following discriminators: , and can be differentiated using the following discriminators: |
| 18. SOTT1ExposureAnimal.animalExposureDetails.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. |
| Short | Extensions 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them |
| Summary | true |
| 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 Names | extensions, user content, modifiers |
| Invariants | ele-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()) |
| 20. SOTT1ExposureAnimal.animalExposureDetails.animalDescription | |
| Definition | Provides a list of the types of domestic animals, dead or alive, the respondent had contact with in the XX weeks/months prior to symptom onset |
| Short | Animal species (name) |
| Control | 0..1 |
| Type | string |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 22. SOTT1ExposureAnimal.animalExposureDetails.domesticatedWild | |
| Definition | Was the animal domesticated or wild |
| Short | Was the animal domesticated or wild |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Domesticated or Wild |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| 24. SOTT1ExposureAnimal.animalExposureDetails.animalCondition | |
| Definition | Was the animal dead, sick, miscarrying or aborting |
| Short | Was the animal dead, sick, miscarrying or aborting |
| Control | 0..1 |
| Binding | The codes SHALL be taken from Yes No Unknown |
| Type | code |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |