OtoAccess HL7 Interface. HL7 Specification

Transcription

1 OtoAccess HL7 Interface HL7 Specification SPO - 18/07/2012

2 Contents Usage guide for OtoAccess HL7 Interface 1 Introduction QRY/ADR Patient Query (Event A19) QRY_A Sample message: QRY_A ADR_A Sample Message: ADR_A ADT Admission Discharge and Transfer Message (Event A01, A08, A11) ADT (_A01, _A08, _A11) Sample message: ADT (_A01, _A08, _A11) ORU Unsolicited Transmission of an Observation Message (Event R01) Sample message: ORU_R Acknowledgement (ACK) Sample message: ACK Segments and Attributes MSH QRD OBR OBX MSA PID PV

3 1 Introduction The document provides the HL7 speciation of the OtoAccess - HL7 interface. The HL7 message structure is proposed based on the HL7 V2.3 model. Other higher Version (V.2.3.1, V2.4 and V2.5) messages are backward compatibility with the HL7 V2.3. From the OtoAccess point of view, HL7 communication is used to achieve two main tasks Importing Demographics into OtoAccess from HIS Exporting report (Text based Lab results) to HIS Therefore, the document proposes the specification for ADT, QRY, ADR, ORU and ACK Message types (with relevant event type) which are supported by OtoAccess. 2 QRY/ADR Patient Query (Event A19) 2.1 QRY_A19 The QRY_A19 message is composed of following segments MSH - Required QRD - Required Sample message: QRY_A19 MSH ^~\& OTO SCR HIS ADM QRY^A19 SCR P 2.3 NE AL DK 8859/1 QRD R I OA ^RD DEM 2.2 ADR_A19 The ADR_A19 message is expected to be composed of following segments MSH MSA QRD PID PV1 - Required - Optional - Required - Required - Optional Any other segments will be considered as optional and will not be processed by OtoAccess. 2

4 2.2.1 Sample Message: ADR_A19 MSH ^~\& HIS ADM OTO SCR ADR^A P 2.3 NE AL DK 8859/1 MSA AA SCR QRD R I OA ^RD DEM PID William^Jan M RoamRoad 6^^ANT^^20181^DK PV1 ^^ ^^^^^ ^^^^^^ ADT Admission Discharge and Transfer Message (Event A01, A08, A11) 3.1 ADT (_A01, _A08, _A11) The ADT_Axx messages are expected to be composed of following segments at least MSH PID PVI -Optional All other segments are considered as optional and not processed by OtoAccess Sample message: ADT (_A01, _A08, _A11) MSH ^~\& HIS ADM OTO SCR ADT^A P 2.3 NE AL DK 8859/1 PID William^Jan M RoamRoad 6^^ANT^^20181^DK PV1 ^^ ^^^^^ ^^^^^^

5 4 ORU Unsolicited Transmission of an Observation Message (Event R01) The ORU_R01 message is composed of following segments MSH PID PVI -Optional OBR OBX at least a OBX segment OBX 4.1 Sample message: ORU_R01 MSH ^~\& OTO SCR HIS ADM ORU^R01 SCR P 2.3 NE AL Be 8859/1 PID William^Jan PV OBR 135^SCR^OTO 135^SCR^OTO ^Fernano^David 563 OBX 1 TX 135^AC440 AC440 RTXL \R\Report: Doctor's text report regarding particular test\r\\r\conclusion: XXXXXX\R\ F OBX 2 TX 135^AC440 AC440 RTXX FILE:////server01.wisdom.com/CoverLeaf/docu ment_135.pdf F 5 Acknowledgement (ACK) OtoAccess Consider the HL7 original mode Acknowledgment types only. The ACK message is composed of following segments MSH MSA 5.1 Sample message: ACK MSH ^~\& OTO SCR HIS ADM ACK^A P 2.3 NE A L DK 8859/1 MSA AA

