IMMZ.D13.Update client record - 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/costateixeira-update-readme and changes regularly. See the Directory of published versions

Logical Model: IMMZ.D13.Update client record

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

Data elements for the IMMZ.D13.Update client record 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
IMMZD13		0..*	Base	IMMZ.D13.Update client record
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)
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-4
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
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
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
immunizationEventStatus		1..1	Coding	Immunization event status Binding: IMMZ.D.DE1 ValueSet for Immunization event status (required)
reasonVaccineWasNotAdministered	C	0..1	Coding	Reason vaccine was not administered Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) Constraints: IMMZ-D-statusNotDone-1
vaccineBrand		1..1	Coding	Vaccine brand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
liveVaccine		0..1	boolean	Live vaccine
countryOfVaccination		1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (required)
administrativeArea		0..1	Coding	Administrative area
vaccineManufacturer		1..1	Coding	Vaccine manufacturer Binding: IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example)
vaccineBatchNumber		0..1	string	Vaccine batch number
vaccineMarketAuthorizationHolder		1..1	Coding	Vaccine market authorization holder Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
expirationDate		0..1	date	Expiration date
doseQuantity	C	0..1	Quantity	Dose quantity Constraints: IMMZ-D-reqGTZero-1
healthWorkerIdentifier		0..1	string	Health worker identifier
totalDosesInSeries	C	0..1	integer	Total doses in series Constraints: IMMZ-D-reqGTZero-1
diseaseTargeted		0..*	Coding	Disease targeted Binding: IMMZ.D.DE126 ValueSet for Disease targeted (required)
dueDateOfNextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD13.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD13.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD13.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD13.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD13.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD13.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD13.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD13.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD13.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD13.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD13.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG
IMMZD13.immunizationEventStatus	required	IMMZ_D_DE1 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1` From this IG
IMMZD13.reasonVaccineWasNotAdministered	required	IMMZ_D_DE5 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5` From this IG
IMMZD13.vaccineBrand	example	IMMZ_D_DE18 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18` From this IG
IMMZD13.countryOfVaccination	required	Iso3166-1-3 `http://hl7.org/fhir/ValueSet/iso3166-1-3` From the FHIR Standard
IMMZD13.vaccineManufacturer	example	IMMZ_D_DE23 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23` From this IG
IMMZD13.vaccineMarketAuthorizationHolder	example	IMMZ_D_DE25 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25` From this IG
IMMZD13.diseaseTargeted	required	IMMZ_D_DE126 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD13.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD13.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqGTZero-1	error	IMMZD13.doseQuantity, IMMZD13.totalDosesInSeries	Must be positive decimal value greater than zero (>0.00) : not($this.exists()) or $this.value > 0
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD13.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-4	error	IMMZD13.typeOfPoliovirusDose	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-8	error	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.typeOfMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD13.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	IMMZD13.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-statusNotDone-1	error	IMMZD13.reasonVaccineWasNotAdministered	Required if input in IMMZ.D.DE1 Immunization event status is Not Done : %resource.immunizationEventStatus.value = 'DE4' or $this.exists()

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD13		0..*	Base	IMMZ.D13.Update client record
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)
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-4
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
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
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
immunizationEventStatus		1..1	Coding	Immunization event status Binding: IMMZ.D.DE1 ValueSet for Immunization event status (required)
reasonVaccineWasNotAdministered	C	0..1	Coding	Reason vaccine was not administered Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) Constraints: IMMZ-D-statusNotDone-1
vaccineBrand		1..1	Coding	Vaccine brand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
liveVaccine		0..1	boolean	Live vaccine
countryOfVaccination		1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (required)
administrativeArea		0..1	Coding	Administrative area
vaccineManufacturer		1..1	Coding	Vaccine manufacturer Binding: IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example)
vaccineBatchNumber		0..1	string	Vaccine batch number
vaccineMarketAuthorizationHolder		1..1	Coding	Vaccine market authorization holder Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
expirationDate		0..1	date	Expiration date
doseQuantity	C	0..1	Quantity	Dose quantity Constraints: IMMZ-D-reqGTZero-1
healthWorkerIdentifier		0..1	string	Health worker identifier
totalDosesInSeries	C	0..1	integer	Total doses in series Constraints: IMMZ-D-reqGTZero-1
diseaseTargeted		0..*	Coding	Disease targeted Binding: IMMZ.D.DE126 ValueSet for Disease targeted (required)
dueDateOfNextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZD13.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD13.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD13.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD13.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD13.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD13.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD13.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD13.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD13.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD13.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD13.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG
IMMZD13.immunizationEventStatus	required	IMMZ_D_DE1 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1` From this IG
IMMZD13.reasonVaccineWasNotAdministered	required	IMMZ_D_DE5 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5` From this IG
IMMZD13.vaccineBrand	example	IMMZ_D_DE18 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18` From this IG
IMMZD13.countryOfVaccination	required	Iso3166-1-3 `http://hl7.org/fhir/ValueSet/iso3166-1-3` From the FHIR Standard
IMMZD13.vaccineManufacturer	example	IMMZ_D_DE23 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23` From this IG
IMMZD13.vaccineMarketAuthorizationHolder	example	IMMZ_D_DE25 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25` From this IG
IMMZD13.diseaseTargeted	required	IMMZ_D_DE126 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD13.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD13.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqGTZero-1	error	IMMZD13.doseQuantity, IMMZD13.totalDosesInSeries	Must be positive decimal value greater than zero (>0.00) : not($this.exists()) or $this.value > 0
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD13.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-4	error	IMMZD13.typeOfPoliovirusDose	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-8	error	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.typeOfMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD13.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	IMMZD13.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-statusNotDone-1	error	IMMZD13.reasonVaccineWasNotAdministered	Required if input in IMMZ.D.DE1 Immunization event status is Not Done : %resource.immunizationEventStatus.value = 'DE4' or $this.exists()

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD13		0..*	Base	IMMZ.D13.Update client record
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)
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-4
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
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
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
immunizationEventStatus		1..1	Coding	Immunization event status Binding: IMMZ.D.DE1 ValueSet for Immunization event status (required)
reasonVaccineWasNotAdministered	C	0..1	Coding	Reason vaccine was not administered Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) Constraints: IMMZ-D-statusNotDone-1
vaccineBrand		1..1	Coding	Vaccine brand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
liveVaccine		0..1	boolean	Live vaccine
countryOfVaccination		1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (required)
administrativeArea		0..1	Coding	Administrative area
vaccineManufacturer		1..1	Coding	Vaccine manufacturer Binding: IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example)
vaccineBatchNumber		0..1	string	Vaccine batch number
vaccineMarketAuthorizationHolder		1..1	Coding	Vaccine market authorization holder Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
expirationDate		0..1	date	Expiration date
doseQuantity	C	0..1	Quantity	Dose quantity Constraints: IMMZ-D-reqGTZero-1
healthWorkerIdentifier		0..1	string	Health worker identifier
totalDosesInSeries	C	0..1	integer	Total doses in series Constraints: IMMZ-D-reqGTZero-1
diseaseTargeted		0..*	Coding	Disease targeted Binding: IMMZ.D.DE126 ValueSet for Disease targeted (required)
dueDateOfNextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD13.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD13.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD13.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD13.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD13.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD13.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD13.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD13.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD13.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD13.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD13.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG
IMMZD13.immunizationEventStatus	required	IMMZ_D_DE1 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1` From this IG
IMMZD13.reasonVaccineWasNotAdministered	required	IMMZ_D_DE5 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5` From this IG
IMMZD13.vaccineBrand	example	IMMZ_D_DE18 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18` From this IG
IMMZD13.countryOfVaccination	required	Iso3166-1-3 `http://hl7.org/fhir/ValueSet/iso3166-1-3` From the FHIR Standard
IMMZD13.vaccineManufacturer	example	IMMZ_D_DE23 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23` From this IG
IMMZD13.vaccineMarketAuthorizationHolder	example	IMMZ_D_DE25 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25` From this IG
IMMZD13.diseaseTargeted	required	IMMZ_D_DE126 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD13.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD13.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqGTZero-1	error	IMMZD13.doseQuantity, IMMZD13.totalDosesInSeries	Must be positive decimal value greater than zero (>0.00) : not($this.exists()) or $this.value > 0
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD13.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-4	error	IMMZD13.typeOfPoliovirusDose	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-8	error	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.typeOfMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD13.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	IMMZD13.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-statusNotDone-1	error	IMMZD13.reasonVaccineWasNotAdministered	Required if input in IMMZ.D.DE1 Immunization event status is Not Done : %resource.immunizationEventStatus.value = 'DE4' or $this.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(10 nested mandatory elements)

