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: SOTMeaslesDemographic - Detailed Descriptions

Draft as of 2023-11-07

Definitions for the SOTMeaslesDemographic logical model.

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

0. SOTMeaslesDemographic
ShortSurveillance & Outbreak Toolkit Measles- Demographics
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. SOTMeaslesDemographic.UniqueId
Definition

Generated for new clients or a universal ID, if used in the country

ShortUnique identification
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
4. SOTMeaslesDemographic.Name
Definition

Client's full name

ShortClient's name
Control1..1
TypeHumanName
6. SOTMeaslesDemographic.DateOfBirth
Definition

The client's date of birth (DOB), if known

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
8. SOTMeaslesDemographic.Age
Definition

Age of the client if date of birth is not known

ShortAge (number of years)
Control1..1
TypeQuantity
10. SOTMeaslesDemographic.Sex
Definition

Assigned sex at birth of the client

ShortSex at birth
Control1..1
BindingThe codes SHALL be taken from SOT Biological Sex
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
12. SOTMeaslesDemographic.Ethnicity
Definition

Client's race and/or ethnicity, if appropriate in country setting

ShortRace/Ethnicity
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTMeaslesDemographic.PlaceOfResidence
Definition

Client's home address or address that the client is consenting to disclose

ShortClient's address (city, district, and province)
Control1..1
TypeAddress
16. SOTMeaslesDemographic.CountryofBirth
Definition

Country of birth

ShortCountry of birth
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTMeaslesDemographic.Landmark
Definition

A landmark to locate the house

ShortLandmark
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTMeaslesDemographic.LocalityType
Definition

Type of Locality

ShortType of locality
Control1..1
BindingThe codes SHALL be taken from SOT Measles Locality Type
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTMeaslesDemographic.Guardian
Definition

Name of mother/Guardian

ShortName of mother/Guardian
Control0..1
TypeHumanName
24. SOTMeaslesDemographic.Telephone
Definition

Telephone

ShortTelephone
Control0..1
TypeContactPoint
26. SOTMeaslesDemographic.Occupation
Definition

Occupation

ShortOccupation
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. SOTMeaslesDemographic.WorkAddress
Definition

Work or school address

ShortWork or school address
Control0..1
TypeAddress
30. SOTMeaslesDemographic.PlaceOfInfection
Definition

Place of infection

ShortPlace of infection
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. SOTMeaslesDemographic
Definition

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

ShortSurveillance & Outbreak Toolkit Measles- DemographicsBase 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. SOTMeaslesDemographic.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. SOTMeaslesDemographic.UniqueId
Definition

Generated for new clients or a universal ID, if used in the country

ShortUnique identification
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
6. SOTMeaslesDemographic.Name
Definition

Client's full name

ShortClient's name
Control1..1
TypeHumanName
8. SOTMeaslesDemographic.DateOfBirth
Definition

The client's date of birth (DOB), if known

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTMeaslesDemographic.Age
Definition

Age of the client if date of birth is not known

ShortAge (number of years)
Control1..1
TypeQuantity
12. SOTMeaslesDemographic.Sex
Definition

Assigned sex at birth of the client

ShortSex at birth
Control1..1
BindingThe codes SHALL be taken from SOT Biological Sex
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTMeaslesDemographic.Ethnicity
Definition

Client's race and/or ethnicity, if appropriate in country setting

ShortRace/Ethnicity
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
16. SOTMeaslesDemographic.PlaceOfResidence
Definition

Client's home address or address that the client is consenting to disclose

ShortClient's address (city, district, and province)
Control1..1
TypeAddress
18. SOTMeaslesDemographic.CountryofBirth
Definition

Country of birth

ShortCountry of birth
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTMeaslesDemographic.Landmark
Definition

A landmark to locate the house

ShortLandmark
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
22. SOTMeaslesDemographic.LocalityType
Definition

Type of Locality

ShortType of locality
Control1..1
BindingThe codes SHALL be taken from SOT Measles Locality Type
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SOTMeaslesDemographic.Guardian
Definition

Name of mother/Guardian

ShortName of mother/Guardian
Control0..1
TypeHumanName
26. SOTMeaslesDemographic.Telephone
Definition

Telephone

ShortTelephone
Control0..1
TypeContactPoint
28. SOTMeaslesDemographic.Occupation
Definition

Occupation

ShortOccupation
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
30. SOTMeaslesDemographic.WorkAddress
Definition

Work or school address

ShortWork or school address
Control0..1
TypeAddress
32. SOTMeaslesDemographic.PlaceOfInfection
Definition

Place of infection

ShortPlace of infection
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. SOTMeaslesDemographic
Definition

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

ShortSurveillance & Outbreak Toolkit Measles- Demographics
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. SOTMeaslesDemographic.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. SOTMeaslesDemographic.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 SOTMeaslesDemographic.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. SOTMeaslesDemographic.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. SOTMeaslesDemographic.UniqueId
Definition

Generated for new clients or a universal ID, if used in the country

ShortUnique identification
Control1..1
Typeid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
10. SOTMeaslesDemographic.Name
Definition

Client's full name

ShortClient's name
Control1..1
TypeHumanName
12. SOTMeaslesDemographic.DateOfBirth
Definition

The client's date of birth (DOB), if known

ShortDate of birth
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
14. SOTMeaslesDemographic.Age
Definition

Age of the client if date of birth is not known

ShortAge (number of years)
Control1..1
TypeQuantity
16. SOTMeaslesDemographic.Sex
Definition

Assigned sex at birth of the client

ShortSex at birth
Control1..1
BindingThe codes SHALL be taken from SOT Biological Sex
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
18. SOTMeaslesDemographic.Ethnicity
Definition

Client's race and/or ethnicity, if appropriate in country setting

ShortRace/Ethnicity
Control0..1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
20. SOTMeaslesDemographic.PlaceOfResidence
Definition

Client's home address or address that the client is consenting to disclose

ShortClient's address (city, district, and province)
Control1..1
TypeAddress
22. SOTMeaslesDemographic.CountryofBirth
Definition

Country of birth

ShortCountry of birth
Control1..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
24. SOTMeaslesDemographic.Landmark
Definition

A landmark to locate the house

ShortLandmark
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
26. SOTMeaslesDemographic.LocalityType
Definition

Type of Locality

ShortType of locality
Control1..1
BindingThe codes SHALL be taken from SOT Measles Locality Type
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
28. SOTMeaslesDemographic.Guardian
Definition

Name of mother/Guardian

ShortName of mother/Guardian
Control0..1
TypeHumanName
30. SOTMeaslesDemographic.Telephone
Definition

Telephone

ShortTelephone
Control0..1
TypeContactPoint
32. SOTMeaslesDemographic.Occupation
Definition

Occupation

ShortOccupation
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
34. SOTMeaslesDemographic.WorkAddress
Definition

Work or school address

ShortWork or school address
Control0..1
TypeAddress
36. SOTMeaslesDemographic.PlaceOfInfection
Definition

Place of infection

ShortPlace of infection
Control0..1
Typestring
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension