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 IMMZD1 logical model.
Guidance on how to interpret the contents of this table can be foundhere
0. IMMZD1 | |
Definition | Data elements for the IMMZ.D1.Capture or update client history Data Dictionary Activity. |
Short | IMMZ.D1.Capture or update client history |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZD1.patient | |
Definition | The patient. |
Short | Patient |
Control | 1..1 |
Type | Reference |
4. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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 | IMMZ.D CodeSystem for Data Elements DE208, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) KA21.4, LOINC 76517-2, SNOMED CT 395507008 |
18. IMMZD1.immunocompromised | |
Definition | The client is known to be immunocompromised. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases |
Short | Immunocompromised |
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 DE209, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) 4B4Z, LOINC 96381-9, SNOMED CT 370388006 |
20. IMMZD1.currentlyOnArt | |
Definition | The client is currently receiving antiretroviral therapy (ART) |
Short | Currently on ART |
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 DE210 |
Invariants | IMMZ-D-reqHIVPositive-1: Required if input in IMMZ.D.DE204 HIV status is HIV-positive (%resource.hivStatus.value != 'DE11' or $this.exists() ) |
22. IMMZD1.typeOfTbInfectionTestPerformed | |
Definition | The type of tuberculosis (TB) infection test performed |
Short | Type of TB infection test performed |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE243 |
Invariants | IMMZ-D-reqVType-2: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines (%resource.vaccineType.value != 'DE1' or $this.exists() ) |
24. IMMZD1.tbInfectionTestResult | |
Definition | Records the result of the TB infection test |
Short | TB infection test result |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE246 ValueSet for TB infection test result (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE246 |
Invariants | IMMZ-D-reqTBTest-1: Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL (not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists() ) |
26. IMMZD1.immunologicallyStable | |
Definition | The client is living with HIV and is immunologically stable with CD4 count or percentage above a minimum as defined in the HIV guidelines |
Short | Immunologically stable |
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 DE249 |
Invariants | IMMZ-D-reqVType-3: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines OR Typhoid vaccines ((%resource.vaccineType.value != 'DE1' and %resource.vaccineType.value != 'DE21') or $this.exists() ) |
28. IMMZD1.clinicallyWell | |
Definition | The client is living with HIV and is clinically well, as defined in HIV guidelines and WHO clinical staging |
Short | Clinically well |
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 DE250 |
Invariants | IMMZ-D-reqVType-2: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines (%resource.vaccineType.value != 'DE1' or $this.exists() ) |
30. IMMZD1.birthWeightInGrams | |
Definition | Represents the client's birth weight value measures in grams |
Short | Birth weight in grams |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE211, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) KA21, LOINC 8339-4 |
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() )IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) ( not($this.exists()) or $this.value >= 0 ) |
32. IMMZD1.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-5: Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines (%resource.vaccineType.value != 'DE14' or $this.exists() ) |
34. IMMZD1.artStartDate | |
Definition | The date on which the client started or restarted ART |
Short | ART start 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 DE215 |
Invariants | IMMZ-D-reqVType-6: Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines (%resource.vaccineType.value != 'DE9' or $this.exists() )IMMZ-D-dateOccurred-1: Date ≤ current date ( not($this.exists()) or $this.value <= today() ) |
36. IMMZD1.highRiskOfPneumococcalInfection | |
Definition | The client is at high risk for pneumococcal infection because of underlying medical conditions (i.e. HIV infection or sickle-cell disease) |
Short | High risk of pneumococcal infection |
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 DE251 |
Invariants | IMMZ-D-reqVType-7: Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines (%resource.vaccineType.value != 'DE13' or $this.exists() ) |
38. IMMZD1.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() ) |
40. IMMZD1.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() ) |
42. IMMZD1.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() ) |
44. IMMZD1.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() ) |
46. IMMZD1.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() ) |
48. IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose | |
Definition | The age in months when client received their first meningococcal dose |
Short | Age in months when client received first meningococcal dose |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE236 |
Invariants | IMMZ-D-reqVType-12: Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines (%resource.vaccineType.value != 'DE10' or $this.exists() )IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) ( not($this.exists()) or $this.value >= 0 ) |
50. IMMZD1.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() ) |
52. IMMZD1.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() ) |
54. IMMZD1.vnaLevel | |
Definition | Vaccine-induced neutralizing antibody (VNA) level, measured as a serum antibody concentration from the result of the concentrated, purified cell culture-derived and embryonated egg-based rabies vaccines (CCEEV) |
Short | VNA level |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE240 |
Invariants | IMMZ-D-reqVType-15: Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines (%resource.vaccineType.value != 'DE15' or $this.exists() ) |
56. IMMZD1.riskOfOccupationalExposureToRabiesVirus | |
Definition | Professional at risk of occupational exposure to rabies virus, particularly animal health workers. Also considered for medical professionals who regularly provide care to persons with rabies |
Short | Risk of occupational exposure to rabies virus |
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 DE253 |
Invariants | IMMZ-D-reqVType-15: Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines (%resource.vaccineType.value != 'DE15' or $this.exists() ) |
58. IMMZD1.dengueSerostatus | |
Definition | Indicates the result of a serological test determining whether the client has antibodies against the dengue virus |
Short | Dengue serostatus |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE241 ValueSet for Dengue serostatus (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE241 |
Invariants | IMMZ-D-reqVType-16: Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines (%resource.vaccineType.value != 'DE25' or $this.exists() ) |
60. IMMZD1.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 |
62. IMMZD1.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 |
64. IMMZD1.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() ) |
66. IMMZD1.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 |
68. IMMZD1.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 ) |
Guidance on how to interpret the contents of this table can be foundhere
0. IMMZD1 | |
Definition | Data elements for the IMMZ.D1.Capture or update client history Data Dictionary Activity. |
Short | IMMZ.D1.Capture or update client history |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZD1.patient | |
Definition | The patient. |
Short | Patient |
Control | 1..1 |
Type | Reference |
4. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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 | IMMZ.D CodeSystem for Data Elements DE208, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) KA21.4, LOINC 76517-2, SNOMED CT 395507008 |
18. IMMZD1.immunocompromised | |
Definition | The client is known to be immunocompromised. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases |
Short | Immunocompromised |
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 DE209, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) 4B4Z, LOINC 96381-9, SNOMED CT 370388006 |
20. IMMZD1.currentlyOnArt | |
Definition | The client is currently receiving antiretroviral therapy (ART) |
Short | Currently on ART |
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 DE210 |
Invariants | IMMZ-D-reqHIVPositive-1: Required if input in IMMZ.D.DE204 HIV status is HIV-positive (%resource.hivStatus.value != 'DE11' or $this.exists() ) |
22. IMMZD1.typeOfTbInfectionTestPerformed | |
Definition | The type of tuberculosis (TB) infection test performed |
Short | Type of TB infection test performed |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE243 |
Invariants | IMMZ-D-reqVType-2: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines (%resource.vaccineType.value != 'DE1' or $this.exists() ) |
24. IMMZD1.tbInfectionTestResult | |
Definition | Records the result of the TB infection test |
Short | TB infection test result |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE246 ValueSet for TB infection test result (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE246 |
Invariants | IMMZ-D-reqTBTest-1: Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL (not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists() ) |
26. IMMZD1.immunologicallyStable | |
Definition | The client is living with HIV and is immunologically stable with CD4 count or percentage above a minimum as defined in the HIV guidelines |
Short | Immunologically stable |
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 DE249 |
Invariants | IMMZ-D-reqVType-3: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines OR Typhoid vaccines ((%resource.vaccineType.value != 'DE1' and %resource.vaccineType.value != 'DE21') or $this.exists() ) |
28. IMMZD1.clinicallyWell | |
Definition | The client is living with HIV and is clinically well, as defined in HIV guidelines and WHO clinical staging |
Short | Clinically well |
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 DE250 |
Invariants | IMMZ-D-reqVType-2: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines (%resource.vaccineType.value != 'DE1' or $this.exists() ) |
30. IMMZD1.birthWeightInGrams | |
Definition | Represents the client's birth weight value measures in grams |
Short | Birth weight in grams |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE211, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) KA21, LOINC 8339-4 |
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() )IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) ( not($this.exists()) or $this.value >= 0 ) |
32. IMMZD1.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-5: Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines (%resource.vaccineType.value != 'DE14' or $this.exists() ) |
34. IMMZD1.artStartDate | |
Definition | The date on which the client started or restarted ART |
Short | ART start 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 DE215 |
Invariants | IMMZ-D-reqVType-6: Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines (%resource.vaccineType.value != 'DE9' or $this.exists() )IMMZ-D-dateOccurred-1: Date ≤ current date ( not($this.exists()) or $this.value <= today() ) |
36. IMMZD1.highRiskOfPneumococcalInfection | |
Definition | The client is at high risk for pneumococcal infection because of underlying medical conditions (i.e. HIV infection or sickle-cell disease) |
Short | High risk of pneumococcal infection |
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 DE251 |
Invariants | IMMZ-D-reqVType-7: Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines (%resource.vaccineType.value != 'DE13' or $this.exists() ) |
38. IMMZD1.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() ) |
40. IMMZD1.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() ) |
42. IMMZD1.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() ) |
44. IMMZD1.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() ) |
46. IMMZD1.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() ) |
48. IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose | |
Definition | The age in months when client received their first meningococcal dose |
Short | Age in months when client received first meningococcal dose |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE236 |
Invariants | IMMZ-D-reqVType-12: Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines (%resource.vaccineType.value != 'DE10' or $this.exists() )IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) ( not($this.exists()) or $this.value >= 0 ) |
50. IMMZD1.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() ) |
52. IMMZD1.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() ) |
54. IMMZD1.vnaLevel | |
Definition | Vaccine-induced neutralizing antibody (VNA) level, measured as a serum antibody concentration from the result of the concentrated, purified cell culture-derived and embryonated egg-based rabies vaccines (CCEEV) |
Short | VNA level |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE240 |
Invariants | IMMZ-D-reqVType-15: Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines (%resource.vaccineType.value != 'DE15' or $this.exists() ) |
56. IMMZD1.riskOfOccupationalExposureToRabiesVirus | |
Definition | Professional at risk of occupational exposure to rabies virus, particularly animal health workers. Also considered for medical professionals who regularly provide care to persons with rabies |
Short | Risk of occupational exposure to rabies virus |
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 DE253 |
Invariants | IMMZ-D-reqVType-15: Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines (%resource.vaccineType.value != 'DE15' or $this.exists() ) |
58. IMMZD1.dengueSerostatus | |
Definition | Indicates the result of a serological test determining whether the client has antibodies against the dengue virus |
Short | Dengue serostatus |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE241 ValueSet for Dengue serostatus (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE241 |
Invariants | IMMZ-D-reqVType-16: Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines (%resource.vaccineType.value != 'DE25' or $this.exists() ) |
60. IMMZD1.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 |
62. IMMZD1.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 |
64. IMMZD1.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() ) |
66. IMMZD1.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 |
68. IMMZD1.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 ) |
Guidance on how to interpret the contents of this table can be foundhere
0. IMMZD1 | |
Definition | Data elements for the IMMZ.D1.Capture or update client history Data Dictionary Activity. |
Short | IMMZ.D1.Capture or update client history |
Control | 0..* |
Is Modifier | false |
Logical Model | Instances of this logical model are not marked to be the target of a Reference |
2. IMMZD1.patient | |
Definition | The patient. |
Short | Patient |
Control | 1..1 |
Type | Reference |
4. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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. IMMZD1.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 | IMMZ.D CodeSystem for Data Elements DE208, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) KA21.4, LOINC 76517-2, SNOMED CT 395507008 |
18. IMMZD1.immunocompromised | |
Definition | The client is known to be immunocompromised. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases |
Short | Immunocompromised |
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 DE209, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) 4B4Z, LOINC 96381-9, SNOMED CT 370388006 |
20. IMMZD1.currentlyOnArt | |
Definition | The client is currently receiving antiretroviral therapy (ART) |
Short | Currently on ART |
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 DE210 |
Invariants | IMMZ-D-reqHIVPositive-1: Required if input in IMMZ.D.DE204 HIV status is HIV-positive (%resource.hivStatus.value != 'DE11' or $this.exists() ) |
22. IMMZD1.typeOfTbInfectionTestPerformed | |
Definition | The type of tuberculosis (TB) infection test performed |
Short | Type of TB infection test performed |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE243 |
Invariants | IMMZ-D-reqVType-2: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines (%resource.vaccineType.value != 'DE1' or $this.exists() ) |
24. IMMZD1.tbInfectionTestResult | |
Definition | Records the result of the TB infection test |
Short | TB infection test result |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE246 ValueSet for TB infection test result (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE246 |
Invariants | IMMZ-D-reqTBTest-1: Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL (not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists() ) |
26. IMMZD1.immunologicallyStable | |
Definition | The client is living with HIV and is immunologically stable with CD4 count or percentage above a minimum as defined in the HIV guidelines |
Short | Immunologically stable |
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 DE249 |
Invariants | IMMZ-D-reqVType-3: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines OR Typhoid vaccines ((%resource.vaccineType.value != 'DE1' and %resource.vaccineType.value != 'DE21') or $this.exists() ) |
28. IMMZD1.clinicallyWell | |
Definition | The client is living with HIV and is clinically well, as defined in HIV guidelines and WHO clinical staging |
Short | Clinically well |
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 DE250 |
Invariants | IMMZ-D-reqVType-2: Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines (%resource.vaccineType.value != 'DE1' or $this.exists() ) |
30. IMMZD1.birthWeightInGrams | |
Definition | Represents the client's birth weight value measures in grams |
Short | Birth weight in grams |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE211, International Classification of Diseases, 11th Revision Mortality and Morbidity Statistics (MMS) KA21, LOINC 8339-4 |
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() )IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) ( not($this.exists()) or $this.value >= 0 ) |
32. IMMZD1.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-5: Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines (%resource.vaccineType.value != 'DE14' or $this.exists() ) |
34. IMMZD1.artStartDate | |
Definition | The date on which the client started or restarted ART |
Short | ART start 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 DE215 |
Invariants | IMMZ-D-reqVType-6: Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines (%resource.vaccineType.value != 'DE9' or $this.exists() )IMMZ-D-dateOccurred-1: Date ≤ current date ( not($this.exists()) or $this.value <= today() ) |
36. IMMZD1.highRiskOfPneumococcalInfection | |
Definition | The client is at high risk for pneumococcal infection because of underlying medical conditions (i.e. HIV infection or sickle-cell disease) |
Short | High risk of pneumococcal infection |
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 DE251 |
Invariants | IMMZ-D-reqVType-7: Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines (%resource.vaccineType.value != 'DE13' or $this.exists() ) |
38. IMMZD1.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() ) |
40. IMMZD1.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() ) |
42. IMMZD1.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() ) |
44. IMMZD1.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() ) |
46. IMMZD1.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() ) |
48. IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose | |
Definition | The age in months when client received their first meningococcal dose |
Short | Age in months when client received first meningococcal dose |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE236 |
Invariants | IMMZ-D-reqVType-12: Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines (%resource.vaccineType.value != 'DE10' or $this.exists() )IMMZ-D-reqGTEZero-1: Must be positive decimal value greater than or equal to zero (≥0) ( not($this.exists()) or $this.value >= 0 ) |
50. IMMZD1.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() ) |
52. IMMZD1.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() ) |
54. IMMZD1.vnaLevel | |
Definition | Vaccine-induced neutralizing antibody (VNA) level, measured as a serum antibody concentration from the result of the concentrated, purified cell culture-derived and embryonated egg-based rabies vaccines (CCEEV) |
Short | VNA level |
Control | 0..1 |
Type | decimal |
Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE240 |
Invariants | IMMZ-D-reqVType-15: Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines (%resource.vaccineType.value != 'DE15' or $this.exists() ) |
56. IMMZD1.riskOfOccupationalExposureToRabiesVirus | |
Definition | Professional at risk of occupational exposure to rabies virus, particularly animal health workers. Also considered for medical professionals who regularly provide care to persons with rabies |
Short | Risk of occupational exposure to rabies virus |
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 DE253 |
Invariants | IMMZ-D-reqVType-15: Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines (%resource.vaccineType.value != 'DE15' or $this.exists() ) |
58. IMMZD1.dengueSerostatus | |
Definition | Indicates the result of a serological test determining whether the client has antibodies against the dengue virus |
Short | Dengue serostatus |
Control | 0..1 |
Binding | The codes SHALL be taken from IMMZ.D.DE241 ValueSet for Dengue serostatus (required to http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241 ) |
Type | Coding |
Definitional Codes | IMMZ.D CodeSystem for Data Elements DE241 |
Invariants | IMMZ-D-reqVType-16: Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines (%resource.vaccineType.value != 'DE25' or $this.exists() ) |
60. IMMZD1.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 |
62. IMMZD1.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 |
64. IMMZD1.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() ) |
66. IMMZD1.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 |
68. IMMZD1.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 ) |