Key Elements View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD13		0..*	Base	IMMZ.D13.Update client record
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)
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-4
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
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
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
immunizationEventStatus		1..1	Coding	Immunization event status Binding: IMMZ.D.DE1 ValueSet for Immunization event status (required)
reasonVaccineWasNotAdministered	C	0..1	Coding	Reason vaccine was not administered Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) Constraints: IMMZ-D-statusNotDone-1
vaccineBrand		1..1	Coding	Vaccine brand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
liveVaccine		0..1	boolean	Live vaccine
countryOfVaccination		1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (required)
administrativeArea		0..1	Coding	Administrative area
vaccineManufacturer		1..1	Coding	Vaccine manufacturer Binding: IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example)
vaccineBatchNumber		0..1	string	Vaccine batch number
vaccineMarketAuthorizationHolder		1..1	Coding	Vaccine market authorization holder Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
expirationDate		0..1	date	Expiration date
doseQuantity	C	0..1	Quantity	Dose quantity Constraints: IMMZ-D-reqGTZero-1
healthWorkerIdentifier		0..1	string	Health worker identifier
totalDosesInSeries	C	0..1	integer	Total doses in series Constraints: IMMZ-D-reqGTZero-1
diseaseTargeted		0..*	Coding	Disease targeted Binding: IMMZ.D.DE126 ValueSet for Disease targeted (required)
dueDateOfNextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD13.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD13.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD13.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD13.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD13.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD13.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD13.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD13.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD13.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD13.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD13.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG
IMMZD13.immunizationEventStatus	required	IMMZ_D_DE1 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1` From this IG
IMMZD13.reasonVaccineWasNotAdministered	required	IMMZ_D_DE5 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5` From this IG
IMMZD13.vaccineBrand	example	IMMZ_D_DE18 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18` From this IG
IMMZD13.countryOfVaccination	required	Iso3166-1-3 `http://hl7.org/fhir/ValueSet/iso3166-1-3` From the FHIR Standard
IMMZD13.vaccineManufacturer	example	IMMZ_D_DE23 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23` From this IG
IMMZD13.vaccineMarketAuthorizationHolder	example	IMMZ_D_DE25 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25` From this IG
IMMZD13.diseaseTargeted	required	IMMZ_D_DE126 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD13.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD13.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqGTZero-1	error	IMMZD13.doseQuantity, IMMZD13.totalDosesInSeries	Must be positive decimal value greater than zero (>0.00) : not($this.exists()) or $this.value > 0
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD13.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-4	error	IMMZD13.typeOfPoliovirusDose	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-8	error	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.typeOfMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD13.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	IMMZD13.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-statusNotDone-1	error	IMMZD13.reasonVaccineWasNotAdministered	Required if input in IMMZ.D.DE1 Immunization event status is Not Done : %resource.immunizationEventStatus.value = 'DE4' or $this.exists()

