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
| 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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImmunizationEuCore | Immunization event information | ||||||||||||||||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | (Complex) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct" | ||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource" | ||||||||||||||||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() |
1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||||||||||||||
![]() ![]() |
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.
| ||||||||||||||||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who was immunized
| ||||||||||||||||||
![]() ![]() |
1..1 | Date of vaccination Slice: Unordered, Closed by type:$this
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 | |||||||||||||||||||
![]() ![]() ![]() |
dateTime | ||||||||||||||||||||
![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Vaccine administration date | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life" | ||||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function | ||||||||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Administering centre
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() |
0..1 | boolean | Dose potency | ||||||||||||||||||
Documentation for this format | |||||||||||||||||||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImmunizationEuCore | Immunization event information | ||||||||||||||||||
![]() ![]() |
0..1 | id | Logical id of this artifact | ||||||||||||||||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | ||||||||||||||||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
![]() ![]() |
0..1 | code | Language of the immunization content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||
![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | (Complex) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Medication (EU core)) | Reference to a resource (by instance) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct" | ||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) Binding: ImmunizationOriginCodes (preferred) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core)) | Reference to a resource (by instance) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource" | ||||||||||||||||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() |
0..* | Identifier | Identifier of the immunization | ||||||||||||||||||
![]() ![]() |
1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Reason for not performing. Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | ||||||||||||||||||
![]() ![]() |
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.
| ||||||||||||||||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who was immunized
| ||||||||||||||||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | ||||||||||||||||||
![]() ![]() |
1..1 | Date of vaccination Slice: Unordered, Closed by type:$this
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 | |||||||||||||||||||
![]() ![]() ![]() |
dateTime | ||||||||||||||||||||
![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Vaccine administration date | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Periods of Life (preferred) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | ||||||||||||||||||
![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | ||||||||||||||||||
![]() ![]() |
0..1 | boolean | Indicates context the data was recorded in | ||||||||||||||||||
![]() ![]() |
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. | ||||||||||||||||||
![]() ![]() |
0..1 | Reference(Location (EU core)) | Where immunization occurred | ||||||||||||||||||
![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer/MAH | ||||||||||||||||||
![]() ![]() |
0..1 | string | Batch/lot number | ||||||||||||||||||
![]() ![]() |
0..1 | date | Vaccine expiration date | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | ||||||||||||||||||
![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 | |||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function | ||||||||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Administering centre
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() |
0..* | Annotation | Additional immunization notes | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | Individual responsible for the annotation | |||||||||||||||||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When the annotation was made | ||||||||||||||||||
![]() ![]() ![]() |
1..1 | markdown | Additional notes about the immunization | ||||||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Reasons for the administration. Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | ||||||||||||||||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||||||||||||||||||
![]() ![]() |
0..1 | boolean | Dose potency | ||||||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | ||||||||||||||||||
![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | |||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Educational material document identifier | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | ||||||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | ||||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When reaction started | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | ||||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): The diseases against which the patient has been immunised
| ||||||||||||||||||
![]() ![]() ![]() |
1..1 | Dose Number | |||||||||||||||||||
![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Number of doses | |||||||||||||||||||
![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||
Documentation for this format | |||||||||||||||||||||
| 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 |
| 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
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImmunizationEuCore | Immunization event information | ||||||||||||||||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | (Complex) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct" | ||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource" | ||||||||||||||||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() |
1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||||||||||||||
![]() ![]() |
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.
| ||||||||||||||||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who was immunized
| ||||||||||||||||||
![]() ![]() |
1..1 | Date of vaccination Slice: Unordered, Closed by type:$this
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 | |||||||||||||||||||
![]() ![]() ![]() |
dateTime | ||||||||||||||||||||
![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Vaccine administration date | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life" | ||||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function | ||||||||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Administering centre
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() |
0..1 | boolean | Dose potency | ||||||||||||||||||
Documentation for this format | |||||||||||||||||||||
| 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. |
| 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
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
ImmunizationEuCore | |||||||||||
![]() ![]() |
Content/Rules for all slices | |||||||||||
![]() ![]() ![]() |
0..1 | R5 Immunization.administeredProduct | R5: Product that was administered (new)
| |||||||||
![]() ![]() |
1..1 | CodeableConcept | Vaccine product administered
| |||||||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who was immunized
| |||||||||
![]() ![]() |
1..1 | dateTime, string | Date of vaccination
| |||||||||
![]() ![]() |
Content/Rules for all slices | |||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Administering centre
| |||||||||
![]() ![]() |
||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted
| |||||||||
Documentation for this format | ||||||||||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() | |||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
![]() |
0..* | ImmunizationEuCore | Immunization event information | ||||||||||||||||||
![]() ![]() |
0..1 | id | Logical id of this artifact | ||||||||||||||||||
![]() ![]() |
0..1 | Meta | Metadata about the resource | ||||||||||||||||||
![]() ![]() |
0..1 | uri | A set of rules under which this content was created | ||||||||||||||||||
![]() ![]() |
0..1 | code | Language of the immunization content Binding: CommonLanguages (preferred): A human language.
| ||||||||||||||||||
![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | ||||||||||||||||||
![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | (Complex) | R5: Product that was administered (new) URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct Constraints: ext-1
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Medication (EU core)) | Reference to a resource (by instance) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.administeredProduct" | ||||||||||||||||||
![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..* | Extension | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..1 | Extension | DataType slice for a FHIR R5 `CodeableReference` value Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/_datatype" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | string | Value of extension Fixed Value: CodeableReference | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | R5: Reference to a concept (by class) Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "concept" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Reference to a concept (by class) Binding: ImmunizationOriginCodes (preferred) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Extension | Extension Constraints: ext-1 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url Constraints: ext-1 | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "reference" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | Reference(Patient (EU core) | Practitioner (EU core) | PractitionerRole (EU core) | RelatedPerson | Organization (EU core)) | Reference to a resource (by instance) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.informationSource" | ||||||||||||||||||
![]() ![]() |
0..* | Extension | Extensions that cannot be ignored | ||||||||||||||||||
![]() ![]() |
0..* | Identifier | Identifier of the immunization | ||||||||||||||||||
![]() ![]() |
1..1 | code | Immunization status. Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization. | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Reason for not performing. Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered. | ||||||||||||||||||
![]() ![]() |
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.
| ||||||||||||||||||
![]() ![]() |
1..1 | Reference(Patient (EU core)) | Who was immunized
| ||||||||||||||||||
![]() ![]() |
0..1 | Reference(Encounter) | Encounter immunization was part of | ||||||||||||||||||
![]() ![]() |
1..1 | Date of vaccination Slice: Unordered, Closed by type:$this
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 | |||||||||||||||||||
![]() ![]() ![]() |
dateTime | ||||||||||||||||||||
![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Vaccine administration date | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | xml:id (or equivalent in JSON) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extension Slice: Unordered, Open by value:url | ||||||||||||||||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | (Complex) | Many: Periods of Life URL: http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..0 | Extension Slice: Unordered, Open by value:url | |||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | "http://hl7.eu/fhir/extensions/StructureDefinition/periods-of-life" | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Value of extension Binding: Periods of Life (preferred) | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | dateTime | Primitive value for dateTime | ||||||||||||||||||
![]() ![]() |
0..1 | dateTime | When the immunization was first captured in the subject's record | ||||||||||||||||||
![]() ![]() |
0..1 | boolean | Indicates context the data was recorded in | ||||||||||||||||||
![]() ![]() |
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. | ||||||||||||||||||
![]() ![]() |
0..1 | Reference(Location (EU core)) | Where immunization occurred | ||||||||||||||||||
![]() ![]() |
0..1 | Reference(Organization) | Vaccine manufacturer/MAH | ||||||||||||||||||
![]() ![]() |
0..1 | string | Batch/lot number | ||||||||||||||||||
![]() ![]() |
0..1 | date | Vaccine expiration date | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Body site vaccine was administered Binding: CodesForImmunizationSiteOfAdministration (example): The site at which the vaccine was administered. | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | How vaccine entered body Binding: ImmunizationRouteCodes (example): The route by which the vaccine was administered. | ||||||||||||||||||
![]() ![]() |
C | 0..1 | SimpleQuantity(4.0.1) | Amount of vaccine administered Constraints: sqty-1 | |||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function | ||||||||||||||||||
![]() ![]() ![]() |
Content/Rules for all slices | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | What type of performance was done Binding: ImmunizationFunctionCodes (extensible): The role a practitioner or organization plays in the immunization event. | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Practitioner | PractitionerRole | Organization) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | BackboneElement | Administering centre
| ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() ![]() |
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 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443 | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: AP | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | ||||||||||||||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | ||||||||||||||||||
![]() ![]() ![]() ![]() |
1..1 | Reference(Organization (EU core) | PractitionerRole (EU core) | Practitioner (EU core)) | Individual or organization who was performing | ||||||||||||||||||
![]() ![]() |
0..* | Annotation | Additional immunization notes | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | Individual responsible for the annotation | |||||||||||||||||||
![]() ![]() ![]() ![]() |
Reference(Practitioner | Patient | RelatedPerson | Organization) | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When the annotation was made | ||||||||||||||||||
![]() ![]() ![]() |
1..1 | markdown | Additional notes about the immunization | ||||||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Reasons for the administration. Binding: ImmunizationReasonCodes (example): The reason why a vaccine was administered. | ||||||||||||||||||
![]() ![]() |
0..* | Reference(Condition | Observation | DiagnosticReport) | Why immunization occurred | ||||||||||||||||||
![]() ![]() |
0..1 | boolean | Dose potency | ||||||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Reason for being subpotent Binding: ImmunizationSubpotentReason (example): The reason why a dose is considered to be subpotent. | ||||||||||||||||||
![]() ![]() |
C | 0..* | BackboneElement | Educational material presented to patient Constraints: imm-1 | |||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Educational material document identifier | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | uri | Educational material reference pointer | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material publication date | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | Educational material presentation date | ||||||||||||||||||
![]() ![]() |
0..* | CodeableConcept | Patient eligibility for a vaccination program Binding: ImmunizationProgramEligibility (example): The patient's eligibility for a vaccation program. | ||||||||||||||||||
![]() ![]() |
0..1 | CodeableConcept | Funding source for the vaccine Binding: ImmunizationFundingSource (example): The source of funding used to purchase the vaccine administered. | ||||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Details of a reaction that follows immunization | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | dateTime | When reaction started | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Observation) | Additional information on reaction | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | boolean | Indicates self-reported reaction | ||||||||||||||||||
![]() ![]() |
0..* | BackboneElement | Protocol followed by the provider | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | string | Name of vaccine series | ||||||||||||||||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for publishing the recommendations | ||||||||||||||||||
![]() ![]() ![]() |
0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Vaccine Target Diseases - IPS (preferred): The diseases against which the patient has been immunised
| ||||||||||||||||||
![]() ![]() ![]() |
1..1 | Dose Number | |||||||||||||||||||
![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||
![]() ![]() ![]() |
0..1 | Number of doses | |||||||||||||||||||
![]() ![]() ![]() ![]() |
positiveInt | ||||||||||||||||||||
![]() ![]() ![]() ![]() |
string | ||||||||||||||||||||
Documentation for this format | |||||||||||||||||||||
| 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 |
| 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
Other representations of profile: CSV, Excel, Schematron