RTB: Tabular response
This page lists the structures and trigger events RTB defines, taken from the standard. The written commentary that theADT page carries has not been written for RTB.
Recognising RTB messages
RTB announces itself in MSH-9 like this:
RTB^K13^RTB_K13- MSH-9.1
RTBmessage code: what kind of message this is - MSH-9.2
K13trigger event: what happened in the real world - MSH-9.3
RTB_K13message 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
RTB takes 3 structures.
RTB_K13
6 different trigger events send this structure:
The segments below are the same for all 6. HL7 varies the meaning, not the shape: there is no separate RTB_Z76 layout. What changes is MSH-9, which tells the receiver which of the 6 happened and therefore what to do with the message.
You must always send: MSH, MSA, QAK, QPD. Everything else is optional, or required only inside a group you chose to send.
| Segment | Name | OPT | Cardinality |
|---|---|---|---|
| MSH | R | 1..1 | |
| SFT | O | 0..* | |
| MSA | R | 1..1 | |
| ERR | O | 0..1 | |
| QAK | R | 1..1 | |
| QPD | R | 1..1 | |
| ROW_DEFINITION | a group of 2 segments, repeated together | O | 0..1 |
| RDFin ROW_DEFINITION | R | 1..1 | |
| RDTin ROW_DEFINITION | 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: ROW_DEFINITION.
RTB_Knn
No trigger event in the standard names this structure.
RTB_Z74
Sent when one thing happens: Z74: Z74.
| Segment | Name | OPT | Cardinality |
|---|---|---|---|
| MSH | Message Header 2.15. | R | 1..1 |
| MSA | Message Acknowledgement 2.15. | R | 1..1 |
| ERR | Error 2.15. | O | 0..* |
| SFT | Software 2.15. | O | 0..* |
| QAK | Query Acknowledgement 5.5. | R | 1..1 |
| QPD | Query Parameter Definition 5.5. | R | 1..1 |
| ROW_DEFINITION | a group of 2 segments, repeated together | O | 0..1 |
| RDFin ROW_DEFINITION | Table Row Definition Segment 5.5. | R | 1..1 |
| RDTin ROW_DEFINITION | Table Row Data Segment 5.5. | O | 0..* |
| DSC | Continuation Pointer 2.15. | O | 0..1 |
Trigger events
The trigger event is the real-world thing that made the message get sent. RTB defines 7.
| Event | Name | Structure |
|---|---|---|
| K13 | K13 | RTB_K13 |
| Z74 | Z74 | RTB_Z74 |
| Z76 | Z76 | RTB_K13 |
| Z78 | Z78 | RTB_K13 |
| Z92 | Z92 | RTB_K13 |
| Z94 | Z94 | RTB_K13 |
| Z96 | Z96 | RTB_K13 |