Differential View

This structure is derived from Base

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD13		0..*	Base	IMMZ.D13.Update client record
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)
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-4
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
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
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
immunizationEventStatus		1..1	Coding	Immunization event status Binding: IMMZ.D.DE1 ValueSet for Immunization event status (required)
reasonVaccineWasNotAdministered	C	0..1	Coding	Reason vaccine was not administered Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) Constraints: IMMZ-D-statusNotDone-1
vaccineBrand		1..1	Coding	Vaccine brand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
liveVaccine		0..1	boolean	Live vaccine
countryOfVaccination		1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (required)
administrativeArea		0..1	Coding	Administrative area
vaccineManufacturer		1..1	Coding	Vaccine manufacturer Binding: IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example)
vaccineBatchNumber		0..1	string	Vaccine batch number
vaccineMarketAuthorizationHolder		1..1	Coding	Vaccine market authorization holder Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
expirationDate		0..1	date	Expiration date
doseQuantity	C	0..1	Quantity	Dose quantity Constraints: IMMZ-D-reqGTZero-1
healthWorkerIdentifier		0..1	string	Health worker identifier
totalDosesInSeries	C	0..1	integer	Total doses in series Constraints: IMMZ-D-reqGTZero-1
diseaseTargeted		0..*	Coding	Disease targeted Binding: IMMZ.D.DE126 ValueSet for Disease targeted (required)
dueDateOfNextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
IMMZD13.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD13.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD13.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD13.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD13.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD13.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD13.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD13.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD13.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD13.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD13.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG
IMMZD13.immunizationEventStatus	required	IMMZ_D_DE1 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1` From this IG
IMMZD13.reasonVaccineWasNotAdministered	required	IMMZ_D_DE5 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5` From this IG
IMMZD13.vaccineBrand	example	IMMZ_D_DE18 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18` From this IG
IMMZD13.countryOfVaccination	required	Iso3166-1-3 `http://hl7.org/fhir/ValueSet/iso3166-1-3` From the FHIR Standard
IMMZD13.vaccineManufacturer	example	IMMZ_D_DE23 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23` From this IG
IMMZD13.vaccineMarketAuthorizationHolder	example	IMMZ_D_DE25 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25` From this IG
IMMZD13.diseaseTargeted	required	IMMZ_D_DE126 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD13.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD13.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqGTZero-1	error	IMMZD13.doseQuantity, IMMZD13.totalDosesInSeries	Must be positive decimal value greater than zero (>0.00) : not($this.exists()) or $this.value > 0
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD13.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-4	error	IMMZD13.typeOfPoliovirusDose	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-8	error	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.typeOfMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD13.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	IMMZD13.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-statusNotDone-1	error	IMMZD13.reasonVaccineWasNotAdministered	Required if input in IMMZ.D.DE1 Immunization event status is Not Done : %resource.immunizationEventStatus.value = 'DE4' or $this.exists()

