Skip to content
Release: Australia · Updated: 2026-03-12 · Official documentation · View source

Immunization table

The Immunization [sn_hcls_immunization] table stores the information about an event of a patient being administered a vaccine or a record of an immunization as reported by a patient, a clinician, or another party.

Key features

  • Extends the Install base item [sn_install_base_item] table to store immunization details.
  • Stores all immunization data associated with a patient, including the vaccine received, administered date, recommended doses, dose number, location where it was administered, practitioner who administered it, and the condition for which the vaccine was given.

Role required to configure the table: sn_hcls.admin.

For more information, see Healthcare and Life Sciences data model.

FieldData typeDescription
Administered byReferencePractitioner who administered the patient.
Administration routeChoice listRoute by which the vaccine was administered. The following routes are available by default: - Intradermal - Intramuscular - Intravenous - Nasal - Oral - Percutaneous - Subcutaneous - Transdermal For more information about the available routes, see immunization routes defined in the FHIR specifications.
Body siteChoice listBody site at which the vaccine was administered. The following body sites are available by default: - Left arm - Left deltoid - Left gluteus medius - Left lower forearm - Left thigh - Left vastus lateralis - Right arm - Right deltoid - Right thigh - Right gluteus medius - Right lower forearm - Right vastus lateralis For more information about the body sites, see immunization sites defined in the FHIR specifications.
Date administeredDate/TimeDate and time when the vaccine was administered.
Dose numberIntegerDose sequence number within the vaccine series.
Dose quantityStringQuantity of dose given to the patient.
EncounterReferenceEncounter the immunization was part of.
External idStringIdentifier of the record in an electronic medical record \(EMR\) system.
Healthcare locationReferenceService delivery location in which the vaccine was or was to be administered.
NumberString

Alpha-numeric profile identifier of the immunization.

The value is auto-generated and is incremented every time you add a new immunization to your ServiceNow instance. The initial value for the Number field is IMM00001001.

Note: To customize the number, define the auto-numbering format for the Immunization [sn_hcls_immunization] table. For more information, see Add auto-numbering records in a table.

ObservationReferenceObservation associated with the immunization.
PatientReferencePatient who received the vaccine and is being administered.
SourceReferenceSource system details of an external healthcare system in a ServiceNow instance.
Vaccine productReferenceVaccine product sold to the patient who is being administered.
Recommended dosesIntegerRecommended number of doses to achieve immunity.
StatusChoice listStatus of the immunization. The following statuses are available by default: - Completed - Incorrect entry - Not done For more information about the available statuses, see immunization statuses defined in the FHIR specifications.
Status reasonStringExplanation why a vaccine was not administered.
Target diseaseReferenceVaccine preventable disease the dose is being administered for.
Vaccine expiry dateDateDate when the vaccine product expires.
Vaccine lot numberStringLot number of the vaccine product.
Vaccine manufacturerStringManufacturer of the vaccine product.

Parent Topic:Healthcare and Life Sciences data model tables