Generated Narrative: StructureDefinition IMMZD1 Profiles: CRMI Shareable StructureDefinition, CRMI Publishable StructureDefinition Name Flags Card. Type Description & Constraints IMMZD1 0..* Base IMMZ.D1.Capture or update client history 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) pretermBirth 0..1 boolean Preterm birth immunocompromised 0..1 boolean Immunocompromised currentlyOnArt <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-reqHIVPositive-1 )">C 0..1 boolean Currently on ART Constraints: IMMZ-D-reqHIVPositive-1 typeOfTbInfectionTestPerformed <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-2 )">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 <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-reqTBTest-1 )">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 <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-3 )">C 0..1 boolean Immunologically stable Constraints: IMMZ-D-reqVType-3 clinicallyWell <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-2 )">C 0..1 boolean Clinically well Constraints: IMMZ-D-reqVType-2 birthWeightInGrams <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, IMMZ-D-reqGTEZero-1 )">C 0..1 decimal Birth weight in grams Constraints: IMMZ-D-reqVType-4, IMMZ-D-reqGTEZero-1 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-5 )">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 <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-6, IMMZ-D-dateOccurred-1 )">C 0..1 date ART start date Constraints: IMMZ-D-reqVType-6, IMMZ-D-dateOccurred-1 highRiskOfPneumococcalInfection <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-7 )">C 0..1 boolean High risk of pneumococcal infection Constraints: IMMZ-D-reqVType-7 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 ageInMonthsWhenClientReceivedFirstMeningococcalDose <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, IMMZ-D-reqGTEZero-1 )">C 0..1 decimal Age in months when client received first meningococcal dose Constraints: IMMZ-D-reqVType-12, IMMZ-D-reqGTEZero-1 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 vnaLevel <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-15 )">C 0..1 decimal VNA level Constraints: IMMZ-D-reqVType-15 riskOfOccupationalExposureToRabiesVirus <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-15 )">C 0..1 boolean Risk of occupational exposure to rabies virus Constraints: IMMZ-D-reqVType-15 dengueSerostatus <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-16 )">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 <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 Documentation for this format
IMMZ.D1.Capture or update client history
Data elements for the IMMZ.D1.Capture or update client history Data Dictionary Activity.
Mapping from the IMMZ.D1 to the IMMZObservation profile
Mapping from the IMMZ.D1 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 infant was preterm; the mother gave birth to the infant when gestational age was less than 37 weeks
Diseases of the immune system, unspecified
The client is known to be immunocompromised. This means the client has a weakened immune system and having a reduced ability to fight infections and other diseases
The client is currently receiving antiretroviral therapy (ART)
Required if input in IMMZ.D.DE204 HIV status is HIV-positive
%resource.hivStatus.value != 'DE11' or $this.exists()
The type of tuberculosis (TB) infection test performed
Required if input in IMMZ.D.DE19 vaccine type is BCG vaccines
%resource.vaccineType.value != 'DE1' or $this.exists()
Records the result of the TB infection test
Required if input in IMMZ.D.DE243 Type of TB infection test performed IS NOT NULL
not(%resource.typeOfTbInfectionTestPerformed.exists()) or $this.exists()
The client is living with HIV and is immunologically stable with CD4 count or percentage above a minimum as defined in the HIV guidelines
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()
The client is living with HIV and is clinically well, as defined in HIV guidelines and WHO clinical staging
Disorders of newborn related to short gestation or low birth weight, not elsewhere classified
Represents the client's birth weight value measures in grams
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()
Must be positive decimal value greater than or equal to zero (≥0)
The type of the poliovirus vaccine dose administered to the client
Required if input in IMMZ.D.DE19 vaccine type is Poliovirus-containing vaccines
%resource.vaccineType.value != 'DE14' or $this.exists()
The date on which the client started or restarted ART
Required if input in IMMZ.D.DE19 vaccine type is Measles-containing vaccines
%resource.vaccineType.value != 'DE9' or $this.exists()
The client is at high risk for pneumococcal infection because of underlying medical conditions (i.e. HIV infection or sickle-cell disease)
Required if input in IMMZ.D.DE19 vaccine type is Pneumococcal vaccines
%resource.vaccineType.value != 'DE13' 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()
Age in months when client received first meningococcal dose
The age in months when client received their first meningococcal dose
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-induced neutralizing antibody (VNA) level, measured as a serum antibody concentration from the result of the concentrated, purified cell culture-derived and embryonated egg-based rabies vaccines (CCEEV)
Required if input in IMMZ.D.DE19 vaccine type is Rabies vaccines
%resource.vaccineType.value != 'DE15' or $this.exists()
Risk of occupational exposure to rabies virus
Professional at risk of occupational exposure to rabies virus, particularly animal health workers. Also considered for medical professionals who regularly provide care to persons with rabies
Indicates the result of a serological test determining whether the client has antibodies against the dengue virus
Required if input in IMMZ.D.DE19 vaccine type is Dengue vaccines
%resource.vaccineType.value != 'DE25' 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