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_Client_History_YellowFever - Detailed Descriptions

Draft as of 2024-05-30

Definitions for the IMMZD1ClientHistoryYellowFever logical model.

Guidance on how to interpret the contents of this table can be found here

0. IMMZD1ClientHistoryYellowFever
Definition

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.

ShortIMMZ.D1 Capture Client History for Yellow Fever
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IMMZD1ClientHistoryYellowFever.vaccineHistory
4. IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType
BindingThe codes SHALL be taken from IMMZ.Z.DE23 Yellow fever containing vaccines
(required to http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE23)

Guidance on how to interpret the contents of this table can be found here

0. IMMZD1ClientHistoryYellowFever
Definition

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.

ShortIMMZ.D1 Capture Client History for Yellow Fever
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IMMZD1ClientHistoryYellowFever.patient
Definition

The patient who is being checked for contraindications.

ShortPatient
Control1..1
TypeReference
4. IMMZD1ClientHistoryYellowFever.type
Definition

The type of dose in a series that the client received

ShortType of dose
Control1..*
BindingThe codes SHALL be taken from IMMZ.D1.DE103 ValueSet for Type of dose
(required to http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103)
TypeCoding
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE103
6. IMMZD1ClientHistoryYellowFever.dateSeriesCompleted
Definition

The date when the client completed the primary vaccination series (per product/antigen)

ShortDate when primary vaccination series was completed
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE81

Guidance on how to interpret the contents of this table can be found here

0. IMMZD1ClientHistoryYellowFever
Definition

Data elements for the IMMZ.D1 Capture Client History Data Dictionary for Yellow Fever.

ShortIMMZ.D1 Capture Client History for Yellow Fever
Control0..*
Is Modifierfalse
Logical ModelInstances of this logical model are not marked to be the target of a Reference
2. IMMZD1ClientHistoryYellowFever.patient
Definition

The patient who is being checked for contraindications.

ShortPatient
Control1..1
TypeReference
4. IMMZD1ClientHistoryYellowFever.type
Definition

The type of dose in a series that the client received

ShortType of dose
Control1..*
BindingThe codes SHALL be taken from IMMZ.D1.DE103 ValueSet for Type of dose
(required to http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE103)
TypeCoding
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE103
6. IMMZD1ClientHistoryYellowFever.completedPrimarySeries
Definition

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.

ShortCompleted the primary vaccination series
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE8
8. IMMZD1ClientHistoryYellowFever.booster
Definition

Indicates if the client has completed the booster series of a product/antigen

ShortCompleted the booster series
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE102
10. IMMZD1ClientHistoryYellowFever.dateSeriesCompleted
Definition

The date when the client completed the primary vaccination series (per product/antigen)

ShortDate when primary vaccination series was completed
Control1..1
Typedate
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE81
12. IMMZD1ClientHistoryYellowFever.hivStatus
Definition

The current human immunodeficiency virus (HIV) status of the client

ShortHIV status
Control0..1
BindingThe codes SHALL be taken from IMMZ.D1.DE10 ValueSet for HIV status
(required to http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.D1.DE10)
TypeCoding
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE10, LOINC 55277-8, SNOMED CT 278977008
14. IMMZD1ClientHistoryYellowFever.pretermBirth
Definition

The infant was preterm; the mother gave birth to the infant when gestational age was less than 37 weeks

ShortPreterm birth
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE15, icd-11 KA21.4, LOINC 76517-2, SNOMED CT 395507008
16. IMMZD1ClientHistoryYellowFever.immunocompromised
Definition

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

ShortImmunocompromised
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE16, icd-11 4B4Z, LOINC 96381-9, SNOMED CT 370388006
18. IMMZD1ClientHistoryYellowFever.onART
Definition

The client is currently receiving antiretroviral therapy (ART)

ShortCurrently on ART
Control0..1
Typeboolean
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Definitional CodesIMMZ.D1 CodeSystem for Data Elements DE17
20. IMMZD1ClientHistoryYellowFever.vaccineHistory
Definition

History of previous vaccine doses.

ShortVaccine History
Control0..*
TypeBackboneElement
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
22. IMMZD1ClientHistoryYellowFever.vaccineHistory.id
Definition

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

ShortUnique id for inter-element referencing
Control0..1
Typestring
Is Modifierfalse
XML FormatIn the XML format, this property is represented as an attribute.
Summaryfalse
24. IMMZD1ClientHistoryYellowFever.vaccineHistory.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

ShortAdditional content defined by implementations
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
SlicingThis element introduces a set of slices on IMMZD1ClientHistoryYellowFever.vaccineHistory.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 26. IMMZD1ClientHistoryYellowFever.vaccineHistory.modifierExtension
    Definition

    May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

    Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

    ShortExtensions that cannot be ignored even if unrecognized
    Comments

    There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    28. IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineType
    Definition

    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

    ShortVaccine type
    Control0..1
    BindingThe codes SHALL be taken from IMMZ.Z.DE23 Yellow fever containing vaccines
    (required to http://smart.who.int/ig/smart-immunizations/ValueSet/IMMZ.Z.DE23)
    TypeCoding
    Definitional CodesIMMZ.D CodeSystem for Data Elements DE19, LOINC 39236-5, SNOMED CT 787859002
    30. IMMZD1ClientHistoryYellowFever.vaccineHistory.vaccineDate
    Definition

    Represents the visit/encounter date, which is the date and time when the vaccine was administered to the client

    ShortDate and time of vaccination
    Control0..1
    Typedate
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Definitional CodesIMMZ.D CodeSystem for Data Elements DE20, LOINC 30952-6