HL7 Europe Discharge Report
1.0.0-ci-build - ci-build 150

HL7 Europe Discharge Report, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/discharge-report/ and changes regularly. See the Directory of published versions

Resource Profile: Immunization: obligations

Official URL: http://hl7.eu/fhir/discharge-report/StructureDefinition/immunization-obl-eu-dr Version: 1.0.0-ci-build
Standards status: Informative Maturity Level: 0 Computable Name: ImmunizationEuDrObligation

Copyright/Legal: Copyright HL7 Europe. Licensed under creative commons public domain (CC0 1.0).

This profile defines obligations for the Immunization resource for the purpose of this guide.

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..* ImmunizationEuCore 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 Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct This element has obligations. 0..1 (Complex) R5: Product that was administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct
Constraints: ext-1
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.Slices for extension.extension:administeredProduct.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:administeredProduct.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
Immunization.Slices for extension.extension:informationSource 0..1 (Complex) R5: Indicates the source of a reported record (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:informationSource.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
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 Immunization status.
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.vaccineCode This element has obligations. This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
Additional BindingsPurposeDocumentation
Vaccines WHO ATC - IPS Preferred
For when WHO ATC code system is preferred
eHDSI Vaccine Preferred
For EU cross-border use
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who was immunized
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
Immunization.Slices for occurrence[x] This element has obligations. This element is included in summaries. 1..1 Date of vaccination
Slice: Unordered, Closed by type:$this
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Immunization.Slices for occurrence[x].occurrenceDateTime dateTime
Immunization.Slices for occurrence[x].occurrenceString string
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime This element is included in summaries. 0..1 dateTime Vaccine administration date
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension Content/Rules for all slices
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife 0..1 (Complex) Many: Periods of Life
URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.url 1..1 uri "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
Immunization.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by value:$this.function
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer: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 performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeringCentreOrHp This element has obligations. This element is included in summaries. 0..* BackboneElement Administering centre
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.Slices for performer.performer:administeringCentreOrHp.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 performer.performer:administeringCentreOrHp.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.
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeringCentreOrHp.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeringCentreOrHp.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeringCentreOrHp.actor This element is included in summaries. 1..1 Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) Individual or organization who was performing
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred Vaccines - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
Immunization.performer:administeringCentreOrHp.​function Base extensible Immunization Function 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 Immunization.extension:administeredProduct, Immunization.extension:administeredProduct.extension, Immunization.extension:administeredProduct.extension:_datatype, Immunization.extension:administeredProduct.extension:concept, Immunization.extension:administeredProduct.extension:reference, Immunization.extension:informationSource, Immunization.extension:informationSource.extension, Immunization.extension:informationSource.extension:_datatype, Immunization.extension:informationSource.extension:concept, Immunization.extension:informationSource.extension:reference, Immunization.modifierExtension, Immunization.occurrence[x]:occurrenceDateTime.extension:periodOfLife, Immunization.performer.modifierExtension, Immunization.performer:administeringCentreOrHp.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ImmunizationEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization ImmunizationEuCore
Immunization.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct This element has obligations. 0..1 R5 Immunization.administeredProduct R5: Product that was administered (new)
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.vaccineCode This element has obligations. 1..1 CodeableConcept Vaccine product administered
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.patient This element has obligations. 1..1 Reference(Patient (EU core)) Who was immunized
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
Immunization.Slices for performer Content/Rules for all slices
Immunization.Slices for performer.performer:administeringCentreOrHp This element has obligations. 0..* BackboneElement Administering centre
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.protocolApplied
Immunization.protocolApplied.targetDisease This element has obligations. 0..* CodeableConcept Vaccine preventatable disease being targetted
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* ImmunizationEuCore 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 immunization 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 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:administeredProduct This element has obligations. 0..1 (Complex) R5: Product that was administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct
Constraints: ext-1
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.Slices for extension.extension:administeredProduct.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.value[x] 0..1 CodeableConcept Reference to a concept (by class)
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.value[x] 0..1 Reference(Medication (EU core)) Reference to a resource (by instance)
Immunization.Slices for extension.extension:administeredProduct.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
Immunization.Slices for extension.extension:informationSource 0..1 (Complex) R5: Indicates the source of a reported record (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.value[x] 0..1 CodeableConcept Reference to a concept (by class)
Binding: ImmunizationOriginCodes (preferred)
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.value[x] 0..1 Reference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core)) Reference to a resource (by instance)
Immunization.Slices for extension.extension:informationSource.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Identifier of the immunization
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code Immunization status.
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason for not performing.
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element has obligations. This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
Additional BindingsPurposeDocumentation
Vaccines WHO ATC - IPS Preferred
For when WHO ATC code system is preferred
eHDSI Vaccine Preferred
For EU cross-border use
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who was immunized
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.Slices for occurrence[x] This element has obligations. This element is included in summaries. 1..1 Date of vaccination
Slice: Unordered, Closed by type:$this
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Immunization.Slices for occurrence[x].occurrenceDateTime dateTime
Immunization.Slices for occurrence[x].occurrenceString string
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime This element is included in summaries. 0..1 dateTime Vaccine administration date
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.id 0..1 string xml:id (or equivalent in JSON)
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension Content/Rules for all slices
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife 0..1 (Complex) Many: Periods of Life
URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.url 1..1 uri "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.value[x] 0..1 CodeableConcept Value of extension
Binding: Periods of Life (preferred)
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.value 0..1 dateTime Primitive value for dateTime
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 (EU core)) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer/MAH
Immunization.lotNumber 0..1 string Batch/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.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by value:$this.function
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer:All Slices.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:All Slices.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer: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 performer.performer:All Slices.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.Slices for performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeringCentreOrHp This element has obligations. This element is included in summaries. 0..* BackboneElement Administering centre
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.Slices for performer.performer:administeringCentreOrHp.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.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 performer.performer:administeringCentreOrHp.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.
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeringCentreOrHp.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeringCentreOrHp.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeringCentreOrHp.actor This element is included in summaries. 1..1 Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.note.id 0..1 string Unique id for inter-element referencing
Immunization.note.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.note.author[x] This element is included in summaries. 0..1 Individual responsible for the annotation
Immunization.note.author[x].authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
Immunization.note.author[x].authorString string
Immunization.note.time This element is included in summaries. 0..1 dateTime When the annotation was made
Immunization.note.text This element is included in summaries. 1..1 markdown Additional notes about the immunization
Immunization.reasonCode 0..* CodeableConcept Reasons for the administration.
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.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease This element has obligations. 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Vaccine Target Diseases - IPS (preferred): The diseases against which the patient has been immunised
Additional BindingsPurposeDocumentation
eHDSI Illness and Disorder Preferred
For when WHO ATC code system is preferred

ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.protocolApplied.doseNumber[x] 1..1 Dose Number
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Number of doses
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.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:informationSource.​extension:concept.value[x] Base preferred Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred Vaccines - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
Immunization.occurrence[x]:occurrenceDateTime.​extension:periodOfLife.​value[x] Base preferred Periods of Life 📦2.0.1 HL7 Europe Base and Core FHIR IG v2.0
Immunization.reportOrigin Base example Immunization Origin Codes 📍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.performer:administeringCentreOrHp.​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 preferred Vaccine Target Diseases - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0

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()

