Generated Narrative: StructureDefinition IMMZD13 Profiles: Extractable Questionnaire - StructureMap, Advanced Behavior Questionnaire, CRMI Shareable StructureDefinition, CRMI Publishable StructureDefinition Name Flags Card. Type Description & Constraints IMMZD13 0..* Base IMMZ.D13.Update client record patient 1..1 Reference() Patient birthDose <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-1 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqPrimaryCompleted-1, IMMZ-D-dateOccurred-1 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-4 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-8 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-9 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-10 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-11 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-12 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-13 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqVType-14 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-dateTimeOccurred-1 )">C 0..1 dateTime Contact date Constraints: IMMZ-D-dateTimeOccurred-1 ancContactNumber 0..1 integer ANC contact number doseNumber <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqGTEZero-1 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-statusNotDone-1 )">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 <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqGTZero-1 )">C 0..1 Quantity Dose quantity Constraints: 0.00)" class="constraint">IMMZ-D-reqGTZero-1 healthWorkerIdentifier 0..1 string Health worker identifier totalDosesInSeries <a style="padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;; padding-left: 3px; padding-right: 3px; border: 1px maroon solid; font-weight: bold; color: #301212; background-color: #fdf4f4;" href="http://hl7.org/fhir/R4/conformance-rules.html#constraints" title="This element has or is affected by constraints ( IMMZ-D-reqGTZero-1 )">C 0..1 integer Total doses in series Constraints: 0.00)" class="constraint">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
Data elements for the IMMZ.D13.Update client record Data Dictionary Activity.
Mapping from the IMMZ.D13 to the IMMZObservation profile
Mapping from the IMMZ.D13 to the IMMZImmunization profile
Indicates if the client received a dose within 24 hours of birth. Whether a birth dose is counted as part of the primary series will depend on the antigen
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()
The type of dose in a series that the client received
Completed the primary vaccination series
Indicates if the client has completed the primary vaccination series of a product/antigen. If the client has not yet completed their primary series, it means they may be expected to receive more doses to complete their vaccination regimen for the respective product/antigen
Indicates if the client has completed the booster series of a product/antigen
Date when primary vaccination series was completed
The date when the client completed the primary vaccination series (per product/antigen)
Required if input in IMMZ.D.DE203 Completed the primary vaccination series is Yes
%resource.completedTheBoosterSeries.value = false or $this.exists()
not($this.exists()) or $this.value <= today()
The type of the poliovirus vaccine dose administered to the client
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()
The type of Japanese encephalitis (JE) vaccine dose administered to the client
Required if input in IMMZ.D.DE19 vaccine type is JE vaccines
%resource.vaccineType.value != 'DE8' or $this.exists()
The type of tick-borne encephalitis (TBE) vaccine dose administered
Required if input in IMMZ.D.DE19 vaccine type is TBE vaccines
%resource.vaccineType.value != 'DE20' or $this.exists()
The type of typhoid vaccine dose administered to the client
Required if input in IMMZ.D.DE19 vaccine type is Typhoid vaccines
%resource.vaccineType.value != 'DE21' or $this.exists()
The type of cholera vaccine dose administered to the client
Required if input in IMMZ.D.DE19 vaccine type is Cholera vaccines
%resource.vaccineType.value != 'DE2' or $this.exists()
The type of meningococcal vaccine dose administered to the client
Required if input in IMMZ.D.DE19 vaccine type is Meningococcal vaccines
%resource.vaccineType.value != 'DE10' or $this.exists()
The type of hepatitis A-containing vaccine dose administered to the client
Required if input in IMMZ.D.DE19 vaccine type is Hepatitis A-containing vaccines
%resource.vaccineType.value != 'DE5' or $this.exists()
The type of hepatitis B-containing vaccine dose administered to the client
Required if input in IMMZ.D.DE6 vaccine type is Hepatitis B-containing vaccines
%resource.vaccineType.value != 'DE6' or $this.exists()
Vaccine code (CPT [Current Procedural Terminology]) CPHS (Children's Preventative Health System)
Vaccine type/category that was administered or was to be administered. Any vaccine code available in the IMMZ.Z Vaccine library list of codes applies in this data element
Represents the visit/encounter date, which is the date and time when each vaccine was administered to the client
The date and time of the client's contact
not($this.exists()) or $this.value <= now()
Number of visits to this health-care entity in the last 12 months
The antenatal care (ANC) contact or visit number
Vaccine dose number including dose number within series
Must be positive decimal value greater than or equal to zero (≥0)
The current status of the individual immunization event
The reason this immunization event was not performed
Required if input in IMMZ.D.DE1 Immunization event status is Not Done
%resource.immunizationEventStatus.value = 'DE4' or $this.exists()
The brand or trade name used to refer to the vaccine received
Uses a living but weakened version of the virus or one that is very similar
The service delivery country where the vaccine administration occurred
The service delivery location (location name, city, municipality, town or village) where the vaccine administration occurred
Name of the market authorization holder of the vaccine received. If market authorization holder is unknown, vaccine manufacturer is REQUIRED
Expiration date of medication (Agency for Healthcare Research and Quality [AHRQ])
Doses of vaccine given per symptom onset
The quantity of vaccine product that was administered
Must be positive decimal value greater than zero (>0.00)
The person, organization or role of the entity that performed the act of giving the vaccine to the client. The implementing system can choose to populate this field using data from a health worker registry or health-care facility registry
The recommended number of doses for immunity according to the national immunization schedule (which may be based on product, age, etc.)
Vaccine-preventable disease being targeted
Date on which the next vaccination should be administered, if a next dose is required