VXR: Vaccination record response
This page lists the structures and trigger events VXR defines, taken from the standard. The written commentary that theADT page carries has not been written for VXR.
Recognising VXR messages
VXR announces itself in MSH-9 like this:
VXR^V03^VXR_V03- MSH-9.1
VXRmessage code: what kind of message this is - MSH-9.2
V03trigger event: what happened in the real world: vaccination record response - MSH-9.3
VXR_V03message structure: which segments to expect, and in what order
How to use these specifications explains MSH-9 in full, with a worked example.
Message structures
VXR takes 1 structure.
VXR_V03: Vaccination Record Response
Sent when one thing happens: V03: Vaccination Record Response.
You must always send: MSH, MSA, QRD, PID. Everything else is optional, or required only inside a group you chose to send.
| Segment | Name | OPT | Cardinality |
|---|---|---|---|
| MSH | R | 1..1 | |
| MSA | R | 1..1 | |
| SFT | O | 0..* | |
| QRD | R | 1..1 | |
| QRF | O | 0..1 | |
| PID | R | 1..1 | |
| PD1 | O | 0..1 | |
| NK1 | O | 0..* | |
| PATIENT_VISIT | a group of 2 segments, repeated together | O | 0..1 |
| PV1in PATIENT_VISIT | R | 1..1 | |
| PV2in PATIENT_VISIT | O | 0..1 | |
| GT1 | O | 0..* | |
| INSURANCE | a group of 3 segments, repeated together | O | 0..* |
| IN1in INSURANCE | R | 1..1 | |
| IN2in INSURANCE | O | 0..1 | |
| IN3in INSURANCE | O | 0..1 | |
| ORDER | a group of 5 segments, repeated together | O | 0..* |
| ORCin ORDER | R | 1..1 | |
| TIMINGin ORDER | a group of 2 segments, repeated together | O | 0..* |
| TQ1in TIMING | R | 1..1 | |
| TQ2in TIMING | O | 0..* | |
| RXAin ORDER | R | 1..1 | |
| RXRin ORDER | O | 0..1 | |
| OBSERVATIONin ORDER | a group of 2 segments, repeated together | O | 0..* |
| OBXin OBSERVATION | R | 1..1 | |
| NTEin OBSERVATION | O | 0..* |
R inside a group means required of that group. Send the group and you must include that segment; leave the group out and it never appears. This structure has 5 such groups: PATIENT_VISIT, INSURANCE, ORDER, TIMING, OBSERVATION.
Trigger events
The trigger event is the real-world thing that made the message get sent. VXR defines 1.
| Event | Name | Structure |
|---|---|---|
| V03 | Vaccination Record Response | VXR_V03 |