6 6 Segments and Attributes 6.1 MSH In the outgoing messages, the bold attributes are system generated and cannot be configured.. The hided attributes are not processed by OtoAccess. 1 ST R Field Separator (PIPE) 2 ST R Encoding Characters ^~\& 3 HD R Sending Application OTO 4 HD R Sending Facility SCR 5 HD O Receiving Application HIS 6 HD O Receiving Facility ADM 7 TS O Date/Time Of Message ST O Security 9 CM R Message Type QRY^A19 10 ST R Message Control ID SCR PT R Processing ID P 12 ID (0104) R Version ID NM O Sequence Number 14 ST O Continuation Pointer 15 ID (0155) O Accept Acknowledgment Type NE 16 ID (0155) O Application Acknowledgment Type AL 17 ID O Country Code BE 18 ID (0211) O Character Set 8859/1 19 CE O Principal Language Of Message MSH-10 : Message Control ID = OtoAccess s Facility Name + Time stamp (yyyymmddhhmmss) Choose the Facility name carefully if attribute length restriction is applied. The length of the SCR is 17. 5

7 6.2 QRD In the outgoing messages, the bold attributes are system generated and cannot be configured.. The hided attributes are not processed by OtoAccess. 1 TS R Query Date/Time ID (0106) R Query Format Code R 3 ID (0091) R Query Priority I 4 ST R Query ID OA ID (0107) O Deferred Response Type 6 TS O Deferred Response Date/Time 7 CQ (0126) R Quantity Limited Request 1^RD 8 XCN R Who Subject Filter CE (0048) R What Subject Filter DEM 10 CE O What Department Data Code 11 ST O What Data Code Value Qual 12 ID (0108) O Query Results Level QRD-4: Query ID = OA + Time stamp (yyyymmddhhmmss) 6.3 OBR In the outgoing messages, the bold attributes are system generated and cannot be configured. The hided attributes are not processed by OtoAccess. 1 SI O Set ID - OBR 2 EI R Placer Order Number 135^SCR^OTO 3 EI R Filler Order Number 135^SCR^OTO 4 CE O Universal Service ID 5 ID O Priority - OBR 6 TS O Requested Date/Time 7 TS R Observation Date/Time # TS O Observation End Date/Time # 9 CQ O Collection Volume * 10 XCN O Collector Identifier * 11 ID (0065) O Specimen Action Code * 12 CE O Danger Code 6

8 13 ST O Relevant Clinical Info. 14 TS O Specimen Received Date/Time * 15 CM (0070) O Specimen Source * 16 XCN O Ordering Provider 17 XTN O Order Callback Phone Number 18 ST O Placer Field 1 19 ST O Placer Field 2 20 ST O Placer Field ST O Placer Field TS R Results Rpt/Status Chng - Date/Time + 23 CM O Charge to Practice ID (0074) O Diagnostic Serv Sect ID 25 ID (0123) O Result Status 26 CM O Parent Result + 27 TQ O Quantity/Timing 28 XCN O Result Copies To 29 CM O Parent 30 ID (0124) O Transportation Mode 31 CE O Reason for Study + 32 CN R Principal Result Interpreter + 342^Fernano^David 33 CM O Assistant Result Interpreter + 34 CN O Technician+ (Examiner) 563^Ella^Williams 35 CM O Transcriptionist + 36 TS O Scheduled Date/Time + 37 NM O Number of Sample Containers * 38 CE O Transport Logistics of Collected Sample * 39 CE O Collector s Comment * 40 CE O Transport Arrangement Responsibility 41 ID (0224) O Transport Arranged 42 ID (0225) O Escort Required 43 CE O Planned Patient Transport Comment 7

