WHO SMART Guidelines - Measles Immunization
0.1.0 - ci-build
WHO SMART Guidelines - Measles Immunization, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-example-immz and changes regularly. See the Directory of published versions
Draft as of 2024-08-12 |
Definitions for the IMMZD1ClientHistoryMeasles logical model.
Guidance on how to interpret the contents of this table can be found here
0. IMMZD1ClientHistoryMeasles | |
Definition | Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Measles. |
Short | IMMZ.D1 Capture Client History for Measles |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZD1ClientHistoryMeasles.patient | |
Definition | The patient who is being checked for contraindications. |
Short | Patient |
Control | 1..1 |
Type | Reference |
4. IMMZD1ClientHistoryMeasles.dose0 | |
Definition | Indicates if the client has received a birth dose and/or supplementary dose |
Short | Dose 0 administered |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE80 |
6. IMMZD1ClientHistoryMeasles.completedPrimarySeries | |
Definition | Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen. |
Short | Completed the primary vaccination series |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE8 |
8. IMMZD1ClientHistoryMeasles.dateSeriesCompleted | |
Definition | The date when the client completed the primary vaccination series (per product/antigen) |
Short | Date when primary vaccination series was completed |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE81 |
10. IMMZD1ClientHistoryMeasles.hivStatus | |
Definition | The current human immunodeficiency virus (HIV) status of the client |
Short | HIV status |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV Status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE10 ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE10 |
12. IMMZD1ClientHistoryMeasles.pretermBirth | |
Definition | The infant was preterm, the mother gave birth to the infant when gestational age was less than 37 weeks |
Short | Preterm birth |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE15 |
14. IMMZD1ClientHistoryMeasles.severelyImmunosuppressed | |
Definition | The client is known to be severely immunocompromised or immunosuppressed |
Short | Severely immunosuppressed |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE92 |
16. IMMZD1ClientHistoryMeasles.artStartDate | |
Definition | The date on which the client started or restarted antiretroviral therapy (ART) |
Short | ART start date |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE49 |
18. IMMZD1ClientHistoryMeasles.vaccineHistory | |
Definition | History of previous vaccine doses. |
Short | Vaccine History |
Control | 0..* |
Type | BackboneElement |
20. IMMZD1ClientHistoryMeasles.vaccineHistory.vaccineType | |
Definition | Vaccine type/category that was administered or was to be administered. Any vaccine code available in the IMMZ.Z Vaccine Library list of codes applies in this data element |
Short | Vaccine type |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.Z.DE9 ValueSet for Measles Vaccines (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.Z.DE9 ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE19 |
22. IMMZD1ClientHistoryMeasles.vaccineHistory.vaccineDate | |
Definition | Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client |
Short | Date and time of vaccination |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE20 |
Guidance on how to interpret the contents of this table can be found here
0. IMMZD1ClientHistoryMeasles | |
Definition | Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Measles. |
Short | IMMZ.D1 Capture Client History for Measles |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZD1ClientHistoryMeasles.patient | |
Definition | The patient who is being checked for contraindications. |
Short | Patient |
Control | 1..1 |
Type | Reference |
4. IMMZD1ClientHistoryMeasles.dose0 | |
Definition | Indicates if the client has received a birth dose and/or supplementary dose |
Short | Dose 0 administered |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE80 |
6. IMMZD1ClientHistoryMeasles.completedPrimarySeries | |
Definition | Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen. |
Short | Completed the primary vaccination series |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE8 |
8. IMMZD1ClientHistoryMeasles.dateSeriesCompleted | |
Definition | The date when the client completed the primary vaccination series (per product/antigen) |
Short | Date when primary vaccination series was completed |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE81 |
10. IMMZD1ClientHistoryMeasles.hivStatus | |
Definition | The current human immunodeficiency virus (HIV) status of the client |
Short | HIV status |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV Status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE10 ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE10 |
12. IMMZD1ClientHistoryMeasles.pretermBirth | |
Definition | The infant was preterm, the mother gave birth to the infant when gestational age was less than 37 weeks |
Short | Preterm birth |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE15 |
14. IMMZD1ClientHistoryMeasles.severelyImmunosuppressed | |
Definition | The client is known to be severely immunocompromised or immunosuppressed |
Short | Severely immunosuppressed |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE92 |
16. IMMZD1ClientHistoryMeasles.artStartDate | |
Definition | The date on which the client started or restarted antiretroviral therapy (ART) |
Short | ART start date |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE49 |
18. IMMZD1ClientHistoryMeasles.vaccineHistory | |
Definition | History of previous vaccine doses. |
Short | Vaccine History |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. IMMZD1ClientHistoryMeasles.vaccineHistory.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()) |
22. IMMZD1ClientHistoryMeasles.vaccineHistory.vaccineType | |
Definition | Vaccine type/category that was administered or was to be administered. Any vaccine code available in the IMMZ.Z Vaccine Library list of codes applies in this data element |
Short | Vaccine type |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.Z.DE9 ValueSet for Measles Vaccines (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.Z.DE9 ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE19 |
24. IMMZD1ClientHistoryMeasles.vaccineHistory.vaccineDate | |
Definition | Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client |
Short | Date and time of vaccination |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE20 |
Guidance on how to interpret the contents of this table can be found here
0. IMMZD1ClientHistoryMeasles | |
Definition | Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Measles. |
Short | IMMZ.D1 Capture Client History for Measles |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZD1ClientHistoryMeasles.patient | |
Definition | The patient who is being checked for contraindications. |
Short | Patient |
Control | 1..1 |
Type | Reference |
4. IMMZD1ClientHistoryMeasles.dose0 | |
Definition | Indicates if the client has received a birth dose and/or supplementary dose |
Short | Dose 0 administered |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE80 |
6. IMMZD1ClientHistoryMeasles.completedPrimarySeries | |
Definition | Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen. |
Short | Completed the primary vaccination series |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE8 |
8. IMMZD1ClientHistoryMeasles.dateSeriesCompleted | |
Definition | The date when the client completed the primary vaccination series (per product/antigen) |
Short | Date when primary vaccination series was completed |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE81 |
10. IMMZD1ClientHistoryMeasles.hivStatus | |
Definition | The current human immunodeficiency virus (HIV) status of the client |
Short | HIV status |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV Status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE10 ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE10 |
12. IMMZD1ClientHistoryMeasles.pretermBirth | |
Definition | The infant was preterm, the mother gave birth to the infant when gestational age was less than 37 weeks |
Short | Preterm birth |
Control | 0..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE15 |
14. IMMZD1ClientHistoryMeasles.severelyImmunosuppressed | |
Definition | The client is known to be severely immunocompromised or immunosuppressed |
Short | Severely immunosuppressed |
Control | 1..1 |
Type | boolean |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE92 |
16. IMMZD1ClientHistoryMeasles.artStartDate | |
Definition | The date on which the client started or restarted antiretroviral therapy (ART) |
Short | ART start date |
Control | 1..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE49 |
18. IMMZD1ClientHistoryMeasles.vaccineHistory | |
Definition | History of previous vaccine doses. |
Short | Vaccine History |
Control | 0..* |
Type | BackboneElement |
Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()) ) |
20. IMMZD1ClientHistoryMeasles.vaccineHistory.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 |
22. IMMZD1ClientHistoryMeasles.vaccineHistory.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 IMMZD1ClientHistoryMeasles.vaccineHistory.extension . The slices areUnordered and Open, and can be differentiated using the following discriminators: |
24. IMMZD1ClientHistoryMeasles.vaccineHistory.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() ) |
26. IMMZD1ClientHistoryMeasles.vaccineHistory.vaccineType | |
Definition | Vaccine type/category that was administered or was to be administered. Any vaccine code available in the IMMZ.Z Vaccine Library list of codes applies in this data element |
Short | Vaccine type |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.Z.DE9 ValueSet for Measles Vaccines (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.Z.DE9 ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE19 |
28. IMMZD1ClientHistoryMeasles.vaccineHistory.vaccineDate | |
Definition | Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client |
Short | Date and time of vaccination |
Control | 0..1 |
Type | date |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D1.DE20 |