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: ImmunizationRecommendation (EU PS)

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

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

This profile defines how to represent Immunization Recommandations 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
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(Patient) Who this profile is for
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 0..* CodeableConcept Generic description of the vaccine/prophylaxis or its component(s)
Binding: Vaccine (preferred)
.... targetDisease Σ 0..1 CodeableConcept Disease or agent that the vaccination provides protection against
Binding: Illness and Disorder (PARTIAL) (preferred)
.... forecastStatus ?!Σ 1..1 CodeableConcept Recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
.... Slices for dateCriterion 0..* BackboneElement Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
...... value 1..1 dateTime Recommended date
..... dateCriterion:nextDose 0..1 BackboneElement Dates governing proposed immunization
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
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://loinc.org
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
........ 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
...... value 1..1 dateTime Recommended date
.... Slices for doseNumber[x] Σ 0..1 Recommended 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
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion:nextDose.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 ImmunizationRecommendation 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 ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation 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()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... patient S 1..1 Reference(Patient) Who this profile is for
... date S 1..1 dateTime Date recommendation(s) created
... recommendation
.... vaccineCode 0..* CodeableConcept Generic description of the vaccine/prophylaxis or its component(s)
Binding: Vaccine (preferred)
.... targetDisease 0..1 CodeableConcept Disease or agent that the vaccination provides protection against
Binding: Illness and Disorder (PARTIAL) (preferred)
.... forecastStatus 1..1 CodeableConcept Recommendation status
.... Slices for dateCriterion 0..* BackboneElement Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion:nextDose 0..1 BackboneElement Dates governing proposed immunization
...... code 1..1 CodeableConcept Type of date
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://loinc.org
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
.... Slices for doseNumber[x] 0..1 positiveInt, string Recommended 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
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... 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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(Patient) Who this profile is for
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Organization) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-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
.... vaccineCode Σ 0..* CodeableConcept Generic description of the vaccine/prophylaxis or its component(s)
Binding: Vaccine (preferred)
.... targetDisease Σ 0..1 CodeableConcept Disease or agent that the vaccination provides protection against
Binding: Illness and Disorder (PARTIAL) (preferred)
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... forecastStatus ?!Σ 1..1 CodeableConcept Recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
.... Slices for dateCriterion 0..* BackboneElement Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion: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
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
...... value 1..1 dateTime Recommended date
..... dateCriterion:nextDose 0..1 BackboneElement Dates governing proposed 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
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
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://loinc.org
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
........ 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
...... value 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... Slices for doseNumber[x] Σ 0..1 Recommended 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
.... supportingImmunization 0..* Reference(Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion:nextDose.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 ImmunizationRecommendation 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 ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation 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()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.dateCriterion
  • The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.doseNumber[x]
  • The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.seriesDoses[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... patient SΣ 1..1 Reference(Patient) Who this profile is for
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... vaccineCode Σ 0..* CodeableConcept Generic description of the vaccine/prophylaxis or its component(s)
Binding: Vaccine (preferred)
.... targetDisease Σ 0..1 CodeableConcept Disease or agent that the vaccination provides protection against
Binding: Illness and Disorder (PARTIAL) (preferred)
.... forecastStatus ?!Σ 1..1 CodeableConcept Recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
.... Slices for dateCriterion 0..* BackboneElement Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion:All Slices Content/Rules for all slices
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
...... value 1..1 dateTime Recommended date
..... dateCriterion:nextDose 0..1 BackboneElement Dates governing proposed immunization
...... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
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://loinc.org
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
........ 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
...... value 1..1 dateTime Recommended date
.... Slices for doseNumber[x] Σ 0..1 Recommended 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
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion:nextDose.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 ImmunizationRecommendation 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 ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation 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()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()

Differential View

This structure is derived from ImmunizationRecommendation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... patient S 1..1 Reference(Patient) Who this profile is for
... date S 1..1 dateTime Date recommendation(s) created
... recommendation
.... vaccineCode 0..* CodeableConcept Generic description of the vaccine/prophylaxis or its component(s)
Binding: Vaccine (preferred)
.... targetDisease 0..1 CodeableConcept Disease or agent that the vaccination provides protection against
Binding: Illness and Disorder (PARTIAL) (preferred)
.... forecastStatus 1..1 CodeableConcept Recommendation status
.... Slices for dateCriterion 0..* BackboneElement Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion:nextDose 0..1 BackboneElement Dates governing proposed immunization
...... code 1..1 CodeableConcept Type of date
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://loinc.org
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
.... Slices for doseNumber[x] 0..1 positiveInt, string Recommended 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
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ImmunizationRecommendation 0..* ImmunizationRecommendation Guidance or advice relating to an immunization
... 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
... 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
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier Σ 0..* Identifier Business identifier
... patient SΣ 1..1 Reference(Patient) Who this profile is for
... date SΣ 1..1 dateTime Date recommendation(s) created
... authority 0..1 Reference(Organization) Who is responsible for protocol
... recommendation ΣC 1..* BackboneElement Vaccine administration recommendations
Constraints: imr-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
.... vaccineCode Σ 0..* CodeableConcept Generic description of the vaccine/prophylaxis or its component(s)
Binding: Vaccine (preferred)
.... targetDisease Σ 0..1 CodeableConcept Disease or agent that the vaccination provides protection against
Binding: Illness and Disorder (PARTIAL) (preferred)
.... contraindicatedVaccineCode Σ 0..* CodeableConcept Vaccine which is contraindicated to fulfill the recommendation
Binding: VaccineAdministeredValueSet (example): The type of vaccine administered.
.... forecastStatus ?!Σ 1..1 CodeableConcept Recommendation status
Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol.
.... forecastReason Σ 0..* CodeableConcept Vaccine administration status reason
Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol.
.... Slices for dateCriterion 0..* BackboneElement Dates governing proposed immunization
Slice: Unordered, Open by pattern:code
..... dateCriterion: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
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
...... value 1..1 dateTime Recommended date
..... dateCriterion:nextDose 0..1 BackboneElement Dates governing proposed 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
...... code 1..1 CodeableConcept Type of date
Binding: ImmunizationRecommendationDateCriterionCodes (example): Classifies date criterion with respect to conveying information about a patient's vaccination status (e.g. due date, latest to give date, etc.).
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://loinc.org
........ version 0..1 string Version of the system - if relevant
........ code 1..1 code Symbol in syntax defined by the system
Fixed Value: 30980-7
........ 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
...... value 1..1 dateTime Recommended date
.... description 0..1 string Protocol details
.... series 0..1 string Name of vaccination series
.... Slices for doseNumber[x] Σ 0..1 Recommended 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
.... supportingImmunization 0..* Reference(Immunization | ImmunizationEvaluation) Past immunizations supporting recommendation
.... supportingPatientInformation 0..* Reference(Resource) Patient observations supporting recommendation

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ImmunizationRecommendation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.vaccineCode Base preferred Vaccine 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.targetDisease Base preferred Illness and Disorder (PARTIAL) 📦0.1.0 This IG
ImmunizationRecommendation.​recommendation.contraindicatedVaccineCode Base example Vaccine Administered Value Set 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastStatus Base example Immunization Recommendation Status Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.forecastReason Base example Immunization Recommendation Reason Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.
ImmunizationRecommendation.​recommendation.dateCriterion:nextDose.​code Base example Immunization Recommendation Date Criterion Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error ImmunizationRecommendation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ImmunizationRecommendation 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 ImmunizationRecommendation 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 ImmunizationRecommendation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ImmunizationRecommendation 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()
imr-1 error ImmunizationRecommendation.recommendation One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()

This structure is derived from ImmunizationRecommendation

Summary

Must-Support: 2 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.dateCriterion
  • The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.doseNumber[x]
  • The element 1 is sliced based on the value of ImmunizationRecommendation.recommendation.seriesDoses[x]

 

Other representations of profile: CSV, Excel, Schematron