This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Detailed Descriptions for the elements in the Immunization resource.
Describes the event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician or another party.
A unique identifier assigned to this immunization record.
A plan, order or recommendation fulfilled in whole or in part by this immunization.
Allows tracing of an authorization for the Immunization.
Indicates the current status of the immunization event.
Will generally be set to show that the immunization has been completed or not done. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Indicates the reason the immunization event was not performed.
This is generally only used for the status of "not-done". The reason for performing the immunization event is captured in reasonCode, not here.
Vaccine that was administered or was to be administered.
The code for the administered vaccine may be reported at various levels of granularity from a very generic code for a general type of vaccine (e.g. the SNOMED or CVX code for the flu vaccine) to a very discrete code for a specific product including the form and packaging (e.g. an NDC code). Because vaccineCode uses the CodeableConcept data type, multiple codes at different levels of granularity may be reported for a single immunization event provided that all codes are appropriate for the same vaccine. For example, both NDC and CVX codes may be provided for a given immunization event by repeating the coding element within vaccineCode.
An indication of which product was administered to the patient. This is typically a more detailed representation of the concept conveyed by the vaccineCode data element. If a Medication resource is referenced, it may be to a stand-alone resource or a contained resource within the Immunization resource.
Name of vaccine manufacturer.
Lot number of the vaccine product.
Date vaccine batch expires.
The patient who either received or did not receive the immunization.
The visit or admission or other contact between patient and health care provider the immunization was performed as part of.
Additional information that is relevant to the immunization (e.g. for a vaccine recipient who is pregnant, the gestational age of the fetus). The reason why a vaccine was given (e.g. occupation, underlying medical condition) should be conveyed in Immunization.reason, not as supporting information. The reason why a vaccine was not given (e.g. contraindication) should be conveyed in Immunization.statusReason, not as supporting information.
Date vaccine administered or was to be administered.
When immunizations are given a specific date and time should always be known. When immunizations are patient reported, a specific date might not be known. Although partial dates are allowed, an adult patient might not be able to recall the year a childhood immunization was given. An exact date is always preferable, but the use of the String data type is acceptable when an exact date is not known. A small number of vaccines (e.g. live oral typhoid vaccine) are given as a series of patient self-administered dose over a span of time. In cases like this, often, only the first dose (typically a provider supervised dose) is recorded with the occurrence indicating the date/time of the first dose.
Indicates whether the data contained in the resource was captured by the individual/organization which was responsible for the administration of the vaccine rather than as 'secondary reported' data documented by a third party. A value of 'true' means this data originated with the individual/organization which was responsible for the administration of the vaccine.
Reflects the "reliability" of the content.
Typically the source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Typically will not be populated if primarySource = True, not required even if primarySource = False.
The service delivery location where the vaccine administration occurred.
Body site where vaccine was administered.
The path by which the vaccine product is taken into the body.
The quantity of vaccine product that was administered.
Indicates who performed the immunization event.
Describes the type of performance (e.g. ordering provider, administering provider, etc.).
The practitioner or organization who performed the action.
When the individual practitioner who performed the action is known, it is best to send.
Extra information about the immunization that is not conveyed by the other attributes.
Describes why the immunization occurred in coded or textual form, or Indicates another resource (Condition, Observation or DiagnosticReport) whose existence justifies this immunization.
Indication if a dose is considered to be subpotent. By default, a dose should be considered to be potent.
Typically, the recognition of the dose being sub-potent is retrospective, after the administration (ex. notification of a manufacturer recall after administration). However, in the case of a partial administration (the patient moves unexpectedly and only some of the dose is actually administered), subpotency may be recognized immediately, but it is still important to record the event.
Reason why a dose is considered to be subpotent.
Indicates a patient's eligibility for a funding program.
Indicates which program the patient had their eligility evaluated for.
Indicates the patient's eligility status for for a specific payment program.
Indicates the source of the vaccine actually administered. This may be different than the patient eligibility (e.g. the patient may be eligible for a publically purchased vaccine but due to inventory issues, vaccine purchased with private funds was actually administered).
Categorical data indicating that an adverse event is associated in time to an immunization.
A reaction may be an indication of an allergy or intolerance and, if this is determined to be the case, it should be recorded as a new AllergyIntolerance resource instance as most systems will not query against past Immunization.reaction elements.
Date of reaction to the immunization.
Details of the reaction.
Self-reported indicator.
The protocol (set of recommendations) being followed by the provider who administered the dose.
One possible path to achieve presumed immunity against a disease - within the context of an authority.
Indicates the authority who published the protocol (e.g. ACIP) that is being followed.
The vaccine preventable disease the dose is being administered against.
Nominal position in a series as intended by the practitioner administering the dose.
The use of an integer is preferred if known. Text should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).
The recommended number of doses to achieve immunity as intended by the practitioner administering the dose.
The use of an integer is preferred if known.