This page is part of the Immunization Decision Support Forecast FHIR IG (v0.2.0: STU 1 Ballot 2) based on FHIR R4. The current version which supercedes this version is 1.0.0. For a full list of available versions, see the Directory of published versions 
StructureDefinition-immds-immunizationrecommendation
Scope and Usage
Defines constraints and extensions on the immunizationrecommendation resource for the minimal set of data to perform the Immunization Decision Support Forecast operation.
Examples
The following examples are provided to illustrate conformant resource content to this profile.
Formal Views of Profile Content
Description of Profiles, Differentials, and Snapshots.
The official URL for this profile is: http://hl7.org/fhir/uv/immds/StructureDefinition/immds-immunizationrecommendation
Published on Thu Jun 27 20:00:00 EDT 2019 as a active by HL7 International - Public Health Work Group.
This profile builds on ImmunizationRecommendation
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  ImmunizationRecommendation | I | 0..* | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
 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 | Σ | 1..1 | Reference(Patient) | Who this profile is for |
| date | Σ | 1..1 | dateTime | Date recommendation(s) created |
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
 recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
 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 | Vaccine or vaccine group recommendation applies to Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (extensible) |
| forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (extensible) |
| dateCriterion | I | 0..* | 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 (extensible) | |
| value | 1..1 | dateTime | Recommended date | |
| description | 0..1 | string | Protocol details | |
| series | 0..1 | string | Name of vaccination series | |
 doseNumber[x] | Σ | 0..1 | positiveInt, string | Recommended dose number within series |
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | |
| supportingImmunization | 0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(Resource) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
Differential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
| ImmunizationRecommendation | I | 0..* | 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 |
| language | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred) Max Binding: AllLanguages | |
| text | 0..1 | Narrative | Text summary of the resource, for human interpretation | |
| 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 | Σ | 1..1 | Reference(Patient) | Who this profile is for |
| date | Σ | 1..1 | dateTime | Date recommendation(s) created |
| authority | 0..1 | Reference(Organization) | Who is responsible for protocol | |
| recommendation | ΣI | 1..* | BackboneElement | Vaccine administration recommendations |
| 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 | Vaccine or vaccine group recommendation applies to Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| targetDisease | Σ | 0..1 | CodeableConcept | Disease to be immunized against Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| contraindicatedVaccineCode | Σ | 0..* | CodeableConcept | Vaccine which is contraindicated to fulfill the recommendation Binding: US Core Vaccine Administered Value Set (CVX) (extensible) |
| forecastStatus | ?!Σ | 1..1 | CodeableConcept | Vaccine recommendation status Binding: ImmunizationRecommendationStatusCodes (extensible) |
| forecastReason | Σ | 0..* | CodeableConcept | Vaccine administration status reason Binding: ImmunizationRecommendationReasonCodes (extensible) |
| dateCriterion | I | 0..* | 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 (extensible) | |
| value | 1..1 | dateTime | Recommended date | |
| description | 0..1 | string | Protocol details | |
| series | 0..1 | string | Name of vaccination series | |
| doseNumber[x] | Σ | 0..1 | positiveInt, string | Recommended dose number within series |
| seriesDoses[x] | 0..1 | positiveInt, string | Recommended number of doses for immunity | |
| supportingImmunization | 0..* | Reference(Immunization | ImmunizationEvaluation) | Past immunizations supporting recommendation | |
| supportingPatientInformation | 0..* | Reference(Resource) | Patient observations supporting recommendation | |
| Documentation for this format | ||||
Downloads: StructureDefinition: (XML, JSON), Schema: XML Schematron
Terminology Bindings
| Path | Conformance | ValueSet |
| ImmunizationRecommendation.language | preferred | CommonLanguages Max Binding: AllLanguages |
| ImmunizationRecommendation.recommendation.vaccineCode | extensible | USCoreVaccineAdministeredValueSetCvx |
| ImmunizationRecommendation.recommendation.targetDisease | extensible | USCoreVaccineAdministeredValueSetCvx |
| ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | extensible | USCoreVaccineAdministeredValueSetCvx |
| ImmunizationRecommendation.recommendation.forecastStatus | extensible | ImmunizationRecommendationStatusCodes |
| ImmunizationRecommendation.recommendation.forecastReason | extensible | ImmunizationRecommendationReasonCodes |
| ImmunizationRecommendation.recommendation.dateCriterion.code | extensible | ImmunizationRecommendationDateCriterionCodes |
Constraints
| Id | Path | Details | Requirements |
| dom-2 | ImmunizationRecommendation | If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty() | |
| dom-4 | 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-3 | 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-6 | ImmunizationRecommendation | A resource should have narrative for robust management : text.div.exists() | |
| dom-5 | ImmunizationRecommendation | If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty() | |
| ele-1 | ImmunizationRecommendation.recommendation | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
| imr-1 | ImmunizationRecommendation.recommendation | One of vaccineCode or targetDisease SHALL be present : vaccineCode.exists() or targetDisease.exists() | |
| ele-1 | ImmunizationRecommendation.recommendation.dateCriterion | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) |
