IMMZ.D1.Capture or update client history - WHO Immunization Implementation Guide v0.2.0

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/tree/sop and changes regularly. See the Directory of published versions

Logical Model: IMMZ.D1.Capture or update client history

Official URL: http://smart.who.int/immunizations/StructureDefinition/IMMZD1				Version: 0.2.0
Active as of 2025-01-10				Computable Name: IMMZ_D1_Capture_or_update_client_history

Data elements for the IMMZ.D1.Capture or update client history Data Dictionary Activity.

Usages:

This Logical Model is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

Key Elements Table
Differential Table
Snapshot Table
Statistics/References
All

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD1		0..*	Base	IMMZ.D1.Capture or update client history
patient		1..1	Reference()	Patient
birthDose	C	0..1	boolean	Birth dose Constraints: IMMZ-D-reqVType-1
typeOfDose		1..1	Coding	Type of dose Binding: IMMZ.D.DE258 ValueSet for Type of dose (required)
completedThePrimaryVaccinationSeries		0..1	boolean	Completed the primary vaccination series
completedTheBoosterSeries		0..1	boolean	Completed the booster series
dateWhenPrimaryVaccinationSeriesWasCompleted	C	0..1	date	Date when primary vaccination series was completed Constraints: IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D.DE204 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
currentlyOnArt	C	0..1	boolean	Currently on ART Constraints: IMMZ-D-reqHIVPositive-1
typeOfTbInfectionTestPerformed	C	0..1	Coding	Type of TB infection test performed Binding: IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required) Constraints: IMMZ-D-reqVType-2
tbInfectionTestResult	C	0..1	Coding	TB infection test result Binding: IMMZ.D.DE246 ValueSet for TB infection test result (required) Constraints: IMMZ-D-reqTBTest-1
immunologicallyStable	C	0..1	boolean	Immunologically stable Constraints: IMMZ-D-reqVType-3
clinicallyWell	C	0..1	boolean	Clinically well Constraints: IMMZ-D-reqVType-2
birthWeightInGrams	C	0..1	decimal	Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-5
artStartDate	C	0..1	date	ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1
highRiskOfPneumococcalInfection	C	0..1	boolean	High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7
typeOfJeDose	C	0..1	Coding	Type of JE dose Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) Constraints: IMMZ-D-reqVType-8
typeOfTbeDose	C	0..1	Coding	Type of TBE dose Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) Constraints: IMMZ-D-reqVType-9
typeOfTyphoidDose	C	0..1	Coding	Type of typhoid dose Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) Constraints: IMMZ-D-reqVType-10
typeOfCholeraDose	C	0..1	Coding	Type of cholera dose Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) Constraints: IMMZ-D-reqVType-11
typeOfMeningococcalDose	C	0..1	Coding	Type of meningococcal dose Binding: IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required) Constraints: IMMZ-D-reqVType-12
ageInMonthsWhenClientReceivedFirstMeningococcalDose	C	0..1	decimal	Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1
typeOfHepatitisADose	C	0..1	Coding	Type of hepatitis A dose Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) Constraints: IMMZ-D-reqVType-13
typeOfHepatitisBDose	C	0..1	Coding	Type of hepatitis B dose Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) Constraints: IMMZ-D-reqVType-14
vnaLevel	C	0..1	decimal	VNA level Constraints: IMMZ-D-reqVType-15
riskOfOccupationalExposureToRabiesVirus	C	0..1	boolean	Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15
dengueSerostatus	C	0..1	Coding	Dengue serostatus Binding: IMMZ.D.DE241 ValueSet for Dengue serostatus (required) Constraints: IMMZ-D-reqVType-16
vaccineType		1..*	Coding	Vaccine type Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
dateAndTimeOfVaccination		1..1	dateTime	Date and time of vaccination
contactDate	C	0..1	dateTime	Contact date Constraints: IMMZ-D-dateTimeOccurred-1
ancContactNumber		0..1	integer	ANC contact number
doseNumber	C	1..1	integer	Dose number Constraints: IMMZ-D-reqGTEZero-1
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD1.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD1.typeOfTbInfectionTestPerformed	required	IMMZ_D_DE243 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243` From this IG
IMMZD1.tbInfectionTestResult	required	IMMZ_D_DE246 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246` From this IG
IMMZD1.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD1.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD1.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD1.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD1.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD1.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD1.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD1.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD1.dengueSerostatus	required	IMMZ_D_DE241 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241` From this IG
IMMZD1.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted, IMMZD1.artStartDate	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD1.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD1.birthWeightInGrams, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose, IMMZD1.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqHIVPositive-1	error	IMMZD1.currentlyOnArt	Required if input in IMMZ.D.DE204 HIV status is HIV-positive : %resource.hivStatus.value != 'DE11' or $this.exists()
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqTBTest-1	error	IMMZD1.tbInfectionTestResult	Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL : not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD1.birthDose	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()
IMMZ-D-reqVType-2	error	IMMZD1.typeOfTbInfectionTestPerformed, IMMZD1.clinicallyWell	Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines : %resource.vaccineType.value != 'DE1' or $this.exists()
IMMZ-D-reqVType-3	error	IMMZD1.immunologicallyStable	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()
IMMZ-D-reqVType-4	error	IMMZD1.birthWeightInGrams	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-reqVType-5	error	IMMZD1.typeOfPoliovirusDose	Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines : %resource.vaccineType.value != 'DE14' or $this.exists()
IMMZ-D-reqVType-6	error	IMMZD1.artStartDate	Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines : %resource.vaccineType.value != 'DE9' or $this.exists()
IMMZ-D-reqVType-7	error	IMMZD1.highRiskOfPneumococcalInfection	Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines : %resource.vaccineType.value != 'DE13' or $this.exists()
IMMZ-D-reqVType-8	error	IMMZD1.typeOfJeDose	Required if input in IMMZ.D.DE19 vaccine type is JE vaccines : %resource.vaccineType.value != 'DE8' or $this.exists()
IMMZ-D-reqVType-9	error	IMMZD1.typeOfTbeDose	Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines : %resource.vaccineType.value != 'DE20' or $this.exists()
IMMZ-D-reqVType-10	error	IMMZD1.typeOfTyphoidDose	Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines : %resource.vaccineType.value != 'DE21' or $this.exists()
IMMZ-D-reqVType-11	error	IMMZD1.typeOfCholeraDose	Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines : %resource.vaccineType.value != 'DE2' or $this.exists()
IMMZ-D-reqVType-12	error	IMMZD1.typeOfMeningococcalDose, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD1.typeOfHepatitisADose	Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines : %resource.vaccineType.value != 'DE5' or $this.exists()
IMMZ-D-reqVType-14	error	IMMZD1.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-reqVType-15	error	IMMZD1.vnaLevel, IMMZD1.riskOfOccupationalExposureToRabiesVirus	Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines : %resource.vaccineType.value != 'DE15' or $this.exists()
IMMZ-D-reqVType-16	error	IMMZD1.dengueSerostatus	Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines : %resource.vaccineType.value != 'DE25' or $this.exists()

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD1		0..*	Base	IMMZ.D1.Capture or update client history
patient		1..1	Reference()	Patient
birthDose	C	0..1	boolean	Birth dose Constraints: IMMZ-D-reqVType-1
typeOfDose		1..1	Coding	Type of dose Binding: IMMZ.D.DE258 ValueSet for Type of dose (required)
completedThePrimaryVaccinationSeries		0..1	boolean	Completed the primary vaccination series
completedTheBoosterSeries		0..1	boolean	Completed the booster series
dateWhenPrimaryVaccinationSeriesWasCompleted	C	0..1	date	Date when primary vaccination series was completed Constraints: IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D.DE204 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
currentlyOnArt	C	0..1	boolean	Currently on ART Constraints: IMMZ-D-reqHIVPositive-1
typeOfTbInfectionTestPerformed	C	0..1	Coding	Type of TB infection test performed Binding: IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required) Constraints: IMMZ-D-reqVType-2
tbInfectionTestResult	C	0..1	Coding	TB infection test result Binding: IMMZ.D.DE246 ValueSet for TB infection test result (required) Constraints: IMMZ-D-reqTBTest-1
immunologicallyStable	C	0..1	boolean	Immunologically stable Constraints: IMMZ-D-reqVType-3
clinicallyWell	C	0..1	boolean	Clinically well Constraints: IMMZ-D-reqVType-2
birthWeightInGrams	C	0..1	decimal	Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-5
artStartDate	C	0..1	date	ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1
highRiskOfPneumococcalInfection	C	0..1	boolean	High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7
typeOfJeDose	C	0..1	Coding	Type of JE dose Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) Constraints: IMMZ-D-reqVType-8
typeOfTbeDose	C	0..1	Coding	Type of TBE dose Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) Constraints: IMMZ-D-reqVType-9
typeOfTyphoidDose	C	0..1	Coding	Type of typhoid dose Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) Constraints: IMMZ-D-reqVType-10
typeOfCholeraDose	C	0..1	Coding	Type of cholera dose Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) Constraints: IMMZ-D-reqVType-11
typeOfMeningococcalDose	C	0..1	Coding	Type of meningococcal dose Binding: IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required) Constraints: IMMZ-D-reqVType-12
ageInMonthsWhenClientReceivedFirstMeningococcalDose	C	0..1	decimal	Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1
typeOfHepatitisADose	C	0..1	Coding	Type of hepatitis A dose Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) Constraints: IMMZ-D-reqVType-13
typeOfHepatitisBDose	C	0..1	Coding	Type of hepatitis B dose Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) Constraints: IMMZ-D-reqVType-14
vnaLevel	C	0..1	decimal	VNA level Constraints: IMMZ-D-reqVType-15
riskOfOccupationalExposureToRabiesVirus	C	0..1	boolean	Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15
dengueSerostatus	C	0..1	Coding	Dengue serostatus Binding: IMMZ.D.DE241 ValueSet for Dengue serostatus (required) Constraints: IMMZ-D-reqVType-16
vaccineType		1..*	Coding	Vaccine type Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
dateAndTimeOfVaccination		1..1	dateTime	Date and time of vaccination
contactDate	C	0..1	dateTime	Contact date Constraints: IMMZ-D-dateTimeOccurred-1
ancContactNumber		0..1	integer	ANC contact number
doseNumber	C	1..1	integer	Dose number Constraints: IMMZ-D-reqGTEZero-1
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZD1.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD1.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD1.typeOfTbInfectionTestPerformed	required	IMMZ_D_DE243 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243` From this IG
IMMZD1.tbInfectionTestResult	required	IMMZ_D_DE246 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246` From this IG
IMMZD1.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD1.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD1.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD1.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD1.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD1.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD1.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD1.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD1.dengueSerostatus	required	IMMZ_D_DE241 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241` From this IG
IMMZD1.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted, IMMZD1.artStartDate	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD1.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD1.birthWeightInGrams, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose, IMMZD1.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqHIVPositive-1	error	IMMZD1.currentlyOnArt	Required if input in IMMZ.D.DE204 HIV status is HIV-positive : %resource.hivStatus.value != 'DE11' or $this.exists()
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqTBTest-1	error	IMMZD1.tbInfectionTestResult	Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL : not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD1.birthDose	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()
IMMZ-D-reqVType-2	error	IMMZD1.typeOfTbInfectionTestPerformed, IMMZD1.clinicallyWell	Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines : %resource.vaccineType.value != 'DE1' or $this.exists()
IMMZ-D-reqVType-3	error	IMMZD1.immunologicallyStable	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()
IMMZ-D-reqVType-4	error	IMMZD1.birthWeightInGrams	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-reqVType-5	error	IMMZD1.typeOfPoliovirusDose	Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines : %resource.vaccineType.value != 'DE14' or $this.exists()
IMMZ-D-reqVType-6	error	IMMZD1.artStartDate	Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines : %resource.vaccineType.value != 'DE9' or $this.exists()
IMMZ-D-reqVType-7	error	IMMZD1.highRiskOfPneumococcalInfection	Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines : %resource.vaccineType.value != 'DE13' or $this.exists()
IMMZ-D-reqVType-8	error	IMMZD1.typeOfJeDose	Required if input in IMMZ.D.DE19 vaccine type is JE vaccines : %resource.vaccineType.value != 'DE8' or $this.exists()
IMMZ-D-reqVType-9	error	IMMZD1.typeOfTbeDose	Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines : %resource.vaccineType.value != 'DE20' or $this.exists()
IMMZ-D-reqVType-10	error	IMMZD1.typeOfTyphoidDose	Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines : %resource.vaccineType.value != 'DE21' or $this.exists()
IMMZ-D-reqVType-11	error	IMMZD1.typeOfCholeraDose	Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines : %resource.vaccineType.value != 'DE2' or $this.exists()
IMMZ-D-reqVType-12	error	IMMZD1.typeOfMeningococcalDose, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD1.typeOfHepatitisADose	Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines : %resource.vaccineType.value != 'DE5' or $this.exists()
IMMZ-D-reqVType-14	error	IMMZD1.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-reqVType-15	error	IMMZD1.vnaLevel, IMMZD1.riskOfOccupationalExposureToRabiesVirus	Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines : %resource.vaccineType.value != 'DE15' or $this.exists()
IMMZ-D-reqVType-16	error	IMMZD1.dengueSerostatus	Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines : %resource.vaccineType.value != 'DE25' or $this.exists()

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD1		0..*	Base	IMMZ.D1.Capture or update client history
patient		1..1	Reference()	Patient
birthDose	C	0..1	boolean	Birth dose Constraints: IMMZ-D-reqVType-1
typeOfDose		1..1	Coding	Type of dose Binding: IMMZ.D.DE258 ValueSet for Type of dose (required)
completedThePrimaryVaccinationSeries		0..1	boolean	Completed the primary vaccination series
completedTheBoosterSeries		0..1	boolean	Completed the booster series
dateWhenPrimaryVaccinationSeriesWasCompleted	C	0..1	date	Date when primary vaccination series was completed Constraints: IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D.DE204 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
currentlyOnArt	C	0..1	boolean	Currently on ART Constraints: IMMZ-D-reqHIVPositive-1
typeOfTbInfectionTestPerformed	C	0..1	Coding	Type of TB infection test performed Binding: IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required) Constraints: IMMZ-D-reqVType-2
tbInfectionTestResult	C	0..1	Coding	TB infection test result Binding: IMMZ.D.DE246 ValueSet for TB infection test result (required) Constraints: IMMZ-D-reqTBTest-1
immunologicallyStable	C	0..1	boolean	Immunologically stable Constraints: IMMZ-D-reqVType-3
clinicallyWell	C	0..1	boolean	Clinically well Constraints: IMMZ-D-reqVType-2
birthWeightInGrams	C	0..1	decimal	Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-5
artStartDate	C	0..1	date	ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1
highRiskOfPneumococcalInfection	C	0..1	boolean	High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7
typeOfJeDose	C	0..1	Coding	Type of JE dose Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) Constraints: IMMZ-D-reqVType-8
typeOfTbeDose	C	0..1	Coding	Type of TBE dose Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) Constraints: IMMZ-D-reqVType-9
typeOfTyphoidDose	C	0..1	Coding	Type of typhoid dose Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) Constraints: IMMZ-D-reqVType-10
typeOfCholeraDose	C	0..1	Coding	Type of cholera dose Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) Constraints: IMMZ-D-reqVType-11
typeOfMeningococcalDose	C	0..1	Coding	Type of meningococcal dose Binding: IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required) Constraints: IMMZ-D-reqVType-12
ageInMonthsWhenClientReceivedFirstMeningococcalDose	C	0..1	decimal	Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1
typeOfHepatitisADose	C	0..1	Coding	Type of hepatitis A dose Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) Constraints: IMMZ-D-reqVType-13
typeOfHepatitisBDose	C	0..1	Coding	Type of hepatitis B dose Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) Constraints: IMMZ-D-reqVType-14
vnaLevel	C	0..1	decimal	VNA level Constraints: IMMZ-D-reqVType-15
riskOfOccupationalExposureToRabiesVirus	C	0..1	boolean	Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15
dengueSerostatus	C	0..1	Coding	Dengue serostatus Binding: IMMZ.D.DE241 ValueSet for Dengue serostatus (required) Constraints: IMMZ-D-reqVType-16
vaccineType		1..*	Coding	Vaccine type Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
dateAndTimeOfVaccination		1..1	dateTime	Date and time of vaccination
contactDate	C	0..1	dateTime	Contact date Constraints: IMMZ-D-dateTimeOccurred-1
ancContactNumber		0..1	integer	ANC contact number
doseNumber	C	1..1	integer	Dose number Constraints: IMMZ-D-reqGTEZero-1
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD1.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD1.typeOfTbInfectionTestPerformed	required	IMMZ_D_DE243 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243` From this IG
IMMZD1.tbInfectionTestResult	required	IMMZ_D_DE246 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246` From this IG
IMMZD1.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD1.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD1.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD1.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD1.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD1.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD1.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD1.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD1.dengueSerostatus	required	IMMZ_D_DE241 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241` From this IG
IMMZD1.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted, IMMZD1.artStartDate	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD1.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD1.birthWeightInGrams, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose, IMMZD1.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqHIVPositive-1	error	IMMZD1.currentlyOnArt	Required if input in IMMZ.D.DE204 HIV status is HIV-positive : %resource.hivStatus.value != 'DE11' or $this.exists()
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqTBTest-1	error	IMMZD1.tbInfectionTestResult	Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL : not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD1.birthDose	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()
IMMZ-D-reqVType-2	error	IMMZD1.typeOfTbInfectionTestPerformed, IMMZD1.clinicallyWell	Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines : %resource.vaccineType.value != 'DE1' or $this.exists()
IMMZ-D-reqVType-3	error	IMMZD1.immunologicallyStable	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()
IMMZ-D-reqVType-4	error	IMMZD1.birthWeightInGrams	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-reqVType-5	error	IMMZD1.typeOfPoliovirusDose	Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines : %resource.vaccineType.value != 'DE14' or $this.exists()
IMMZ-D-reqVType-6	error	IMMZD1.artStartDate	Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines : %resource.vaccineType.value != 'DE9' or $this.exists()
IMMZ-D-reqVType-7	error	IMMZD1.highRiskOfPneumococcalInfection	Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines : %resource.vaccineType.value != 'DE13' or $this.exists()
IMMZ-D-reqVType-8	error	IMMZD1.typeOfJeDose	Required if input in IMMZ.D.DE19 vaccine type is JE vaccines : %resource.vaccineType.value != 'DE8' or $this.exists()
IMMZ-D-reqVType-9	error	IMMZD1.typeOfTbeDose	Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines : %resource.vaccineType.value != 'DE20' or $this.exists()
IMMZ-D-reqVType-10	error	IMMZD1.typeOfTyphoidDose	Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines : %resource.vaccineType.value != 'DE21' or $this.exists()
IMMZ-D-reqVType-11	error	IMMZD1.typeOfCholeraDose	Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines : %resource.vaccineType.value != 'DE2' or $this.exists()
IMMZ-D-reqVType-12	error	IMMZD1.typeOfMeningococcalDose, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD1.typeOfHepatitisADose	Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines : %resource.vaccineType.value != 'DE5' or $this.exists()
IMMZ-D-reqVType-14	error	IMMZD1.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-reqVType-15	error	IMMZD1.vnaLevel, IMMZD1.riskOfOccupationalExposureToRabiesVirus	Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines : %resource.vaccineType.value != 'DE15' or $this.exists()
IMMZ-D-reqVType-16	error	IMMZD1.dengueSerostatus	Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines : %resource.vaccineType.value != 'DE25' or $this.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD1		0..*	Base	IMMZ.D1.Capture or update client history
patient		1..1	Reference()	Patient
birthDose	C	0..1	boolean	Birth dose Constraints: IMMZ-D-reqVType-1
typeOfDose		1..1	Coding	Type of dose Binding: IMMZ.D.DE258 ValueSet for Type of dose (required)
completedThePrimaryVaccinationSeries		0..1	boolean	Completed the primary vaccination series
completedTheBoosterSeries		0..1	boolean	Completed the booster series
dateWhenPrimaryVaccinationSeriesWasCompleted	C	0..1	date	Date when primary vaccination series was completed Constraints: IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D.DE204 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
currentlyOnArt	C	0..1	boolean	Currently on ART Constraints: IMMZ-D-reqHIVPositive-1
typeOfTbInfectionTestPerformed	C	0..1	Coding	Type of TB infection test performed Binding: IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required) Constraints: IMMZ-D-reqVType-2
tbInfectionTestResult	C	0..1	Coding	TB infection test result Binding: IMMZ.D.DE246 ValueSet for TB infection test result (required) Constraints: IMMZ-D-reqTBTest-1
immunologicallyStable	C	0..1	boolean	Immunologically stable Constraints: IMMZ-D-reqVType-3
clinicallyWell	C	0..1	boolean	Clinically well Constraints: IMMZ-D-reqVType-2
birthWeightInGrams	C	0..1	decimal	Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-5
artStartDate	C	0..1	date	ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1
highRiskOfPneumococcalInfection	C	0..1	boolean	High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7
typeOfJeDose	C	0..1	Coding	Type of JE dose Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) Constraints: IMMZ-D-reqVType-8
typeOfTbeDose	C	0..1	Coding	Type of TBE dose Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) Constraints: IMMZ-D-reqVType-9
typeOfTyphoidDose	C	0..1	Coding	Type of typhoid dose Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) Constraints: IMMZ-D-reqVType-10
typeOfCholeraDose	C	0..1	Coding	Type of cholera dose Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) Constraints: IMMZ-D-reqVType-11
typeOfMeningococcalDose	C	0..1	Coding	Type of meningococcal dose Binding: IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required) Constraints: IMMZ-D-reqVType-12
ageInMonthsWhenClientReceivedFirstMeningococcalDose	C	0..1	decimal	Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1
typeOfHepatitisADose	C	0..1	Coding	Type of hepatitis A dose Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) Constraints: IMMZ-D-reqVType-13
typeOfHepatitisBDose	C	0..1	Coding	Type of hepatitis B dose Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) Constraints: IMMZ-D-reqVType-14
vnaLevel	C	0..1	decimal	VNA level Constraints: IMMZ-D-reqVType-15
riskOfOccupationalExposureToRabiesVirus	C	0..1	boolean	Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15
dengueSerostatus	C	0..1	Coding	Dengue serostatus Binding: IMMZ.D.DE241 ValueSet for Dengue serostatus (required) Constraints: IMMZ-D-reqVType-16
vaccineType		1..*	Coding	Vaccine type Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
dateAndTimeOfVaccination		1..1	dateTime	Date and time of vaccination
contactDate	C	0..1	dateTime	Contact date Constraints: IMMZ-D-dateTimeOccurred-1
ancContactNumber		0..1	integer	ANC contact number
doseNumber	C	1..1	integer	Dose number Constraints: IMMZ-D-reqGTEZero-1
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD1.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD1.typeOfTbInfectionTestPerformed	required	IMMZ_D_DE243 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243` From this IG
IMMZD1.tbInfectionTestResult	required	IMMZ_D_DE246 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246` From this IG
IMMZD1.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD1.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD1.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD1.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD1.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD1.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD1.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD1.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD1.dengueSerostatus	required	IMMZ_D_DE241 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241` From this IG
IMMZD1.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted, IMMZD1.artStartDate	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD1.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD1.birthWeightInGrams, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose, IMMZD1.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqHIVPositive-1	error	IMMZD1.currentlyOnArt	Required if input in IMMZ.D.DE204 HIV status is HIV-positive : %resource.hivStatus.value != 'DE11' or $this.exists()
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqTBTest-1	error	IMMZD1.tbInfectionTestResult	Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL : not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD1.birthDose	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()
IMMZ-D-reqVType-2	error	IMMZD1.typeOfTbInfectionTestPerformed, IMMZD1.clinicallyWell	Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines : %resource.vaccineType.value != 'DE1' or $this.exists()
IMMZ-D-reqVType-3	error	IMMZD1.immunologicallyStable	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()
IMMZ-D-reqVType-4	error	IMMZD1.birthWeightInGrams	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-reqVType-5	error	IMMZD1.typeOfPoliovirusDose	Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines : %resource.vaccineType.value != 'DE14' or $this.exists()
IMMZ-D-reqVType-6	error	IMMZD1.artStartDate	Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines : %resource.vaccineType.value != 'DE9' or $this.exists()
IMMZ-D-reqVType-7	error	IMMZD1.highRiskOfPneumococcalInfection	Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines : %resource.vaccineType.value != 'DE13' or $this.exists()
IMMZ-D-reqVType-8	error	IMMZD1.typeOfJeDose	Required if input in IMMZ.D.DE19 vaccine type is JE vaccines : %resource.vaccineType.value != 'DE8' or $this.exists()
IMMZ-D-reqVType-9	error	IMMZD1.typeOfTbeDose	Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines : %resource.vaccineType.value != 'DE20' or $this.exists()
IMMZ-D-reqVType-10	error	IMMZD1.typeOfTyphoidDose	Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines : %resource.vaccineType.value != 'DE21' or $this.exists()
IMMZ-D-reqVType-11	error	IMMZD1.typeOfCholeraDose	Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines : %resource.vaccineType.value != 'DE2' or $this.exists()
IMMZ-D-reqVType-12	error	IMMZD1.typeOfMeningococcalDose, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD1.typeOfHepatitisADose	Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines : %resource.vaccineType.value != 'DE5' or $this.exists()
IMMZ-D-reqVType-14	error	IMMZD1.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-reqVType-15	error	IMMZD1.vnaLevel, IMMZD1.riskOfOccupationalExposureToRabiesVirus	Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines : %resource.vaccineType.value != 'DE15' or $this.exists()
IMMZ-D-reqVType-16	error	IMMZD1.dengueSerostatus	Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines : %resource.vaccineType.value != 'DE25' or $this.exists()

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD1		0..*	Base	IMMZ.D1.Capture or update client history
patient		1..1	Reference()	Patient
birthDose	C	0..1	boolean	Birth dose Constraints: IMMZ-D-reqVType-1
typeOfDose		1..1	Coding	Type of dose Binding: IMMZ.D.DE258 ValueSet for Type of dose (required)
completedThePrimaryVaccinationSeries		0..1	boolean	Completed the primary vaccination series
completedTheBoosterSeries		0..1	boolean	Completed the booster series
dateWhenPrimaryVaccinationSeriesWasCompleted	C	0..1	date	Date when primary vaccination series was completed Constraints: IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D.DE204 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
currentlyOnArt	C	0..1	boolean	Currently on ART Constraints: IMMZ-D-reqHIVPositive-1
typeOfTbInfectionTestPerformed	C	0..1	Coding	Type of TB infection test performed Binding: IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required) Constraints: IMMZ-D-reqVType-2
tbInfectionTestResult	C	0..1	Coding	TB infection test result Binding: IMMZ.D.DE246 ValueSet for TB infection test result (required) Constraints: IMMZ-D-reqTBTest-1
immunologicallyStable	C	0..1	boolean	Immunologically stable Constraints: IMMZ-D-reqVType-3
clinicallyWell	C	0..1	boolean	Clinically well Constraints: IMMZ-D-reqVType-2
birthWeightInGrams	C	0..1	decimal	Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-5
artStartDate	C	0..1	date	ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1
highRiskOfPneumococcalInfection	C	0..1	boolean	High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7
typeOfJeDose	C	0..1	Coding	Type of JE dose Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) Constraints: IMMZ-D-reqVType-8
typeOfTbeDose	C	0..1	Coding	Type of TBE dose Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) Constraints: IMMZ-D-reqVType-9
typeOfTyphoidDose	C	0..1	Coding	Type of typhoid dose Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) Constraints: IMMZ-D-reqVType-10
typeOfCholeraDose	C	0..1	Coding	Type of cholera dose Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) Constraints: IMMZ-D-reqVType-11
typeOfMeningococcalDose	C	0..1	Coding	Type of meningococcal dose Binding: IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required) Constraints: IMMZ-D-reqVType-12
ageInMonthsWhenClientReceivedFirstMeningococcalDose	C	0..1	decimal	Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1
typeOfHepatitisADose	C	0..1	Coding	Type of hepatitis A dose Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) Constraints: IMMZ-D-reqVType-13
typeOfHepatitisBDose	C	0..1	Coding	Type of hepatitis B dose Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) Constraints: IMMZ-D-reqVType-14
vnaLevel	C	0..1	decimal	VNA level Constraints: IMMZ-D-reqVType-15
riskOfOccupationalExposureToRabiesVirus	C	0..1	boolean	Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15
dengueSerostatus	C	0..1	Coding	Dengue serostatus Binding: IMMZ.D.DE241 ValueSet for Dengue serostatus (required) Constraints: IMMZ-D-reqVType-16
vaccineType		1..*	Coding	Vaccine type Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
dateAndTimeOfVaccination		1..1	dateTime	Date and time of vaccination
contactDate	C	0..1	dateTime	Contact date Constraints: IMMZ-D-dateTimeOccurred-1
ancContactNumber		0..1	integer	ANC contact number
doseNumber	C	1..1	integer	Dose number Constraints: IMMZ-D-reqGTEZero-1
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZD1.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD1.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD1.typeOfTbInfectionTestPerformed	required	IMMZ_D_DE243 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243` From this IG
IMMZD1.tbInfectionTestResult	required	IMMZ_D_DE246 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246` From this IG
IMMZD1.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD1.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD1.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD1.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD1.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD1.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD1.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD1.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD1.dengueSerostatus	required	IMMZ_D_DE241 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241` From this IG
IMMZD1.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted, IMMZD1.artStartDate	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD1.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD1.birthWeightInGrams, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose, IMMZD1.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqHIVPositive-1	error	IMMZD1.currentlyOnArt	Required if input in IMMZ.D.DE204 HIV status is HIV-positive : %resource.hivStatus.value != 'DE11' or $this.exists()
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqTBTest-1	error	IMMZD1.tbInfectionTestResult	Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL : not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD1.birthDose	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()
IMMZ-D-reqVType-2	error	IMMZD1.typeOfTbInfectionTestPerformed, IMMZD1.clinicallyWell	Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines : %resource.vaccineType.value != 'DE1' or $this.exists()
IMMZ-D-reqVType-3	error	IMMZD1.immunologicallyStable	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()
IMMZ-D-reqVType-4	error	IMMZD1.birthWeightInGrams	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-reqVType-5	error	IMMZD1.typeOfPoliovirusDose	Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines : %resource.vaccineType.value != 'DE14' or $this.exists()
IMMZ-D-reqVType-6	error	IMMZD1.artStartDate	Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines : %resource.vaccineType.value != 'DE9' or $this.exists()
IMMZ-D-reqVType-7	error	IMMZD1.highRiskOfPneumococcalInfection	Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines : %resource.vaccineType.value != 'DE13' or $this.exists()
IMMZ-D-reqVType-8	error	IMMZD1.typeOfJeDose	Required if input in IMMZ.D.DE19 vaccine type is JE vaccines : %resource.vaccineType.value != 'DE8' or $this.exists()
IMMZ-D-reqVType-9	error	IMMZD1.typeOfTbeDose	Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines : %resource.vaccineType.value != 'DE20' or $this.exists()
IMMZ-D-reqVType-10	error	IMMZD1.typeOfTyphoidDose	Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines : %resource.vaccineType.value != 'DE21' or $this.exists()
IMMZ-D-reqVType-11	error	IMMZD1.typeOfCholeraDose	Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines : %resource.vaccineType.value != 'DE2' or $this.exists()
IMMZ-D-reqVType-12	error	IMMZD1.typeOfMeningococcalDose, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD1.typeOfHepatitisADose	Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines : %resource.vaccineType.value != 'DE5' or $this.exists()
IMMZ-D-reqVType-14	error	IMMZD1.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-reqVType-15	error	IMMZD1.vnaLevel, IMMZD1.riskOfOccupationalExposureToRabiesVirus	Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines : %resource.vaccineType.value != 'DE15' or $this.exists()
IMMZ-D-reqVType-16	error	IMMZD1.dengueSerostatus	Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines : %resource.vaccineType.value != 'DE25' or $this.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD1		0..*	Base	IMMZ.D1.Capture or update client history
patient		1..1	Reference()	Patient
birthDose	C	0..1	boolean	Birth dose Constraints: IMMZ-D-reqVType-1
typeOfDose		1..1	Coding	Type of dose Binding: IMMZ.D.DE258 ValueSet for Type of dose (required)
completedThePrimaryVaccinationSeries		0..1	boolean	Completed the primary vaccination series
completedTheBoosterSeries		0..1	boolean	Completed the booster series
dateWhenPrimaryVaccinationSeriesWasCompleted	C	0..1	date	Date when primary vaccination series was completed Constraints: IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1
hivStatus		0..1	Coding	HIV status Binding: IMMZ.D.DE204 ValueSet for HIV status (required)
pretermBirth		0..1	boolean	Preterm birth
immunocompromised		0..1	boolean	Immunocompromised
currentlyOnArt	C	0..1	boolean	Currently on ART Constraints: IMMZ-D-reqHIVPositive-1
typeOfTbInfectionTestPerformed	C	0..1	Coding	Type of TB infection test performed Binding: IMMZ.D.DE243 ValueSet for Type of TB infection test performed (required) Constraints: IMMZ-D-reqVType-2
tbInfectionTestResult	C	0..1	Coding	TB infection test result Binding: IMMZ.D.DE246 ValueSet for TB infection test result (required) Constraints: IMMZ-D-reqTBTest-1
immunologicallyStable	C	0..1	boolean	Immunologically stable Constraints: IMMZ-D-reqVType-3
clinicallyWell	C	0..1	boolean	Clinically well Constraints: IMMZ-D-reqVType-2
birthWeightInGrams	C	0..1	decimal	Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-5
artStartDate	C	0..1	date	ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1
highRiskOfPneumococcalInfection	C	0..1	boolean	High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7
typeOfJeDose	C	0..1	Coding	Type of JE dose Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required) Constraints: IMMZ-D-reqVType-8
typeOfTbeDose	C	0..1	Coding	Type of TBE dose Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required) Constraints: IMMZ-D-reqVType-9
typeOfTyphoidDose	C	0..1	Coding	Type of typhoid dose Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required) Constraints: IMMZ-D-reqVType-10
typeOfCholeraDose	C	0..1	Coding	Type of cholera dose Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required) Constraints: IMMZ-D-reqVType-11
typeOfMeningococcalDose	C	0..1	Coding	Type of meningococcal dose Binding: IMMZ.D.DE232 ValueSet for Type of meningococcal dose (required) Constraints: IMMZ-D-reqVType-12
ageInMonthsWhenClientReceivedFirstMeningococcalDose	C	0..1	decimal	Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1
typeOfHepatitisADose	C	0..1	Coding	Type of hepatitis A dose Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required) Constraints: IMMZ-D-reqVType-13
typeOfHepatitisBDose	C	0..1	Coding	Type of hepatitis B dose Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required) Constraints: IMMZ-D-reqVType-14
vnaLevel	C	0..1	decimal	VNA level Constraints: IMMZ-D-reqVType-15
riskOfOccupationalExposureToRabiesVirus	C	0..1	boolean	Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15
dengueSerostatus	C	0..1	Coding	Dengue serostatus Binding: IMMZ.D.DE241 ValueSet for Dengue serostatus (required) Constraints: IMMZ-D-reqVType-16
vaccineType		1..*	Coding	Vaccine type Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
dateAndTimeOfVaccination		1..1	dateTime	Date and time of vaccination
contactDate	C	0..1	dateTime	Contact date Constraints: IMMZ-D-dateTimeOccurred-1
ancContactNumber		0..1	integer	ANC contact number
doseNumber	C	1..1	integer	Dose number Constraints: IMMZ-D-reqGTEZero-1
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD1.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD1.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD1.typeOfTbInfectionTestPerformed	required	IMMZ_D_DE243 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE243` From this IG
IMMZD1.tbInfectionTestResult	required	IMMZ_D_DE246 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE246` From this IG
IMMZD1.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD1.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD1.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD1.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD1.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD1.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD1.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD1.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD1.dengueSerostatus	required	IMMZ_D_DE241 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE241` From this IG
IMMZD1.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted, IMMZD1.artStartDate	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD1.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD1.birthWeightInGrams, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose, IMMZD1.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqHIVPositive-1	error	IMMZD1.currentlyOnArt	Required if input in IMMZ.D.DE204 HIV status is HIV-positive : %resource.hivStatus.value != 'DE11' or $this.exists()
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD1.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqTBTest-1	error	IMMZD1.tbInfectionTestResult	Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL : not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD1.birthDose	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()
IMMZ-D-reqVType-2	error	IMMZD1.typeOfTbInfectionTestPerformed, IMMZD1.clinicallyWell	Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines : %resource.vaccineType.value != 'DE1' or $this.exists()
IMMZ-D-reqVType-3	error	IMMZD1.immunologicallyStable	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()
IMMZ-D-reqVType-4	error	IMMZD1.birthWeightInGrams	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-reqVType-5	error	IMMZD1.typeOfPoliovirusDose	Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines : %resource.vaccineType.value != 'DE14' or $this.exists()
IMMZ-D-reqVType-6	error	IMMZD1.artStartDate	Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines : %resource.vaccineType.value != 'DE9' or $this.exists()
IMMZ-D-reqVType-7	error	IMMZD1.highRiskOfPneumococcalInfection	Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines : %resource.vaccineType.value != 'DE13' or $this.exists()
IMMZ-D-reqVType-8	error	IMMZD1.typeOfJeDose	Required if input in IMMZ.D.DE19 vaccine type is JE vaccines : %resource.vaccineType.value != 'DE8' or $this.exists()
IMMZ-D-reqVType-9	error	IMMZD1.typeOfTbeDose	Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines : %resource.vaccineType.value != 'DE20' or $this.exists()
IMMZ-D-reqVType-10	error	IMMZD1.typeOfTyphoidDose	Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines : %resource.vaccineType.value != 'DE21' or $this.exists()
IMMZ-D-reqVType-11	error	IMMZD1.typeOfCholeraDose	Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines : %resource.vaccineType.value != 'DE2' or $this.exists()
IMMZ-D-reqVType-12	error	IMMZD1.typeOfMeningococcalDose, IMMZD1.ageInMonthsWhenClientReceivedFirstMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD1.typeOfHepatitisADose	Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines : %resource.vaccineType.value != 'DE5' or $this.exists()
IMMZ-D-reqVType-14	error	IMMZD1.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-reqVType-15	error	IMMZD1.vnaLevel, IMMZD1.riskOfOccupationalExposureToRabiesVirus	Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines : %resource.vaccineType.value != 'DE15' or $this.exists()
IMMZ-D-reqVType-16	error	IMMZD1.dengueSerostatus	Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines : %resource.vaccineType.value != 'DE25' or $this.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(5 nested mandatory elements)

Other representations of profile: CSV, Excel