WHO Immunization Implementation Guide
0.2.0 - ci-build

WHO Immunization Implementation Guide, published by WHO. This guide is not an authorized publication; it is the continuous build for version 0.2.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/tree/claude/sync-litlfred-2026-11-19 and changes regularly. See the Directory of published versions
Built from commit 71303abd.   Branch: claude/sync-litlfred-2026-11-19.

Resource Profile: SMART Guidelines Immunizations Immunization

Official URL: http://smart.who.int/immunizations/StructureDefinition/IMMZ.Immunization Version: 0.2.0
Draft as of 2025-01-16 Computable Name: IMMZImmunization

Immunization Profile for the Immunizations SMART Guidelines. From IMMZ.D Administer Vaccine

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfPolio.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfPolio.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required)
Immunization.Slices for extension.extension:typeOfJe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfJe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfJe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfJe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required)
Immunization.Slices for extension.extension:typeOfTbe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTbe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTbe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTbe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required)
Immunization.Slices for extension.extension:typeOfTyphoid 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTyphoid.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTyphoid.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTyphoid.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required)
Immunization.Slices for extension.extension:typeOfCholera 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfCholera.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfCholera.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfCholera.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfMeningococcal 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfMeningococcal.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfMeningococcal.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfMeningococcal.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisA 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisA.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisA.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisA.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisB 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisB.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisB.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisB.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required)
Immunization.Slices for extension.extension:vaccineBrand 1..1 CodeableConcept Immunization Vaccine Brand
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
Immunization.Slices for extension.extension:liveVaccine 0..1 boolean Immunization Live Vaccine
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
Immunization.Slices for extension.extension:marketAuthorizationHolder 1..1 CodeableConcept Immunization Market Authorization Holder
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.Slices for protocolApplied 1..* BackboneElement Protocol followed by the provider
Slice: Unordered, Open by exists:series, exists:doseNumber
Immunization.Slices for protocolApplied.protocolApplied:All Slices Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x] 1..1 Dose number within series
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberString string
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol 1..* BackboneElement Protocol followed by the provider
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension.extension:dueDateOfNextDose 0..1 date Immunization Due Date of Next Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.series 1..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.doseNumber[x] 1..1 string Dose number within series

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.extension:typeOfPolio.​value[x] Base required IMMZ.D.DE212 ValueSet for Type of poliovirus dose 📦0.2.0 This IG
Immunization.extension:typeOfJe.​value[x] Base required IMMZ.D.DE216 ValueSet for Type of JE dose 📦0.2.0 This IG
Immunization.extension:typeOfTbe.​value[x] Base required IMMZ.D.DE220 ValueSet for Type of TBE dose 📦0.2.0 This IG
Immunization.extension:typeOfTyphoid.​value[x] Base required IMMZ.D.DE225 ValueSet for Type of typhoid dose 📦0.2.0 This IG
Immunization.extension:typeOfCholera.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfMeningococcal.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisA.​value[x] Base required IMMZ.D.DE237 ValueSet for Type of hepatitis A dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisB.​value[x] Base required IMMZ.D.DE254 ValueSet for Type of hepatitis B dose 📦0.2.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base required IMMZ.D.DE5 ValueSet for Reason vaccine was not administered 📦0.2.0 This IG
Immunization.vaccineCode Base required IMMZ.Z.VS ValueSet for vaccine types 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
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 Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfPolio.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required)
Immunization.Slices for extension.extension:typeOfJe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfJe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required)
Immunization.Slices for extension.extension:typeOfTbe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTbe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required)
Immunization.Slices for extension.extension:typeOfTyphoid 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTyphoid.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required)
Immunization.Slices for extension.extension:typeOfCholera 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfCholera.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfMeningococcal 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfMeningococcal.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisA 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisA.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisB 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisB.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required)
Immunization.Slices for extension.extension:vaccineBrand 1..1 CodeableConcept Immunization Vaccine Brand
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
Immunization.Slices for extension.extension:liveVaccine 0..1 boolean Immunization Live Vaccine
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
Immunization.Slices for extension.extension:marketAuthorizationHolder 1..1 CodeableConcept Immunization Market Authorization Holder
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required)
Immunization.vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
Immunization.location
Immunization.location.extension 1..* Extension Extension
Immunization.location.Slices for extension Content/Rules for all slices
Immunization.location.Slices for extension.extension:countryOfVaccination 1..1 CodeableConcept Immunization Country of Vaccination
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination
Binding: Iso3166-1-3 (required)
Immunization.location.Slices for extension.extension:administrativeArea 0..1 CodeableConcept Immunization Administrative Area
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea
Immunization.Slices for protocolApplied 1..* BackboneElement Protocol followed by the provider
Slice: Unordered, Open by exists:series, exists:doseNumber
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol 1..* BackboneElement Protocol followed by the provider
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension.extension:dueDateOfNextDose 0..1 date Immunization Due Date of Next Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.series 1..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.doseNumber[x] 1..1 string Dose number within series

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.extension:typeOfPolio.​value[x] Base required IMMZ.D.DE212 ValueSet for Type of poliovirus dose 📦0.2.0 This IG
Immunization.extension:typeOfJe.​value[x] Base required IMMZ.D.DE216 ValueSet for Type of JE dose 📦0.2.0 This IG
Immunization.extension:typeOfTbe.​value[x] Base required IMMZ.D.DE220 ValueSet for Type of TBE dose 📦0.2.0 This IG
Immunization.extension:typeOfTyphoid.​value[x] Base required IMMZ.D.DE225 ValueSet for Type of typhoid dose 📦0.2.0 This IG
Immunization.extension:typeOfCholera.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfMeningococcal.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisA.​value[x] Base required IMMZ.D.DE237 ValueSet for Type of hepatitis A dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisB.​value[x] Base required IMMZ.D.DE254 ValueSet for Type of hepatitis B dose 📦0.2.0 This IG
Immunization.statusReason Base required IMMZ.D.DE5 ValueSet for Reason vaccine was not administered 📦0.2.0 This IG
Immunization.vaccineCode Base required IMMZ.Z.VS ValueSet for vaccine types 📦0.2.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfPolio.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfPolio.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfPolio.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required)
Immunization.Slices for extension.extension:typeOfJe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfJe.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfJe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfJe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfJe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required)
Immunization.Slices for extension.extension:typeOfTbe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTbe.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfTbe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTbe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTbe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required)
Immunization.Slices for extension.extension:typeOfTyphoid 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTyphoid.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfTyphoid.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTyphoid.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTyphoid.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required)
Immunization.Slices for extension.extension:typeOfCholera 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfCholera.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfCholera.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfCholera.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfCholera.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfMeningococcal 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfMeningococcal.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfMeningococcal.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfMeningococcal.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfMeningococcal.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisA 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisA.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfHepatitisA.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisA.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisA.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisB 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisB.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfHepatitisB.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisB.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisB.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required)
Immunization.Slices for extension.extension:vaccineBrand 1..1 CodeableConcept Immunization Vaccine Brand
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
Immunization.Slices for extension.extension:liveVaccine 0..1 boolean Immunization Live Vaccine
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
Immunization.Slices for extension.extension:marketAuthorizationHolder 1..1 CodeableConcept Immunization Market Authorization Holder
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.location.id 0..1 string Unique id for inter-element referencing
Immunization.location.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.location.Slices for extension.extension:countryOfVaccination 1..1 CodeableConcept Immunization Country of Vaccination
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination
Binding: Iso3166-1-3 (required)
Immunization.location.Slices for extension.extension:administrativeArea 0..1 CodeableConcept Immunization Administrative Area
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea
Immunization.location.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Immunization.location.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Immunization.location.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Immunization.location.display This element is included in summaries. 0..1 string Text alternative for the resource
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.Slices for protocolApplied 1..* BackboneElement Protocol followed by the provider
Slice: Unordered, Open by exists:series, exists:doseNumber
Immunization.Slices for protocolApplied.protocolApplied:All Slices Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:All Slices.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for protocolApplied.protocolApplied:All Slices.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for protocolApplied.protocolApplied:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:All Slices.series 0..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:All Slices.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.Slices for protocolApplied.protocolApplied:All Slices.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x] 1..1 Dose number within series
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberString string
Immunization.Slices for protocolApplied.protocolApplied:All Slices.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.Slices for protocolApplied.protocolApplied:All Slices.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:All Slices.seriesDoses[x].seriesDosesString string
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol 1..* BackboneElement Protocol followed by the provider
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension.extension:dueDateOfNextDose 0..1 date Immunization Due Date of Next Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.series 1..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.doseNumber[x] 1..1 string Dose number within series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.extension:typeOfPolio.​value[x] Base required IMMZ.D.DE212 ValueSet for Type of poliovirus dose 📦0.2.0 This IG
Immunization.extension:typeOfJe.​value[x] Base required IMMZ.D.DE216 ValueSet for Type of JE dose 📦0.2.0 This IG
Immunization.extension:typeOfTbe.​value[x] Base required IMMZ.D.DE220 ValueSet for Type of TBE dose 📦0.2.0 This IG
Immunization.extension:typeOfTyphoid.​value[x] Base required IMMZ.D.DE225 ValueSet for Type of typhoid dose 📦0.2.0 This IG
Immunization.extension:typeOfCholera.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfMeningococcal.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisA.​value[x] Base required IMMZ.D.DE237 ValueSet for Type of hepatitis A dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisB.​value[x] Base required IMMZ.D.DE254 ValueSet for Type of hepatitis B dose 📦0.2.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base required IMMZ.D.DE5 ValueSet for Reason vaccine was not administered 📦0.2.0 This IG
Immunization.vaccineCode Base required IMMZ.Z.VS ValueSet for vaccine types 📦0.2.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.
Immunization.protocolApplied:immzProtocol.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
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()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfPolio.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfPolio.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required)
Immunization.Slices for extension.extension:typeOfJe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfJe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfJe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfJe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required)
Immunization.Slices for extension.extension:typeOfTbe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTbe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTbe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTbe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required)
Immunization.Slices for extension.extension:typeOfTyphoid 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTyphoid.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTyphoid.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTyphoid.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required)
Immunization.Slices for extension.extension:typeOfCholera 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfCholera.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfCholera.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfCholera.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfMeningococcal 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfMeningococcal.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfMeningococcal.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfMeningococcal.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisA 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisA.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisA.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisA.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisB 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisB.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisB.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisB.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required)
Immunization.Slices for extension.extension:vaccineBrand 1..1 CodeableConcept Immunization Vaccine Brand
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
Immunization.Slices for extension.extension:liveVaccine 0..1 boolean Immunization Live Vaccine
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
Immunization.Slices for extension.extension:marketAuthorizationHolder 1..1 CodeableConcept Immunization Market Authorization Holder
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.Slices for protocolApplied 1..* BackboneElement Protocol followed by the provider
Slice: Unordered, Open by exists:series, exists:doseNumber
Immunization.Slices for protocolApplied.protocolApplied:All Slices Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x] 1..1 Dose number within series
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberString string
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol 1..* BackboneElement Protocol followed by the provider
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension.extension:dueDateOfNextDose 0..1 date Immunization Due Date of Next Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.series 1..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.doseNumber[x] 1..1 string Dose number within series

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.extension:typeOfPolio.​value[x] Base required IMMZ.D.DE212 ValueSet for Type of poliovirus dose 📦0.2.0 This IG
Immunization.extension:typeOfJe.​value[x] Base required IMMZ.D.DE216 ValueSet for Type of JE dose 📦0.2.0 This IG
Immunization.extension:typeOfTbe.​value[x] Base required IMMZ.D.DE220 ValueSet for Type of TBE dose 📦0.2.0 This IG
Immunization.extension:typeOfTyphoid.​value[x] Base required IMMZ.D.DE225 ValueSet for Type of typhoid dose 📦0.2.0 This IG
Immunization.extension:typeOfCholera.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfMeningococcal.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisA.​value[x] Base required IMMZ.D.DE237 ValueSet for Type of hepatitis A dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisB.​value[x] Base required IMMZ.D.DE254 ValueSet for Type of hepatitis B dose 📦0.2.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base required IMMZ.D.DE5 ValueSet for Reason vaccine was not administered 📦0.2.0 This IG
Immunization.vaccineCode Base required IMMZ.Z.VS ValueSet for vaccine types 📦0.2.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
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()

