HL7 Czech Hospital Discharge Report Implementation Guide
0.0.2 - ci-build

HL7 Czech Hospital Discharge Report Implementation Guide, published by HL7 Czech Republic. This guide is not an authorized publication; it is the continuous build for version 0.0.2 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7-cz/hdr/ and changes regularly. See the Directory of published versions

## Resource Profile: Immunization (HDR CZ)

Official URL: https://hl7.cz/fhir/hdr/StructureDefinition/cz-immunization-hdr | Version: 0.0.2
Draft as of 2025-10-01 | Computable Name: CZ_ImmunizationHdr

This profile constrains the Immunization resource for the purpose of this guide.

This profile constrains the Immunization resource for the purpose of this guide.

Usages:

- Derived from this Profile: Immunization Obligations: HDR CZ
- Refer to this Profile: Composition (HDR CZ)
- Examples for this Profile: Immunization/3f85726c-ad2f-441b-89ce-10000000001e and Immunization/Immunization-CovidExample

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..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS)
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:basedOn |  | 0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(ImmunizationRecommendation (CZ HDR)) | Value of extension
extension:administeredProduct |  | 0..1 | (Complex) | Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct
Slices for extension |  |  |  | Content/Rules for all slices
extension:concept |  | 0..1 | Extension | Extension
extension |  | 0..0 |  |
url |  | 1..1 | uri | "concept"
extension:reference |  | 0..1 | Extension | Extension
extension |  | 0..0 |  |
url |  | 1..1 | uri | "reference"
value[x] |  | 0..1 | Reference(Medication (CZ)) | Value of extension
url |  | 1..1 | uri | "http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode | Σ | 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
patient | Σ | 1..1 | Reference(Patient (CZ core)) | Who was immunized
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date
location |  | 0..1 | Reference(Location) | Location
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | Batch/lot number
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:administeringCentre | Σ | 0..* | BackboneElement | Administering centre
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)(0.1.0-ci-build)) | Individual or organization who was performing
performer:administeringHp | Σ | 0..* | BackboneElement | Administering Health Professional
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(PractitionerRole (EU core)(0.1.0-ci-build) | Practitioner (EU core)(0.1.0-ci-build)) | 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 | 📦1.1.0 | International Patient Summary Implementation Guide v1.1
Immunization.performer:administeringCentre.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.performer:administeringHp.​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 | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

This structure is derived from Immunization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:basedOn |  | 0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
value[x] |  | 1..1 | Reference(ImmunizationRecommendation (CZ HDR)) | Value of extension
extension:administeredProduct |  | 0..1 | (Complex) | Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct
Slices for extension |  |  |  | Content/Rules for all slices
extension:reference |  | 0..1 | Extension | Extension
value[x] |  | 0..1 | Reference(Medication (CZ)) | Value of extension
vaccineCode |  | 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
patient |  | 1..1 | Reference(Patient (CZ core)) | Who was immunized
occurrence[x] |  | 1..1 | dateTime | Vaccine administration date
location |  | 0..1 | Reference(Location) | Location
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | Batch/lot number
Slices for performer |  | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function
performer:administeringCentre |  | 0..* | BackboneElement | Administering centre
function |  | 0..1 | CodeableConcept | What type of performance was done Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
actor |  | 1..1 | Reference(Organization (EU core)(0.1.0-ci-build)) | Individual or organization who was performing
performer:administeringHp |  | 0..* | BackboneElement | Administering Health Professional
function |  | 0..1 | CodeableConcept | What type of performance was done Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
actor |  | 1..1 | Reference(PractitionerRole (EU core)(0.1.0-ci-build) | Practitioner (EU core)(0.1.0-ci-build)) | Individual or organization who was performing
protocolApplied |  |  |  |
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Condition Value Set (preferred)
Slices for doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | Dose Number
Slices for seriesDoses[x] |  | 0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDoses[x]:seriesDosesPositiveInt |  | 0..1 | positiveInt | Number of doses
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦1.1.0 | International Patient Summary Implementation Guide v1.1
Immunization.protocolApplied.​targetDisease | Base | preferred | Condition Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS)
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 resource 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:basedOn |  | 0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(ImmunizationRecommendation (CZ HDR)) | Value of extension
extension:administeredProduct |  | 0..1 | (Complex) | Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:concept |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "concept"
value[x] |  | 0..1 | CodeableConcept | Value of extension
extension:reference |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "reference"
value[x] |  | 0..1 | Reference(Medication (CZ)) | Value of extension
url |  | 1..1 | uri | "http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | Σ | 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
patient | Σ | 1..1 | Reference(Patient (CZ core)) | Who was immunized
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date
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) | Location
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:administeringCentre | Σ | 0..* | BackboneElement | Administering centre
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)(0.1.0-ci-build)) | Individual or organization who was performing
performer:administeringHp | Σ | 0..* | BackboneElement | Administering Health Professional
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(PractitionerRole (EU core)(0.1.0-ci-build) | Practitioner (EU core)(0.1.0-ci-build)) | Individual or organization who was performing
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred 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 |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Condition Value Set (preferred)
Slices for doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | Dose Number
Slices for seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
seriesDoses[x]:seriesDosesPositiveInt |  | 0..1 | positiveInt | Number of doses
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 | 📦1.1.0 | International Patient Summary Implementation Guide v1.1
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:administeringCentre.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.performer:administeringHp.​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 | Condition Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1

