This page is part of the FHIR Specification (v4.3.0: R4B - STU). 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
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.
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 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.
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.
The date the occurrence of the immunization was first captured in the record - potentially significantly after the occurrence of the event.
An indication that the content of the record is based on information from the person who administered the vaccine. This reflects the context under which the data was originally recorded.
Reflects the "reliability" of the content.
The source of the data when the report of the immunization event is not based on information from the person who administered the vaccine.
Should not be populated if primarySource = True, not required even if primarySource = False.
The service delivery location where the vaccine administration occurred.
Name of vaccine manufacturer.
Lot number of the vaccine product.
Date vaccine batch expires.
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.
Reasons why the vaccine was administered.
Condition, Observation or DiagnosticReport that supports why the immunization was administered.
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.
Educational material presented to the patient (or guardian) at the time of vaccine administration.
Identifier of the material presented to the patient.
Reference pointer to the educational material given to the patient if the information was on line.
Date the educational material was published.
Date the educational material was given to the patient.
Indicates a patient's eligibility for a funding 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.
The use of an integer is preferred if known. A string 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.
The use of an integer is preferred if known. A string should only be used in cases where an integer is not available (such as when documenting a recurring booster dose).