FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2

Public Health and Emergency Response Work GroupMaturity Level: 1 Trial UseCompartments: Patient

Detailed Descriptions for the elements in the ImmunizationRecommendation resource.

ImmunizationRecommendation
Definition

A patient's point-in-time immunization and recommendation (i.e. forecasting a patient's immunization eligibility according to a published schedule) with optional supporting justification.

Control1..1
ImmunizationRecommendation.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
Definition

The patient the recommendations are for.

Control1..1
TypeReference(Patient)
Summarytrue
ImmunizationRecommendation.recommendation
Definition

Vaccine administration recommendations.

Control1..*
Summarytrue
InvariantsDefined on this element
imr-1: One of vaccineCode or targetDisease SHALL be present (expression : vaccineCode.exists() or targetDisease.exists(), xpath: exists(f:vaccineCode) or exists(f:targetDisease))
ImmunizationRecommendation.recommendation.date
Definition

The date the immunization recommendation was created.

Control1..1
TypedateTime
Summarytrue
ImmunizationRecommendation.recommendation.vaccineCode
Definition

Vaccine that pertains to the recommendation.

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

The targeted disease for the recommendation.

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

The next recommended dose number (e.g. dose 2 is the next recommended dose).

Control0..1
TypepositiveInt
Summarytrue
Comments

May need other dose concepts such as administered vs. valid.

ImmunizationRecommendation.recommendation.forecastStatus
Definition

Vaccine administration status.

Control1..1
Terminology BindingImmunization Recommendation Status Codes (Example)
TypeCodeableConcept
Summarytrue
ImmunizationRecommendation.recommendation.dateCriterion
Definition

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

Control0..*
ImmunizationRecommendation.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
Definition

The date whose meaning is specified by dateCriterion.code.

Control1..1
TypedateTime
ImmunizationRecommendation.recommendation.protocol
Definition

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

Control0..1
ImmunizationRecommendation.recommendation.protocol.doseSequence
Definition

Indicates the nominal position in a series of the next dose. This is the recommended dose number as per a specified protocol.

Control0..1
TypepositiveInt
ImmunizationRecommendation.recommendation.protocol.description
Definition

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

Control0..1
Typestring
ImmunizationRecommendation.recommendation.protocol.authority
Definition

Indicates the authority who published the protocol. For example, ACIP.

Control0..1
TypeReference(Organization)
ImmunizationRecommendation.recommendation.protocol.series
Definition

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

Control0..1
Typestring
ImmunizationRecommendation.recommendation.supportingImmunization
Definition

Immunization event history that supports the status and recommendation.

Control0..*
TypeReference(Immunization)
ImmunizationRecommendation.recommendation.supportingPatientInformation
Definition

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

Control0..*
TypeReference(Observation | AllergyIntolerance)