9 6.4 OBX In the outgoing messages, the bold attributes are system generated and cannot be configured. The hided attributes are not processed by OtoAccess. 1 SI R Set ID - OBX Value 1 2 ID (0125) C Type Observation TX 3 CE R Identifier Observation 65536^AUD^OTO^127^ Tone 4 ST C Sub-ID Observation RTXL 5 * C Value Observation Report... 6 CE O Value Units 7 ST O References Range 8 ID (0078) O Abnormal Flags 9 NM O Probability 10 ID (0080) O Nature of Abnormal Test 11 ID (0085) R Observation Result Status F 12 TS O Date Last Obs Normal Values 13 ST O User Defined Access Checks 14 TS O Date/Time of the Observation 15 CE O Producer's ID 16 XCN O Responsible Observer 17 CE O Observation Method 6.5 MSA In the outgoing messages, the bold attributes are system generated and cannot be configured. The hided attributes are not processed by OtoAccess. 1 ID (0008) R Acknowledgment Code AA 2 ST R Message Control ID ST O Text Message 4 NM O Expected Sequence Number 5 ID (0102) B Delayed Acknowledgment Type 6 CE O Error Condition 8

10 6.6 PID The incoming messages may contain following attributes. The hided attributes are not processed by OtoAccess. 1 SI O Set ID - PID 2 CX O Patient ID CX R Patient Identifier List 4 CX O Alternate Patient ID - PID 5 XPN R Patient Name William^Jan 6 XPN O Mother s Maiden Name 7 TS O Date/Time of Birth IS (0001) O Sex M 9 XPN O Patient Alias 10 IS (0005) O Race 11 XAD O Patient Address RoamRoad 6^^ANT^^20181^DK 12 IS B County Code 13 XTN O Phone Number - Home 14 XTN O Phone Number - Business 15 CE (0296) O Primary Language 16 IS (0002) O Marital Status 17 IS (0006) O Religion 18 CX O Patient Account Number 19 ST O SSN Number - Patient 20 CM O Driver's License Number - Patient 21 CX O Mother's Identifier 22 IS (0189) O Ethnic Group 23 ST O Birth Place 24 ID (0136) O Multiple Birth Indicator 25 NM O Birth Order 26 IS (0171) O Citizenship 27 CE (0172) O Veterans Military Status 28 CE O Nationality 29 TS O Patient Death Date and Time 30 ID (0136) O Patient Death Indicator 9

11 6.7 PV1 The incoming messages may contain following attributes. The hided attributes are not processed by OtoAccess. 1 SI O Set ID - PV1 2 IS (0004) R Patient Class 3 PL O Assigned Patient Location 4 IS (0007) O Admission Type 5 CX O Preadmit Number 6 PL O Prior Patient Location 7 XCN (0010) O Attending Doctor 8 XCN (0010) O Referring Doctor 9 XCN (0010) O Consulting Doctor 10 IS (0069) O Hospital Service 11 PL O Temporary Location 12 IS (0087) O Preadmit Test Indicator 13 IS (0092) O Re-admission Indicator 14 IS (0023) O Admit Source 15 IS (0009) O Ambulatory Status 16 IS (0099) O VIP Indicator 17 XCN (0010) O Admitting Doctor 18 IS (0018) O Patient Type 19 CX O Visit Number CM (0064) O Financial Class 21 IS (0032) O Charge Price Indicator 22 IS (0045) O Courtesy Code 23 IS (0046) O Credit Rating 24 IS (0044) O Contract Code 25 DT O Contract Effective Date 26 NM O Contract Amount 27 NM O Contract Period 28 IS (0073) O Interest Code 29 IS (0110) O Transfer to Bad Debt Code 30 DT O Transfer to Bad Debt Date 31 IS (0021) O Bad Debt Agency Code 32 NM O Bad Debt Transfer Amount 10

12 33 NM O Bad Debt Recovery Amount 34 IS (0111) O Delete Account Indicator 35 DT O Delete Account Date 36 IS (0112) O Discharge Disposition 37 CM (0113) O Discharged to Location 38 IS (0114) O Diet Type 39 IS (0115) O Servicing Facility 40 IS (0116) O Bed Status 41 IS (0117) O Account Status 42 PL O Pending Location 43 PL O Prior Temporary 44 TS O Location Admit 45 TS O Date/Time Discharge 46 NM O Date/Time Current 47 NM O Patient Balance Total 48 NM O Charges 49 NM O Total Adjustments 50 CX (0192) O Total Payments 51 IS (0326) O Alternate Visit ID 52 XCN (0010) O Visit Indicator 11