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
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
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who this profile is for |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date recommendation(s) created |
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Generic description of the vaccine/prophylaxis or its component(s) Binding: Vaccine (preferred) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Illness and Disorder (PARTIAL) (preferred) |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by pattern:code | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number |
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |
![]() |
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. |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Who this profile is for |
![]() ![]() ![]() |
S | 1..1 | dateTime | Date recommendation(s) created |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Generic description of the vaccine/prophylaxis or its component(s) Binding: Vaccine (preferred) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Illness and Disorder (PARTIAL) (preferred) | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Recommendation status | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by pattern:code | |
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of date Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Dose Number | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |
![]() |
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 |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who this profile is for | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date recommendation(s) created | ||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Generic description of the vaccine/prophylaxis or its component(s) Binding: Vaccine (preferred) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Illness and Disorder (PARTIAL) (preferred) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by pattern:code | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Protocol details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccination series | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number | ||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
![]() |
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. |
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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who this profile is for |
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date recommendation(s) created |
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1 |
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Generic description of the vaccine/prophylaxis or its component(s) Binding: Vaccine (preferred) |
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Illness and Disorder (PARTIAL) (preferred) |
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by pattern:code | |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized |
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number |
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||
![]() ![]() ![]() ![]() ![]() |
string | |||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |
![]() |
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. |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |
![]() ![]() ![]() |
S | 1..1 | Reference(Patient) | Who this profile is for |
![]() ![]() ![]() |
S | 1..1 | dateTime | Date recommendation(s) created |
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Generic description of the vaccine/prophylaxis or its component(s) Binding: Vaccine (preferred) | |
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Illness and Disorder (PARTIAL) (preferred) | |
![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Recommendation status | |
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by pattern:code | |
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | CodeableConcept | Type of date Required Pattern: At least the following | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended dose number within series Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Dose Number | |
![]() ![]() ![]() ![]() |
0..1 | positiveInt, string | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |
![]() |
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
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | ImmunizationRecommendation | Guidance or advice relating to an immunization | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation This profile does not constrain the narrative in regard to content, language, or traceability to data elements | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() ![]() |
Σ | 0..* | Identifier | Business identifier | ||||
![]() ![]() ![]() |
SΣ | 1..1 | Reference(Patient) | Who this profile is for | ||||
![]() ![]() ![]() |
SΣ | 1..1 | dateTime | Date recommendation(s) created | ||||
![]() ![]() ![]() |
0..1 | Reference(Organization) | Who is responsible for protocol | |||||
![]() ![]() ![]() |
ΣC | 1..* | BackboneElement | Vaccine administration recommendations Constraints: imr-1 | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Generic description of the vaccine/prophylaxis or its component(s) Binding: Vaccine (preferred) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | CodeableConcept | Disease or agent that the vaccination provides protection against Binding: Illness and Disorder (PARTIAL) (preferred) | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: VaccineAdministeredValueSet (example): The type of vaccine administered. | ||||
![]() ![]() ![]() ![]() |
?!Σ | 1..1 | CodeableConcept | Recommendation status Binding: ImmunizationRecommendationStatusCodes (example): The patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() ![]() |
Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (example): The reason for the patient's status with respect to a vaccination protocol. | ||||
![]() ![]() ![]() ![]() |
0..* | BackboneElement | Dates governing proposed immunization Slice: Unordered, Open by pattern:code | |||||
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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.). | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Dates governing proposed immunization | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..* | Coding | Code defined by a terminology system Fixed Value: (Complex) | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | uri | Identity of the terminology system Fixed Value: http://loinc.org | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Version of the system - if relevant | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | code | Symbol in syntax defined by the system Fixed Value: 30980-7 | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Representation defined by the system | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | boolean | If this coding was chosen directly by the user | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Plain text representation of the concept | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
1..1 | dateTime | Recommended date | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Protocol details | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Name of vaccination series | |||||
![]() ![]() ![]() ![]() |
Σ | 0..1 | Recommended dose number within series Slice: Unordered, Open by type:$this | |||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | positiveInt | Dose Number | ||||
![]() ![]() ![]() ![]() |
0..1 | Recommended number of doses for immunity Slice: Unordered, Open by type:$this | ||||||
![]() ![]() ![]() ![]() ![]() |
positiveInt | |||||||
![]() ![]() ![]() ![]() ![]() |
string | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | positiveInt | Number of doses | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |||||
![]() ![]() ![]() ![]() |
0..* | Reference(Resource) | Patient observations supporting recommendation | |||||
![]() |
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. |
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:
Other representations of profile: CSV, Excel, Schematron