This structure is derived from ImmunizationEuCore

Summary

Maturity: 0

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* ImmunizationEuCore 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 Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct This element has obligations. 0..1 (Complex) R5: Product that was administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct
Constraints: ext-1
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.Slices for extension.extension:administeredProduct.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:administeredProduct.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
Immunization.Slices for extension.extension:informationSource 0..1 (Complex) R5: Indicates the source of a reported record (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:informationSource.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
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 Immunization status.
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.vaccineCode This element has obligations. This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
Additional BindingsPurposeDocumentation
Vaccines WHO ATC - IPS Preferred
For when WHO ATC code system is preferred
eHDSI Vaccine Preferred
For EU cross-border use
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who was immunized
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
Immunization.Slices for occurrence[x] This element has obligations. This element is included in summaries. 1..1 Date of vaccination
Slice: Unordered, Closed by type:$this
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Immunization.Slices for occurrence[x].occurrenceDateTime dateTime
Immunization.Slices for occurrence[x].occurrenceString string
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime This element is included in summaries. 0..1 dateTime Vaccine administration date
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension Content/Rules for all slices
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife 0..1 (Complex) Many: Periods of Life
URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.url 1..1 uri "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
Immunization.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by value:$this.function
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer: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 performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeringCentreOrHp This element has obligations. This element is included in summaries. 0..* BackboneElement Administering centre
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.Slices for performer.performer:administeringCentreOrHp.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 performer.performer:administeringCentreOrHp.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.
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeringCentreOrHp.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeringCentreOrHp.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeringCentreOrHp.actor This element is included in summaries. 1..1 Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) Individual or organization who was performing
Immunization.isSubpotent This element is a modifier element. This element is included in summaries. 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred Vaccines - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
Immunization.performer:administeringCentreOrHp.​function Base extensible Immunization Function 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 Immunization.extension:administeredProduct, Immunization.extension:administeredProduct.extension, Immunization.extension:administeredProduct.extension:_datatype, Immunization.extension:administeredProduct.extension:concept, Immunization.extension:administeredProduct.extension:reference, Immunization.extension:informationSource, Immunization.extension:informationSource.extension, Immunization.extension:informationSource.extension:_datatype, Immunization.extension:informationSource.extension:concept, Immunization.extension:informationSource.extension:reference, Immunization.modifierExtension, Immunization.occurrence[x]:occurrenceDateTime.extension:periodOfLife, Immunization.performer.modifierExtension, Immunization.performer:administeringCentreOrHp.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ImmunizationEuCore

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization ImmunizationEuCore
Immunization.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct This element has obligations. 0..1 R5 Immunization.administeredProduct R5: Product that was administered (new)
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.vaccineCode This element has obligations. 1..1 CodeableConcept Vaccine product administered
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.patient This element has obligations. 1..1 Reference(Patient (EU core)) Who was immunized
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
Immunization.occurrence[x] This element has obligations. 1..1 dateTime, string Date of vaccination
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.Slices for performer Content/Rules for all slices
Immunization.Slices for performer.performer:administeringCentreOrHp This element has obligations. 0..* BackboneElement Administering centre
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.protocolApplied
Immunization.protocolApplied.targetDisease This element has obligations. 0..* CodeableConcept Vaccine preventatable disease being targetted
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: doco
Immunization 0..* ImmunizationEuCore 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 immunization 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 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for extension.extension:administeredProduct This element has obligations. 0..1 (Complex) R5: Product that was administered (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct
Constraints: ext-1
ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.Slices for extension.extension:administeredProduct.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:concept.value[x] 0..1 CodeableConcept Reference to a concept (by class)
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:administeredProduct.Slices for extension.extension:reference.value[x] 0..1 Reference(Medication (EU core)) Reference to a resource (by instance)
Immunization.Slices for extension.extension:administeredProduct.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
Immunization.Slices for extension.extension:informationSource 0..1 (Complex) R5: Indicates the source of a reported record (new)
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension Content/Rules for all slices
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype 1..1 Extension DataType slice for a FHIR R5 `CodeableReference` value
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/_datatype"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:_datatype.value[x] 1..1 string Value of extension
Fixed Value: CodeableReference
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept 0..1 Extension R5: Reference to a concept (by class)
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.url 1..1 uri "concept"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:concept.value[x] 0..1 CodeableConcept Reference to a concept (by class)
Binding: ImmunizationOriginCodes (preferred)
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference 0..1 Extension Extension
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.extension 0..0 Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.url 1..1 uri "reference"
Immunization.Slices for extension.extension:informationSource.Slices for extension.extension:reference.value[x] 0..1 Reference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core)) Reference to a resource (by instance)
Immunization.Slices for extension.extension:informationSource.url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
Immunization.modifierExtension This element is a modifier element. 0..* Extension Extensions that cannot be ignored
Immunization.identifier 0..* Identifier Identifier of the immunization
Immunization.status This element is a modifier element. This element is included in summaries. 1..1 code Immunization status.
Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
Immunization.statusReason 0..1 CodeableConcept Reason for not performing.
Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
Immunization.vaccineCode This element has obligations. This element is included in summaries. 1..1 CodeableConcept Vaccine product administered
Binding: Vaccines - IPS (preferred): The type of vaccine for particular disease or diseases against which the patient has been immunised, or a code for absent/unknown immunization.
Additional BindingsPurposeDocumentation
Vaccines WHO ATC - IPS Preferred
For when WHO ATC code system is preferred
eHDSI Vaccine Preferred
For EU cross-border use
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.patient This element has obligations. This element is included in summaries. 1..1 Reference(Patient (EU core)) Who was immunized
ObligationsActor
SHALL:able-to-populate Producer
SHALL:process Consumer
Immunization.encounter 0..1 Reference(Encounter) Encounter immunization was part of
Immunization.Slices for occurrence[x] This element has obligations. This element is included in summaries. 1..1 Date of vaccination
Slice: Unordered, Closed by type:$this
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer

Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them Other type slices that contain no new information are not shown in this view
Immunization.Slices for occurrence[x].occurrenceDateTime dateTime
Immunization.Slices for occurrence[x].occurrenceString string
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime This element is included in summaries. 0..1 dateTime Vaccine administration date
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.id 0..1 string xml:id (or equivalent in JSON)
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension Content/Rules for all slices
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife 0..1 (Complex) Many: Periods of Life
URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.extension 0..0 Extension
Slice: Unordered, Open by value:url
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.url 1..1 uri "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.Slices for extension.extension:periodOfLife.value[x] 0..1 CodeableConcept Value of extension
Binding: Periods of Life (preferred)
Immunization.Slices for occurrence[x].occurrence[x]:occurrenceDateTime.value 0..1 dateTime Primitive value for dateTime
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 (EU core)) Where immunization occurred
Immunization.manufacturer 0..1 Reference(Organization) Vaccine manufacturer/MAH
Immunization.lotNumber 0..1 string Batch/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.Slices for performer This element is included in summaries. 0..* BackboneElement Who performed event
Slice: Unordered, Open by value:$this.function
Immunization.Slices for performer.performer:All Slices Content/Rules for all slices
Immunization.Slices for performer.performer:All Slices.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:All Slices.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer: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 performer.performer:All Slices.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.Slices for performer.performer:All Slices.actor This element is included in summaries. 1..1 Reference(Practitioner | PractitionerRole | Organization) Individual or organization who was performing
Immunization.Slices for performer.performer:administeringCentreOrHp This element has obligations. This element is included in summaries. 0..* BackboneElement Administering centre
ObligationsActor
SHALL:able-to-populate Producer
SHALL:display Consumer
SHALL:process Consumer
Immunization.Slices for performer.performer:administeringCentreOrHp.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.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 performer.performer:administeringCentreOrHp.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.
Required Pattern: At least the following
Immunization.Slices for performer.performer:administeringCentreOrHp.function.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding 1..* Coding Code defined by a terminology system
Fixed Value: (Complex)
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.id 0..1 string Unique id for inter-element referencing
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.extension 0..* Extension Additional content defined by implementations
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.system 1..1 uri Identity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.version 0..1 string Version of the system - if relevant
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.code 1..1 code Symbol in syntax defined by the system
Fixed Value: AP
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.display 0..1 string Representation defined by the system
Immunization.Slices for performer.performer:administeringCentreOrHp.function.coding.userSelected 0..1 boolean If this coding was chosen directly by the user
Immunization.Slices for performer.performer:administeringCentreOrHp.function.text 0..1 string Plain text representation of the concept
Immunization.Slices for performer.performer:administeringCentreOrHp.actor This element is included in summaries. 1..1 Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) Individual or organization who was performing
Immunization.note This element is included in summaries. 0..* Annotation Additional immunization notes
Immunization.note.id 0..1 string Unique id for inter-element referencing
Immunization.note.extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
Immunization.note.author[x] This element is included in summaries. 0..1 Individual responsible for the annotation
Immunization.note.author[x].authorReference Reference(Practitioner | Patient | RelatedPerson | Organization)
Immunization.note.author[x].authorString string
Immunization.note.time This element is included in summaries. 0..1 dateTime When the annotation was made
Immunization.note.text This element is included in summaries. 1..1 markdown Additional notes about the immunization
Immunization.reasonCode 0..* CodeableConcept Reasons for the administration.
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.protocolApplied 0..* BackboneElement Protocol followed by the provider
Immunization.protocolApplied.id 0..1 string Unique id for inter-element referencing
Immunization.protocolApplied.extension 0..* Extension Additional content defined by implementations
Immunization.protocolApplied.modifierExtension This element is a modifier element. This element is included in summaries. 0..* Extension Extensions that cannot be ignored even if unrecognized
Immunization.protocolApplied.series 0..1 string Name of vaccine series
Immunization.protocolApplied.authority 0..1 Reference(Organization) Who is responsible for publishing the recommendations
Immunization.protocolApplied.targetDisease This element has obligations. 0..* CodeableConcept Vaccine preventatable disease being targetted
Binding: Vaccine Target Diseases - IPS (preferred): The diseases against which the patient has been immunised
Additional BindingsPurposeDocumentation
eHDSI Illness and Disorder Preferred
For when WHO ATC code system is preferred

