HL7 Europe Hospital Discharge Report
1.0.0-alpha - qa-preview 150

HL7 Europe Hospital Discharge Report - Downloaded Version 1.0.0-alpha See the Directory of published versions

## Resource Profile: Immunization: obligations

Official URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-obl-eu-hdr | Version: 1.0.0-alpha
Standards status: Informative | Maturity Level: 0 | Computable Name: ImmunizationEuHdrObligation
Copyright/Legal: Used by permission of HL7 Europe, all rights reserved Creative Commons License

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

Usages:

- This Profile is not used by any profiles in this Implementation Guide

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.

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | ImmunizationEuCore | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:administeredProduct | O | 0..1 | (Complex) | Product that was administered URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
Slices for extension |  |  |  | Content/Rules for all slices
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
url |  | 1..1 | uri | "concept"
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "reference"
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.administeredProduct from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource |  | 0..1 | (Complex) | Indicates the source of a reported record URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
url |  | 1..1 | uri | "concept"
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "reference"
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.informationSource from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode | O Σ | 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 Bindings | Purpose | Documentation
Vaccines WHO ATC - IPS | candidate | For when WHO ATC code system is preferred
eHDSI Vaccine | candidate | For EU cross-border use
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
patient | O Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized
Obligations | Actor
SHALL:handle | HDRConsumer
SHALL:able-to-populate | HDRCreator
Slices for occurrence[x] | O Σ | 1..1 |  | Date of vaccination Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | Σ | 0..1 | dateTime | Vaccine administration date
Slices for extension |  |  |  | Content/Rules for all slices
extension:periodOfLife |  | 0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
performer:administeringCentreOrHp | O Σ | 0..* | BackboneElement | Administering centre
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
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.0 | 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:concept, Immunization.extension:administeredProduct.extension:reference, Immunization.extension:administeredProduct.extension:_datatype, Immunization.extension:informationSource, Immunization.extension:informationSource.extension:concept, Immunization.extension:informationSource.extension:reference, Immunization.extension:informationSource.extension:_datatype, 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | ImmunizationEuCore | Immunization event information
Slices for extension |  |  |  | Content/Rules for all slices
extension:administeredProduct | O | 0..1 | R5 Immunization.administeredProduct | Product that was administered
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
vaccineCode | O | 1..1 | CodeableConcept | Vaccine product administered
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
patient | O | 1..1 | Reference(Patient (EU core)) | Who was immunized
Obligations | Actor
SHALL:handle | HDRConsumer
SHALL:able-to-populate | HDRCreator
occurrence[x] | O | 1..1 | dateTime, string | Date of vaccination
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
Slices for performer |  |  |  | Content/Rules for all slices
performer:administeringCentreOrHp | O | 0..* | BackboneElement | Administering centre
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
protocolApplied |  |  |  |
targetDisease | O | 0..* | CodeableConcept | Vaccine preventatable disease being targetted
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | ImmunizationEuCore | Immunization event information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the immunization content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:administeredProduct | O | 0..1 | (Complex) | Product that was administered URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Closed by value:url Constraints: ext-1
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "concept"
value[x] |  | 0..1 | CodeableConcept | Reference to a concept (by class)
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "reference"
value[x] |  | 0..1 | Reference(Medication (EU core)) | Reference to a resource (by instance)
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.administeredProduct from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource |  | 0..1 | (Complex) | Indicates the source of a reported record URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Closed by value:url Constraints: ext-1
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "concept"
value[x] |  | 0..1 | CodeableConcept | Reference to a concept (by class)
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "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)
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.informationSource from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Identifier of the immunization
status | ?!Σ | 1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | Reason for not performing. Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | O Σ | 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 Bindings | Purpose | Documentation
Vaccines WHO ATC - IPS | candidate | For when WHO ATC code system is preferred
eHDSI Vaccine | candidate | For EU cross-border use
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
patient | O Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized
Obligations | Actor
SHALL:handle | HDRConsumer
SHALL:able-to-populate | HDRCreator
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
Slices for occurrence[x] | O Σ | 1..1 |  | Date of vaccination Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | Σ | 0..1 | dateTime | Vaccine administration date
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:periodOfLife |  | 0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Periods of Life (preferred)
value |  | 0..1 | dateTime | Primitive value for dateTime
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in
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.
location |  | 0..1 | Reference(Location (EU core)) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | Batch/lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity |  | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
performer:administeringCentreOrHp | O Σ | 0..* | BackboneElement | Administering centre
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing
note | Σ | 0..* | Annotation | Additional immunization notes
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner | Patient | RelatedPerson | Organization) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | Σ | 1..1 | markdown | Additional notes about the immunization
reasonCode |  | 0..* | CodeableConcept | Reasons for the administration. Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease | O | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): The diseases against which the patient has been immunised
Additional Bindings | Purpose | Documentation
eHDSI Illness and Disorder | candidate | For when WHO ATC code system is preferred
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
doseNumber[x] |  | 1..1 |  | Dose Number
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Number of doses
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍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.0 | International Patient Summary Implementation Guide v2.0
Immunization.occurrence[x]:occurrenceDateTime.​extension:periodOfLife.​value[x] | Base | preferred | Periods of Life | 📦2.0.0-gamma | 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.0 | 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()`

This structure is derived from ImmunizationEuCore

Summary

Maturity: 0

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | ImmunizationEuCore | Immunization event information
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  |  |  | Content/Rules for all slices
extension:administeredProduct | O | 0..1 | (Complex) | Product that was administered URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
Slices for extension |  |  |  | Content/Rules for all slices
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
url |  | 1..1 | uri | "concept"
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "reference"
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.administeredProduct from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource |  | 0..1 | (Complex) | Indicates the source of a reported record URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
Slices for extension |  |  |  | Content/Rules for all slices
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
url |  | 1..1 | uri | "concept"
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "reference"
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.informationSource from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode | O Σ | 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 Bindings | Purpose | Documentation
Vaccines WHO ATC - IPS | candidate | For when WHO ATC code system is preferred
eHDSI Vaccine | candidate | For EU cross-border use
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
patient | O Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized
Obligations | Actor
SHALL:handle | HDRConsumer
SHALL:able-to-populate | HDRCreator
Slices for occurrence[x] | O Σ | 1..1 |  | Date of vaccination Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | Σ | 0..1 | dateTime | Vaccine administration date
Slices for extension |  |  |  | Content/Rules for all slices
extension:periodOfLife |  | 0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
performer:administeringCentreOrHp | O Σ | 0..* | BackboneElement | Administering centre
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
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.0 | 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:concept, Immunization.extension:administeredProduct.extension:reference, Immunization.extension:administeredProduct.extension:_datatype, Immunization.extension:informationSource, Immunization.extension:informationSource.extension:concept, Immunization.extension:informationSource.extension:reference, Immunization.extension:informationSource.extension:_datatype, 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

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | ImmunizationEuCore | Immunization event information
Slices for extension |  |  |  | Content/Rules for all slices
extension:administeredProduct | O | 0..1 | R5 Immunization.administeredProduct | Product that was administered
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
vaccineCode | O | 1..1 | CodeableConcept | Vaccine product administered
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
patient | O | 1..1 | Reference(Patient (EU core)) | Who was immunized
Obligations | Actor
SHALL:handle | HDRConsumer
SHALL:able-to-populate | HDRCreator
occurrence[x] | O | 1..1 | dateTime, string | Date of vaccination
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
Slices for performer |  |  |  | Content/Rules for all slices
performer:administeringCentreOrHp | O | 0..* | BackboneElement | Administering centre
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
protocolApplied |  |  |  |
targetDisease | O | 0..* | CodeableConcept | Vaccine preventatable disease being targetted
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | ImmunizationEuCore | Immunization event information
id | Σ | 0..1 | id | Logical id of this artifact
meta | Σ | 0..1 | Meta | Metadata about the resource
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the immunization content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:administeredProduct | O | 0..1 | (Complex) | Product that was administered URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Closed by value:url Constraints: ext-1
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "concept"
value[x] |  | 0..1 | CodeableConcept | Reference to a concept (by class)
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "reference"
value[x] |  | 0..1 | Reference(Medication (EU core)) | Reference to a resource (by instance)
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.administeredProduct from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct"
extension:informationSource |  | 0..1 | (Complex) | Indicates the source of a reported record URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Closed by value:url Constraints: ext-1
extension:concept |  | 0..1 | Extension | Reference to a concept (by class) Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "concept"
value[x] |  | 0..1 | CodeableConcept | Reference to a concept (by class)
extension:reference |  | 0..1 | Extension | Extension Constraints: ext-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "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)
extension:_datatype |  | 0..1 | (Complex) | Data type name for Immunization.informationSource from FHIR R5 URL: http://hl7.org/fhir/StructureDefinition/_datatype Constraints: ext-1
id |  | 0..1 | id | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url Constraints: ext-1
url |  | 1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype"
value[x] |  | 1..1 | string | Value of extension Fixed Value: CodeableReference
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Identifier of the immunization
status | ?!Σ | 1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | Reason for not performing. Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | O Σ | 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 Bindings | Purpose | Documentation
Vaccines WHO ATC - IPS | candidate | For when WHO ATC code system is preferred
eHDSI Vaccine | candidate | For EU cross-border use
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
patient | O Σ | 1..1 | Reference(Patient (EU core)) | Who was immunized
Obligations | Actor
SHALL:handle | HDRConsumer
SHALL:able-to-populate | HDRCreator
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
Slices for occurrence[x] | O Σ | 1..1 |  | Date of vaccination Slice: Unordered, Closed by type:$this
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
occurrenceDateTime |  |  | dateTime |
occurrenceString |  |  | string |
occurrence[x]:occurrenceDateTime | Σ | 0..1 | dateTime | Vaccine administration date
id |  | 0..1 | string | xml:id (or equivalent in JSON)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:periodOfLife |  | 0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  | Extension Slice: Unordered, Open by value:url
url |  | 1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life"
value[x] |  | 0..1 | CodeableConcept | Value of extension Binding: Periods of Life (preferred)
value |  | 0..1 | dateTime | Primitive value for dateTime
recorded |  | 0..1 | dateTime | When the immunization was first captured in the subject's record
primarySource | Σ | 0..1 | boolean | Indicates context the data was recorded in
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.
location |  | 0..1 | Reference(Location (EU core)) | Where immunization occurred
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | Batch/lot number
expirationDate |  | 0..1 | date | Vaccine expiration date
site |  | 0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered.
route |  | 0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered.
doseQuantity |  | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered
Slices for performer | Σ | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function
performer:All Slices |  |  |  | Content/Rules for all slices
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event.
actor | Σ | 1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing
performer:administeringCentreOrHp | O Σ | 0..* | BackboneElement | Administering centre
Obligations | Actor
SHALL:handle | HDRConsumer
SHOULD:able-to-populate | HDRCreator
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
function | Σ | 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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
actor | Σ | 1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing
note | Σ | 0..* | Annotation | Additional immunization notes
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
author[x] | Σ | 0..1 |  | Individual responsible for the annotation
authorReference |  |  | Reference(Practitioner | Patient | RelatedPerson | Organization) |
authorString |  |  | string |
time | Σ | 0..1 | dateTime | When the annotation was made
text | Σ | 1..1 | markdown | Additional notes about the immunization
reasonCode |  | 0..* | CodeableConcept | Reasons for the administration. Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered.
reasonReference |  | 0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred
isSubpotent | ?!Σ | 0..1 | boolean | Dose potency
subpotentReason |  | 0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent.
education | C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
documentType |  | 0..1 | string | Educational material document identifier
reference |  | 0..1 | uri | Educational material reference pointer
publicationDate |  | 0..1 | dateTime | Educational material publication date
presentationDate |  | 0..1 | dateTime | Educational material presentation date
programEligibility |  | 0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program.
fundingSource |  | 0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered.
reaction |  | 0..* | BackboneElement | Details of a reaction that follows immunization
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
date |  | 0..1 | dateTime | When reaction started
detail |  | 0..1 | Reference(Observation) | Additional information on reaction
reported |  | 0..1 | boolean | Indicates self-reported reaction
protocolApplied |  | 0..* | BackboneElement | Protocol followed by the provider
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
series |  | 0..1 | string | Name of vaccine series
authority |  | 0..1 | Reference(Organization) | Who is responsible for publishing the recommendations
targetDisease | O | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): The diseases against which the patient has been immunised
Additional Bindings | Purpose | Documentation
eHDSI Illness and Disorder | candidate | For when WHO ATC code system is preferred
Obligations | Actor
SHALL:handle | HDRConsumer
MAY:able-to-populate | HDRCreator
doseNumber[x] |  | 1..1 |  | Dose Number
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
seriesDoses[x] |  | 0..1 |  | Number of doses
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
Immunization.language | Base | preferred | Common Languages | 📍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.0 | International Patient Summary Implementation Guide v2.0
Immunization.occurrence[x]:occurrenceDateTime.​extension:periodOfLife.​value[x] | Base | preferred | Periods of Life | 📦2.0.0-gamma | 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.0 | 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()`

This structure is derived from ImmunizationEuCore

Summary

Maturity: 0

Other representations of profile: CSV, Excel, Schematron