OUL: Unsolicited laboratory observation message
This page lists the structures and trigger events OUL defines, taken from the standard. The written commentary that theADT page carries has not been written for OUL.
Recognising OUL messages
OUL announces itself in MSH-9 like this:
OUL^R21^OUL_R21- MSH-9.1
OULmessage code: what kind of message this is - MSH-9.2
R21trigger event: what happened in the real world: unsolicited laboratory observation message - MSH-9.3
OUL_R21message 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
OUL takes 4 structures.
OUL_R21: Unsolicited Laboratory Observation Message
Sent when one thing happens: R21: Unsolicited Laboratory Observation Message.
You must always send: MSH, OBR. 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..* | |
| NTE | O | 0..1 | |
| PATIENT | a group of 3 segments, repeated together | O | 0..1 |
| PIDin PATIENT | R | 1..1 | |
| PD1in PATIENT | O | 0..1 | |
| NTEin PATIENT | O | 0..* | |
| VISIT | a group of 2 segments, repeated together | O | 0..1 |
| PV1in VISIT | R | 1..1 | |
| PV2in VISIT | O | 0..1 | |
| ORDER_OBSERVATION | a group of 7 segments, repeated together | R | 1..* |
| CONTAINER | a group of 2 segments, repeated together | O | 0..1 |
| SACin CONTAINER | R | 1..1 | |
| SIDin CONTAINER | O | 0..1 | |
| ORC | O | 0..1 | |
| OBR | R | 1..1 | |
| NTE | O | 0..* | |
| TIMING_QTY | a group of 2 segments, repeated together | O | 0..* |
| TQ1in TIMING_QTY | R | 1..1 | |
| TQ2in TIMING_QTY | O | 0..* | |
| OBSERVATION | a group of 4 segments, repeated together | R | 1..* |
| OBX | O | 0..1 | |
| TCD | O | 0..1 | |
| SID | O | 0..* | |
| NTE | O | 0..* | |
| CTI | 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 6 such groups: PATIENT, VISIT, ORDER_OBSERVATION, CONTAINER, TIMING_QTY, OBSERVATION.
OUL_R22: Unsolicited Specimen Oriented Observation Message –
Sent when one thing happens: R22: Unsolicited Specimen Oriented Observation Message –.
You must always send: MSH, SPM, OBR. 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..* | |
| NTE | O | 0..1 | |
| PATIENT | a group of 3 segments, repeated together | O | 0..1 |
| PIDin PATIENT | R | 1..1 | |
| PD1in PATIENT | O | 0..1 | |
| NTEin PATIENT | O | 0..* | |
| VISIT | a group of 2 segments, repeated together | O | 0..1 |
| PV1in VISIT | R | 1..1 | |
| PV2in VISIT | O | 0..1 | |
| SPECIMEN | a group of 4 segments, repeated together | R | 1..* |
| SPM | R | 1..1 | |
| OBX | O | 0..* | |
| CONTAINER | a group of 2 segments, repeated together | O | 0..* |
| SACin CONTAINER | R | 1..1 | |
| INVin CONTAINER | O | 0..1 | |
| ORDER | a group of 6 segments, repeated together | R | 1..* |
| OBR | R | 1..1 | |
| ORC | O | 0..1 | |
| NTE | O | 0..* | |
| TIMING_QTY | a group of 2 segments, repeated together | O | 0..* |
| TQ1in TIMING_QTY | R | 1..1 | |
| TQ2in TIMING_QTY | O | 0..* | |
| RESULT | a group of 4 segments, repeated together | O | 0..* |
| OBXin RESULT | R | 1..1 | |
| TCDin RESULT | O | 0..1 | |
| SIDin RESULT | O | 0..* | |
| NTEin RESULT | O | 0..* | |
| CTI | 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 7 such groups: PATIENT, VISIT, SPECIMEN, CONTAINER, ORDER, TIMING_QTY, RESULT.
OUL_R23
Sent when one thing happens: R23: R23.
You must always send: MSH, SPM, SAC, OBR. 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..* | |
| NTE | O | 0..1 | |
| PATIENT | a group of 3 segments, repeated together | O | 0..1 |
| PIDin PATIENT | R | 1..1 | |
| PD1in PATIENT | O | 0..1 | |
| NTEin PATIENT | O | 0..* | |
| VISIT | a group of 2 segments, repeated together | O | 0..1 |
| PV1in VISIT | R | 1..1 | |
| PV2in VISIT | O | 0..1 | |
| SPECIMEN | a group of 3 segments, repeated together | R | 1..* |
| SPM | R | 1..1 | |
| OBX | O | 0..* | |
| CONTAINER | a group of 3 segments, repeated together | R | 1..* |
| SAC | R | 1..1 | |
| INV | O | 0..1 | |
| ORDER | a group of 6 segments, repeated together | R | 1..* |
| OBR | R | 1..1 | |
| ORC | O | 0..1 | |
| NTE | O | 0..* | |
| TIMING_QTY | a group of 2 segments, repeated together | O | 0..* |
| TQ1in TIMING_QTY | R | 1..1 | |
| TQ2in TIMING_QTY | O | 0..* | |
| RESULT | a group of 4 segments, repeated together | O | 0..* |
| OBXin RESULT | R | 1..1 | |
| TCDin RESULT | O | 0..1 | |
| SIDin RESULT | O | 0..* | |
| NTEin RESULT | O | 0..* | |
| CTI | O | 0..* | |
| DSC | O | 0..1 |
OUL_R24: Unsolicited Order Oriented Observation Message –
Sent when one thing happens: R24: Unsolicited Order Oriented Observation Message –.
| Segment | Name | OPT | Cardinality |
|---|---|---|---|
| MSH | R | 1..1 | |
| SFT | O | 0..* | |
| NTE | O | 0..1 | |
| PATIENT | a group of 3 segments, repeated together | O | 0..1 |
| PIDin PATIENT | R | 1..1 | |
| PD1in PATIENT | O | 0..1 | |
| NTEin PATIENT | O | 0..* | |
| VISIT | a group of 2 segments, repeated together | O | 0..1 |
| PV1in VISIT | R | 1..1 | |
| PV2in VISIT | O | 0..1 | |
| ORDER | a group of 7 segments, repeated together | R | 1..* |
| OBR | R | 1..1 | |
| ORC | O | 0..1 | |
| NTE | O | 0..* | |
| TIMING_QTY | a group of 2 segments, repeated together | O | 0..* |
| TQ1in TIMING_QTY | R | 1..1 | |
| TQ2in TIMING_QTY | O | 0..* | |
| SPECIMEN | a group of 3 segments, repeated together | O | 0..* |
| SPMin SPECIMEN | R | 1..1 | |
| OBXin SPECIMEN | O | 0..* | |
| CONTAINERin SPECIMEN | a group of 2 segments, repeated together | O | 0..* |
| SACin CONTAINER | R | 1..1 | |
| INVin CONTAINER | O | 0..1 | |
| RESULT | a group of 4 segments, repeated together | O | 0..* |
| OBXin RESULT | R | 1..1 | |
| TCDin RESULT | O | 0..1 | |
| SIDin RESULT | O | 0..* | |
| NTEin RESULT | O | 0..* | |
| CTI | 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 7 such groups: PATIENT, VISIT, ORDER, TIMING_QTY, SPECIMEN, CONTAINER, RESULT.
Trigger events
The trigger event is the real-world thing that made the message get sent. OUL defines 4.
| Event | Name | Structure |
|---|---|---|
| R21 | Unsolicited Laboratory Observation Message | OUL_R21 |
| R22 | Unsolicited Specimen Oriented Observation Message – | OUL_R22 |
| R23 | R23 | OUL_R23 |
| R24 | Unsolicited Order Oriented Observation Message – | OUL_R24 |