ObligationsActor
SHALL:able-to-populate Producer
SHOULD:display Consumer
SHALL:process Consumer
Immunization.protocolApplied.doseNumber[x] 1..1 Dose Number
Immunization.protocolApplied.doseNumber[x].doseNumberPositiveInt positiveInt
Immunization.protocolApplied.doseNumber[x].doseNumberString string
Immunization.protocolApplied.seriesDoses[x] 0..1 Number of doses
Immunization.protocolApplied.seriesDoses[x].seriesDosesPositiveInt positiveInt
Immunization.protocolApplied.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:informationSource.​extension:concept.value[x] Base preferred Immunization Origin Codes 📍4.0.1 FHIR Std.
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.statusReason Base example Immunization Status Reason Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred Vaccines - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0
Immunization.occurrence[x]:occurrenceDateTime.​extension:periodOfLife.​value[x] Base preferred Periods of Life 📦2.0.1 HL7 Europe Base and Core FHIR IG v2.0
Immunization.reportOrigin Base example Immunization Origin Codes 📍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.performer:administeringCentreOrHp.​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 preferred Vaccine Target Diseases - IPS 📦2.0.1 International Patient Summary Implementation Guide v2.0

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()

This structure is derived from ImmunizationEuCore

Summary

Maturity: 0

 

Other representations of profile: CSV, Excel, Schematron