WHO Immunization Implementation Guide
0.2.0 - ci-build
WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations/ and changes regularly. See the Directory of published versions
| Active as of 2025-01-10 |
Definitions for the IMMZD13 logical model.
Guidance on how to interpret the contents of this table can be foundhere
| 0. IMMZD13 | |
| Definition | Data elements for the IMMZ.D13.Update client record Data Dictionary Activity. |
| Short | IMMZ.D13.Update client record |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZD13.patient | |
| Definition | The patient. |
| Short | Patient |
| Control | 1..1 |
| Type | Reference |
| 4. IMMZD13.birthDose | |
| Definition | Indicates if the client received a dose within 24 hours of birth. Whether a birth dose is counted as part of the primary series will depend on the antigen |
| Short | Birth dose |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE263 |
| Invariants | IMMZ-D-reqVType-1: Required if input in IMMZ.D.DE19 vaccine type is Hepatitis B-containing vaccines OR Poliovirus-containing vaccines. ((%resource.vaccineType.value != 'DE6' and %resource.vaccineType.value != 'DE14') or $this.exists()) |
| 6. IMMZD13.typeOfDose | |
| Definition | The type of dose in a series that the client received |
| Short | Type of dose |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE258 ValueSet for Type of dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE258 |
| 8. IMMZD13.completedThePrimaryVaccinationSeries | |
| 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 | IMMZ.D CodeSystem for Data Elements DE203 |
| 10. IMMZD13.completedTheBoosterSeries | |
| Definition | Indicates if the client has completed the booster series of a product/antigen |
| Short | Completed the booster series |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE257 |
| 12. IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted | |
| Definition | The date when the client completed the primary vaccination series (per product/antigen) |
| Short | Date when primary vaccination series was completed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE242 |
| Invariants | IMMZ-D-reqPrimaryCompleted-1: Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes (%resource.completedTheBoosterSeries.value = false or $this.exists())IMMZ-D-dateOccurred-1: Date ≤ current date ( not($this.exists()) or $this.value <= today()) |
| 14. IMMZD13.hivStatus | |
| Definition | The current HIV status of the client |
| Short | HIV status |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE204 ValueSet for HIV status (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE204, LOINC 55277-8, SNOMED CT 278977008 |
| 16. IMMZD13.typeOfPoliovirusDose | |
| Definition | The type of the poliovirus vaccine dose administered to the client |
| Short | Type of poliovirus dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE212, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) XM0N50 |
| Invariants | IMMZ-D-reqVType-4: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines OR Hepatitis B-containing vaccines ((%resource.vaccineType.value != 'DE1' and %resource.vaccineType.value != 'DE6') or $this.exists()) |
| 18. IMMZD13.typeOfJeDose | |
| Definition | The type of Japanese encephalitis (JE) vaccine dose administered to the client |
| Short | Type of JE dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE216 ValueSet for Type of JE dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE216 |
| Invariants | IMMZ-D-reqVType-8: Required if input in IMMZ.D.DE19 vaccine type is JE vaccines (%resource.vaccineType.value != 'DE8' or $this.exists()) |
| 20. IMMZD13.typeOfTbeDose | |
| Definition | The type of tick-borne encephalitis (TBE) vaccine dose administered |
| Short | Type of TBE dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE220 ValueSet for Type of TBE dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE220 |
| Invariants | IMMZ-D-reqVType-9: Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines (%resource.vaccineType.value != 'DE20' or $this.exists()) |
| 22. IMMZD13.typeOfTyphoidDose | |
| Definition | The type of typhoid vaccine dose administered to the client |
| Short | Type of typhoid dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE225 ValueSet for Type of typhoid dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE225 |
| Invariants | IMMZ-D-reqVType-10: Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines (%resource.vaccineType.value != 'DE21' or $this.exists()) |
| 24. IMMZD13.typeOfCholeraDose | |
| Definition | The type of cholera vaccine dose administered to the client |
| Short | Type of cholera dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE229 |
| Invariants | IMMZ-D-reqVType-11: Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines (%resource.vaccineType.value != 'DE2' or $this.exists()) |
| 26. IMMZD13.typeOfMeningococcalDose | |
| Definition | The type of meningococcal vaccine dose administered to the client |
| Short | Type of meningococcal dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE232 |
| Invariants | IMMZ-D-reqVType-12: Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines (%resource.vaccineType.value != 'DE10' or $this.exists()) |
| 28. IMMZD13.typeOfHepatitisADose | |
| Definition | The type of hepatitis A-containing vaccine dose administered to the client |
| Short | Type of hepatitis A dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE237 |
| Invariants | IMMZ-D-reqVType-13: Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines (%resource.vaccineType.value != 'DE5' or $this.exists()) |
| 30. IMMZD13.typeOfHepatitisBDose | |
| Definition | The type of hepatitis B-containing vaccine dose administered to the client |
| Short | Type of hepatitis B dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE254 |
| Invariants | IMMZ-D-reqVType-14: Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines (%resource.vaccineType.value != 'DE6' or $this.exists()) |
| 32. IMMZD13.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 | 1..* |
| Binding | The codes SHALL be taken from IMMZ.Z.VS ValueSet for vaccine types (required to http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE19, LOINC 39236-5, SNOMED CT 787859002 |
| 34. IMMZD13.dateAndTimeOfVaccination | |
| Definition | Represents the visit/encounter date, which is the date and time when each 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 | IMMZ.D CodeSystem for Data Elements DE20, LOINC 30952-6 |
| 36. IMMZD13.contactDate | |
| Definition | The date and time of the client's contact |
| Short | Contact date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE201, LOINC 21975-8, SNOMED CT 406543005 |
| Invariants | IMMZ-D-dateTimeOccurred-1: DateTime ≤ current DateTime (not($this.exists()) or $this.value <= now()) |
| 38. IMMZD13.ancContactNumber | |
| Definition | The antenatal care (ANC) contact or visit number |
| Short | ANC contact number |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE202, LOINC 75612-2, SNOMED CT 3401000175105 |
| 40. IMMZD13.doseNumber | |
| Definition | Vaccine dose number including dose number within series |
| Short | Dose number |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE124 |
| Invariants | IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) (not($this.exists()) or $this.value >= 0) |
| 42. IMMZD13.immunizationEventStatus | |
| Definition | The current status of the individual immunization event |
| Short | Immunization event status |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE1 ValueSet for Immunization event status (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE1 |
| 44. IMMZD13.reasonVaccineWasNotAdministered | |
| 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.D.DE5 ValueSet for Reason vaccine was not administered (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE5, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) QC04 |
| Invariants | IMMZ-D-statusNotDone-1: Required if input in IMMZ.D.DE1 Immunization event status is Not Done (%resource.immunizationEventStatus.value = 'DE4' or $this.exists()) |
| 46. IMMZD13.vaccineBrand | |
| Definition | The brand or trade name used to refer to the vaccine received |
| Short | Vaccine brand |
| Control | 1..1 |
| Binding | For example codes, see IMMZ.D.DE18 ValueSet for Vaccine brand (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE18 |
| 48. IMMZD13.liveVaccine | |
| Definition | Uses a living but weakened version of the virus or one that is very similar |
| Short | Live vaccine |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE173 |
| 50. IMMZD13.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 Iso3166-1-3 (required to http://hl7.org/fhir/ValueSet/iso3166-1-3) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE21 |
| 52. IMMZD13.administrativeArea | |
| Definition | The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred |
| Short | Administrative area |
| Control | 0..1 |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE22, LOINC 72060-7 |
| 54. IMMZD13.vaccineManufacturer | |
| Definition | The manufacturer of the vaccine product |
| Short | Vaccine manufacturer |
| Control | 1..1 |
| Binding | For example codes, see IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE23, LOINC 30957-5 |
| 56. IMMZD13.vaccineBatchNumber | |
| 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 | IMMZ.D CodeSystem for Data Elements DE24, LOINC 30959-1 |
| 58. IMMZD13.vaccineMarketAuthorizationHolder | |
| 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 | 1..1 |
| Binding | For example codes, see IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE25 |
| 60. IMMZD13.expirationDate | |
| Definition | The expiration date of the vaccine |
| Short | Expiration date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE26, LOINC 74066-2 |
| 62. IMMZD13.doseQuantity | |
| Definition | The quantity of vaccine product that was administered |
| Short | Dose quantity |
| Control | 0..1 |
| Type | Quantity |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE34, LOINC 82745-1 |
| Invariants | IMMZ-D-reqGTZero-1: Must be positive decimal value greater than zero (>0.00) (not($this.exists()) or $this.value > 0) |
| 64. IMMZD13.healthWorkerIdentifier | |
| 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-care 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 | IMMZ.D CodeSystem for Data Elements DE35 |
| 66. IMMZD13.totalDosesInSeries | |
| Definition | The recommended number of doses for immunity according to the national immunization schedule (which may be based on product, age, etc.) |
| 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 | IMMZ.D CodeSystem for Data Elements DE125 |
| Invariants | IMMZ-D-reqGTZero-1: Must be positive decimal value greater than zero (>0.00) (not($this.exists()) or $this.value > 0) |
| 68. IMMZD13.diseaseTargeted | |
| Definition | Vaccine-preventable disease being targeted |
| Short | Disease targeted |
| Control | 0..* |
| Binding | The codes SHALL be taken from IMMZ.D.DE126 ValueSet for Disease targeted (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE126 |
| 70. IMMZD13.dueDateOfNextDose | |
| Definition | Date on which the next vaccination should be administered, if a next dose is required |
| Short | Due date of next dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE149 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. IMMZD13 | |
| Definition | Data elements for the IMMZ.D13.Update client record Data Dictionary Activity. |
| Short | IMMZ.D13.Update client record |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZD13.patient | |
| Definition | The patient. |
| Short | Patient |
| Control | 1..1 |
| Type | Reference |
| 4. IMMZD13.birthDose | |
| Definition | Indicates if the client received a dose within 24 hours of birth. Whether a birth dose is counted as part of the primary series will depend on the antigen |
| Short | Birth dose |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE263 |
| Invariants | IMMZ-D-reqVType-1: Required if input in IMMZ.D.DE19 vaccine type is Hepatitis B-containing vaccines OR Poliovirus-containing vaccines. ((%resource.vaccineType.value != 'DE6' and %resource.vaccineType.value != 'DE14') or $this.exists()) |
| 6. IMMZD13.typeOfDose | |
| Definition | The type of dose in a series that the client received |
| Short | Type of dose |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE258 ValueSet for Type of dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE258 |
| 8. IMMZD13.completedThePrimaryVaccinationSeries | |
| 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 | IMMZ.D CodeSystem for Data Elements DE203 |
| 10. IMMZD13.completedTheBoosterSeries | |
| Definition | Indicates if the client has completed the booster series of a product/antigen |
| Short | Completed the booster series |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE257 |
| 12. IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted | |
| Definition | The date when the client completed the primary vaccination series (per product/antigen) |
| Short | Date when primary vaccination series was completed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE242 |
| Invariants | IMMZ-D-reqPrimaryCompleted-1: Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes (%resource.completedTheBoosterSeries.value = false or $this.exists())IMMZ-D-dateOccurred-1: Date ≤ current date ( not($this.exists()) or $this.value <= today()) |
| 14. IMMZD13.hivStatus | |
| Definition | The current HIV status of the client |
| Short | HIV status |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE204 ValueSet for HIV status (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE204, LOINC 55277-8, SNOMED CT 278977008 |
| 16. IMMZD13.typeOfPoliovirusDose | |
| Definition | The type of the poliovirus vaccine dose administered to the client |
| Short | Type of poliovirus dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE212, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) XM0N50 |
| Invariants | IMMZ-D-reqVType-4: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines OR Hepatitis B-containing vaccines ((%resource.vaccineType.value != 'DE1' and %resource.vaccineType.value != 'DE6') or $this.exists()) |
| 18. IMMZD13.typeOfJeDose | |
| Definition | The type of Japanese encephalitis (JE) vaccine dose administered to the client |
| Short | Type of JE dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE216 ValueSet for Type of JE dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE216 |
| Invariants | IMMZ-D-reqVType-8: Required if input in IMMZ.D.DE19 vaccine type is JE vaccines (%resource.vaccineType.value != 'DE8' or $this.exists()) |
| 20. IMMZD13.typeOfTbeDose | |
| Definition | The type of tick-borne encephalitis (TBE) vaccine dose administered |
| Short | Type of TBE dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE220 ValueSet for Type of TBE dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE220 |
| Invariants | IMMZ-D-reqVType-9: Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines (%resource.vaccineType.value != 'DE20' or $this.exists()) |
| 22. IMMZD13.typeOfTyphoidDose | |
| Definition | The type of typhoid vaccine dose administered to the client |
| Short | Type of typhoid dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE225 ValueSet for Type of typhoid dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE225 |
| Invariants | IMMZ-D-reqVType-10: Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines (%resource.vaccineType.value != 'DE21' or $this.exists()) |
| 24. IMMZD13.typeOfCholeraDose | |
| Definition | The type of cholera vaccine dose administered to the client |
| Short | Type of cholera dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE229 |
| Invariants | IMMZ-D-reqVType-11: Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines (%resource.vaccineType.value != 'DE2' or $this.exists()) |
| 26. IMMZD13.typeOfMeningococcalDose | |
| Definition | The type of meningococcal vaccine dose administered to the client |
| Short | Type of meningococcal dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE232 |
| Invariants | IMMZ-D-reqVType-12: Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines (%resource.vaccineType.value != 'DE10' or $this.exists()) |
| 28. IMMZD13.typeOfHepatitisADose | |
| Definition | The type of hepatitis A-containing vaccine dose administered to the client |
| Short | Type of hepatitis A dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE237 |
| Invariants | IMMZ-D-reqVType-13: Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines (%resource.vaccineType.value != 'DE5' or $this.exists()) |
| 30. IMMZD13.typeOfHepatitisBDose | |
| Definition | The type of hepatitis B-containing vaccine dose administered to the client |
| Short | Type of hepatitis B dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE254 |
| Invariants | IMMZ-D-reqVType-14: Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines (%resource.vaccineType.value != 'DE6' or $this.exists()) |
| 32. IMMZD13.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 | 1..* |
| Binding | The codes SHALL be taken from IMMZ.Z.VS ValueSet for vaccine types (required to http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE19, LOINC 39236-5, SNOMED CT 787859002 |
| 34. IMMZD13.dateAndTimeOfVaccination | |
| Definition | Represents the visit/encounter date, which is the date and time when each 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 | IMMZ.D CodeSystem for Data Elements DE20, LOINC 30952-6 |
| 36. IMMZD13.contactDate | |
| Definition | The date and time of the client's contact |
| Short | Contact date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE201, LOINC 21975-8, SNOMED CT 406543005 |
| Invariants | IMMZ-D-dateTimeOccurred-1: DateTime ≤ current DateTime (not($this.exists()) or $this.value <= now()) |
| 38. IMMZD13.ancContactNumber | |
| Definition | The antenatal care (ANC) contact or visit number |
| Short | ANC contact number |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE202, LOINC 75612-2, SNOMED CT 3401000175105 |
| 40. IMMZD13.doseNumber | |
| Definition | Vaccine dose number including dose number within series |
| Short | Dose number |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE124 |
| Invariants | IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) (not($this.exists()) or $this.value >= 0) |
| 42. IMMZD13.immunizationEventStatus | |
| Definition | The current status of the individual immunization event |
| Short | Immunization event status |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE1 ValueSet for Immunization event status (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE1 |
| 44. IMMZD13.reasonVaccineWasNotAdministered | |
| 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.D.DE5 ValueSet for Reason vaccine was not administered (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE5, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) QC04 |
| Invariants | IMMZ-D-statusNotDone-1: Required if input in IMMZ.D.DE1 Immunization event status is Not Done (%resource.immunizationEventStatus.value = 'DE4' or $this.exists()) |
| 46. IMMZD13.vaccineBrand | |
| Definition | The brand or trade name used to refer to the vaccine received |
| Short | Vaccine brand |
| Control | 1..1 |
| Binding | For example codes, see IMMZ.D.DE18 ValueSet for Vaccine brand (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE18 |
| 48. IMMZD13.liveVaccine | |
| Definition | Uses a living but weakened version of the virus or one that is very similar |
| Short | Live vaccine |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE173 |
| 50. IMMZD13.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 Iso3166-1-3 (required to http://hl7.org/fhir/ValueSet/iso3166-1-3) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE21 |
| 52. IMMZD13.administrativeArea | |
| Definition | The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred |
| Short | Administrative area |
| Control | 0..1 |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE22, LOINC 72060-7 |
| 54. IMMZD13.vaccineManufacturer | |
| Definition | The manufacturer of the vaccine product |
| Short | Vaccine manufacturer |
| Control | 1..1 |
| Binding | For example codes, see IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE23, LOINC 30957-5 |
| 56. IMMZD13.vaccineBatchNumber | |
| 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 | IMMZ.D CodeSystem for Data Elements DE24, LOINC 30959-1 |
| 58. IMMZD13.vaccineMarketAuthorizationHolder | |
| 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 | 1..1 |
| Binding | For example codes, see IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE25 |
| 60. IMMZD13.expirationDate | |
| Definition | The expiration date of the vaccine |
| Short | Expiration date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE26, LOINC 74066-2 |
| 62. IMMZD13.doseQuantity | |
| Definition | The quantity of vaccine product that was administered |
| Short | Dose quantity |
| Control | 0..1 |
| Type | Quantity |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE34, LOINC 82745-1 |
| Invariants | IMMZ-D-reqGTZero-1: Must be positive decimal value greater than zero (>0.00) (not($this.exists()) or $this.value > 0) |
| 64. IMMZD13.healthWorkerIdentifier | |
| 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-care 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 | IMMZ.D CodeSystem for Data Elements DE35 |
| 66. IMMZD13.totalDosesInSeries | |
| Definition | The recommended number of doses for immunity according to the national immunization schedule (which may be based on product, age, etc.) |
| 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 | IMMZ.D CodeSystem for Data Elements DE125 |
| Invariants | IMMZ-D-reqGTZero-1: Must be positive decimal value greater than zero (>0.00) (not($this.exists()) or $this.value > 0) |
| 68. IMMZD13.diseaseTargeted | |
| Definition | Vaccine-preventable disease being targeted |
| Short | Disease targeted |
| Control | 0..* |
| Binding | The codes SHALL be taken from IMMZ.D.DE126 ValueSet for Disease targeted (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE126 |
| 70. IMMZD13.dueDateOfNextDose | |
| Definition | Date on which the next vaccination should be administered, if a next dose is required |
| Short | Due date of next dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE149 |
Guidance on how to interpret the contents of this table can be foundhere
| 0. IMMZD13 | |
| Definition | Data elements for the IMMZ.D13.Update client record Data Dictionary Activity. |
| Short | IMMZ.D13.Update client record |
| Control | 0..* |
| Is Modifier | false |
| Logical Model | Instances of this logical model are not marked to be the target of a Reference |
| 2. IMMZD13.patient | |
| Definition | The patient. |
| Short | Patient |
| Control | 1..1 |
| Type | Reference |
| 4. IMMZD13.birthDose | |
| Definition | Indicates if the client received a dose within 24 hours of birth. Whether a birth dose is counted as part of the primary series will depend on the antigen |
| Short | Birth dose |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE263 |
| Invariants | IMMZ-D-reqVType-1: Required if input in IMMZ.D.DE19 vaccine type is Hepatitis B-containing vaccines OR Poliovirus-containing vaccines. ((%resource.vaccineType.value != 'DE6' and %resource.vaccineType.value != 'DE14') or $this.exists()) |
| 6. IMMZD13.typeOfDose | |
| Definition | The type of dose in a series that the client received |
| Short | Type of dose |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE258 ValueSet for Type of dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE258 |
| 8. IMMZD13.completedThePrimaryVaccinationSeries | |
| 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 | IMMZ.D CodeSystem for Data Elements DE203 |
| 10. IMMZD13.completedTheBoosterSeries | |
| Definition | Indicates if the client has completed the booster series of a product/antigen |
| Short | Completed the booster series |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE257 |
| 12. IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted | |
| Definition | The date when the client completed the primary vaccination series (per product/antigen) |
| Short | Date when primary vaccination series was completed |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE242 |
| Invariants | IMMZ-D-reqPrimaryCompleted-1: Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes (%resource.completedTheBoosterSeries.value = false or $this.exists())IMMZ-D-dateOccurred-1: Date ≤ current date ( not($this.exists()) or $this.value <= today()) |
| 14. IMMZD13.hivStatus | |
| Definition | The current HIV status of the client |
| Short | HIV status |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE204 ValueSet for HIV status (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE204, LOINC 55277-8, SNOMED CT 278977008 |
| 16. IMMZD13.typeOfPoliovirusDose | |
| Definition | The type of the poliovirus vaccine dose administered to the client |
| Short | Type of poliovirus dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE212, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) XM0N50 |
| Invariants | IMMZ-D-reqVType-4: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines OR Hepatitis B-containing vaccines ((%resource.vaccineType.value != 'DE1' and %resource.vaccineType.value != 'DE6') or $this.exists()) |
| 18. IMMZD13.typeOfJeDose | |
| Definition | The type of Japanese encephalitis (JE) vaccine dose administered to the client |
| Short | Type of JE dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE216 ValueSet for Type of JE dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE216 |
| Invariants | IMMZ-D-reqVType-8: Required if input in IMMZ.D.DE19 vaccine type is JE vaccines (%resource.vaccineType.value != 'DE8' or $this.exists()) |
| 20. IMMZD13.typeOfTbeDose | |
| Definition | The type of tick-borne encephalitis (TBE) vaccine dose administered |
| Short | Type of TBE dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE220 ValueSet for Type of TBE dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE220 |
| Invariants | IMMZ-D-reqVType-9: Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines (%resource.vaccineType.value != 'DE20' or $this.exists()) |
| 22. IMMZD13.typeOfTyphoidDose | |
| Definition | The type of typhoid vaccine dose administered to the client |
| Short | Type of typhoid dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE225 ValueSet for Type of typhoid dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE225 |
| Invariants | IMMZ-D-reqVType-10: Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines (%resource.vaccineType.value != 'DE21' or $this.exists()) |
| 24. IMMZD13.typeOfCholeraDose | |
| Definition | The type of cholera vaccine dose administered to the client |
| Short | Type of cholera dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE229 ValueSet for Type of cholera dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE229 |
| Invariants | IMMZ-D-reqVType-11: Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines (%resource.vaccineType.value != 'DE2' or $this.exists()) |
| 26. IMMZD13.typeOfMeningococcalDose | |
| Definition | The type of meningococcal vaccine dose administered to the client |
| Short | Type of meningococcal dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE232 |
| Invariants | IMMZ-D-reqVType-12: Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines (%resource.vaccineType.value != 'DE10' or $this.exists()) |
| 28. IMMZD13.typeOfHepatitisADose | |
| Definition | The type of hepatitis A-containing vaccine dose administered to the client |
| Short | Type of hepatitis A dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE237 |
| Invariants | IMMZ-D-reqVType-13: Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines (%resource.vaccineType.value != 'DE5' or $this.exists()) |
| 30. IMMZD13.typeOfHepatitisBDose | |
| Definition | The type of hepatitis B-containing vaccine dose administered to the client |
| Short | Type of hepatitis B dose |
| Control | 0..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE254 |
| Invariants | IMMZ-D-reqVType-14: Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines (%resource.vaccineType.value != 'DE6' or $this.exists()) |
| 32. IMMZD13.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 | 1..* |
| Binding | The codes SHALL be taken from IMMZ.Z.VS ValueSet for vaccine types (required to http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE19, LOINC 39236-5, SNOMED CT 787859002 |
| 34. IMMZD13.dateAndTimeOfVaccination | |
| Definition | Represents the visit/encounter date, which is the date and time when each 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 | IMMZ.D CodeSystem for Data Elements DE20, LOINC 30952-6 |
| 36. IMMZD13.contactDate | |
| Definition | The date and time of the client's contact |
| Short | Contact date |
| Control | 0..1 |
| Type | dateTime |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE201, LOINC 21975-8, SNOMED CT 406543005 |
| Invariants | IMMZ-D-dateTimeOccurred-1: DateTime ≤ current DateTime (not($this.exists()) or $this.value <= now()) |
| 38. IMMZD13.ancContactNumber | |
| Definition | The antenatal care (ANC) contact or visit number |
| Short | ANC contact number |
| Control | 0..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE202, LOINC 75612-2, SNOMED CT 3401000175105 |
| 40. IMMZD13.doseNumber | |
| Definition | Vaccine dose number including dose number within series |
| Short | Dose number |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE124 |
| Invariants | IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) (not($this.exists()) or $this.value >= 0) |
| 42. IMMZD13.immunizationEventStatus | |
| Definition | The current status of the individual immunization event |
| Short | Immunization event status |
| Control | 1..1 |
| Binding | The codes SHALL be taken from IMMZ.D.DE1 ValueSet for Immunization event status (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE1 |
| 44. IMMZD13.reasonVaccineWasNotAdministered | |
| 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.D.DE5 ValueSet for Reason vaccine was not administered (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE5, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) QC04 |
| Invariants | IMMZ-D-statusNotDone-1: Required if input in IMMZ.D.DE1 Immunization event status is Not Done (%resource.immunizationEventStatus.value = 'DE4' or $this.exists()) |
| 46. IMMZD13.vaccineBrand | |
| Definition | The brand or trade name used to refer to the vaccine received |
| Short | Vaccine brand |
| Control | 1..1 |
| Binding | For example codes, see IMMZ.D.DE18 ValueSet for Vaccine brand (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE18 |
| 48. IMMZD13.liveVaccine | |
| Definition | Uses a living but weakened version of the virus or one that is very similar |
| Short | Live vaccine |
| Control | 0..1 |
| Type | boolean |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE173 |
| 50. IMMZD13.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 Iso3166-1-3 (required to http://hl7.org/fhir/ValueSet/iso3166-1-3) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE21 |
| 52. IMMZD13.administrativeArea | |
| Definition | The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred |
| Short | Administrative area |
| Control | 0..1 |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE22, LOINC 72060-7 |
| 54. IMMZD13.vaccineManufacturer | |
| Definition | The manufacturer of the vaccine product |
| Short | Vaccine manufacturer |
| Control | 1..1 |
| Binding | For example codes, see IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE23, LOINC 30957-5 |
| 56. IMMZD13.vaccineBatchNumber | |
| 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 | IMMZ.D CodeSystem for Data Elements DE24, LOINC 30959-1 |
| 58. IMMZD13.vaccineMarketAuthorizationHolder | |
| 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 | 1..1 |
| Binding | For example codes, see IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE25 |
| 60. IMMZD13.expirationDate | |
| Definition | The expiration date of the vaccine |
| Short | Expiration date |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE26, LOINC 74066-2 |
| 62. IMMZD13.doseQuantity | |
| Definition | The quantity of vaccine product that was administered |
| Short | Dose quantity |
| Control | 0..1 |
| Type | Quantity |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE34, LOINC 82745-1 |
| Invariants | IMMZ-D-reqGTZero-1: Must be positive decimal value greater than zero (>0.00) (not($this.exists()) or $this.value > 0) |
| 64. IMMZD13.healthWorkerIdentifier | |
| 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-care 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 | IMMZ.D CodeSystem for Data Elements DE35 |
| 66. IMMZD13.totalDosesInSeries | |
| Definition | The recommended number of doses for immunity according to the national immunization schedule (which may be based on product, age, etc.) |
| 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 | IMMZ.D CodeSystem for Data Elements DE125 |
| Invariants | IMMZ-D-reqGTZero-1: Must be positive decimal value greater than zero (>0.00) (not($this.exists()) or $this.value > 0) |
| 68. IMMZD13.diseaseTargeted | |
| Definition | Vaccine-preventable disease being targeted |
| Short | Disease targeted |
| Control | 0..* |
| Binding | The codes SHALL be taken from IMMZ.D.DE126 ValueSet for Disease targeted (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126) |
| Type | Coding |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE126 |
| 70. IMMZD13.dueDateOfNextDose | |
| Definition | Date on which the next vaccination should be administered, if a next dose is required |
| Short | Due date of next dose |
| Control | 0..1 |
| Type | date |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Definitional Codes | IMMZ.D CodeSystem for Data Elements DE149 |