Differential View

This structure is derived from Immunization

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfPolio.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required)
Immunization.Slices for extension.extension:typeOfJe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfJe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required)
Immunization.Slices for extension.extension:typeOfTbe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTbe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required)
Immunization.Slices for extension.extension:typeOfTyphoid 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTyphoid.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required)
Immunization.Slices for extension.extension:typeOfCholera 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfCholera.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfMeningococcal 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfMeningococcal.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisA 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisA.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisB 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisB.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required)
Immunization.Slices for extension.extension:vaccineBrand 1..1 CodeableConcept Immunization Vaccine Brand
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
Immunization.Slices for extension.extension:liveVaccine 0..1 boolean Immunization Live Vaccine
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
Immunization.Slices for extension.extension:marketAuthorizationHolder 1..1 CodeableConcept Immunization Market Authorization Holder
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required)
Immunization.vaccineCode 1..1 CodeableConcept Vaccine product administered
Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
Immunization.occurrence[x] 1..1 dateTime Vaccine administration date
Immunization.location
Immunization.location.extension 1..* Extension Extension
Immunization.location.Slices for extension Content/Rules for all slices
Immunization.location.Slices for extension.extension:countryOfVaccination 1..1 CodeableConcept Immunization Country of Vaccination
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination
Binding: Iso3166-1-3 (required)
Immunization.location.Slices for extension.extension:administrativeArea 0..1 CodeableConcept Immunization Administrative Area
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea
Immunization.Slices for protocolApplied 1..* BackboneElement Protocol followed by the provider
Slice: Unordered, Open by exists:series, exists:doseNumber
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol 1..* BackboneElement Protocol followed by the provider
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension.extension:dueDateOfNextDose 0..1 date Immunization Due Date of Next Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.series 1..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.doseNumber[x] 1..1 string Dose number within series

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.extension:typeOfPolio.​value[x] Base required IMMZ.D.DE212 ValueSet for Type of poliovirus dose 📦0.2.0 This IG
Immunization.extension:typeOfJe.​value[x] Base required IMMZ.D.DE216 ValueSet for Type of JE dose 📦0.2.0 This IG
Immunization.extension:typeOfTbe.​value[x] Base required IMMZ.D.DE220 ValueSet for Type of TBE dose 📦0.2.0 This IG
Immunization.extension:typeOfTyphoid.​value[x] Base required IMMZ.D.DE225 ValueSet for Type of typhoid dose 📦0.2.0 This IG
Immunization.extension:typeOfCholera.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfMeningococcal.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisA.​value[x] Base required IMMZ.D.DE237 ValueSet for Type of hepatitis A dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisB.​value[x] Base required IMMZ.D.DE254 ValueSet for Type of hepatitis B dose 📦0.2.0 This IG
Immunization.statusReason Base required IMMZ.D.DE5 ValueSet for Reason vaccine was not administered 📦0.2.0 This IG
Immunization.vaccineCode Base required IMMZ.Z.VS ValueSet for vaccine types 📦0.2.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* Immunization Immunization event information
Immunization.id This element is included in summaries. 0..1 id Logical id of this artifact
Immunization.meta This element is included in summaries. 0..1 Meta Metadata about the resource
Immunization.implicitRules This element is a modifier element. This element is included in summaries. 0..1 uri A set of rules under which this content was created
Immunization.language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
Immunization.text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
Immunization.contained 0..* Resource Contained, inline Resources
Immunization.Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfPolio.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfPolio.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfPolio.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfPolio.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE212 ValueSet for Type of poliovirus dose (required)
Immunization.Slices for extension.extension:typeOfJe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfJe.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfJe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfJe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfJe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE216 ValueSet for Type of JE dose (required)
Immunization.Slices for extension.extension:typeOfTbe 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTbe.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfTbe.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTbe.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTbe.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE220 ValueSet for Type of TBE dose (required)
Immunization.Slices for extension.extension:typeOfTyphoid 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfTyphoid.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfTyphoid.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfTyphoid.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfTyphoid.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE225 ValueSet for Type of typhoid dose (required)
Immunization.Slices for extension.extension:typeOfCholera 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfCholera.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfCholera.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfCholera.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfCholera.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfMeningococcal 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfMeningococcal.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfMeningococcal.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfMeningococcal.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfMeningococcal.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE229 ValueSet for Type of cholera dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisA 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisA.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfHepatitisA.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisA.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisA.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE237 ValueSet for Type of hepatitis A dose (required)
Immunization.Slices for extension.extension:typeOfHepatitisB 0..1 (Complex) Immunization Type of Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose
Immunization.Slices for extension.extension:typeOfHepatitisB.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:typeOfHepatitisB.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:typeOfHepatitisB.url 1..1 uri "http://smart.who.int/immunizations/StructureDefinition/IMMZTypeOfDose"
Immunization.Slices for extension.extension:typeOfHepatitisB.value[x] 0..1 CodeableConcept Value of extension
Binding: IMMZ.D.DE254 ValueSet for Type of hepatitis B dose (required)
Immunization.Slices for extension.extension:vaccineBrand 1..1 CodeableConcept Immunization Vaccine Brand
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZVaccineBrand
Binding: IMMZ.D.DE18 ValueSet for Vaccine brand (example)
Immunization.Slices for extension.extension:liveVaccine 0..1 boolean Immunization Live Vaccine
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZLiveVaccine
Immunization.Slices for extension.extension:marketAuthorizationHolder 1..1 CodeableConcept Immunization Market Authorization Holder
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZMarketAuthorization
Binding: IMMZ.D.DE25 ValueSet for Vaccine market authorization holder (example)
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Business identifier
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code completed | entered-in-error | not-done
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason not done
Binding: IMMZ.D.DE5 ValueSet for Reason vaccine was not administered (required)
Immunization.vaccineCode This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: IMMZ.Z.VS ValueSet for vaccine types (required)
Immunization.patient This element is included in summaries. 1..1 Reference(Patient) Who was immunized
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.occurrence[x] This element is included in summaries. 1..1 dateTime Vaccine administration date
Immunization.recorded 0..1 dateTime When the immunization was first captured in the subject's record
Immunization.primarySource This element is included in summaries. 0..1 boolean Indicates context the data was recorded in
Immunization.reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
Immunization.location 0..1 Reference(Location) Where immunization occurred
Immunization.location.id 0..1 string Unique id for inter-element referencing
Immunization.location.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.location.Slices for extension.extension:countryOfVaccination 1..1 CodeableConcept Immunization Country of Vaccination
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZCountryOfVaccination
Binding: Iso3166-1-3 (required)
Immunization.location.Slices for extension.extension:administrativeArea 0..1 CodeableConcept Immunization Administrative Area
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZAdministrativeArea
Immunization.location.reference This element is included in summaries. C 0..1 string Literal reference, Relative, internal or absolute URL
Immunization.location.type This element is included in summaries. 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
Immunization.location.identifier This element is included in summaries. 0..1 Identifier Logical reference, when literal reference is not known
Immunization.location.display This element is included in summaries. 0..1 string Text alternative for the resource
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer
Immunization.lotNumber 0..1 string Vaccine lot number
Immunization.expirationDate 0..1 date Vaccine expiration date
Immunization.site 0..1 CodeableConcept Body site vaccine was administered
Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
Immunization.route 0..1 CodeableConcept How vaccine entered body
Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
Immunization.doseQuantity C 0..1 SimpleQuantity(4.0.1) Amount of vaccine administered
Constraints: sqty-1
Immunization.performer This element is included in summaries. 0..* BackboneElement Who performed event
Immunization.performer.id 0..1 string Unique id for inter-element referencing
Immunization.performer.extension 0..* Extension Additional content defined by implementations
Immunization.performer.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.performer.function This element is included in summaries. 0..1 CodeableConcept What type of performance was done
Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
Immunization.performer.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.reasonCode 0..* CodeableConcept Why immunization occurred
Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
Immunization.reasonReference 0..* Reference(Condition | Observation | DiagnosticReport) Why immunization occurred
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency
Immunization.subpotentReason 0..* CodeableConcept Reason for being subpotent
Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
Immunization.education C 0..* BackboneElement Educational material presented to patient
Constraints: imm-1
Immunization.education.id 0..1 string Unique id for inter-element referencing
Immunization.education.extension 0..* Extension Additional content defined by implementations
Immunization.education.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.education.documentType 0..1 string Educational material document identifier
Immunization.education.reference 0..1 uri Educational material reference pointer
Immunization.education.publicationDate 0..1 dateTime Educational material publication date
Immunization.education.presentationDate 0..1 dateTime Educational material presentation date
Immunization.programEligibility 0..* CodeableConcept Patient eligibility for a vaccination program
Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
Immunization.fundingSource 0..1 CodeableConcept Funding source for the vaccine
Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
Immunization.reaction 0..* BackboneElement Details of a reaction that follows immunization
Immunization.reaction.id 0..1 string Unique id for inter-element referencing
Immunization.reaction.extension 0..* Extension Additional content defined by implementations
Immunization.reaction.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.reaction.date 0..1 dateTime When reaction started
Immunization.reaction.detail 0..1 Reference(Observation) Additional information on reaction
Immunization.reaction.reported 0..1 boolean Indicates self-reported reaction
Immunization.Slices for protocolApplied 1..* BackboneElement Protocol followed by the provider
Slice: Unordered, Open by exists:series, exists:doseNumber
Immunization.Slices for protocolApplied.protocolApplied:All Slices Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:All Slices.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for protocolApplied.protocolApplied:All Slices.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for protocolApplied.protocolApplied:All Slices.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:All Slices.series 0..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:All Slices.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.Slices for protocolApplied.protocolApplied:All Slices.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x] 1..1 Dose number within series
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:All Slices.doseNumber[x].doseNumberString string
Immunization.Slices for protocolApplied.protocolApplied:All Slices.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.Slices for protocolApplied.protocolApplied:All Slices.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:All Slices.seriesDoses[x].seriesDosesString string
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol 1..* BackboneElement Protocol followed by the provider
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension Content/Rules for all slices
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.Slices for extension.extension:dueDateOfNextDose 0..1 date Immunization Due Date of Next Dose
URL: http://smart.who.int/immunizations/StructureDefinition/IMMZDueDateOfNextDose
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.series 1..1 string Name of vaccine series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.targetDisease 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: ImmunizationTargetDiseaseCodes (example): The vaccine preventable disease the dose is being administered for.
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.doseNumber[x] 1..1 string Dose number within series
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.seriesDoses[x] 0..1 Recommended number of doses for immunity
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.Slices for protocolApplied.protocolApplied:immzProtocol.seriesDoses[x].seriesDosesString string

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📍4.0.1 FHIR Std.
Immunization.extension:typeOfPolio.​value[x] Base required IMMZ.D.DE212 ValueSet for Type of poliovirus dose 📦0.2.0 This IG
Immunization.extension:typeOfJe.​value[x] Base required IMMZ.D.DE216 ValueSet for Type of JE dose 📦0.2.0 This IG
Immunization.extension:typeOfTbe.​value[x] Base required IMMZ.D.DE220 ValueSet for Type of TBE dose 📦0.2.0 This IG
Immunization.extension:typeOfTyphoid.​value[x] Base required IMMZ.D.DE225 ValueSet for Type of typhoid dose 📦0.2.0 This IG
Immunization.extension:typeOfCholera.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfMeningococcal.​value[x] Base required IMMZ.D.DE229 ValueSet for Type of cholera dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisA.​value[x] Base required IMMZ.D.DE237 ValueSet for Type of hepatitis A dose 📦0.2.0 This IG
Immunization.extension:typeOfHepatitisB.​value[x] Base required IMMZ.D.DE254 ValueSet for Type of hepatitis B dose 📦0.2.0 This IG
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base required IMMZ.D.DE5 ValueSet for Reason vaccine was not administered 📦0.2.0 This IG
Immunization.vaccineCode Base required IMMZ.Z.VS ValueSet for vaccine types 📦0.2.0 This IG
Immunization.reportOrigin Base example Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.location.​type Base extensible ResourceType 📍4.0.1 FHIR Std.
Immunization.site Base example Codes for Immunization Site of Administration 📍4.0.1 FHIR Std.
Immunization.route Base example Immunization Route Codes 📍4.0.1 FHIR Std.
Immunization.performer.​function Base extensible Immunization Function Codes 📍4.0.1 FHIR Std.
Immunization.reasonCode Base example Immunization Reason Codes 📍4.0.1 FHIR Std.
Immunization.subpotentReason Base example Immunization Subpotent Reason 📍4.0.1 FHIR Std.
Immunization.programEligibility Base example Immunization Program Eligibility 📍4.0.1 FHIR Std.
Immunization.fundingSource Base example Immunization Funding Source 📍4.0.1 FHIR Std.
Immunization.protocolApplied.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.
Immunization.protocolApplied:immzProtocol.​targetDisease Base example Immunization Target Disease Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
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()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()
sqty-1 error Immunization.doseQuantity The comparator is not used on a SimpleQuantity comparator.empty()

 

Other representations of profile: CSV, Excel, Schematron