This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
STU
3).
(v3.5.0:
R4
Ballot
#2).
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
Group
|
Maturity Level : 1 | Trial Use | Compartments : Patient |
Detailed Descriptions for the elements in the ImmunizationRecommendation resource.
| ImmunizationRecommendation | |||||||||
| Element Id | ImmunizationRecommendation | ||||||||
| Definition |
A
patient's
point-in-time
|
||||||||
| Control | 1..1 | ||||||||
| Type | DomainResource | ||||||||
| ImmunizationRecommendation.identifier | |||||||||
| Element Id | ImmunizationRecommendation.identifier | ||||||||
| Definition |
A unique identifier assigned to this particular recommendation record. |
||||||||
| Note | This is a business identifer, not a resource identifier (see discussion ) | ||||||||
| Control | 0..* | ||||||||
| Type | Identifier | ||||||||
| Summary | true | ||||||||
| ImmunizationRecommendation.patient | |||||||||
| Element Id | ImmunizationRecommendation.patient | ||||||||
| Definition |
The
patient
the
|
||||||||
| Control | 1..1 | ||||||||
| Type | Reference ( Patient ) | ||||||||
| Summary | true | ||||||||
| ImmunizationRecommendation.date | |||||||||
| Element Id | ImmunizationRecommendation.date | ||||||||
| Definition | The date the immunization recommendation(s) were created. | ||||||||
| Control | 1..1 | ||||||||
| Type | dateTime | ||||||||
| Summary | true | ||||||||
| ImmunizationRecommendation.authority | |||||||||
| Element Id | ImmunizationRecommendation.authority | ||||||||
| Definition | Indicates the authority who published the protocol (e.g. ACIP). | ||||||||
| Control | 0..1 | ||||||||
| Type | Reference ( Organization ) | ||||||||
| ImmunizationRecommendation.recommendation | |||||||||
| Element Id | ImmunizationRecommendation.recommendation | ||||||||
| Definition |
Vaccine administration recommendations. |
||||||||
| Control | 1..* | ||||||||
| Summary | true | ||||||||
| Invariants |
|
||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.vaccineCode | ||||||||
| Definition |
|
||||||||
| Control |
| ||||||||
| Terminology Binding | Vaccine Administered Value Set ( Example ) | ||||||||
| Type |
|
||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.targetDisease | ||||||||
| Definition |
|
||||||||
| Control | 0..1 | ||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.contraindicatedVaccineCode | ||||||||
| Definition |
|
||||||||
| Control |
|
||||||||
| Terminology Binding |
|
||||||||
| Type | CodeableConcept | ||||||||
| Summary | true | ||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.forecastStatus | ||||||||
| Definition |
|
||||||||
| Control |
| ||||||||
| Terminology Binding | Immunization Recommendation Status Codes ( Example ) | ||||||||
| Type |
|
||||||||
|
|
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).) | ||||||||
|
|
|
||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.forecastReason | ||||||||
| Definition |
|
||||||||
| Control |
|
||||||||
| Terminology Binding |
Immunization
Recommendation
|
||||||||
| 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. |
||||||||
| Control | 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. |
||||||||
| Control | 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. |
||||||||
| Control | 1..1 | ||||||||
| Type | dateTime | ||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.description | ||||||||
| Definition |
Contains
|
||||||||
| Control | 0..1 | ||||||||
| Type | string | ||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.series | ||||||||
| Definition |
|
||||||||
| Control | 0..1 | ||||||||
| Type |
|
||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.doseNumber[x] | ||||||||
| Definition |
|
||||||||
| Control | 0..1 | ||||||||
| Type | positiveInt | string | ||||||||
|
|
|
||||||||
|
|
|
||||||||
|
|
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). |
||||||||
|
|
|||||||||
| Element Id | ImmunizationRecommendation.recommendation.seriesDoses[x] | ||||||||
| Definition |
|
||||||||
| Control | 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 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. |
||||||||
| Control | 0..* | ||||||||
| Type | Reference ( Immunization | ImmunizationEvaluation ) | ||||||||
| 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. |
||||||||
| Control | 0..* | ||||||||
| Type |
Reference
(
|
||||||||