XpanDH Patient Summary
0.1.0 - ci-build 150

XpanDH Patient Summary, published by XpanDH Project. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-eu/xpandh-ps/ and changes regularly. See the Directory of published versions

Resource Profile: Immunization (EU PS)

Official URL: http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/Immunization-ps-xpandh Version: 0.1.0
Draft as of 2025-10-10 Computable Name: ImmunizationPsXpandh

Copyright/Legal: Used by permission of the XpanDH project, all rights reserved Creative Commons License

This profile constrains the Immunization resource for the purpose of the European patient summary.

This profile constrains the Immunization resource for the purpose of the European patient summary.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationUvIps Immunization event information
... 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 (EU PS)) Value of extension
.... extension:administeredProduct 0..1 (Complex) Immunization AdministeredProduct
URL: http://hl7.eu/fhir/ig/xpandh/ps/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 (EU PS)) Value of extension
..... url 1..1 uri "http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/immunization-administeredProduct"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode S 1..1 CodeableConceptIPS Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccine (preferred)
Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free Set candidate
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPS candidate
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPS candidate
"known absent" and "not known", for use with other value sets
.... coding S 0..* CodingIPS A reference to a code defined by a terminology system
.... text SΣ 0..1 string Name of the vaccine
... patient SΣ 1..1 Reference(Patient (EU PS)) Who was immunized
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... occurrence[x] SΣ 1..1 dateTime Vaccine administration date
.... Slices for extension Content/Rules for all slices
..... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... location 0..1 Reference(Location (EU PS)) Where immunization occurred
... 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) 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 PS) | Practitioner (EU PS)) Individual or organization who was performing
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
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 ImmunizationUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization ImmunizationUvIps
... 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 (EU PS)) Value of extension
.... extension:administeredProduct 0..1 (Complex) Immunization AdministeredProduct
URL: http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/immunization-administeredProduct
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... value[x] 0..1 Reference(Medication (EU PS)) Value of extension
... vaccineCode 1..1 CodeableConceptIPS Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccine (preferred)
.... text 0..1 string Name of the vaccine
... patient 1..1 Reference(Patient (EU PS)) Who was immunized
... location 0..1 Reference(Location (EU PS)) Where immunization occurred
... 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) 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 PS) | Practitioner (EU PS)) Individual or organization who was performing
... protocolApplied
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: Illness and Disorder (PARTIAL) (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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
Immunization.protocolApplied.​targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationUvIps Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
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 (EU PS)) Value of extension
.... extension:administeredProduct 0..1 (Complex) Immunization AdministeredProduct
URL: http://hl7.eu/fhir/ig/xpandh/ps/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 (EU PS)) Value of extension
..... url 1..1 uri "http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/immunization-administeredProduct"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 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 S 1..1 CodeableConceptIPS Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccine (preferred)
Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free Set candidate
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPS candidate
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPS candidate
"known absent" and "not known", for use with other value sets
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding S 0..* CodingIPS A reference to a code defined by a terminology system
.... text SΣ 0..1 string Name of the vaccine
... patient SΣ 1..1 Reference(Patient (EU PS)) Who was immunized
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 dateTime Vaccine administration date
.... 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:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location (EU PS)) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer/MAH
... lotNumber 0..1 string Batch/lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1 SimpleQuantity 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) 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 PS) | Practitioner (EU PS)) 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 preventable disease being targeted
Binding: Illness and Disorder (PARTIAL) (preferred)
Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free Set candidate

