WHO Immunization Implementation Guide
0.1.0 - CI Build International flag

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

Logical Model: IMMZ.D1 Capture Client History for Polio

Official URL: http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZD1ClientHistoryPolio Version: 0.1.0
Draft as of 2024-05-30 Computable Name: IMMZ_D1_Client_History_Polio

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Polio.

Usage:

  • This Logical Model Profile 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.

This structure is derived from IMMZ_D1_Client_History

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryPolio 0..* IMMZ_D1_Client_History
Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory
IMMZ.D1 Capture Client History for Polio
Instances of this logical model are not marked to be the target of a Reference
... vaccineHistory
.... vaccineType 0..1 Coding Vaccine type
Binding: IMMZ.Z.DE14 Polio containing vaccines (required)
... birth 1..1 boolean Birth dose
... poliotype 1..1 Coding Type of polio dose
Binding: IMMZ.D1.DE35 ValueSet for Type of polio dose (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
IMMZD1ClientHistoryPolio.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE14
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE14
from this IG
IMMZD1ClientHistoryPolio.poliotyperequiredIMMZ_D1_DE35
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE35
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryPolio 0..* IMMZ_D1_Client_History
Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory
IMMZ.D1 Capture Client History for Polio
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)
... dateSeriesCompleted 1..1 date Date when primary vaccination series was completed
... poliotype 1..1 Coding Type of polio dose
Binding: IMMZ.D1.DE35 ValueSet for Type of polio dose (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryPolio.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
IMMZD1ClientHistoryPolio.poliotyperequiredIMMZ_D1_DE35
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE35
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryPolio 0..* IMMZ_D1_Client_History
Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory
IMMZ.D1 Capture Client History for Polio
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
... 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
Binding: IMMZ.Z.DE14 Polio containing vaccines (required)
.... vaccineDate 0..1 date Date and time of vaccination
... birth 1..1 boolean Birth dose
... poliotype 1..1 Coding Type of polio dose
Binding: IMMZ.D1.DE35 ValueSet for Type of polio dose (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryPolio.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
IMMZD1ClientHistoryPolio.hivStatusrequiredIMMZ_D1_DE10
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10
from this IG
IMMZD1ClientHistoryPolio.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE14
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE14
from this IG
IMMZD1ClientHistoryPolio.poliotyperequiredIMMZ_D1_DE35
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE35
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from IMMZ_D1_Client_History

Summary

Mandatory: 0 element(2 nested mandatory elements)

Differential View

This structure is derived from IMMZ_D1_Client_History

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryPolio 0..* IMMZ_D1_Client_History
Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory
IMMZ.D1 Capture Client History for Polio
Instances of this logical model are not marked to be the target of a Reference
... vaccineHistory
.... vaccineType 0..1 Coding Vaccine type
Binding: IMMZ.Z.DE14 Polio containing vaccines (required)
... birth 1..1 boolean Birth dose
... poliotype 1..1 Coding Type of polio dose
Binding: IMMZ.D1.DE35 ValueSet for Type of polio dose (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
IMMZD1ClientHistoryPolio.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE14
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE14
from this IG
IMMZD1ClientHistoryPolio.poliotyperequiredIMMZ_D1_DE35
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE35
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryPolio 0..* IMMZ_D1_Client_History
Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory
IMMZ.D1 Capture Client History for Polio
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)
... dateSeriesCompleted 1..1 date Date when primary vaccination series was completed
... poliotype 1..1 Coding Type of polio dose
Binding: IMMZ.D1.DE35 ValueSet for Type of polio dose (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryPolio.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
IMMZD1ClientHistoryPolio.poliotyperequiredIMMZ_D1_DE35
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE35
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryPolio 0..* IMMZ_D1_Client_History
Elements defined in Ancestors:patient, type, completedPrimarySeries, booster, dateSeriesCompleted, hivStatus, pretermBirth, immunocompromised, onART, vaccineHistory
IMMZ.D1 Capture Client History for Polio
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
... 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
Binding: IMMZ.Z.DE14 Polio containing vaccines (required)
.... vaccineDate 0..1 date Date and time of vaccination
... birth 1..1 boolean Birth dose
... poliotype 1..1 Coding Type of polio dose
Binding: IMMZ.D1.DE35 ValueSet for Type of polio dose (required)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryPolio.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
IMMZD1ClientHistoryPolio.hivStatusrequiredIMMZ_D1_DE10
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10
from this IG
IMMZD1ClientHistoryPolio.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE14
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE14
from this IG
IMMZD1ClientHistoryPolio.poliotyperequiredIMMZ_D1_DE35
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE35
from this IG

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from IMMZ_D1_Client_History

Summary

Mandatory: 0 element(2 nested mandatory elements)

 

Other representations of profile: CSV, Excel