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
Active as of 2024-08-12 |
Definitions for the IMMZDUpdateVaccinationRecord logical model.
Guidance on how to interpret the contents of this table can be found here
0. IMMZDUpdateVaccinationRecord | |
Definition | Data elements for IMMZ.D Update Vaccination Record. |
Short | IMMZ.D Update Vaccination Record |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZDUpdateVaccinationRecord.immunizatioEventStatus | |
Definition | The current status of the individual immunization event |
Short | The current status of the individual immunization event |
Control | 1..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE1 CodeSystem for Immunization status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE1VS ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE1 |
4. IMMZDUpdateVaccinationRecord.reasonNotDone | |
Definition | The reason this immunization event was not performed |
Short | Reason vaccine was not administered |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE5 values for Reason Not Done (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE5VS ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE5 |
6. IMMZDUpdateVaccinationRecord.vaccineProduct | |
Definition | The brand or trade name used to refer to the vaccine received |
Short | Vaccine brand |
Control | 1..1 |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE18 |
8. IMMZDUpdateVaccinationRecord.liveVaccine | |
Definition | Uses a living but weakened version of the virus or one that's very similar |
Short | Live attenuated vaccine |
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 D.DE173 |
10. IMMZDUpdateVaccinationRecord.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 |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE19 |
12. IMMZDUpdateVaccinationRecord.dateTime | |
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 | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE20 |
14. IMMZDUpdateVaccinationRecord.countryOfVaccination | |
Definition | The service delivery country where the vaccine administration occurred |
Short | Country of vaccination |
Control | 1..1 |
Binding | The codes SHALL be taken from Country ValueSet (required to http://smart.who.int/immunizations-measles/ValueSet/sgcountry ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE21 |
16. IMMZDUpdateVaccinationRecord.vaccinationLocation | |
Definition | The service delivery location where the vaccine administration occurred |
Short | Vaccination location |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE22 |
18. IMMZDUpdateVaccinationRecord.vaccineManufacturer | |
Definition | The manufacturer of the vaccine product |
Short | Vaccine manufacturer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE23 |
20. IMMZDUpdateVaccinationRecord.vaccineLotNumber | |
Definition | Batch number or lot number of vaccine |
Short | Vaccine batch number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE24 |
22. IMMZDUpdateVaccinationRecord.vaccineMAH | |
Definition | Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED |
Short | Vaccine market authorization holder |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE25 |
24. IMMZDUpdateVaccinationRecord.vaccineExpirationDate | |
Definition | The expiration date of the vaccine |
Short | Expiration date |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE26 |
26. IMMZDUpdateVaccinationRecord.vaccineDoseQuantity | |
Definition | The quantity of vaccine product that was administered |
Short | Dose quantity |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE34 |
28. IMMZDUpdateVaccinationRecord.healthWorker | |
Definition | The person, organization, or role of the entity that performed the act of giving the vaccine to the client. The implementing system can choose to populate this field using data from a health worker registry or health facility registry |
Short | Health worker identifier |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE35 |
30. IMMZDUpdateVaccinationRecord.vaccineDoseNumber | |
Definition | Vaccine dose number including dose number within series |
Short | Dose number |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE124 |
32. IMMZDUpdateVaccinationRecord.vaccineTotalDosesInSeries | |
Definition | The recommended number of doses for immunity according to the national protocol |
Short | Total doses in series |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE125 |
Guidance on how to interpret the contents of this table can be found here
0. IMMZDUpdateVaccinationRecord | |
Definition | Data elements for IMMZ.D Update Vaccination Record. |
Short | IMMZ.D Update Vaccination Record |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZDUpdateVaccinationRecord.immunizatioEventStatus | |
Definition | The current status of the individual immunization event |
Short | The current status of the individual immunization event |
Control | 1..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE1 CodeSystem for Immunization status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE1VS ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE1 |
4. IMMZDUpdateVaccinationRecord.reasonNotDone | |
Definition | The reason this immunization event was not performed |
Short | Reason vaccine was not administered |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE5 values for Reason Not Done (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE5VS ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE5 |
6. IMMZDUpdateVaccinationRecord.vaccineProduct | |
Definition | The brand or trade name used to refer to the vaccine received |
Short | Vaccine brand |
Control | 1..1 |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE18 |
8. IMMZDUpdateVaccinationRecord.liveVaccine | |
Definition | Uses a living but weakened version of the virus or one that's very similar |
Short | Live attenuated vaccine |
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 D.DE173 |
10. IMMZDUpdateVaccinationRecord.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 |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE19 |
12. IMMZDUpdateVaccinationRecord.dateTime | |
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 | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE20 |
14. IMMZDUpdateVaccinationRecord.countryOfVaccination | |
Definition | The service delivery country where the vaccine administration occurred |
Short | Country of vaccination |
Control | 1..1 |
Binding | The codes SHALL be taken from Country ValueSet (required to http://smart.who.int/immunizations-measles/ValueSet/sgcountry ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE21 |
16. IMMZDUpdateVaccinationRecord.vaccinationLocation | |
Definition | The service delivery location where the vaccine administration occurred |
Short | Vaccination location |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE22 |
18. IMMZDUpdateVaccinationRecord.vaccineManufacturer | |
Definition | The manufacturer of the vaccine product |
Short | Vaccine manufacturer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE23 |
20. IMMZDUpdateVaccinationRecord.vaccineLotNumber | |
Definition | Batch number or lot number of vaccine |
Short | Vaccine batch number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE24 |
22. IMMZDUpdateVaccinationRecord.vaccineMAH | |
Definition | Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED |
Short | Vaccine market authorization holder |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE25 |
24. IMMZDUpdateVaccinationRecord.vaccineExpirationDate | |
Definition | The expiration date of the vaccine |
Short | Expiration date |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE26 |
26. IMMZDUpdateVaccinationRecord.vaccineDoseQuantity | |
Definition | The quantity of vaccine product that was administered |
Short | Dose quantity |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE34 |
28. IMMZDUpdateVaccinationRecord.healthWorker | |
Definition | The person, organization, or role of the entity that performed the act of giving the vaccine to the client. The implementing system can choose to populate this field using data from a health worker registry or health facility registry |
Short | Health worker identifier |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE35 |
30. IMMZDUpdateVaccinationRecord.vaccineDoseNumber | |
Definition | Vaccine dose number including dose number within series |
Short | Dose number |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE124 |
32. IMMZDUpdateVaccinationRecord.vaccineTotalDosesInSeries | |
Definition | The recommended number of doses for immunity according to the national protocol |
Short | Total doses in series |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE125 |
Guidance on how to interpret the contents of this table can be found here
0. IMMZDUpdateVaccinationRecord | |
Definition | Data elements for IMMZ.D Update Vaccination Record. |
Short | IMMZ.D Update Vaccination Record |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZDUpdateVaccinationRecord.immunizatioEventStatus | |
Definition | The current status of the individual immunization event |
Short | The current status of the individual immunization event |
Control | 1..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE1 CodeSystem for Immunization status (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE1VS ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE1 |
4. IMMZDUpdateVaccinationRecord.reasonNotDone | |
Definition | The reason this immunization event was not performed |
Short | Reason vaccine was not administered |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D1.DE5 values for Reason Not Done (required to http://smart.who.int/immunizations-measles/ValueSet/IMMZ.D1.DE5VS ) |
Type | code |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE5 |
6. IMMZDUpdateVaccinationRecord.vaccineProduct | |
Definition | The brand or trade name used to refer to the vaccine received |
Short | Vaccine brand |
Control | 1..1 |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE18 |
8. IMMZDUpdateVaccinationRecord.liveVaccine | |
Definition | Uses a living but weakened version of the virus or one that's very similar |
Short | Live attenuated vaccine |
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 D.DE173 |
10. IMMZDUpdateVaccinationRecord.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 |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE19 |
12. IMMZDUpdateVaccinationRecord.dateTime | |
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 | 1..1 |
Type | dateTime |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE20 |
14. IMMZDUpdateVaccinationRecord.countryOfVaccination | |
Definition | The service delivery country where the vaccine administration occurred |
Short | Country of vaccination |
Control | 1..1 |
Binding | The codes SHALL be taken from Country ValueSet (required to http://smart.who.int/immunizations-measles/ValueSet/sgcountry ) |
Type | Coding |
Definitional Codes | Immunizations Concepts CodeSystem D.DE21 |
16. IMMZDUpdateVaccinationRecord.vaccinationLocation | |
Definition | The service delivery location where the vaccine administration occurred |
Short | Vaccination location |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE22 |
18. IMMZDUpdateVaccinationRecord.vaccineManufacturer | |
Definition | The manufacturer of the vaccine product |
Short | Vaccine manufacturer |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE23 |
20. IMMZDUpdateVaccinationRecord.vaccineLotNumber | |
Definition | Batch number or lot number of vaccine |
Short | Vaccine batch number |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE24 |
22. IMMZDUpdateVaccinationRecord.vaccineMAH | |
Definition | Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED |
Short | Vaccine market authorization holder |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE25 |
24. IMMZDUpdateVaccinationRecord.vaccineExpirationDate | |
Definition | The expiration date of the vaccine |
Short | Expiration date |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE26 |
26. IMMZDUpdateVaccinationRecord.vaccineDoseQuantity | |
Definition | The quantity of vaccine product that was administered |
Short | Dose quantity |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE34 |
28. IMMZDUpdateVaccinationRecord.healthWorker | |
Definition | The person, organization, or role of the entity that performed the act of giving the vaccine to the client. The implementing system can choose to populate this field using data from a health worker registry or health facility registry |
Short | Health worker identifier |
Control | 0..1 |
Type | string |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE35 |
30. IMMZDUpdateVaccinationRecord.vaccineDoseNumber | |
Definition | Vaccine dose number including dose number within series |
Short | Dose number |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE124 |
32. IMMZDUpdateVaccinationRecord.vaccineTotalDosesInSeries | |
Definition | The recommended number of doses for immunity according to the national protocol |
Short | Total doses in series |
Control | 0..1 |
Type | integer |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | Immunizations Concepts CodeSystem D.DE125 |