Current Build
Public Health and Emergency Response Work GroupMaturity Level: 1 Trial Use Compartments: Patient

Detailed Descriptions for the elements in the ImmunizationRecommendation resource.

ImmunizationRecommendation
Element IdImmunizationRecommendation
Definition

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

Control1..1
TypeDomainResource
ImmunizationRecommendation.identifier
Element IdImmunizationRecommendation.identifier
Definition

A unique identifier assigned to this particular recommendation record.

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Summarytrue
ImmunizationRecommendation.patient
Element IdImmunizationRecommendation.patient
Definition

The patient the recommendation(s) are for.

Control1..1
TypeReference(Patient)
Summarytrue
ImmunizationRecommendation.date
Element IdImmunizationRecommendation.date
Definition

The date the immunization recommendation(s) were created.

Control1..1
TypedateTime
Summarytrue
ImmunizationRecommendation.authority
Element IdImmunizationRecommendation.authority
Definition

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

Control0..1
TypeReference(Organization)
ImmunizationRecommendation.recommendation
Element IdImmunizationRecommendation.recommendation
Definition

Vaccine administration recommendations.

Control1..*
Summarytrue
Invariants
Defined on this element
imr-1Rule One of vaccineCode or targetDisease SHALL be presentvaccineCode.exists() or targetDisease.exists()
ImmunizationRecommendation.recommendation.vaccineCode
Element IdImmunizationRecommendation.recommendation.vaccineCode
Definition

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

Control0..*
Terminology BindingVaccine Administered Value Set (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.targetDisease
Element IdImmunizationRecommendation.recommendation.targetDisease
Definition

The targeted disease for the recommendation.

Control0..1
Terminology BindingImmunization Recommendation Target Disease Codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Element IdImmunizationRecommendation.recommendation.contraindicatedVaccineCode
Definition

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

Control0..*
Terminology BindingVaccine Administered Value Set (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.forecastStatus
Element IdImmunizationRecommendation.recommendation.forecastStatus
Definition

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

Control1..1
Terminology BindingImmunization Recommendation Status Codes (Example)
TypeCodeableConcept
Is Modifiertrue (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).)
Summarytrue
ImmunizationRecommendation.recommendation.forecastReason
Element IdImmunizationRecommendation.recommendation.forecastReason
Definition

The reason for the assigned forecast status.

Control0..*
Terminology BindingImmunization Recommendation Reason Codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.dateCriterion
Element IdImmunizationRecommendation.recommendation.dateCriterion
Definition

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

Control0..*
ImmunizationRecommendation.recommendation.dateCriterion.code
Element IdImmunizationRecommendation.recommendation.dateCriterion.code
Definition

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

Control1..1
Terminology BindingImmunization Recommendation Date Criterion Codes (Example)
TypeCodeableConcept
ImmunizationRecommendation.recommendation.dateCriterion.value
Element IdImmunizationRecommendation.recommendation.dateCriterion.value
Definition

The date whose meaning is specified by dateCriterion.code.

Control1..1
TypedateTime
ImmunizationRecommendation.recommendation.description
Element IdImmunizationRecommendation.recommendation.description
Definition

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

Control0..1
Typestring
ImmunizationRecommendation.recommendation.series
Element IdImmunizationRecommendation.recommendation.series
Definition

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

Control0..1
Typestring
ImmunizationRecommendation.recommendation.doseNumber[x]
Element IdImmunizationRecommendation.recommendation.doseNumber[x]
Definition

Nominal position of the recommended dose in a series (e.g. dose 2 is the next recommended dose).

Control0..1
TypepositiveInt|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
Comments

The use of an integer is prefered 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.seriesDoses[x]
Element IdImmunizationRecommendation.recommendation.seriesDoses[x]
Definition

The recommended number of doses to achieve immunity.

Control0..1
TypepositiveInt|string
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

The use of an integer is prefered 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 IdImmunizationRecommendation.recommendation.supportingImmunization
Definition

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

Control0..*
TypeReference(Immunization | ImmunizationEvaluation)
ImmunizationRecommendation.recommendation.supportingPatientInformation
Element IdImmunizationRecommendation.recommendation.supportingPatientInformation
Definition

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

Control0..*
TypeReference(Any)