Snapshot View

Name	Flags	Card.	Type	Description & Constraints Filter: Bindings Constraints Obligations
IMMZD13		0..*	Base	IMMZ.D13.Update client record
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)
typeOfPoliovirusDose	C	0..1	Coding	Type of poliovirus dose Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required) Constraints: IMMZ-D-reqVType-4
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
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
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
immunizationEventStatus		1..1	Coding	Immunization event status Binding: IMMZ.D.DE1 ValueSet for Immunization event status (required)
reasonVaccineWasNotAdministered	C	0..1	Coding	Reason vaccine was not administered Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required) Constraints: IMMZ-D-statusNotDone-1
vaccineBrand		1..1	Coding	Vaccine brand Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
liveVaccine		0..1	boolean	Live vaccine
countryOfVaccination		1..1	Coding	Country of vaccination Binding: Iso3166-1-3 (required)
administrativeArea		0..1	Coding	Administrative area
vaccineManufacturer		1..1	Coding	Vaccine manufacturer Binding: IMMZ.D.DE23 ValueSet for Vaccine manufacturer (example)
vaccineBatchNumber		0..1	string	Vaccine batch number
vaccineMarketAuthorizationHolder		1..1	Coding	Vaccine market authorization holder Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
expirationDate		0..1	date	Expiration date
doseQuantity	C	0..1	Quantity	Dose quantity Constraints: IMMZ-D-reqGTZero-1
healthWorkerIdentifier		0..1	string	Health worker identifier
totalDosesInSeries	C	0..1	integer	Total doses in series Constraints: IMMZ-D-reqGTZero-1
diseaseTargeted		0..*	Coding	Disease targeted Binding: IMMZ.D.DE126 ValueSet for Disease targeted (required)
dueDateOfNextDose		0..1	date	Due date of next dose
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
IMMZD13.typeOfDose	required	IMMZ_D_DE258 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE258` From this IG
IMMZD13.hivStatus	required	IMMZ_D_DE204 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE204` From this IG
IMMZD13.typeOfPoliovirusDose	required	IMMZ_D_DE212 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE212` From this IG
IMMZD13.typeOfJeDose	required	IMMZ_D_DE216 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE216` From this IG
IMMZD13.typeOfTbeDose	required	IMMZ_D_DE220 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE220` From this IG
IMMZD13.typeOfTyphoidDose	required	IMMZ_D_DE225 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE225` From this IG
IMMZD13.typeOfCholeraDose	required	IMMZ_D_DE229 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE229` From this IG
IMMZD13.typeOfMeningococcalDose	required	IMMZ_D_DE232 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE232` From this IG
IMMZD13.typeOfHepatitisADose	required	IMMZ_D_DE237 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE237` From this IG
IMMZD13.typeOfHepatitisBDose	required	IMMZ_D_DE254 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE254` From this IG
IMMZD13.vaccineType	required	IMMZ_Z_VS `http://smart.who.int/immunizations/ValueSet/IMMZ.Z.VS` From this IG
IMMZD13.immunizationEventStatus	required	IMMZ_D_DE1 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE1` From this IG
IMMZD13.reasonVaccineWasNotAdministered	required	IMMZ_D_DE5 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE5` From this IG
IMMZD13.vaccineBrand	example	IMMZ_D_DE18 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE18` From this IG
IMMZD13.countryOfVaccination	required	Iso3166-1-3 `http://hl7.org/fhir/ValueSet/iso3166-1-3` From the FHIR Standard
IMMZD13.vaccineManufacturer	example	IMMZ_D_DE23 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE23` From this IG
IMMZD13.vaccineMarketAuthorizationHolder	example	IMMZ_D_DE25 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE25` From this IG
IMMZD13.diseaseTargeted	required	IMMZ_D_DE126 `http://smart.who.int/immunizations/ValueSet/IMMZ.D.DE126` From this IG