.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Immunization.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 Vaccine 📦0.1.0 This IG
Immunization.patient.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.site Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Immunization.route Base preferred Medicine Route of Administration - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
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 Illness and Disorder (PARTIAL) 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationUvIps Immunization event information
... 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 (EU PS)) Value of extension
.... extension:administeredProduct 0..1 (Complex) Immunization AdministeredProduct
URL: http://hl7.eu/fhir/ig/xpandh/ps/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 (EU PS)) Value of extension
..... url 1..1 uri "http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/immunization-administeredProduct"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... vaccineCode S 1..1 CodeableConceptIPS Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccine (preferred)
Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free Set candidate
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPS candidate
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPS candidate
"known absent" and "not known", for use with other value sets
.... coding S 0..* CodingIPS A reference to a code defined by a terminology system
.... text SΣ 0..1 string Name of the vaccine
... patient SΣ 1..1 Reference(Patient (EU PS)) Who was immunized
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
... occurrence[x] SΣ 1..1 dateTime Vaccine administration date
.... Slices for extension Content/Rules for all slices
..... extension:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... location 0..1 Reference(Location (EU PS)) Where immunization occurred
... 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) 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 PS) | Practitioner (EU PS)) Individual or organization who was performing
... isSubpotent ?!Σ 0..1 boolean Dose potency

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.status Base required Immunization Status Codes 📍4.0.1 FHIR Std.
Immunization.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
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 ImmunizationUvIps

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization ImmunizationUvIps
... 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 (EU PS)) Value of extension
.... extension:administeredProduct 0..1 (Complex) Immunization AdministeredProduct
URL: http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/immunization-administeredProduct
..... Slices for extension Content/Rules for all slices
...... extension:reference 0..1 Extension Extension
....... value[x] 0..1 Reference(Medication (EU PS)) Value of extension
... vaccineCode 1..1 CodeableConceptIPS Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccine (preferred)
.... text 0..1 string Name of the vaccine
... patient 1..1 Reference(Patient (EU PS)) Who was immunized
... location 0..1 Reference(Location (EU PS)) Where immunization occurred
... 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) 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 PS) | Practitioner (EU PS)) Individual or organization who was performing
... protocolApplied
.... targetDisease 0..* CodeableConcept Vaccine preventable disease being targeted
Binding: Illness and Disorder (PARTIAL) (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

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
Immunization.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
Immunization.protocolApplied.​targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Immunization 0..* ImmunizationUvIps Immunization event information
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
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 (EU PS)) Value of extension
.... extension:administeredProduct 0..1 (Complex) Immunization AdministeredProduct
URL: http://hl7.eu/fhir/ig/xpandh/ps/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 (EU PS)) Value of extension
..... url 1..1 uri "http://hl7.eu/fhir/ig/xpandh/ps/StructureDefinition/immunization-administeredProduct"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business identifier
... status ?!SΣ 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 S 1..1 CodeableConceptIPS Vaccine that was administered or was to be administered.Several kinds of vaccine product coding could be provided. The IPS assumes that either the type of the vaccine for particular disease or diseases (e.g. MMR vaccine) against which the patient has been immunised is provided; or the known absent / unknown code. Other coded information can be provided as well as: the IDMP Pharmaceutical Product Identifiers (PhPID), Medicinal Product Identifier (MPID), Packaged Medicinal Product Identifier (PCID), when available, or equivalent coded concepts; the WHO ATC codes; or any other kind of code that that identifies, classifies or cluster the administered product.
Binding: Vaccine (preferred)
Additional BindingsPurposeDocumentation
Vaccines - SNOMED CT IPS Free Set candidate
For when codes from the SNOMED CT IPS free set are preferred
Vaccines WHO ATC - IPS candidate
For when WHO ATC code system is preferred
Absent or Unknown Immunization - IPS candidate
"known absent" and "not known", for use with other value sets
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding S 0..* CodingIPS A reference to a code defined by a terminology system
.... text SΣ 0..1 string Name of the vaccine
... patient SΣ 1..1 Reference(Patient (EU PS)) Who was immunized
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... reference SΣC 1..1 string Literal reference, Relative, internal or absolute URL
.... type Σ 0..1 uri Type the reference refers to (e.g. "Patient")
Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
.... identifier Σ 0..1 Identifier Logical reference, when literal reference is not known
.... display Σ 0..1 string Text alternative for the resource
... encounter 0..1 Reference(Encounter) Encounter immunization was part of
... occurrence[x] SΣ 1..1 dateTime Vaccine administration date
.... 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:data-absent-reason S 0..1 code occurrence[x] absence reason
URL: http://hl7.org/fhir/StructureDefinition/data-absent-reason
Binding: DataAbsentReason (required)
... recorded 0..1 dateTime When the immunization was first captured in the subject's record
... primarySource Σ 0..1 boolean Indicates context the data was recorded in
... reportOrigin 0..1 CodeableConcept Indicates the source of a secondarily reported record
Binding: ImmunizationOriginCodes (example): The source of the data for a record which is not from a primary source.
... location 0..1 Reference(Location (EU PS)) Where immunization occurred
... manufacturer 0..1 Reference(Organization) Vaccine manufacturer/MAH
... lotNumber 0..1 string Batch/lot number
... expirationDate 0..1 date Vaccine expiration date
... site 0..1 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: SNOMEDCTBodyStructures (preferred)
... route 0..1 CodeableConceptIPS Concept - reference to a terminology or just text
Binding: Medicine Route of Administration - IPS (preferred)
... doseQuantity 0..1 SimpleQuantity 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) 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 PS) | Practitioner (EU PS)) 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 preventable disease being targeted
Binding: Illness and Disorder (PARTIAL) (preferred)
Additional BindingsPurpose
Vaccine Target Diseases - SNOMED CT IPS Free Set candidate

.... 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

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
Immunization.language Base preferred Common Languages 📦4.0.1 FHIR Std.
Immunization.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 Vaccine 📦0.1.0 This IG
Immunization.patient.​type Base extensible ResourceType 📦4.0.1 FHIR Std.
Immunization.reportOrigin Base example Immunization Origin Codes 📦4.0.1 FHIR Std.
Immunization.site Base preferred SNOMED CT Body Structures 📦4.0.1 FHIR Std.
Immunization.route Base preferred Medicine Route of Administration - IPS 📦1.1.0 International Patient Summary Implementation Guide v1.1
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 Illness and Disorder (PARTIAL) 📦0.1.0 This IG

Constraints

Id Grade Path(s) Description Expression
dom-2 error Immunization If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error Immunization If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error Immunization If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error Immunization If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice Immunization A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()
imm-1 error Immunization.education One of documentType or reference SHALL be present documentType.exists() or reference.exists()

 

Other representations of profile: CSV, Excel, Schematron