#### 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 Immunization

Summary

Structures

This structure refers to these other structures:

- ImmunizationRecommendation (CZ HDR) (https://hl7.cz/fhir/hdr/StructureDefinition/cz-immunizationRecommendation-hdr)
- Medication (CZ) (https://hl7.cz/fhir/core/StructureDefinition/cz-Medication)
- Patient (CZ core) (https://hl7.cz/fhir/core/StructureDefinition/cz-patient-core)
- Organization (EU core) (http://hl7.eu/fhir/base/StructureDefinition/organization-eu-core|0.1.0-ci-build)
- PractitionerRole (EU core) (http://hl7.eu/fhir/base/StructureDefinition/practitionerRole-eu-core|0.1.0-ci-build)
- Practitioner (EU core) (http://hl7.eu/fhir/base/StructureDefinition/practitioner-eu-core|0.1.0-ci-build)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
- http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.performer
- The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]
- The element 1 is sliced based on the value of Immunization.protocolApplied.seriesDoses[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS)
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:basedOn |  | 0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(ImmunizationRecommendation (CZ HDR)) | Value of extension
extension:administeredProduct |  | 0..1 | (Complex) | Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct
Slices for extension |  |  |  | Content/Rules for all slices
extension:concept |  | 0..1 | Extension | Extension
extension |  | 0..0 |  |
url |  | 1..1 | uri | "concept"
extension:reference |  | 0..1 | Extension | Extension
extension |  | 0..0 |  |
url |  | 1..1 | uri | "reference"
value[x] |  | 0..1 | Reference(Medication (CZ)) | Value of extension
url |  | 1..1 | uri | "http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
vaccineCode | Σ | 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
patient | Σ | 1..1 | Reference(Patient (CZ core)) | Who was immunized
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date
location |  | 0..1 | Reference(Location) | Location
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | Batch/lot number
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:administeringCentre | Σ | 0..* | BackboneElement | Administering centre
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)(0.1.0-ci-build)) | Individual or organization who was performing
performer:administeringHp | Σ | 0..* | BackboneElement | Administering Health Professional
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(PractitionerRole (EU core)(0.1.0-ci-build) | Practitioner (EU core)(0.1.0-ci-build)) | 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 | 📦1.1.0 | International Patient Summary Implementation Guide v1.1
Immunization.performer:administeringCentre.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.performer:administeringHp.​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 | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`

Differential View

This structure is derived from Immunization

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS)
Slices for extension |  | 0..* | Extension | Extension Slice: Unordered, Open by value:url
extension:basedOn |  | 0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
value[x] |  | 1..1 | Reference(ImmunizationRecommendation (CZ HDR)) | Value of extension
extension:administeredProduct |  | 0..1 | (Complex) | Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct
Slices for extension |  |  |  | Content/Rules for all slices
extension:reference |  | 0..1 | Extension | Extension
value[x] |  | 0..1 | Reference(Medication (CZ)) | Value of extension
vaccineCode |  | 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
patient |  | 1..1 | Reference(Patient (CZ core)) | Who was immunized
occurrence[x] |  | 1..1 | dateTime | Vaccine administration date
location |  | 0..1 | Reference(Location) | Location
manufacturer |  | 0..1 | Reference(Organization) | Vaccine manufacturer/MAH
lotNumber |  | 0..1 | string | Batch/lot number
Slices for performer |  | 0..* | BackboneElement | Who performed event Slice: Unordered, Open by value:$this.function
performer:administeringCentre |  | 0..* | BackboneElement | Administering centre
function |  | 0..1 | CodeableConcept | What type of performance was done Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
actor |  | 1..1 | Reference(Organization (EU core)(0.1.0-ci-build)) | Individual or organization who was performing
performer:administeringHp |  | 0..* | BackboneElement | Administering Health Professional
function |  | 0..1 | CodeableConcept | What type of performance was done Required Pattern: At least the following
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0443
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: AP
actor |  | 1..1 | Reference(PractitionerRole (EU core)(0.1.0-ci-build) | Practitioner (EU core)(0.1.0-ci-build)) | Individual or organization who was performing
protocolApplied |  |  |  |
targetDisease |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Condition Value Set (preferred)
Slices for doseNumber[x] |  | 1..1 | positiveInt, string | Dose number within series Slice: Unordered, Open by type:$this
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | Dose Number
Slices for seriesDoses[x] |  | 0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDoses[x]:seriesDosesPositiveInt |  | 0..1 | positiveInt | Number of doses
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
Immunization.vaccineCode | Base | preferred | Vaccines - IPS | 📦1.1.0 | International Patient Summary Implementation Guide v1.1
Immunization.protocolApplied.​targetDisease | Base | preferred | Condition Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
Immunization |  | 0..* | Immunization | Immunization event information This profile also imposes the profile Immunization (IPS)
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 resource 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:basedOn |  | 0..1 | (Complex) | Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn"
value[x] |  | 1..1 | Reference(ImmunizationRecommendation (CZ HDR)) | Value of extension
extension:administeredProduct |  | 0..1 | (Complex) | Immunization AdministeredProduct URL: http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:concept |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "concept"
value[x] |  | 0..1 | CodeableConcept | Value of extension
extension:reference |  | 0..1 | Extension | Extension
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..0 |  |
url |  | 1..1 | uri | "reference"
value[x] |  | 0..1 | Reference(Medication (CZ)) | Value of extension
url |  | 1..1 | uri | "http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct"
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored
identifier |  | 0..* | Identifier | Business identifier
status | ?!Σ | 1..1 | code | completed | entered-in-error | not-done Binding: ImmunizationStatusCodes (required): A set of codes indicating the current status of an Immunization.
statusReason |  | 0..1 | CodeableConcept | Reason not done Binding: ImmunizationStatusReasonCodes (example): The reason why a vaccine was not administered.
vaccineCode | Σ | 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
patient | Σ | 1..1 | Reference(Patient (CZ core)) | Who was immunized
encounter |  | 0..1 | Reference(Encounter) | Encounter immunization was part of
occurrence[x] | Σ | 1..1 | dateTime | Vaccine administration date
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) | Location
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:administeringCentre | Σ | 0..* | BackboneElement | Administering centre
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)(0.1.0-ci-build)) | Individual or organization who was performing
performer:administeringHp | Σ | 0..* | BackboneElement | Administering Health Professional
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(PractitionerRole (EU core)(0.1.0-ci-build) | Practitioner (EU core)(0.1.0-ci-build)) | Individual or organization who was performing
note | Σ | 0..* | Annotation | Additional immunization notes
reasonCode |  | 0..* | CodeableConcept | Why immunization occurred 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 |  | 0..* | CodeableConcept | Vaccine preventatable disease being targetted Binding: Condition Value Set (preferred)
Slices for doseNumber[x] |  | 1..1 |  | Dose number within series Slice: Unordered, Open by type:$this
doseNumberPositiveInt |  |  | positiveInt |
doseNumberString |  |  | string |
doseNumber[x]:doseNumberPositiveInt |  | 0..1 | positiveInt | Dose Number
Slices for seriesDoses[x] |  | 0..1 |  | Recommended number of doses for immunity Slice: Unordered, Open by type:$this
seriesDosesPositiveInt |  |  | positiveInt |
seriesDosesString |  |  | string |
seriesDoses[x]:seriesDosesPositiveInt |  | 0..1 | positiveInt | Number of doses
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 | 📦1.1.0 | International Patient Summary Implementation Guide v1.1
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:administeringCentre.​function | Base | extensible | Immunization Function Codes | 📍4.0.1 | FHIR Std.
Immunization.performer:administeringHp.​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 | Condition Value Set | 📦0.1.0-ballot | HL7 Europe Hospital Discharge Report v0.1

#### 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 Immunization

Summary

Structures

This structure refers to these other structures:

- ImmunizationRecommendation (CZ HDR) (https://hl7.cz/fhir/hdr/StructureDefinition/cz-immunizationRecommendation-hdr)
- Medication (CZ) (https://hl7.cz/fhir/core/StructureDefinition/cz-Medication)
- Patient (CZ core) (https://hl7.cz/fhir/core/StructureDefinition/cz-patient-core)
- Organization (EU core) (http://hl7.eu/fhir/base/StructureDefinition/organization-eu-core|0.1.0-ci-build)
- PractitionerRole (EU core) (http://hl7.eu/fhir/base/StructureDefinition/practitionerRole-eu-core|0.1.0-ci-build)
- Practitioner (EU core) (http://hl7.eu/fhir/base/StructureDefinition/practitioner-eu-core|0.1.0-ci-build)

Extensions

This structure refers to these extensions:

- http://hl7.org/fhir/5.0/StructureDefinition/extension-Immunization.basedOn
- http://hl7.eu/fhir/hdr/StructureDefinition/immunization-administeredProduct

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of Immunization.performer
- The element 1 is sliced based on the value of Immunization.protocolApplied.doseNumber[x]
- The element 1 is sliced based on the value of Immunization.protocolApplied.seriesDoses[x]

Other representations of profile: CSV, Excel, Schematron