DOC: Document response
This page lists the structures and trigger events DOC defines, taken from the standard. The written commentary that theADT page carries has not been written for DOC.
Recognising DOC messages
DOC announces itself in MSH-9 like this:
DOC^T12^DOC_T12- MSH-9.1
DOCmessage code: what kind of message this is - MSH-9.2
T12trigger event: what happened in the real world: document query - MSH-9.3
DOC_T12message 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
DOC takes 1 structure.
DOC_T12: Document Query
Sent when one thing happens: T12: Document Query.
You must always send: MSH, MSA, QRD, PID, PV1, TXA. 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 | |
| ERR | O | 0..1 | |
| QAK | O | 0..1 | |
| QRD | R | 1..1 | |
| RESULT | a group of 5 segments, repeated together | R | 1..* |
| EVN | O | 0..1 | |
| PID | R | 1..1 | |
| PV1 | R | 1..1 | |
| TXA | R | 1..1 | |
| OBX | O | 0..* | |
| DSC | O | 0..1 |
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: RESULT.
Trigger events
The trigger event is the real-world thing that made the message get sent. DOC defines 1.
| Event | Name | Structure |
|---|---|---|
| T12 | Document Query | DOC_T12 |