Table of Contents |
---|
4.1 Purpose
This section describes the transaction set required for sending structured patient-oriented clinical data from one computer system to another. A common use of these transaction sets will be to transmit observations and results of diagnostic studies from the producing system (e.g., clinical 4.4.1.4.1 laboratory system, Radiology system) (the filler), to the ordering syste4.4.1.25 OBR-25 Result status (ID) 00258m system (e.g., GP Surgery, specialists office system) (the placer). However, the transaction set is not limited to such transactions. Observations can be sent from producing systems to archival medical record systems (not necessarily the order placer) and from such medical record systems to other systems that were not part of the ordering loop, e.g., an office practice system of the referring physician for inpatient test results ordered by an inpatient surgeon. These transaction sets permit the transmission of any kind of clinical observations including (but not limited to) clinical laboratory results, the results of imaging studies (excluding the image), Pulmonary function studies, measures of patient status and condition, vital signs, intake and output, severity and/or frequency of symptoms, drug allergies, problem lists, diagnostic lists, physician and nursing history, physicals, progress notes, operative notes and so on. An observation can be one of many data types. The main ones are text, numbers and codes. This provides the flexibility needed to transmit observations that are recorded as continuous values (e.g., glucose, diastolic blood pressure), as categorical values, e.g., patient position (sitting, reclining or standing), VDRL (reactive, weakly reactive or nonreactive), or as text. An entire History and Physical could be transmitted as an observation whose value is one large chunk of formatted text.
...
The triggering events that follow are all served by the ORU (Observational report – Unsolicited) or the ORF (Observational Report Response) messages in combination with ACK and QRY. Only the ORU messsage message is covered in the Australian localisation and some of the optional segments have been removed.
...
The ORU^R01 message is sent out by the laboratory and in respose response a ACK^R01 message should be produced to confirm receipt of the ORU message. The structure of the ACK message is as below:
...
The OBR segments confirm the status and completion of the ordered tests back to the placer allowing the placer to check off each test ordered as it is received. The OBR segments do not contain the results or when the results will be available. However, the structure of the OBR and OBX segments in the ORU can reflect the specimen used to determine the results e.g. specimen ID.
HL7 Attribute Table – OBR – Observation Request
SEQ | LEN | DT | OPT | RP/# | TBL# | ITEM# | ELEMENT NAME |
---|---|---|---|---|---|---|---|
1 | 4 | SI | C | 00237 | Set ID - OBR | ||
2 | 250** | EI | C | 00216 | Placer Order Number | ||
3 | 250** | EI | C | 00238 | Filler Order Number | ||
4 | 250 | CE | R | 00238 | Universal Service Identifier | ||
7 | 26 | TS | C | 00241 | Observation Date/Time # | ||
8 | 26 | TS | O | 00242 | Observation End Date/Time # | ||
9 | 250*** | CQ | O | 00243 | Collection Volume * | ||
10 | 250 | XCN | O | Y | 00244 | Collector Identifier * | |
11 | 1 | ID | O | 0065 | 00245 | Specimen Action Code * | |
12 | 250 | CE | O | 00246 | Danger Code | ||
13 | 300 | ST | O | 00247 | Relevant Clinical Info | ||
14 | 26 | TS | C | 00248 | Specimen Received date/Time * | ||
15 | 300 | CM | O | 0070 | 00249 | Specimen Source * | |
16 | 250 | XCN | C**** | Y | 00226 | Ordering Provider | |
17 | 250 | XTN | O | Y/2 | 00250 | Order Callback Phone Number | |
18 | 60 | ST | O | Y**** | 00251 | Placer Field 1 | |
19 | 60 | ST | O | Y**** | 00252 | Placer Field 2 | |
20 | 60 | ST | O | Y**** | 00253 | Filler Field 1 † | |
21 | 60 | ST | O | Y**** | 00254 | Filler Field 2 † | |
22 | 26 | TS | C | 00255 | Results Rpt/Status Chng - Date/Time † | ||
23 | 40 | CM | O | 00256 | Charge to Practice † | ||
24 | 10 | ID | R | 0074 | 00257 | Diagnostic Serv Section ID | |
25 | 1 | ID | C | 0123 | 00258 | Result Status † | |
27 | 200 | TQ | O | Y | 00221 | Quantity/Timing | |
28 | 250 | XCN | O | Y**** | 00260 | Result Copies To | |
30 | 20 | ID | O | 0124 | 00262 | Transportation Mode | |
31 | 250 | CE | O | Y | 00263 | Reason for Study | |
32 | 200 | CM | O | 00264 | Principle Result Interpreter † | ||
33 | 200 | CM | O | Y | 00265 | Assistant Result Interpreter † | |
34 | 200 | CM | O | Y | 00266 | Technician † | |
35 | 200 | CM | O | Y | 00267 | Transcriptionist † | |
36 | 26 | TS | O | 00268 | Scheduled date/Time † | ||
37 | 4 | NM | O | 01028 | Number of Sample Containers * | ||
38 | 250 | CE | O | Y | 01029 | Transport Logistics of Collected Sample * | |
39 | 250 | CE | O | Y | 01030 | CollectorsCollector's Comment | |
40 | 250 | CE | O | 01031 | Transport Arrangement ResponsabilityResponsibility | ||
41 | 30 | ID | O | 0224 | 01032 | Transport Arranged | |
42 | 1 | ID | O | 0225 | 01033 | Escort Required | |
43 | 250 | CE | O | Y | 01034 | Planned Patient transport Comment | |
44 | 250 | CE | O | 0088 | 00393 | Procedure Code | |
45 | 250 | CE | O | Y | 0340 | 01316 | Procedure Code Modifier |
46 | 250 | CE | O | Y | 0411 | 01474 | Placer Supplemental Service Information |
47 | 250 | CE | O | Y | 0411 | 01475 | Filler Supplemental Service Information |
...
OBR-28 Repeat is NOT restricted to 5 copy doctors in this specification as it is in the HL7 International specification.
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
4.4.1.1 OBR-1 Set ID - OBR (SI) 00237
Definition: For the first order transmitted, the sequence number shall be 1; for the second order, it shall be 2; and so on. This field is required if more than one OBR segment is sent with the order.
Anchor | ||||
---|---|---|---|---|
|
Anchor | ||||
---|---|---|---|---|
|
4.4.1.2 OBR-2 Placer order number (EI) 00216
...
Since third party providers at another site (those other than the placer and filler of an order) can send and receive ORM and ORR messages (ie i.e. create orders), the placer site ID in this field may not be the same as any sending and receiving HDs (as identified in the MSH segment).
...
Definition: This field is the order number associated with the filling application. It is a case of the Entity Identifier data type (See Datatypes, “EI - Entity Identifier”). Its first component is a string that identifies an order detail segment (e.g., OBR). It is assigned by the order filler application. This string must uniquely identify the order (as specified in the order detail segment) from other orders in a particular filling application (e.g., clinical laboratory). This uniqueness must persist over time. The second through fourth components contain the the original authoring filler site ID, in the form of the HD data type (see Datatypes, “HD - hierarchic designator”). The second component of the filler order number always identifies the actual filler of an order. Since third party sites/applications (those other than the placer and filler of an order) can send and receive ORM and ORR messages, the filler application ID in this field may not be the same as any sending and receiving application HDs (as identified in the MSH segment).
...
Definition: This field is the identifier code for the requested observation/test/battery. This can be based on local and/or “universal” codes. We recommend the “universal” procedure identifier if available (eg e.g. SNOMED-CT).
This field is used for the requested service. The RCPA Board approved Requesting Pathology Terminology Reference Set is available on the RCPA website.
...
In referral messages the referral summary is indicated by the OBR-4 code, which should be either a child concept of the SNOMED CT-AU concept 373942005 Discharge Summary (record artifact), for hospital discharge or a child of 3457005 | Patient referral (procedure) for provider to provider referral. This OBR/OBX group should contain the VMR data if available. Senders may include older referrals in a REF message but the current referral must appear as the first OBR/OBX group. A initial candidate set of record artifact decended descended codes has been submitted to the Australian Digital Health Agency
...
Subcomponents of units: <identifier (ST)> & <test (ST)> & <name of coding system (IS)> & <alternate identifier (ST)> & <alternate text (ST)> & <name of alternate coding system (IS)>
Definition: For laboratory tests, the collection volume is the volume of a specimen. The default unit is ML. Specifically, units should be expressed using UCUM (unitsofmeasure.org). This is a results-only field except when the placer or a party has already drawn the specimen.
...
Definition: This field is the action to be taken with respect to the specimens that accompany or precede this order. The purpose of this field is to further qualify (when appropriate) the general action indicated by the order control code contained in the accompanying ORC segment. For example, when a new order (ORC - “NW”) is sent to the lab, this field would be used to tell the lab whether or not to collect the specimen (“L” or “O”).
Anchor table0065 table0065
HL7 Table 0065 - Specimen Action Code
Value | Description |
---|---|
A | Add ordered tests to the existing Specimen |
G | Generated order; reflex order |
L | lab to obtain specimen from patient |
O | Specimen obtained by service other than Lab |
P | Pending specimen; Order sent prior to delivery |
R | Revised order |
S | Schedule the test specified below |
...
Snomed-CT AU is a recommended source terminology for this field.
ege.g. 71837009^Cytotoxic agent (product)^SCT
...
SNOMED-CT AU is recommended as a terminology source this field. e.g. 122575003&Urine Specimen&SCT
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0070 – Specimen source codes
Value | Description |
---|---|
ABS | Abscess |
AMN | Amniotic fluid |
ASP | Aspirate |
BPH | Basophils |
BIFL | Bile fluid |
BLDA | Blood arterial |
BBL | Blood bag |
BLDC | Blood capillary |
BPU | Blood product unit |
BLDV | Blood venous |
BON | Bone |
BRTH | Breath (use EXHLD) |
BRO | Bronchial |
BRN | Burn |
CALC | Calculus (=Stone) |
CDM | Cardiac muscle |
CNL | Cannula |
CTP | Catheter tip |
CSF | Cerebral spinal fluid |
CVM | Cervical mucus |
CVX | Cervix |
COL | Colostrum |
BLDCO | Cord blood |
CNJT | Conjunctiva |
CUR | Curettage |
CYST | Cyst |
DIAF | Dialysis fluid |
DOSE | Dose med or substance |
DRN | Drain |
EAR | Ear |
EARW | Ear wax (cerumen) |
ELT | Electrode |
ENDC | Endocardium |
ENDM | Endometrium |
EOS | Eosinophils |
RBC | Erythrocytes |
EYE | Eye |
EXG | Exhaled gas (=breath) |
FIB | Fibroblasts |
FLT | Filter |
FIST | Fistula |
FLU | Body fluid, unsp |
GAS | Gas |
GAST | Gastric fluid/contents |
GEN | Genital |
GENC | Genital cervix |
GENL | Genital lochia |
GENV | Genital vaginal |
HAR | Hair |
IHG | Inhaled Gas |
IT | Intubation tube |
ISLT | Isolate |
LAM | Lamella |
WBC | Leukocytes |
LN | Line |
LNA | Line arterial |
LNV | Line venous |
LIQ | Liquid NOS |
LYM | Lymphocytes |
MAC | Macrophages |
MAR | Marrow |
MEC | Meconium |
MBLD | Menstrual blood |
MLK | Milk |
MILK | Breast milk |
NAIL | Nail |
NOS | Nose (nasal passage) |
ORH | Other |
PAFL | Pancreatic fluid |
PAT | Patient |
PRT | Peritoneal fluid /ascites |
PLC | Placenta |
PLAS | Plasma |
PLB | Plasma bag |
PLR | Pleural fluid (thoracentesis fld) |
PMN | Polymorphonuclear neutrophils |
PPP | Platelet poor plasma |
PRP | Platelet rich plasma |
PUS | Pus |
RT | Route of medicine |
SAL | Saliva |
SMN | Seminal fluid |
SER | Serum |
SKN | Skin |
SKM | Skeletal muscle |
SPRM | Spermatozoa |
SPT | Sputum |
SPTC | Sputum - coughed |
SPTT | Sputum - tracheal aspirate |
STON | Stone (use CALC) |
STL | Stool = Fecal |
SWT | Sweat |
SNV | Synovial fluid (Joint fluid) |
TEAR | Tears |
THRT | Throat |
THRB | Thrombocyte (platelet) |
TISS | Tissue |
TISG | Tissue gall bladder |
TLGI | Tissue large intestine |
TLNG | Tissue lung |
TISPL | Tissue placenta |
TSMI | Tissue small intestine |
TISU | Tissue ulcer |
TUB | Tube NOS |
ULC | Ulcer |
UMB | Umbilical blood |
UMED | Unknown medicine |
URTH | Urethra |
UR | Urine |
URC | Urine clean catch |
URT | Urine catheter |
URNS | Urine sediment |
USUB | Unknown substance |
VITF | Vitreous Fluid |
VOM | Vomitus |
BLD | Whole blood |
BDY | Whole body |
WAT | Water |
WICK | Wick |
WND | Wound |
WNDA | Wound abscess |
WNDE | Wound exudate |
WNDD | Wound drainage |
XXX | To be specified in another part of the message |
The second component should include free text additives to the specimen such as Heparin, EDTA, or Oxlate, when applicable.
...
The fourth component specifies the body site from which the specimen was obtained, and the fifth is the site modifier. For example, the site could be antecubital fossa, and the site modifier “right.” The components of the CE fields become subcomponents. Refer to HL7 Table 0163 – - Body site. SNOMED-CT AU is recommended as a terminology source this field. e.g. 64033007&kidney structure&SCT
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0163 – Body site
Value | Description |
---|---|
BE | Bilateral Ears |
OU | Bilateral Eyes |
BN | Bilateral Nares |
BU | Buttock |
CT | Chest Tube |
LA | Left Arm |
LAC | Left Anterior Chest |
LACF | Left Antecubital Fossa |
LD | Left Deltoid |
LE | Left Ear |
LEJ | Left External Jugular |
OS | Left Eye |
LF | Left Foot |
LG | Left Gluteus Medius |
LH | Left Hand |
LIJ | Left Internal Jugular |
LLAQ | Left Lower Abd Quadrant |
LLFA | Left Lower Forearm |
LMFA | Left Mid Forearm |
LN | Left Naris |
LPC | Left Posterior Chest |
LSC | Left Subclavian |
LT | Left Thigh |
LUA | Left Upper Arm |
LUAQ | Left Upper Abd Quadrant |
LUFA | Left Upper Forearm |
LVG | Left Ventragluteal |
LVL | Left Vastus Lateralis |
NB | Nebulized |
PA | Perianal |
PERIN | Perineal |
RA | Right Arm |
RAC | Right Anterior Chest |
RACF | Right Antecubital Fossa |
RD | Right Deltoid |
RE | Right Ear |
REJ | Right External Jugular |
OD | Right Eye |
RF | Right Foot |
RG | Right Gluteus Medius |
RH | Right Hand |
RIJ | Right Internal Jugular |
RLAQ | Rt Lower Abd Quadrant |
RLFA | Right Lower Forearm |
RMFA | Right Mid Forearm |
RN | Right Naris |
RPC | Right Posterior Chest |
RSC | Right Subclavian |
RT | Right Thigh |
RUA | Right Upper Arm |
RUAQ | Right Upper Abd Quadrant |
RUFA | Right Upper Forearm |
RVL | Right Vastus Lateralis |
RVG | Right Ventragluteal |
...
The ST field is encoded with repeating name=value pairs separated by commas. e. egg. |name=value,name=value,name=value|
...
When transmitted all reserved HL7 delimiters must be escaped and the OBR-20 ST result extracted, unescaped and then parsed as a comma separated name=value pairs.
ege.g. |LN=2016-1234-XYZ\T\LBA| is extracted as LN=2016-1234-XYZ&LBA
...
Definition: This field is the section of the diagnostic service where the observation was performed. If the study was performed by an outside service, the identification of that service should be recorded here.
Refer to HL7 Table 0074 - Diagnostic service section ID for for valid entries. This field is required in Australian implementations to indicate to the placer system which clinical area to display the results.
Anchor table0074 table0074
HL7 Table 0074 - Diagnostic service section ID
Value | Description |
---|---|
AU | Audiology |
BG | Blood Gases |
BLB | Blood Bank |
CG | Cytogenetics |
CUS | Cardiac Ultrasound |
CTH | Cardiac Catheterization |
CT | CAT Scan |
CH | Chemistry |
CP | Cytopathology |
EC | Electrocardiac (e.g. ECG, EEC, Holter) |
EN | Electroneuro |
GE † | Genetics |
HM | Haematology |
ICU | Bedside ICU Monitoring |
IMM | Immunology |
LAB | Laboratory (for multiple departments within the same OBR). |
MB | Microbiology |
MCB | Mycobacteriology |
MYC | Mycology |
NMR | Nuclear Magnetic Resonance |
NMS | Nuclear Medicine Scan |
NRS | Nursing Services MeasureszMeasures |
OUS | OB Ultrasound |
OT | Occupational Therapy |
OTH | Other |
OSL | Outside Lab |
PHR | Pharmacy |
PT | Physical Therapy |
PHY | Physician (Hx. Dx, admission note, etc) |
PF | Pulmonary Function |
RAD | Radiology |
RUS | Radiology Ultrasound |
RC | Respiratory Care (therapy) |
RT | Radiation Therapy |
RX | Radiograph |
SR | Serology |
SP | Histology and Anatomical Pathology |
TX | Toxicology |
VUS | Vascular Ultrasound |
VR | Virology |
XRC | Cineradiograph |
...
Note: † An Australian extension to the the laboratory department code.
...
There are two methods of sending status information. If the status is that of the entire order, use ORC-15- order effective date/time and ORC-5-order status. If the status pertains to the order detail segment, use OBR-25-result status and OBR-22-results report/status change - date/time. If both are present, the OBR values override the ORC values. This field would typically be used in a response to an order status query where the level of detail requested does not include the OBX segments. When the individual status of each result is necessary, OBX-11- observ result status may be used. In the Australian environment, when any part of a report is corrected, a complete report, containing all the OBX segments should be transmitted with an OBR-25 status of 'C'. The individually updated OBX segments can be flagged with their own result status in OBX-11.
Refer to HL7 Table 0123 - Result status for valid OBR Result Status entries.
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0123 - Result status
Value | Description |
---|---|
O | Order received; specimen not yet received |
I | No results available; specimen received, procedure incomplete |
S | No results available; procedure scheduled, but not done |
A | Some, but not all, results available |
P | Preliminary: A verified early result is available, final results not yet obtained |
C | Correction to results |
R | Results stored; not yet verified |
F | Final results; results stored and verified. Can only be changed with a corrected result. |
X | No results available; Order canceled. |
Y | No order on record for this test. (Used only on queries) |
Z | No record of this patient. (Used only on queries) |
...
Definition: This field identifies how (or whether) to transport a patient, when applicable. Refer to HL7 Table 0124 - Transportation mode for valid codes.
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0124 - Transportation mode
Value | Description |
---|---|
CART | Cart - patient travels on cart or gurney |
PORT | The examining device goes to patient's location |
WALK | Patient walks to diagnostic service |
WHLC | Wheelchair |
...
Snomed-CT AU is a recommended source terminology for this field.
ege.g. 274640006^Fever with chills (finding)^SCT
...
e.g. 161156004^Language difficulty (finding)^SCT161156004 | Lang161156004 | Language difficulty (finding)uage difficulty (finding)
Anchor | ||||
---|---|---|---|---|
|
4.4.1.40 OBR-40 Transport arrangement responsibility (CE) 01031
...
Definition: This field is an indicator of whether transport arrangements are known to have been made.
Refer to HL7 Table 0224 - Transport arranged for valid codes.
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0224 - Transport arranged
Value | Description |
---|---|
A | Arranged |
N | Not Arranged |
U | Unknown |
...
Definition: This field is an indicator that the patient needs to be escorted to the diagnostic service department. Note: The nature of the escort requirements should be stated in the OBR-43-planned patient transport comment field. See
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0225 - Escort required
Value | Description |
---|---|
R | Required |
N | Not Required |
U | Unknown |
...
Definition: This field contains a unique identifier assigned to the procedure, if any, associated with the Universal Service ID reported in field 4. User-defined Table 0088 - Procedure code is used as the HL7 identifier for the user-defined table of values for this field. This field is a CE data type for compatibility with clinical and ancillary systems.
Anchor | ||||
---|---|---|---|---|
|
User-defined Table 0088 - Procedure code
Value | Description |
---|---|
No suggested values defined |
...
Definition: This field contains the procedure code modifier to the procedure code reported in field 44, when applicable. Procedure code modifiers are defined by regulatory agencies. Multiple modifiers may be reported. User-defined Table 0088 - Procedure code is used as the HL7 identifier for the user-defined table of values for this field.
...
Definition: This field contains supplemental service information sent from the placer system to the filler system for the universal procedure code reported in OBR-4 Universal Service ID. This field will be used to provide ordering information detail that is not available in other, specific fields in the OBR segment. Multiple supplemental service information elements may be reported. Refer to User-defined table 0411 - Supplemental service information values for suggested values. This field can be used to describe details such as whether study is to be done on the right or left, for example where the study is of the arm and the order master file does not distinguish right from left or whether the study is to be done with or without contrast (when the order master file does not make such distinctions).
...
Anchor | ||||
---|---|---|---|---|
|
User-defined Table 0411 - Supplemental service information values
Value | Description |
---|---|
1ST | First |
2ND | Second |
3RD | Third |
4TH | Fourth |
5TH | Fifth |
ANT | Anterior |
A/P | Anterior/Posterior |
BLT | Bilateral |
DEC | Decubitus |
DST | Distal |
LAT | Lateral |
LFT | Left |
LLQ | Left Lower Quadrant |
LOW | Lower |
LUQ | Left Upper Quadrant |
MED | Medial |
OR | Operating Room |
PED | Pediatric |
POS | Posterior |
PRT | Portable |
PRX | Proximal |
REC | Recumbent |
RLQ | Right Lower Quadrant |
RGH | Right |
RUQ | Right upper Quadrant |
UPP | Upper |
UPR | UpwrightUpright |
WCT | With Contrast |
WOC | Without Contrast |
WSD | With Sedation |
...
Following the final atomic OBX segment are the OBX display segment(s) with the presented report. There must be at least one display segment per OBR segment and where there is more than one display type it must contain the same report detail. If there is a digital signature it will appear after the OBX display segments.
HL7 Attribute Table – OBX – Observation/Result
SEQ | LEN | DT | OPT | RP# | TBL# | ITEM# | ELEMENT NAME |
---|---|---|---|---|---|---|---|
1 | 4 | SI | O | 00569 | Set ID - OBX | ||
2 | 3** | ID | C | 0125 | 00570 | Value Type | |
3 | 250 | CE | R | 00571 | Observation Identifier | ||
4 | 20 | ST | C | 00572 | Observation Sub-ID | ||
5 | 16 MB† | * | C | Y | 00573 | Observation Value | |
6 | 250 | CE | O | 00574 | Units | ||
7 | 60 | ST | O | 00575 | References Range | ||
8 | 5 | IS | O | Y/5 | 0078 | 00576 | Abnormal Flags |
9 | 5 | NM | O | 00577 | Probability | ||
10 | 2 | ID | O | Y | 0080 | 00578 | Nature of Abnormal Test |
11 | 1 | ID | R | 0085 | 00579 | Observation Result Status | |
12 | 26 | TS | O | 00580 | Date last Observation Normal value | ||
13 | 20 | ST | O | 00581 | User Defined Access Checks | ||
14 | 26 | TS | O | 00582 | Date/Time of the Observation | ||
15 | 250 | CE | O | 00583 | Producers ID | ||
16 | 250 | XCN | O | Y | 00584 | Responsible Observer | |
17 | 250 | CE | O | Y | 00936 | Observation Method | |
18 | 250*** | EI | O | Y | 01479 | Equipment Instance Identifier | |
19 | 26 | TS | O | 01480 | Date/Time of the Analysis |
...
All HL7 data types are valid, and are included in Table 0125 except CM, CQ, SI, and ID. For a CM definition to have meaning, the specifics about the CM must be included in the field definition. OBX-5- observation value is a general field definition that is influenced by the data type OBX-3, so CMs are undefined in this context. CQ is invalid because units for OBX-5-observation value are always specified explicitly in an OBX segment with OBX-6 units. SI is invalid because it only applied to HL7 message segments, and ID because it requires a constant field definition. The RP value (reference pointer) must be used if the actual observation value is not sent in OBX but exists somewhere else. For example, if the observation consists of an image (document or medical), the image itself may not necessarily be sent in OBX. The sending system may in that case opt to send a reference pointer. The receiving system can use this reference pointer whenever it needs access to the actual image through other interface standards, e.g., DICOM, or through appropriate servers.
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0125 - Value type
Value | Description |
---|---|
CE | Coded Entry |
CNE | Coded with no exceptions |
CWE | Coded with exceptions |
CF | Coded Element with Formatted values |
CK | Composite ID With Check Digit |
CN | Composite ID And Name |
CP | Composite Price |
CX | Extended Composite ID With Check Digit |
DR | Date/Time Range |
DT | Date |
ED | Encapsulated Data |
EI | Enitity Entity Identifier |
FT | Formatted Text (Display) |
MO | Money |
NM | Numeric |
RP | Reference Pointer |
SN | Structured Numeric |
ST | String Data. |
TM | Time |
TS | Time Stamp (Date & Time) |
XAD | Extended Address |
XCN | Extended Composite Name And Number For Persons |
XON | Extended Composite Name And Number For Organizations |
XPN | Extended Person Name |
XTN | Extended Telecommunications Number |
...
When local codes are used as the first identifier in this field we strongly encourage sending a universal identifier as well to permit receivers to equivalence results from different providers of the same service (e.g., a hospital lab and commercial lab that provides serum potassium to a nursing home). LOINC® is an HL7 approved code system for the Observation identifier. It covers observations and measurements, such as laboratory tests, physical findings, radiology studies, and claims attachments and can be obtained from loinc.org. LOINC codes, selected by the RCPA for Standards for Pathology Informatics in Australia (SPIA) reporting terminology reference sets which can be obtained at RCPA website or from the National Clinical Terminology Service.
...
On occasions no code will be defined or available and only the text component of the CE will be valued. Where a coded term exists in a standard terminology then the identifer identifier and coding system name component should be valued.
...
Definition: This field contains a table lookup indicating the normalcy status of the result. We strongly recommend sending this value when applicable. (See ASTM 1238 - review for more details). Refer to User-defined Table 0078 - Abnormal flags for valid entries.
When the laboratory can discern the normal status of a textual report, such as chest X-ray reports or microbiologic culture, these should be reported as N when normal and A when abnormal. Multiple codes, e.g., abnormal and worse, would be separated by a repeat delimiter, e.g., A~W.
Anchor | ||||
---|---|---|---|---|
|
User-defined Table 0078 - Abnormal flags
Value | Description |
---|---|
In the Australian context the three-tier scale is: | |
+ | At least one level above normal limit |
++ | Two levels above |
+++ | Three levels above |
- | At least one level below normal limit |
-- | Two levels below |
--- | Three levels below |
In the Australian context the two-tier scale is: | |
L | Below low normal |
H | Above high normal |
LL | Below lower panic limits |
HH | Above upper panic limits |
For Microbiology use: | |
S | Susceptible. Indicates for microbiology susceptibilities only. |
R | Resistant. Indicates for microbiology susceptibilities only. |
I | Intermediate. Indicates for microbiology susceptibilities only. |
For non-numeric results: | |
A | Abnormal (applies to non-numeric results) |
N | Normal (applies to non-numeric results) |
...
Definition: This field contains the nature of the abnormal test. Refer to HL7 Table 0080 - Nature of abnormal testing for valid values. As many of the codes as apply may be included, separated by repeat delimiters. For example, normal values based on age, sex, and race would be codes as A~S~R.
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0080 - Nature of abnormal testing
Value | Description |
---|---|
A | An age-based population |
N | None - generic normal range |
R | A race-based population |
S | A sex-based population |
...
Definition: This field contains the observation result status.
Refer to HL7 table 0085 - Observation result status codes interpretation for valid values.
This field reflects the current completion status of the results for one Observation Identifier. It is a required field. Previous versions of HL7 stated this implicitly by defining a default value of “F.” Code F indicates that the result has been verified to be correct and final. Code W indicates that the result has been verified to be wrong (incorrect); a replacement (corrected) result may be transmitted later. Code C indicates that data contained in the OBX-5-observation value field are to replace previously transmitted (verified and) final result data with the same observation ID (including suffix, if applicable) and observation sub-ID usually because the previous results were wrong. Code D indicates that data previously transmitted in a result segment with the same observation ID (including suffix) and observation sub-ID should be deleted.
...
Multiple preliminary results may be reported at different observation times. e.g. a microbiology culture.
Anchor | ||||
---|---|---|---|---|
|
HL7 Table 0085 - Observation result status codes interpretation
Value | Description |
---|---|
C | Record coming over is a correction and thus replaces a final result |
D | Deletes the OBX record |
F | Final results; Can only be changed with a corrected result. |
I | Specimen in lab; results pending |
N | Not asked; used to affirmatively document that the observation identified in the OBX was not sought when the universal service ID in OBR-4 implies that it would be sought. |
O | Order detail description only (no result) |
P | Preliminary results |
R | Results entered -- not verified |
S | Partial results |
X | Results cannot be obtained for this observation |
U | Results status change to final without retransmitting results already sent as ‘preliminary.’ E.g., radiology changes status from preliminary to final |
W | Post original as wrong, e.g., transmitted for wrong patient |
...
See conformance points section HL7au:000008.
Display Format codes Anchor DisplayFormatCodesTable DisplayFormatCodesTable
Identifier (ST) | Text (ST)* | Name of Coding System (IS) | OBX Value Type |
---|---|---|---|
RTF | Display Format in RTF | AUSPDI | ED |
HTML | Display Format in HTML | AUSPDI | ED |
Display Format in PDF | AUSPDI | ED | |
TXT | Display Format in Text | AUSPDI | FT |
...
For receivers, when a display segment is shown, earlier atomic OBX segments should not be rendered (See HL7au:000008.1.6). Where there is one or more display segments available only one should be visible at a time, however the system must allow users to access the alternative formats provided. See HL7au:000008.1.1.
4.5.1 Using the PIT display format
...
4.5.3 Using the HTML display Format
The html HTML format uses xhtml XHTML and the details regarding the format of the html are given in the Appendix. xHTML XHTML display data should be base64 encoded in an ED segment. The xhtml XHTML should be valid xml. Any html HTML display segment SHOULD be displayed with a compliant browser control. These are available of virtually all platforms an ensure reliable display of compliant xhtmlXHTML. When handled correctly xhtml XHTML is the most inter-operable of all formats.
...
NTE segments are not used in the Australian setting but comments about individual results (A single OBX) or a report (All OBX segments under a OBR Segment) are supported by the use of OBX segments with specific LOINC codes. Result Comments are in an OBX segment immediately following the result OBX and report comments are contained in an OBX segment at the end of the report but before the display orientated OBX segments detailed in Section 4.5. The LOINC code in a Comment OBX Segment (In OBX-3) allows differentiation between result and report comments. Ideally result comments should be linked to result by use of OBX-4 Observation Sub-ID as well as the position in the message.
...
LOINC Code | Long Name |
---|---|
70949-3 | Pathology report.section heading |
73983-9 | Report.section heading Unspecified body region |
When these codes are used the display of OBX-3 should be suppressed and the Value component displayed as a heading. The value component is usually of type CE (Coded Entry) or ST (String). These LOINC codes are usually used in conjunction with the OBX-4 Observation SubID to allow repetition of the codes for multiple headings and nested sections.
...
LOINC Code | Long Name |
---|---|
60572-5 | Report template ID |
This OBX segment can be omitted from the display but for systems capable of interpreting the template provides an identifier for the template that the data confirms to. Any data in the list of OBX segments under the current OBR segment that has a OBX-4 Observation SubID starting with the SubID of the Template identifier OBX is a part of the templated data.
...
OBX-8 Abnormal flags should be taken into consideration and atomic results with abnormal flags SHOULD be highlighted. If colour is used, then highlighting must be achived achieved by an additional method not relying on colour to accomodate colour accommodate colour blind readers. The abnormal flags SHOULD be displayed and displayed immediately after any Numeric, Structured numeric, String or Coded data.
...
The display of Free Text (FT) data SHOULD use a non proportional font to allow data of separate lines to align. This display SHOULD allow for a minimum of 80 characters before any word wrapping occurs. Free Text that is specified as able to be wordwrapped should word wrapped should be word wrapped to make it visible to the user on one screen and not be hidden off the right hand side of the screen as one line of text.
...
4.9 Pathology terminology
Pathology terminology is published on the RCPA website and the National Clinical Terminology Service.
...
- Units of measure should always be shown where a quantity is shown on pathology reports.
- The exception is where it is explicit that no units are used for a particular test such as Human chorionic gonadotropin qual.
- Pathology reports should use the units specified in the Standards for Pathology Informatics in Australia (SPIA) for those tests where units have been determined.
- A single, standardised unit of measure should be used for tests in reports from pathology laboratories.
- There may, however, be valid exceptions to this rule;
- in a transition from one preferred unit to another
- where alternate units are required by legislation or regulation such as for a registry
- during a period of consensus building as to which will be the preferred unit, but this period should be as short as practical
- where a facsimile of an historic report is produced – historic data need not comply.
- Units should be represented in electronic messages in fields for units in such a way that receiving systems can readily convert units under the clinical governance of the receivers. The Unified Code for Units of Measure (UCUM) must be used where it is the intention to represent units in a computable form (see http://unitsofmeasure.org/).
- Where the unit is not specified here, UCUM should be used for the unit. UCUM lexical elements such as square brackets (‘[’ and ‘]’) can be removed in the display format for enhanced clarity. However, the fully defined UCUM syntax should be used in electronic messaging.
- Superscripts and subscripts should not be used in units.
- The caret symbol (^) should be used to represent “raised to a power of”. Care must be taken to appropriately “escape” and "unescape" the caret symbol (^) as this symbol is used as a component separator in HL7 messages. Refer to examples in clause G6.08.
- Units raised to a power should be indicated in the preferred display unit by the exponent as an integer written immediately behind the unit term. For example, the preferred display unit for millilitre per minute per 1.73 square metre is mL/min/1.73m^2. Powers of ten should be represented by 10^ e.g. 10^12/.
- Display example:
- mL/min/1.73m^2
- 6.1x10^12/L
- Message example:
- ml/min/1.73m\S\2
- 6.1x10\S\12/L
- Display example:
4.11 SPIA Rendering of numeric results, ranges, units, previous results and flagging
The following is a summary of chapter 7 Rendering of numeric results, ranges, units, previous results and flagging from the RCPA's Standards for Pathology Informatics in Australia (SPIA), for further detail refer to this document.
...
3. Numeric results are incomplete without associated units and guidance for interpretation (eg e.g. reference intervals) and so these must always be shown with the number.
...
- Numeric results must be right justified (when shown in columns) and have corresponding guidance values (e.g. reference interval) and units if these exist.
- Numeric results must have a leading zero where there is no number in the units place (i.e. 0.7 not .7).
- For columnar cumulative reports the latest result must be shown in the furthest right column of results (i.e. time must go from left to right across the page) or at the top for cumulative reports shown in rows (i.e. time must go from the bottom to the top of the page).
- The latest result must be differentiated from earlier results by at least two methods one of which is a heading ‘Latest Results’.
- A box such as that shown in Figure 3 was favoured by 75% of survey respondents for columnar reports.
- Bolding of the heading text was considered effective by the Committee.
- Guidance values must be bounded by parentheses and have no spaces.
- Italics should not be used.
- The column showing units must be headed ‘Units’, be left justified and be to the immediate right of the ‘Reference’ column.
- The numbers used for guidance must be rendered with the same number of decimal places as the related result.
- For some analytes, such as tumour markers, a result may be orders of magnitude above guidance in which case current practice for some laboratories is to adjust for significant figures because of concern at overstating precision. It is not known whether it is safer to do this or to adopt the number of decimal places for the low range result. If a different number of decimal places is used at different concentrations, the guidance should be rendered to the same number of decimal places as the results of a similar magnitude to the guidance values.
- Results are considered outside the guidance values if after rounding to the format of the displayed result (and the guidance) the result is greater than the higher number or less than the lower number of the guidance values. S7.10 Results outside the guidance values must be highlighted by at least two methods one of which is either an ‘L’ or ‘H’ one space to the right of the result (‘L’ for a result lower and ‘H’ for a result higher).
- A single asterisk (‘*’) and the ‘+’ and ‘-‘characters should not be used for flagging results
- Underlining of results should not be used for highlighting results
- Colour was preferred by most respondents in the survey but because of colour blindness and possible loss of colour in some communications, if colour is used, then the font should also be bolded.
- Multi-level flagging may be used in which case ‘LL’ or ‘HH' should be used for the second level.
- Headings must be differentiated from test names.
- Dates must be shown in the form 30-Jan-14 (i.e. not in the form 30/01/14).
4.12 Harmonised reference intervals
The following is a summary of chapter 8 Harmonised reference intervals from the RCPA's Standards for Pathology Informatics in Australia (SPIA) for further detail refer to this document.
...
More recently in the RCPA PITUS 15-16 working group 5 "Report modelling for safe atomic reporting to registries" have progressed FHIR artefacts which are then transported in a HL7 V2.4 message. The initial work is based on the colorectal cancer protocol and the prostate (radical prostatectomy) cancer protocol and is available at http://fhir.hl7.org.au/fhir/rcpa/index.html.
...
In the OBX segments, the same LOINC code is used to indicate the item eg e.g. unit of blood or fresh frozen plasma etc, and OBX-4 Observation sub-ID is used to indicate the separate units of red cells or fresh frozen plasma etc.
...
Note: A new microbiology model is under development and the following example is to demonstrate the use of OBX sub-id, and is not intended as a definitive guide to micro urine reporting.
Code Block | ||||
---|---|---|---|---|
| ||||
MSH|^~\&|EQUATORDXTRAY^EQUATORDXTRAY^L|Acme Pathology^1001^AUSNATA|||20150420221113+1000||ORU^R01^ORU_R01|20150420.123321|P|2.4^AUS&&ISO3166_1^HL7AU.ONO.1&&HL7AU|||AL||AUS PID|1|... PV1|1|O||||||01234567W^BROWN^Bill^^^DR^^^AUSHICPR^L^^^UPIN|01234567W^BROWN^Bill^^^DR^^^AUSHICPR^L^^^UPIN ORC|RE||03-7654321-URC-0^Acme Pathology^1001^AUSNATA||CM|||||||01234567W^BROWN^Bill^^^DR^^^AUSHICPR^L^^^UPIN OBR|1||03-7654321-URC-0^Acme Pathology^1001^AUSNATA|URC^URINE MICRO^L|||201503081300+1000|||||||201503081928+1000||01234567W^BROWN^Bill^^^DR^^^AUSHICPR^L^^^UPIN||||DR=MME,LN=03-7654323,RC=Y||201504181642+1000||MB|F||^^^201503080000+1000|01234564W^GREEN^Wilma^^^DR^^^AUSHICPR^L^^^UPIN||||Reporting Pathologist OBX|1|ST|19159-3^Collection Method^LN||Mid stream urine||||||F|||201503082316+1000 OBX|2|ST|25428-4^Glucose^LN||Negative||||||F|||201503082350+1000 OBX|3|ST|2514-8^Ketones^LN||Negative||||||F|||201503082350+1000 OBX|4|ST|20454-5^Protein^LN||+||||||F|||201503082350+1000 OBX|5|NM|30405-5^Leucocytes^LN||40|10*6/L^10*6/L^UCUM|<10|+|||F|||201503090015+1000 OBX|6|NM|30391-7^Erythrocytes^LN||20|10*6/L^10*6/L^UCUM|<10|+|||F|||201503090015+1000 OBX|7|SN|30383-4^Epithelial cells^LN||<^10|10*6/L^10*6/L^UCUM|||||F|||201503090015+1000 OBX|8|ST|8269-3^^LN|1|Organism 1||||||F OBX|9|CE|630-4^Bacteria Identified^LN|1|40886007^Klebsiella oxytoca^SCT|||A|||F OBX|10|SN|19090-0^Colony Count^LN|1|>^10|||A|||F OBX|11|ST|18864-9^Amp/Amoxycillin^LN|1|R|||R|||F OBX|12|ST|18862-3^Amoxycillin+Clavulanic acid^LN|1|R|||R|||F OBX|13|ST|18897-9^Cephalexin^LN|1|R|||R|||F OBX|14|ST|18955-5^Nitrofurantoin^LN|1|R|||R|||F OBX|15|ST|18956-3^Norfloxacin^LN|1|S|||S|||F OBX|16|ST|18997-7^Trimethoprim^LN|1|R|||R|||F OBX|17|ST|18928-2^Gentamicin^LN|1|S|||S|||F OBX|18|ST|8270-1^^LN|2|Organism 2||||||F OBX|19|CE|630-4^Bacteria Identified^LN|2|73457008^Protues mirabilis^SCT|||A|||F OBX|20|SN|19090-0^Colony Count^LN|2|>^100|||A|||F OBX|21|ST|18864-9^Amp/Amoxycillin^LN|2|R|||R|||F OBX|22|ST|18862-3^Amoxycillin+Clavulanic acid^LN|2|S|||S|||F OBX|23|ST|18897-9^Cephalexin^LN|2|S|||S|||F OBX|24|ST|18955-5^Nitrofurantoin^LN|2|S|||S|||F OBX|25|ST|18956-3^Norfloxacin^LN|2|S|||S|||F OBX|26|ST|18997-7^Trimethoprim^LN|2|R|||R|||F OBX|27|ST|18928-2^Gentamicin^LN|2|S|||S|||F OBX|28|FT|8251-1^Generated comment^LN||\.br\May be suggestive of UTI in the presence of symptoms.\.br\||||||F |
Note:
- A display segment is expected, but has not been included in this example.
- All results are reported under a single order (placer/filler) number.
- An organism and its related sensitivities are reported within a group of OBX segments e.g. the value of "1" is common to all OBX-4 fields from OBX|8| to OBX|17| in the example above. If greater than one organism is present then the value of OBX-4 Observation sub-ID should be incremented for each organism.
- Comments associated with the organism/sensitivity pattern must have the same OBX-4 Observation sub-ID as the organism/sensitivity pattern.
- Comments associated with the report must have a different OBX-4 Observation sub-ID to the specific organism OBX-4 Observation sub-ID.
- For the organism eg e.g. OBX|9| above, use a LOINC code in OBX-3.
- For the identification of the organism a SNOMED CT code is used in OBX-5 Observation value eg e.g. OBX|9|-5 above of |40886007^Klebsiella oxytoca^SCT|.
If there is an abnormality indicator for the organism it will be in OBX-8 Abnormal Flags with the acceptable values of "A" for "Abnormal", "N" for "Normal" or "null".
If a colony count is present it will be in a separate OBX following the organism OBX eg e.g. OBX|10| above. It will have a LOINC code in OBX-3 eg e.g. 19090-0 for "Colony count [#/volume] in Urine" with the OBX-5 Observation value e.g. "|<10|".
- When reporting sensitivities for the organism the encoded value for the antibiotic is in OBX-5 Observation value and the sensitivity result is placed in OBX-8 Abnormal Flags with the acceptable values being:
- S - sensitive;
- R - resistant; and
- I - intermediate
- The LOINC code used for sensitivities identifies the method used for the sensitivities.
- OBX-17 Observation Method is not used for microbiology susceptibility method. OBX-17 Observation Method is used for transmitting flags to indicate "combining of results" - refer to "Combining test values from different organisations".
...
https://labtest.com.au/mylabapp/data%20path/id/2016F0001000-1?viewview=jpegrender&mode=online
We will match the URL parts as follows:
URL Part | Value |
---|---|
scheme | https:// |
server | labtest.com.au |
application path | /mylabapp |
data path | /data%20path/id/2016F0001000-1 |
query | ?viewview=jpegrender&mode=online |
These parts would be encoded into a RP datatype as follows:
...
Order to report scenario | ORC-1 Order control code (HL7 table 0119) | Order control code description | Comment |
---|---|---|---|
Direct 1:1 matching of order with the report | RE | Observations/Performed Service to follow | Note: This is a variance to HL7 V2.4, section 4.5.1.1.1(j) which states that this codes is not necessary in an ORU message. However, HL7 provides no option to filling this mandatory field. |
Greater than one ordered test on a single report - Results with no direct order | CN | Combined result | |
Greater than one ordered test on a single report - Final test sent in report | RE | Observations/Performed Service to follow | |
Reflex or self determined tests or where a single test generates greater than one report - result for the original order | PA | Parent order/service | Medicare Australia permits the laboratory automatically adding on tests based on initial results, though these add-ons are more likely to be non-billable. These add-on tests will not have a Placer Order Number; however they can be matched using the Placer Group Number. |
Reflex or self determined tests or where a single test generates greater than one report - child orders | PA/CH | Parent order/service / Child order/service | |
Reflex or self determined tests or where a single test generates greater than one report - final test sent with the report | RE | Observations/Performed Service to follow | |
Report copies to recipients that are not the original requester | RE | Observations/Performed Service to follow | Placer group number and placer order number shall be <null>. |
Add-on tests - requested by someone who is not the original requester | RE | Observations/Performed Service to follow | The placer group number should be sent as for the original request. For the ordering provider, placer order number will be returned. However, for the original requester, the placer order number shall be <null> ie i.e. although the original requester did not order the test they would generally be included in the copy to doctors. |
An order may be cancelled by the placer up until the time the result is sent or by the filler due to an unsatisfactory specimen. Once a test is resulted it cannot be cancelled. | CA | Cancel order/service | Placer Applications. |
...
The pathology provider will respond with the the following ORR^O02 message - ignoring the two-stage acknowledgement for this scenario:
...
In this scenario the test resulted is the same the the test ordered; hence there no combining or replacing of test codes as per scenario 1 and 2.
...
A pathology provider will want to match the patient identifier to enable the provision of cumulative results which provides more information over time than just a snapshot and Medicare has rules on some tests regarding the frequency a test can be ordered over a period of a specific period of time. The pathology results receiver will want the patient identifier to match results on a patient where the order originated from another provider eg e.g. copy to doctor, to determine if it is an existing patient or a new patient to their patient management system. It is therefore useful to the receivers of the request or the results to receive as many patient identifiers as possible.
...
Code | Definition | Additional comments and examples |
---|---|---|
AUSEHR | My Health Record consent flag. | For example AUSEHR=Y indicates that consent has been given for this report to be uploaded to the My Health Record. |
CP | This is a copy result ie i.e. the receiving doctor is not the requesting doctor. | Useful to the receiving site when a result is received with no corresponding order or the patient has no history at the medical practice. Example: |CP=Y| for the case when it is a copy doctor. |
DR | The doctor code or Provider Number used by the diagnostics provider for the Receiving | The code can be used by the diagnostics provider to write a ‘tracking’ record for the result after the surgery has acknowledged receipt of the result. It is not required to be returned by the surgery; the diagnostics provider will retrieve the code from their copy of the message when the acknowledgment is received. |
LN | Laboratory/Diagnostic imaging Number assigned by the diagnostics provider to the specimen or procedure. | For electronic orders the Filler Order Number is used to acknowledge receipt of the order. This may not necessarily correspond to the diagnostics provider's identifier for the result. This value must be retained and displayed by the PMS because referral to the performing diagnostics provider will usually require this number to be quoted (NOT the Filler Order Number). |
RC | Request complete | HL7 only allows an individual ‘order’ items to be flagged complete—not a list of orders that formed a request. In the case where electronic orders are not implemented, this provides a mechanism to indicate the when all results for the request have been reported. This is indicated via the ‘RC= Placer Group Number’ Y’ item. |
4.23 Tracking Result Identifiers
...
When an electronic request is made the order will be transmitted to the laboratory, the laboratory must respond with with a Filler Order Number: If the order contains more than one order on the same request ie i.e. same Placer Group Number then the laboratory must respond with the same number of order responses.
The preferred response is to respond immediately to the order with an ACK message and transmit an ORR message with a Filler Order Number when the specimen is received.
An optional method is for the laboratory to hold the order and not respond until the specimen has been received by the laboratory and the lab number can be used as one part of the Filler Order Number.
...
Code Block |
---|
MSH|... PID|... PV1|.... ORC|RE||11P123456-98765432^MLS^2623^AUSNATA|996042222^SNP^1964^AUSNATA|CA||||20160623164200|JAMB^James Brown^^^^^^^NATA2623||049266KX^Teste^Testy^^^Mr^^^AUSHIC|||20160810171724 OBR|1||11P123456-98765432^MLS^2623^AUSNATA|ALL^ALL^NATA2623||20110623164200|20160623164200|||||""|Nil - Testing Hl7|||049266KX^Teste^Testy||MPATH|KEST|IMAGE|12552953|||CH|X OBX|1|ST|ALL^ALL^L|1|Delete all results for this report||||||D |
Anchor | ||||
---|---|---|---|---|
|
Encapsulated data attachments are non-displayable files that are ancillary to the main report. They are not e.g. images that form part of the report, related documents, or data which could be used in a display segment. An example of an attachment would be raw XML data from an instrument. Documents which are related to the current report (defined by the OBR) and are displayable using one of the supported AUSPDI display segment datatypes should appear under their own OBR. Attachments can also be represented inline (meaning under the same OBR) or under their own OBR which has the advantage of having a unique document identifier for citation purposes (OBR-3 Filler Order Number), a representation of relevant dates and authorship to be associated with the attachment. Where an attachment is used some narriative documenting the attachment should appear in the display segment associated with the OBR under which the attachment appears.
...
MIME Type | Mime | |
---|---|---|
application | x-hl7-cda-xdm-zip | HL7 CDA when packaged in XDM ZIP format |
application | fhir+xml; fhirVersion=[version] | Atomic HL7 FHIR resource content in XML format * |
application | fhir+json; fhirVersion=[version] | Atomic HL7 FHIR resource content in JSON format * |
text | csv | Comma separated file format |
application | vnd.ms-powerpoint | Powerpoint presentation |
application | vnd.openxmlformats-officedocument.presentationml.presentation | Powerpoint presentation |
application | vnd.openxmlformats-officedocument.wordprocessingml.document | Microsoft Word .docx file |
application | vnd.ms-excel | Excel spreadsheet xls |
*Refer to the FHIR specification for appropriate values of the version variable. e.g. "4.0" https://www.hl7.org/fhir/versioning.html
Code Block | ||
---|---|---|
| ||
ORC|RE||2.25.263498878813690208021966154988434320272^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO||CM|||||||0191324T^MCINTYRE^ANDREW^^^^^^AUSHICPR^L^^^UPIN OBR|1||2.25.263498878813690208021966154988434320272^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO|18842-5^Discharge Summarization Note^LN|||20140825103830|||||||||2671351T^Doctor^Good^^^Dr^^^AUSHICPR||||||20140825103830||PHY|F||^^^20140825103830 OBX|1|ED|18842-5^Discharge Summarization Note^LN||^application^x-hl7-cda-xdm-zip^base64^UEsDBBQ OBX|2|ED|HTML^Display format in HTML^AUSPDI||^text^html^Base64^PD94bWwgdmVyc2lvbj0iMS4wIj8+Cjwh.... OBX|3|ED|PDF^Display in PDF Format^AUSPDI||^application^pdf^Base64^JVBERi0xLjQNCiXi48/TDQolDQol...ORC|RE||12123-1^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO||CM|||||||0191324T^MCINTYRE^ANDREW^^^^^^AUSHICPR^L^^^UPIN ORC|RE||12123-2^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO||CM|||||||0191324T^MCINTYRE^ANDREW^^^^^^AUSHICPR^L^^^UPIN OBR|3||12123-2^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO|52033-8^General correspondence^LN Note^LN|||20140825103830|||||||||2671351T^Doctor^Good^^^Dr^^^AUSHICPR||||||20140825103830||PHY|F||^^^20140825103830 OBX|1|ED|52033-8^General correspondence^LN|2|^application^octet-stream^Base64^...||||||F OBX|2|ED|PDF^Display format in PDF^AUSPDI||^application^pdf^Base64^...||||||F|||20170322 ORC|RE||12123-3^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO||CM|||||||0191324T^MCINTYRE^ANDREW^^^^^^AUSHICPR^L^^^UPIN OBR|4||12123-3^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO|52033-8^General correspondence^LN Note^LN|||20140825103830|||||||||2671351T^Doctor^Good^^^Dr^^^AUSHICPR||||||20140825103830||PHY|F||^^^20140825103830 OBX|1|ED|PDF^Display format in PDF^AUSPDI|Supporting Letter|^application^pdf^Base64^...||||||F|||20170322 OBX|1|ED|RTF^Display format in RTF^AUSPDI|Supporting Letter|^application^rtf^Base64^...||||||F ORC|RE||12123-4^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO||CM|||||||0191324T^MCINTYRE^ANDREW^^^^^^AUSHICPR^L^^^UPIN OBR|5||12123-4^Good Hospital^1.2.36.1.2001.1003.0.8003629900024197^ISO|52070-0^Workers compensation^LN|||20140825103830|||||||||2671351T^Doctor^Good^^^Dr^^^AUSHICPR||||||20140825103830||PHY|F||^^^20140825103830 OBX|1|ED|PDF^Display format in PDF^AUSPDI|claimform1|^application^pdf^Base64^...||||||F|||20170322 |
...
To refer to another document under another OBR then the OBR can be referenced using an OBX EI (Entity Identifier) with a OBX-3 Observation Identifier value of LP72255-0^Citation^LN.
ege.g.
OBX|4|EI|LP72255-0^Citation^LN||1234^ACME Pathology^7654^AUSNATA||||||F
...