VXX: Response for vaccination query with multiple PID matches
This page lists the structures and trigger events VXX defines, taken from the standard. The written commentary that theADT page carries has not been written for VXX.
Recognising VXX messages
VXX announces itself in MSH-9 like this:
MSH-9
VXX^V02^VXX_V02- MSH-9.1
VXXmessage code: what kind of message this is - MSH-9.2
V02trigger event: what happened in the real world - MSH-9.3
VXX_V02message 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
VXX takes 1 structure.
VXX_V02
Sent when one thing happens: V02: V02.
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 | |
| PATIENT | a group of 2 segments, repeated together | R | 1..* |
| PID | R | 1..1 | |
| NK1 | 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 1 such group: PATIENT.
Trigger events
The trigger event is the real-world thing that made the message get sent. VXX defines 1.
| Event | Name | Structure |
|---|---|---|
| V02 | V02 | VXX_V02 |