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 Rubella

Official URL: http://smart.who.int/ig/smart-immunizations/StructureDefinition/IMMZD1ClientHistoryRubella Version: 0.1.0
Draft as of 2024-03-22 Computable Name: IMMZ_D1_Client_History_Rubella

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

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
.. IMMZD1ClientHistoryRubella 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 Rubella
Instances of this logical model are not marked to be the target of a Reference
... vaccineHistory
.... vaccineType 0..1CodingVaccine type
Binding: IMMZ.Z.DE.17 Rubella containing vaccines (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
IMMZD1ClientHistoryRubella.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE17
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE17
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryRubella 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 Rubella
Instances of this logical model are not marked to be the target of a Reference
... patient 1..1Reference()Patient
... type 1..*CodingType of dose
Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
... dateSeriesCompleted 1..1dateDate when primary vaccination series was completed

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryRubella.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryRubella 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 Rubella
Instances of this logical model are not marked to be the target of a Reference
... patient 1..1Reference()Patient
... type 1..*CodingType of dose
Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
... completedPrimarySeries 0..1booleanCompleted the primary vaccination series
... dateSeriesCompleted 1..1dateDate when primary vaccination series was completed
... hivStatus 0..1CodingHIV status
Binding: IMMZ.D1.DE10 ValueSet for HIV status (required)
... pretermBirth 0..1booleanPreterm birth
... immunocompromised 0..1booleanImmunocompromised
... onART 0..1booleanCurrently on ART
... vaccineHistory 0..*BackboneElementVaccine History
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineType 0..1CodingVaccine type
Binding: IMMZ.Z.DE.17 Rubella containing vaccines (required)
.... vaccineDate 0..1dateDate and time of vaccination

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryRubella.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
IMMZD1ClientHistoryRubella.hivStatusrequiredIMMZ_D1_DE10
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10
from this IG
IMMZD1ClientHistoryRubella.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE17
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE17
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

Differential View

This structure is derived from IMMZ_D1_Client_History

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryRubella 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 Rubella
Instances of this logical model are not marked to be the target of a Reference
... vaccineHistory
.... vaccineType 0..1CodingVaccine type
Binding: IMMZ.Z.DE.17 Rubella containing vaccines (required)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
IMMZD1ClientHistoryRubella.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE17
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE17
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryRubella 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 Rubella
Instances of this logical model are not marked to be the target of a Reference
... patient 1..1Reference()Patient
... type 1..*CodingType of dose
Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
... dateSeriesCompleted 1..1dateDate when primary vaccination series was completed

doco Documentation for this format

Terminology Bindings

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

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. IMMZD1ClientHistoryRubella 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 Rubella
Instances of this logical model are not marked to be the target of a Reference
... patient 1..1Reference()Patient
... type 1..*CodingType of dose
Binding: IMMZ.D1.DE103 ValueSet for Type of dose (required)
... completedPrimarySeries 0..1booleanCompleted the primary vaccination series
... dateSeriesCompleted 1..1dateDate when primary vaccination series was completed
... hivStatus 0..1CodingHIV status
Binding: IMMZ.D1.DE10 ValueSet for HIV status (required)
... pretermBirth 0..1booleanPreterm birth
... immunocompromised 0..1booleanImmunocompromised
... onART 0..1booleanCurrently on ART
... vaccineHistory 0..*BackboneElementVaccine History
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... vaccineType 0..1CodingVaccine type
Binding: IMMZ.Z.DE.17 Rubella containing vaccines (required)
.... vaccineDate 0..1dateDate and time of vaccination

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
IMMZD1ClientHistoryRubella.typerequiredIMMZ_D1_DE103
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103
from this IG
IMMZD1ClientHistoryRubella.hivStatusrequiredIMMZ_D1_DE10
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10
from this IG
IMMZD1ClientHistoryRubella.vaccineHistory.vaccineTyperequiredIMMZ_Z_DE17
http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE17
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

 

Other representations of profile: CSV, Excel