Constraints

Id	Grade	Path(s)	Details	Requirements
IMMZ-D-dateOccurred-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Date ≤ current date : not($this.exists()) or $this.value <= today()
IMMZ-D-dateTimeOccurred-1	error	IMMZD13.contactDate	DateTime ≤ current DateTime : not($this.exists()) or $this.value <= now()
IMMZ-D-reqGTEZero-1	error	IMMZD13.doseNumber	Must be positive decimal value greater than or equal to zero (≥0) : not($this.exists()) or $this.value >= 0
IMMZ-D-reqGTZero-1	error	IMMZD13.doseQuantity, IMMZD13.totalDosesInSeries	Must be positive decimal value greater than zero (>0.00) : not($this.exists()) or $this.value > 0
IMMZ-D-reqPrimaryCompleted-1	error	IMMZD13.dateWhenPrimaryVaccinationSeriesWasCompleted	Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes : %resource.completedTheBoosterSeries.value = false or $this.exists()
IMMZ-D-reqVType-1	error	IMMZD13.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-4	error	IMMZD13.typeOfPoliovirusDose	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-8	error	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.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	IMMZD13.typeOfMeningococcalDose	Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines : %resource.vaccineType.value != 'DE10' or $this.exists()
IMMZ-D-reqVType-13	error	IMMZD13.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	IMMZD13.typeOfHepatitisBDose	Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines : %resource.vaccineType.value != 'DE6' or $this.exists()
IMMZ-D-statusNotDone-1	error	IMMZD13.reasonVaccineWasNotAdministered	Required if input in IMMZ.D.DE1 Immunization event status is Not Done : %resource.immunizationEventStatus.value = 'DE4' or $this.exists()

This structure is derived from Base

Summary

Mandatory: 0 element(10 nested mandatory elements)

Other representations of profile: CSV, Excel