WHO Immunization Implementation Guide
0.1.0 - CI Build
WHO Immunization Implementation Guide
0.1.0 - CI Build
WHO Immunization Implementation Guide, published by World Health Organization (WHO). This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/WorldHealthOrganization/smart-immunizations and changes regularly. See the Directory of published versions
| Official URL: http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZD1ClientHistory | Version: 0.1.0 | |||
| Draft as of 2024-05-30 | Computable Name: IMMZ_D1_Client_History | |||
Data elements for the IMMZ.D1 Capture Client History Data Dictionary for the fields that apply to all antigens.
Usage:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  IMMZD1ClientHistory |
0..* | Base | IMMZ.D1 Capture Client History for All Antigens Instances of this logical model are not marked to be the target of a Reference | |
  patient |
1..1 | Reference() | Patient | |
 type |
1..* | Coding | Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required) | |
 completedPrimarySeries |
0..1 | boolean | Completed the primary vaccination series | |
| booster |
0..1 | boolean | Completed the booster series | |
| dateSeriesCompleted |
1..1 | date | Date when primary vaccination series was completed | |
| hivStatus |
0..1 | Coding | HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required) | |
| pretermBirth |
0..1 | boolean | Preterm birth | |
| immunocompromised |
0..1 | boolean | Immunocompromised | |
| onART |
0..1 | boolean | Currently on ART | |
 vaccineHistory |
0..* | BackboneElement | Vaccine History | |
 vaccineType |
0..1 | Coding | Vaccine type | |
 vaccineDate |
0..1 | date | Date and time of vaccination | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| IMMZD1ClientHistory.type | required | IMMZ_D1_DE103http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103from this IG | |
| IMMZD1ClientHistory.hivStatus | required | IMMZ_D1_DE10http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10from this IG |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IMMZD1ClientHistory |
0..* | Base | IMMZ.D1 Capture Client History for All Antigens Instances of this logical model are not marked to be the target of a Reference | |
| patient |
1..1 | Reference() | Patient | |
| type |
1..* | Coding | Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required) | |
| completedPrimarySeries |
0..1 | boolean | Completed the primary vaccination series | |
| booster |
0..1 | boolean | Completed the booster series | |
| dateSeriesCompleted |
1..1 | date | Date when primary vaccination series was completed | |
| hivStatus |
0..1 | Coding | HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required) | |
| pretermBirth |
0..1 | boolean | Preterm birth | |
| immunocompromised |
0..1 | boolean | Immunocompromised | |
| onART |
0..1 | boolean | Currently on ART | |
| vaccineHistory |
0..* | BackboneElement | Vaccine History | |
 modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineType |
