.
Page
versions:
R5
R4B
R4
R3
R2
This
page
is
part
of
the
FHIR
Specification
(v0.0.82:
DSTU
1).
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
Formal definitions for the elements in the Immunization resource.
| Immunization | |
| Definition | Immunization event information. |
| Control | 1..1 |
| Immunization.identifier | |
| Definition | A unique identifier assigned to this adverse reaction record. |
| Control | 0..* |
| Type | Identifier |
| Immunization.date | |
| Definition | Date vaccine administered or was to be administered. |
| Control | 1..1 |
| Type | dateTime |
| Immunization.vaccineType | |
| Definition | Vaccine that was administered or was to be administered. |
| Control | 1..1 |
| Binding | VaccineType: The type of vaccine administered ( Value Set Definition ) |
| Type | CodeableConcept |
| Immunization.subject | |
| Definition | The patient to whom the vaccine was to be administered. |
| Control | 1..1 |
| Type | Resource ( Patient ) |
| Immunization.refusedIndicator | |
| Definition | Indicates if the vaccination was refused. |
| Control | 1..1 |
| Type | boolean |
| Immunization.reported | |
| Definition | True if this administration was reported rather than directly administered. |
| Control | 1..1 |
| Type | boolean |
| Comments | May need source of reported info (e.g. parent), but leave out for now. |
| Immunization.performer | |
| Definition | Clinician who administered the vaccine. |
| Control | 0..1 |
| Type | Resource ( Practitioner ) |
| Immunization.requester | |
| Definition | Clinician who ordered the vaccination. |
| Control | 0..1 |
| Type | Resource ( Practitioner ) |
| Comments | Other participants - delegate to Provenance resource. |
| Immunization.manufacturer | |
| Definition | Name of vaccine manufacturer. |
| Control | 0..1 |
| Type | Resource ( Organization ) |
| Immunization.location | |
| Definition | The service delivery location where the vaccine administration occurred. |
| Control | 0..1 |
| Type | Resource ( Location ) |
| Immunization.lotNumber | |
| Definition | Lot number of the vaccine product. |
| Control | 0..1 |
| Type | string |
| Immunization.expirationDate | |
| Definition | Date vaccine batch expires. |
| Control | 0..1 |
| Type | date |
| Immunization.site | |
| Definition | Body site where vaccine was administered. |
| Control | 0..1 |
| Binding | ImmunizationSite: ( See http://hl7.org/fhir/vs/immunization-site ) |
| Type | CodeableConcept |
| Immunization.route | |
| Definition | The path by which the vaccine product is taken into the body. |
| Control | 0..1 |
| Binding | ImmunizationRoute: ( See http://hl7.org/fhir/vs/immunization-route ) |
| Type | CodeableConcept |
| Immunization.doseQuantity | |
| Definition | The quantity of vaccine product that was administered. |
| Control | 0..1 |
| Type | Quantity |
| Immunization.explanation | |
| Definition | Reasons why a vaccine was administered or refused. |
| Control | 0..1 |
| Immunization.explanation.reason | |
| Definition | Reasons why a vaccine was administered. |
| Control | 0..* |
| Binding | ImmunizationReason: ( See http://hl7.org/fhir/vs/immunization-reason ) |
| Type | CodeableConcept |
| Immunization.explanation.refusalReason | |
| Definition | Refusal or exemption reasons. |
| Control | 0..* |
| Binding | NoImmunizationReason: ( See http://hl7.org/fhir/vs/no-immunization-reason ) |
| Type | CodeableConcept |
| Immunization.reaction | |
| Definition | Categorical data indicating that an adverse event is associated in time to an immunization. |
| Control | 0..* |
| Immunization.reaction.date | |
| Definition | Date of reaction to the immunization. |
| Control | 0..1 |
| Type | dateTime |
| Immunization.reaction.detail | |
| Definition | Details of the reaction. |
| Control | 0..1 |
| Type | Resource ( AdverseReaction | Observation ) |
| Immunization.reaction.reported | |
| Definition | Self-reported indicator. |
| Control | 0..1 |
| Type | boolean |
| Immunization.vaccinationProtocol | |
| Definition | Contains information about the protocol(s) under which the vaccine was administered. |
| Control | 0..* |
| Immunization.vaccinationProtocol.doseSequence | |
| Definition | Nominal position in a series. |
| Control | 1..1 |
| Type | integer |
| Immunization.vaccinationProtocol.description | |
| Definition | Contains the description about the protocol under which the vaccine was administered. |
| Control | 0..1 |
| Type | string |
| Immunization.vaccinationProtocol.authority | |
| Definition | Indicates the authority who published the protocol? E.g. ACIP. |
| Control | 0..1 |
| Type | Resource ( Organization ) |
| Immunization.vaccinationProtocol.series | |
| Definition | One possible path to achieve presumed immunity against a disease - within the context of an authority. |
| Control | 0..1 |
| Type | string |
| Immunization.vaccinationProtocol.seriesDoses | |
| Definition | The recommended number of doses to achieve immunity. |
| Control | 0..1 |
| Type | integer |
| Immunization.vaccinationProtocol.doseTarget | |
| Definition | The targeted disease. |
| Control | 1..1 |
| Binding | VaccinationProtocolDoseTarget: ( See http://hl7.org/fhir/vs/vaccination-protocol-dose-target ) |
| Type | CodeableConcept |
| Immunization.vaccinationProtocol.doseStatus | |
| Definition | Indicates if the immunization event should "count" against the protocol. |
| Control | 1..1 |
| Binding | VaccinationProtocolDoseStatus: ( See http://hl7.org/fhir/vs/vaccination-protocol-dose-status ) |
| Type | CodeableConcept |
| Comments | May need to differentiate between status declarations by a provider vs. a CDS engine. |
| Immunization.vaccinationProtocol.doseStatusReason | |
| Definition | Provides an explanation as to why a immunization event should or should not count against the protocol. |
| Control | 0..1 |
| Binding | VaccinationProtocolDoseStatusReason: ( See http://hl7.org/fhir/vs/vaccination-protocol-dose-status-reason ) |
| Type | CodeableConcept |
©
HL7.org
2011+.
FHIR
DSTU
(v0.0.82.2943)
generated
on
Tue,
Sep
30,
2014
18:09+1000.
Links:
What's
a
DSTU?
|
Version
History
|
|
Propose
a
change