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

Logical Model: IMMZD1ClientHistoryMeasles - Detailed Descriptions

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.

ShortIMMZ.D1 Capture Client History for Measles
Logical ModelInstances 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.

ShortPatient
Control1..1
TypeReference
4. IMMZD1ClientHistoryMeasles.dose0
Definition

Indicates if the client has received a birth dose and/or supplementary dose

ShortDose 0 administered
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations 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.

ShortCompleted the primary vaccination series
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE8
8. IMMZD1ClientHistoryMeasles.dateSeriesCompleted
Definition

The date when the client completed the primary vaccination series (per product/antigen)

ShortDate when primary vaccination series was completed
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE81
10. IMMZD1ClientHistoryMeasles.hivStatus
Definition

The current human immunodeficiency virus (HIV) status of the client

ShortHIV status
Control0..1
BindingThe codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV Status
(required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE10)
TypeCoding
Definitional CodesImmunizations 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

ShortPreterm birth
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE15
14. IMMZD1ClientHistoryMeasles.severelyImmunosuppressed
Definition

The client is known to be severely immunocompromised or immunosuppressed

ShortSeverely immunosuppressed
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE92
16. IMMZD1ClientHistoryMeasles.artStartDate
Definition

The date on which the client started or restarted antiretroviral therapy (ART)

ShortART start date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE49
18. IMMZD1ClientHistoryMeasles.vaccineHistory
Definition

History of previous vaccine doses.

ShortVaccine History
Control0..*
TypeBackboneElement
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

ShortVaccine type
Control0..1
BindingThe codes SHALL be taken from IMMZ.Z.DE9 ValueSet for Measles Vaccines
(required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.Z.DE9)
TypeCoding
Definitional CodesImmunizations 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

ShortDate and time of vaccination
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations 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.

ShortIMMZ.D1 Capture Client History for Measles
Control0..*
Is Modifierfalse
Logical ModelInstances 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.

ShortPatient
Control1..1
TypeReference
4. IMMZD1ClientHistoryMeasles.dose0
Definition

Indicates if the client has received a birth dose and/or supplementary dose

ShortDose 0 administered
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations 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.

ShortCompleted the primary vaccination series
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE8
8. IMMZD1ClientHistoryMeasles.dateSeriesCompleted
Definition

The date when the client completed the primary vaccination series (per product/antigen)

ShortDate when primary vaccination series was completed
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE81
10. IMMZD1ClientHistoryMeasles.hivStatus
Definition

The current human immunodeficiency virus (HIV) status of the client

ShortHIV status
Control0..1
BindingThe codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV Status
(required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE10)
TypeCoding
Definitional CodesImmunizations 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

ShortPreterm birth
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE15
14. IMMZD1ClientHistoryMeasles.severelyImmunosuppressed
Definition

The client is known to be severely immunocompromised or immunosuppressed

ShortSeverely immunosuppressed
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE92
16. IMMZD1ClientHistoryMeasles.artStartDate
Definition

The date on which the client started or restarted antiretroviral therapy (ART)

ShortART start date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE49
18. IMMZD1ClientHistoryMeasles.vaccineHistory
Definition

History of previous vaccine doses.

ShortVaccine History
Control0..*
TypeBackboneElement
Invariantsele-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).

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())
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

ShortVaccine type
Control0..1
BindingThe codes SHALL be taken from IMMZ.Z.DE9 ValueSet for Measles Vaccines
(required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.Z.DE9)
TypeCoding
Definitional CodesImmunizations 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

ShortDate and time of vaccination
Control0..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations 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.

ShortIMMZ.D1 Capture Client History for Measles
Control0..*
Is Modifierfalse
Logical ModelInstances 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.

ShortPatient
Control1..1
TypeReference
4. IMMZD1ClientHistoryMeasles.dose0
Definition

Indicates if the client has received a birth dose and/or supplementary dose

ShortDose 0 administered
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations 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.

ShortCompleted the primary vaccination series
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE8
8. IMMZD1ClientHistoryMeasles.dateSeriesCompleted
Definition

The date when the client completed the primary vaccination series (per product/antigen)

ShortDate when primary vaccination series was completed
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE81
10. IMMZD1ClientHistoryMeasles.hivStatus
Definition

The current human immunodeficiency virus (HIV) status of the client

ShortHIV status
Control0..1
BindingThe codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV Status
(required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE10)
TypeCoding
Definitional CodesImmunizations 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

ShortPreterm birth
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE15
14. IMMZD1ClientHistoryMeasles.severelyImmunosuppressed
Definition

The client is known to be severely immunocompromised or immunosuppressed

ShortSeverely immunosuppressed
Control1..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE92
16. IMMZD1ClientHistoryMeasles.artStartDate
Definition

The date on which the client started or restarted antiretroviral therapy (ART)

ShortART start date
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesImmunizations Concepts CodeSystem D1.DE49
18. IMMZD1ClientHistoryMeasles.vaccineHistory
Definition

History of previous vaccine doses.

ShortVaccine History
Control0..*
TypeBackboneElement
Invariantsele-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.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
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.

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 IMMZD1ClientHistoryMeasles.vaccineHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 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).

    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())
    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

    ShortVaccine type
    Control0..1
    BindingThe codes SHALL be taken from IMMZ.Z.DE9 ValueSet for Measles Vaccines
    (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.Z.DE9)
    TypeCoding
    Definitional CodesImmunizations 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

    ShortDate and time of vaccination
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Definitional CodesImmunizations Concepts CodeSystem D1.DE20