Skip to content
Contact Us

HL7 VXU Message: Immunization Records

HL7 VXU (Unsolicited Vaccination Record Update) messages transmit immunization and vaccination records from EHRs, pharmacies, and clinics to external systems — most commonly Immunization Information Systems (IIS), also known as immunization registries. The VXU^V04 is the single trigger event: an unsolicited update that reports one or more vaccinations a patient has received.

SegmentNameRequiredPurpose
MSHMessage HeaderYesSender, receiver, message type, version
PIDPatient IdentificationYesPatient demographics and identifiers
PD1Patient Additional DemographicNoRegistry/protection indicators, primary facility
NK1Next of Kin / Associated PartiesNoParent or guardian (common for pediatric records)
PV1Patient VisitNoVisit context for the encounter
ORCCommon OrderYesOrder grouping for each vaccination (repeating)
RXAPharmacy/Treatment AdministrationYesThe vaccine administered (repeating)
RXRPharmacy/Treatment RouteNoRoute and body site of administration
OBXObservation/ResultNoSupporting observations (VIS dates, eligibility)

A VXU^V04 carries a repeating ORC + RXA group — one per vaccine administered — with optional RXR and OBX segments inside each group. A single message can therefore report an entire immunization history in one transmission.

RXA (Pharmacy/Treatment Administration) is the defining segment of a VXU message — it records the specific vaccine that was given. Key fields:

FieldNamePurpose
RXA-3Date/Time Start of AdministrationWhen the vaccine was administered
RXA-5Administered CodeThe vaccine — typically a CVX code
RXA-6Administered AmountDose quantity
RXA-7Administered UnitsDose units (e.g., mL)
RXA-9Administration NotesInformation source (e.g., new vs. historical record)
RXA-15Substance Lot NumberLot number of the vaccine product
RXA-16Substance Expiration DateProduct expiration date
RXA-17Substance Manufacturer NameManufacturer — typically an MVX code
RXA-18Substance Refusal ReasonReason if the vaccine was refused
RXA-20Completion StatusCP (complete), RE (refused), NA (not administered), PA (partial)
RXA-21Action CodeA (add), D (delete), U (update)

Vaccines in RXA-5 are coded with CVX (CDC vaccine administered codes); manufacturers in RXA-17 use MVX (CDC manufacturer codes). Both code sets are maintained by the CDC.

RXR (Pharmacy/Treatment Route) describes how the vaccine entered the body. It follows the RXA it relates to:

FieldNameExample
RXR-1RouteIM (intramuscular), SC (subcutaneous), IN (intranasal)
RXR-2Administration SiteLD (left deltoid), RD (right deltoid), LVL/RVL (vastus lateralis)

OBX segments inside an ORC/RXA group carry observations that support the immunization record rather than lab results. Common uses include:

  • Vaccine Information Statement (VIS) dates — the publication date and the date the VIS was presented to the patient
  • Funding eligibility — whether the dose was VFC-eligible (Vaccines for Children) and the patient’s eligibility category
  • Vaccine funding program / source — public vs. private stock
  • Dose number and series-related observations

Each observation is linked to its vaccination by appearing within that vaccine’s segment group.

A single-vaccine immunization update sent to an immunization registry:

VXU^V04 — Immunization Record (Influenza Vaccine)
Header Patient Clinical Order/Result Financial

Browse the full HL7 sample messages catalog for more example messages — each one ready to copy as valid HL7 or download as a .hl7 file.

CodeStatusMeaning
CPCompleteThe vaccine was fully administered
PAPartially AdministeredA partial dose was given
RERefusedThe patient or guardian refused the vaccine
NANot AdministeredThe vaccine was not given

RXA-9 (Administration Notes) distinguishes a newly administered dose from a historical record entered from an outside source. A code of 00 (new immunization record) means the sending system administered the vaccine, while 01 (historical information — source unspecified) and related codes indicate the dose was recorded from prior documentation. Registries treat the two differently — new administrations may carry lot and manufacturer detail that historical entries often lack.

Immunization registries expect standardized coding: CVX codes identify the vaccine in RXA-5, and MVX codes identify the manufacturer in RXA-17. Both code sets are published and maintained by the CDC. Integration engines mapping local vaccine catalogs to VXU output must keep these crosswalks current, since the CDC adds CVX codes as new vaccine products reach the market.

The canonical profile for VXU messaging is the CDC HL7 Version 2.5.1 Implementation Guide for Immunization Messaging. It constrains the base HL7 v2.5.1 standard — defining required fields, cardinalities, and value sets specifically for IIS reporting. Most state and regional immunization registries publish their own local addendum on top of this guide, so implementations should validate against both the CDC guide and the target registry’s specification.

A registry typically returns an ACK to confirm receipt of a VXU message. Beyond unsolicited updates, the immunization messaging guide also defines a query pair — QBP^Q11 (request an immunization history) and RSP^K11 (the registry’s response) — used when a provider needs to retrieve a consolidated history rather than report a new dose.