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.
VXU^V04 Message Structure
Section titled “VXU^V04 Message Structure”| Segment | Name | Required | Purpose |
|---|---|---|---|
| MSH | Message Header | Yes | Sender, receiver, message type, version |
| PID | Patient Identification | Yes | Patient demographics and identifiers |
| PD1 | Patient Additional Demographic | No | Registry/protection indicators, primary facility |
| NK1 | Next of Kin / Associated Parties | No | Parent or guardian (common for pediatric records) |
| PV1 | Patient Visit | No | Visit context for the encounter |
| ORC | Common Order | Yes | Order grouping for each vaccination (repeating) |
| RXA | Pharmacy/Treatment Administration | Yes | The vaccine administered (repeating) |
| RXR | Pharmacy/Treatment Route | No | Route and body site of administration |
| OBX | Observation/Result | No | Supporting 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.
The RXA Segment
Section titled “The RXA Segment”RXA (Pharmacy/Treatment Administration) is the defining segment of a VXU message — it records the specific vaccine that was given. Key fields:
| Field | Name | Purpose |
|---|---|---|
| RXA-3 | Date/Time Start of Administration | When the vaccine was administered |
| RXA-5 | Administered Code | The vaccine — typically a CVX code |
| RXA-6 | Administered Amount | Dose quantity |
| RXA-7 | Administered Units | Dose units (e.g., mL) |
| RXA-9 | Administration Notes | Information source (e.g., new vs. historical record) |
| RXA-15 | Substance Lot Number | Lot number of the vaccine product |
| RXA-16 | Substance Expiration Date | Product expiration date |
| RXA-17 | Substance Manufacturer Name | Manufacturer — typically an MVX code |
| RXA-18 | Substance Refusal Reason | Reason if the vaccine was refused |
| RXA-20 | Completion Status | CP (complete), RE (refused), NA (not administered), PA (partial) |
| RXA-21 | Action Code | A (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.
The RXR Segment
Section titled “The RXR Segment”RXR (Pharmacy/Treatment Route) describes how the vaccine entered the body. It follows the RXA it relates to:
| Field | Name | Example |
|---|---|---|
| RXR-1 | Route | IM (intramuscular), SC (subcutaneous), IN (intranasal) |
| RXR-2 | Administration Site | LD (left deltoid), RD (right deltoid), LVL/RVL (vastus lateralis) |
OBX in VXU Messages
Section titled “OBX in VXU Messages”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.
Sample VXU^V04 Message
Section titled “Sample VXU^V04 Message”A single-vaccine immunization update sent to an immunization registry:
| Field | Name | Value | Note |
|---|---|---|---|
MSH-3 | Sending Application | EHR_SYS | EHR reporting the immunization |
MSH-5 | Receiving Application | STATE_IIS | State Immunization Information System |
MSH-9 | Message Type | VXU^V04^VXU_V04 | Unsolicited Vaccination Record Update |
MSH-12 | Version ID | 2.5.1 | Version used by the CDC immunization guide |
| Field | Name | Value | Note |
|---|---|---|---|
PID-3 | Patient Identifier List | MRN12345^^^MAIN_CLINIC^MR | |
PID-5 | Patient Name | DOE^EMMA^ROSE | |
PID-7 | Date of Birth | 20180310 | Used for age-based registry forecasting |
PID-8 | Administrative Sex | F |
| Field | Name | Value | Note |
|---|---|---|---|
NK1-2 | Name | DOE^SARAH | Parent / guardian |
NK1-3 | Relationship | MTH^Mother^HL70063 | Common on pediatric immunization records |
| Field | Name | Value | Note |
|---|---|---|---|
ORC-1 | Order Control | RE | Observations to follow |
ORC-3 | Filler Order Number | IZ4567^MAIN_CLINIC | Immunization record identifier |
ORC-5 | Order Status | CM | Complete |
| Field | Name | Value | Note |
|---|---|---|---|
RXA-3 | Date/Time Start of Administration | 20260304 | Vaccine administered March 4, 2026 |
RXA-5 | Administered Code | 88^Influenza, unspecified formulation^CVX | Vaccine coded with CVX |
RXA-6 | Administered Amount | 0.5 | |
RXA-7 | Administered Units | mL^milliliters^UCUM | |
RXA-9 | Administration Notes | 00^New immunization record^NIP001 | New (not historical) record |
RXA-15 | Substance Lot Number | AB1234 | Vaccine lot number |
RXA-16 | Substance Expiration Date | 20271031 | |
RXA-17 | Substance Manufacturer Name | SKB^GlaxoSmithKline^MVX | Manufacturer coded with MVX |
RXA-20 | Completion Status | CP | Complete |
RXA-21 | Action Code | A | Add this immunization record |
| Field | Name | Value | Note |
|---|---|---|---|
RXR-1 | Route | IM^Intramuscular^HL70162 | Intramuscular injection |
RXR-2 | Administration Site | LD^Left Deltoid^HL70163 |
| Field | Name | Value | Note |
|---|---|---|---|
OBX-2 | Value Type | DT | Date |
OBX-3 | Observation ID | 29768-9^Date vaccine information statement published^LN | VIS publication date (LOINC) |
OBX-5 | Observation Value | 20240815 | |
OBX-11 | Result Status | F | Final |
| Field | Name | Value | Note |
|---|---|---|---|
OBX-3 | Observation ID | 29769-7^Date vaccine information statement presented^LN | Date the VIS was given to the patient |
OBX-5 | Observation Value | 20260304 |
| Field | Name | Value | Note |
|---|---|---|---|
OBX-3 | Observation ID | 64994-7^Vaccine funding program eligibility category^LN | VFC eligibility category (LOINC) |
OBX-5 | Observation Value | V01^Not VFC eligible^HL70064 |
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.
RXA-20: Completion Status Codes
Section titled “RXA-20: Completion Status Codes”| Code | Status | Meaning |
|---|---|---|
| CP | Complete | The vaccine was fully administered |
| PA | Partially Administered | A partial dose was given |
| RE | Refused | The patient or guardian refused the vaccine |
| NA | Not Administered | The vaccine was not given |
Key Implementation Considerations
Section titled “Key Implementation Considerations”New vs. Historical Records
Section titled “New vs. Historical Records”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.
CVX and MVX Code Sets
Section titled “CVX and MVX Code Sets”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 CDC Immunization Messaging Guide
Section titled “The CDC Immunization Messaging Guide”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.
Acknowledgments and Query Responses
Section titled “Acknowledgments and Query Responses”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.