0..1 | Coding | Vaccine type | |
| vaccineDate |
0..1 | date | Date and time of vaccination | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| IMMZD1ClientHistory.type | required | IMMZ_D1_DE103http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103from this IG | |
| IMMZD1ClientHistory.hivStatus | required | IMMZ_D1_DE10http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IMMZD1ClientHistory |
0..* | Base | IMMZ.D1 Capture Client History for All Antigens Instances of this logical model are not marked to be the target of a Reference | |
| patient |
1..1 | Reference() | Patient | |
| type |
1..* | Coding | Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required) | |
| completedPrimarySeries |
0..1 | boolean | Completed the primary vaccination series | |
| booster |
0..1 | boolean | Completed the booster series | |
| dateSeriesCompleted |
1..1 | date | Date when primary vaccination series was completed | |
| hivStatus |
0..1 | Coding | HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required) | |
| pretermBirth |
0..1 | boolean | Preterm birth | |
| immunocompromised |
0..1 | boolean | Immunocompromised | |
| onART |
0..1 | boolean | Currently on ART | |
| vaccineHistory |
0..* | BackboneElement | Vaccine History | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineType |
0..1 | Coding | Vaccine type | |
| vaccineDate |
0..1 | date | Date and time of vaccination | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| IMMZD1ClientHistory.type | required | IMMZ_D1_DE103http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103from this IG | |
| IMMZD1ClientHistory.hivStatus | required | IMMZ_D1_DE10http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base
Differential View
This structure is derived from Base
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IMMZD1ClientHistory |
0..* | Base | IMMZ.D1 Capture Client History for All Antigens Instances of this logical model are not marked to be the target of a Reference | |
| patient |
1..1 | Reference() | Patient | |
| type |
1..* | Coding | Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required) | |
| completedPrimarySeries |
0..1 | boolean | Completed the primary vaccination series | |
| booster |
0..1 | boolean | Completed the booster series | |
| dateSeriesCompleted |
1..1 | date | Date when primary vaccination series was completed | |
| hivStatus |
0..1 | Coding | HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required) | |
| pretermBirth |
0..1 | boolean | Preterm birth | |
| immunocompromised |
0..1 | boolean | Immunocompromised | |
| onART |
0..1 | boolean | Currently on ART | |
| vaccineHistory |
0..* | BackboneElement | Vaccine History | |
| vaccineType |
0..1 | Coding | Vaccine type | |
| vaccineDate |
0..1 | date | Date and time of vaccination | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| IMMZD1ClientHistory.type | required | IMMZ_D1_DE103http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103from this IG | |
| IMMZD1ClientHistory.hivStatus | required | IMMZ_D1_DE10http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10from this IG |
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IMMZD1ClientHistory |
0..* | Base | IMMZ.D1 Capture Client History for All Antigens Instances of this logical model are not marked to be the target of a Reference | |
| patient |
1..1 | Reference() | Patient | |
| type |
1..* | Coding | Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required) | |
| completedPrimarySeries |
0..1 | boolean | Completed the primary vaccination series | |
| booster |
0..1 | boolean | Completed the booster series | |
| dateSeriesCompleted |
1..1 | date | Date when primary vaccination series was completed | |
| hivStatus |
0..1 | Coding | HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required) | |
| pretermBirth |
0..1 | boolean | Preterm birth | |
| immunocompromised |
0..1 | boolean | Immunocompromised | |
| onART |
0..1 | boolean | Currently on ART | |
| vaccineHistory |
0..* | BackboneElement | Vaccine History | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineType |
0..1 | Coding | Vaccine type | |
| vaccineDate |
0..1 | date | Date and time of vaccination | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| IMMZD1ClientHistory.type | required | IMMZ_D1_DE103http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103from this IG | |
| IMMZD1ClientHistory.hivStatus | required | IMMZ_D1_DE10http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| IMMZD1ClientHistory |
0..* | Base | IMMZ.D1 Capture Client History for All Antigens Instances of this logical model are not marked to be the target of a Reference | |
| patient |
1..1 | Reference() | Patient | |
| type |
1..* | Coding | Type of dose Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required) | |
| completedPrimarySeries |
0..1 | boolean | Completed the primary vaccination series | |
| booster |
0..1 | boolean | Completed the booster series | |
| dateSeriesCompleted |
1..1 | date | Date when primary vaccination series was completed | |
| hivStatus |
0..1 | Coding | HIV status Binding: IMMZ.D1.DE10 ValueSet for HIV status (required) | |
| pretermBirth |
0..1 | boolean | Preterm birth | |
| immunocompromised |
0..1 | boolean | Immunocompromised | |
| onART |
0..1 | boolean | Currently on ART | |
| vaccineHistory |
0..* | BackboneElement | Vaccine History | |
| @id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |
| modifierExtension |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
| vaccineType |
0..1 | Coding | Vaccine type | |
| vaccineDate |
0..1 | date | Date and time of vaccination | |
| Documentation for this format | ||||
| Path | Conformance | ValueSet | URI |
| IMMZD1ClientHistory.type | required | IMMZ_D1_DE103http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103from this IG | |
| IMMZD1ClientHistory.hivStatus | required | IMMZ_D1_DE10http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10from this IG |
| Id | Grade | Path(s) | Details | Requirements |
| ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
This structure is derived from Base