Release 4 5 Preview #2
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions
Public Health and Emergency Response Work Group Maturity Level : 1   Trial Use Security Category : Patient Compartments : Patient

Detailed Descriptions for the elements in the ImmunizationRecommendation resource.

ImmunizationRecommendation
Element Id ImmunizationRecommendation
Definition

A patient's point-in-time set of recommendations (i.e. forecasting) according to a published schedule with optional supporting justification.

Cardinality 0..*
Type DomainResource
ImmunizationRecommendation.identifier
Element Id ImmunizationRecommendation.identifier
Definition

A unique identifier assigned to this particular recommendation record.

Note This is a business identifier, not a resource identifier (see discussion )
Cardinality 0..*
Type Identifier
Summary true
ImmunizationRecommendation.instantiatesCanonical
Element Id ImmunizationRecommendation.instantiatesCanonical
Definition

The URL pointing to a FHIR-defined protocol, guideline or other definition that is adhered to in whole or in part by this ImmunizationRecommendation.

Cardinality 0..*
Type canonical ( Definition [ ActivityDefinition , EventDefinition , EvidenceVariable , Measure , OperationDefinition , PlanDefinition , Questionnaire , SubscriptionTopic ])
Summary true
ImmunizationRecommendation.instantiatesUri
Element Id ImmunizationRecommendation.instantiatesUri
Definition

The URL pointing to an externally maintained protocol, guideline or other definition that is adhered to in whole or in part by this ImmunizationRecommendation.

Cardinality 0..*
Type uri
Summary true
Comments

This might be an HTML page, PDF, etc. or could just be a non-resolvable URI identifier.

ImmunizationRecommendation.patient
Element Id ImmunizationRecommendation.patient
Definition

The patient the recommendation(s) are for.

Cardinality 1..1
Type Reference ( Patient )
Summary true
ImmunizationRecommendation.date
Element Id ImmunizationRecommendation.date
Definition

The date the immunization recommendation(s) were created.

Cardinality 1..1
Type dateTime
Summary true
ImmunizationRecommendation.authority
Element Id ImmunizationRecommendation.authority
Definition

Indicates the authority who published the protocol (e.g. ACIP).

Cardinality 0..1
Type Reference ( Organization )
ImmunizationRecommendation.recommendation
Element Id ImmunizationRecommendation.recommendation
Definition

Vaccine administration recommendations.

Cardinality 1..*
Summary true
Comments

A given instance of the .recommendation backbone element should correspond to a single recommended administration.

Invariants
Defined on this element
imr-1 Rule One of vaccineCode or targetDisease SHALL be present vaccineCode.exists() or targetDisease.exists()
ImmunizationRecommendation.recommendation.vaccineCode
Element Id ImmunizationRecommendation.recommendation.vaccineCode
Definition

Vaccine(s) or vaccine group that pertain to the recommendation.

Cardinality 0..*
Terminology Binding Vaccine Administered Value Set ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.targetDisease
Element Id ImmunizationRecommendation.recommendation.targetDisease
Definition

The targeted disease for the recommendation.

Cardinality 0..1 0..*
Terminology Binding Immunization Recommendation Target Disease Codes ( Example )
Type CodeableConcept
Summary true
Comments

A given instance of the .recommendation backbone element should correspond to a single recommended administration but sometimes that administration (eg. MMR) will encompass multiple diseases, thus the targetDisease element is allowed to repeat.

ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Element Id ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Definition

Vaccine(s) which should not be used to fulfill the recommendation.

Cardinality 0..*
Terminology Binding Vaccine Administered Value Set ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.forecastStatus
Element Id ImmunizationRecommendation.recommendation.forecastStatus
Definition

Indicates the patient status with respect to the path to immunity for the target disease.

Cardinality 1..1
Terminology Binding Immunization Recommendation Status Codes ( Example )
Type CodeableConcept
Is Modifier true (Reason: This element is labeled as a modifier because the forecastStatus indicates whether a patient needs additional doses (due, overdue, etc) or not (contraindicated, complete, etc).)
Summary true
ImmunizationRecommendation.recommendation.forecastReason
Element Id ImmunizationRecommendation.recommendation.forecastReason
Definition

The reason for the assigned forecast status.

Cardinality 0..*
Terminology Binding Immunization Recommendation Reason Codes ( Example )
Type CodeableConcept
Summary true
ImmunizationRecommendation.recommendation.dateCriterion
Element Id ImmunizationRecommendation.recommendation.dateCriterion
Definition

Vaccine date recommendations. For example, earliest date to administer, latest date to administer, etc.

Cardinality 0..*
ImmunizationRecommendation.recommendation.dateCriterion.code
Element Id ImmunizationRecommendation.recommendation.dateCriterion.code
Definition

Date classification of recommendation. For example, earliest date to give, latest date to give, etc.

Cardinality 1..1
Terminology Binding Immunization Recommendation Date Criterion Codes ( Example )
Type CodeableConcept
ImmunizationRecommendation.recommendation.dateCriterion.value
Element Id ImmunizationRecommendation.recommendation.dateCriterion.value
Definition

The date whose meaning is specified by dateCriterion.code.

Cardinality 1..1
Type dateTime
ImmunizationRecommendation.recommendation.description
Element Id ImmunizationRecommendation.recommendation.description
Definition

Contains the description about the protocol under which the vaccine was administered.

Cardinality 0..1
Type string
ImmunizationRecommendation.recommendation.series
Element Id ImmunizationRecommendation.recommendation.series
Definition

One possible path to achieve presumed immunity against a disease - within the context of an authority.

Cardinality 0..1
Type string
ImmunizationRecommendation.recommendation.doseNumber[x] ImmunizationRecommendation.recommendation.doseNumber
Element Id ImmunizationRecommendation.recommendation.doseNumber[x] ImmunizationRecommendation.recommendation.doseNumber
Definition

Nominal position of the recommended dose in a series as determined by the evaluation and forecasting process (e.g. dose 2 is the next recommended dose).

Cardinality 0..1
Type positiveInt | string
[x] Note See Choice of Data Types for further information about how to use [x] Summary true
Comments

The use of an integer is prefered preferred if known. A string should only be used in cases where an interger integer is not available (such as when documenting a recurring booster dose).

ImmunizationRecommendation.recommendation.seriesDoses[x] ImmunizationRecommendation.recommendation.seriesDoses
Element Id ImmunizationRecommendation.recommendation.seriesDoses[x] ImmunizationRecommendation.recommendation.seriesDoses
Definition

The recommended number of doses to achieve immunity. immunity as determined by the evaluation and forecasting process.

Cardinality 0..1
Type positiveInt | string
[x] Note See Choice of Data Types for further information about how to use [x] Comments

The use of an integer is prefered preferred if known. A string should only be used in cases where an interger is not available (such as when documenting a recurring booster dose).

ImmunizationRecommendation.recommendation.supportingImmunization
Element Id ImmunizationRecommendation.recommendation.supportingImmunization
Definition

Immunization event history and/or evaluation that supports the status and recommendation.

Cardinality 0..*
Type Reference ( Immunization | ImmunizationEvaluation )
Patterns Reference(Immunization,ImmunizationEvaluation): Common patterns = Event
ImmunizationRecommendation.recommendation.supportingPatientInformation
Element Id ImmunizationRecommendation.recommendation.supportingPatientInformation
Definition

Patient Information that supports the status and recommendation. This includes patient observations, adverse reactions and allergy/intolerance information.

Cardinality 0..*
Type Reference ( Any )