HL7 Interface Specification Merge Eye Station v. 11.3 Merge Healthcare 900 Walnut Ridge Drive Hartland, WI 53029 USA 877.44.MERGE
2012 Merge Healthcare. The information contained herein is confidential and is the sole property of Merge Healthcare. None of the information may be reproduced, copied, and/or re-distributed electronically, manually, or otherwise to any person without advance written permission from Merge Healthcare, except as may be expressly authorized by contracts or other agreements between Merge Healthcare and its customer. Merge Healthcare and AMICAS are registered trademarks and VERICIS, RadSuite, Abraxas, and iconnect are also trademarks of Merge Healthcare. Other trademarks or service marks referred to herein are the property of their respective owners. Merge Eye Station was formerly known as OIS WinStation. Doc # Revision Date WSTN-8911 2 12/6/12 Replaced by Solutions Management.
Purpose This document contains only segments and fields that are mapped to our database. Fields not in this document (including segments required by the HL7 standard) are supported but not mapped. Supports HL7 version 2.5. Table of Contents Purpose............................................................... 1 Table of Contents....................................................... 1 Supported Messages.................................................... 2 HL7 Message Definitions................................................. 2 General Note About the Tables......................................... 2 ADT.............................................................. 3 Admission, Registration, Discharge, Transfer, and Updates................ 3 Merge Patient.................................................... 3 ADT Segment Definitions........................................... 3 Message Example................................................ 5 Staff (Physician)..................................................... 6 Staff Message Type............................................... 6 Staff Segment Definitions........................................... 6 Message Example................................................ 6 Orders............................................................. 7 Order Segment Definitions.......................................... 7 Message Example................................................ 8 Order Result Messages............................................... 9 New Visit....................................................... 9 DigitalReporter Result (OBX)....................................... 10 Message Example............................................... 10 DigitalReporter Append (OBX)...................................... 11 Message Example............................................... 12 1 of 12
Supported Messages HL7 message Remarks Patient ADT^A18 Merge patient/visit * See below ADT^A28 Add person information * See below ADT^A31 Update person information * See below Patient Query QRY^Q01 Patient data query * See below ADT^A19 Patient query Response * See below Physicians MFN^M02^MFN_M02 Add\Update Physician * See below Orders ORM^O01 New order * See below ORM^O01 Update order MDM^T02/ ORU^R01 (Configurable) Result order * See below MDM^T06 Appendix Result order * See below HL7 Message Definitions General Note About the Tables The numbers in the Max Len (maximum length) column in the tables in this section come from the official HL7 specification and are not the actual column length in the system. The column explains how the system HL7 Interface Engine uses each HL7 field. The letters in the OPT/REQ (optional/required) column specify the following: Destination R Meaning Required (Segment, Field) O Optional (Field ) 2 of 12
ADT The ADT message is used to receive patient and patient visit events as they occur. Admission, Registration, Discharge, Transfer, and Updates Message Type A28, A31 (other message can be accepted depending on definition required; A01, etc) Order Segment name OPT/REQ Repeated count /use 1 MSH R N Message Header / Message Header 2 PID R N Patient Identification / Patient Identification *All other segments can be optionally added. Merge Patient Message Merge patient A18 Order Segment name OPT/REQ Repeated count /use 1 MSH R N Message Header 2 PID R N Patient Identification 3 MRG R N Merge information ADT Segment Definitions Message Header (MSH) SEQ Field name Max len Type OPT/ REQ Repeat count 1 Field separator 1 ST R - default 2 Encoding characters 4 ST R Component delimiter - ^ Escape char - \ Sub-component delimiter - & Repeated delimiter - ~ 3 of 12
Message Header (MSH) (Continued) SEQ Field name Max len Type OPT/ REQ Repeat count 9 Message type 7 CM R Required (example: ADT^A01) Patient Identification (PID) SEQ Field name Max len Type OPT/ REQ Rep count 3.1 Patient ID (internal ID) 3.5 Patient internal identifier 64 CX R Y MRN 64 CX R\O Y Required Only if message contain more of one MRN's 5 Patient name 64 each XPN R Y Last name^first name^middle name^ Suffix^Prefix 7 Date/time of Birth 26 TS O 8 Sex 4 IS O Gender lookup values: Male Female Other Unknown 11 Patient address 64 each XAD O Street address^^city address^state^zip code^country 13 Phone number 40 XTN O home 14 Phone number 40 XTN O work 15 Primary language 64 CE O 17 Religion 3 IS O Merge Patient or Visit Information (MRG) SEQ Field name Max len Type OPT/ REQ Rep count 1 Prior patient ID - internal 64 CX R Y Prior Medical Record Number (MRN) or Prior Corporate patient ID 1.5 Patient identifier 64 CX R\O Y Required Only if message contain more than one MRN's 4 of 12
Message Example ADT^A28 MSH ^~\& NextGenEPM ADT^A28 4 2.3 MSA AA 953310561 PID 1 m010 000000000010 Simpson^^Lisa 19580715 F 145 Elm St^^Springfield^IL^35645 7065554343^^^m@m M 234908767 PV1 1 O IN1 1 123 123 Blue Cross Of Georgia 1034 North Peach Tree Street^^Atlanta^GA^30324 Simpson^Marge 01 19580715 145 Elm St^^Springfield^IL^35645.0000 F IN1 2 123 123 Blue Cross Of Georgia 1034 North Peach Tree Street^^Atlanta^GA^30324 EMRJ653OMXFY Nuclear Power Plant Simpson^Homer^J 02 19550101 145 Elm St^^Springfield^IL^35645 XKM234569887.0000 M 00005 ADT^A19 (with multi MRNs) MSH ^~\& WinStation WinStn COMMSVR ZIS 20090803161739 ADR^A19 0000002 P 2.4 MSA AA 0000002 QRD 20090803161739 R I 0000002 1^RD 0068883560^^^^^^^^^^^PI DEM PID 1 0068883560^^^^PI~183565563^^^NLMINBIZA^NNNLD VD ANDEL-HUELE&&HUELE&VD&ANDEL^L^F^test^ValueFirstName ADT^18 (merge) MSH ^~\& EPIC BRIDGES 20101108094412 JM5405 ADT^A18 16657447 P 2.3 EVN A18 201011080944 JM5405^HARVEY^JEAN^M^^^^^DMC^^^^^DBO PID 1 E936045^^^^EPI~000548340^^^^STMH~35226295^^^^DMC~5322974^^^^SMDV 5322974^^^50^S MDV Lname^Fname^MI 19660727 F TURNER^TRENDA^V^~JACOBSON^TRENDA^V^ W 452 N PARKERDR^^JANESVILLE^WI^53545^USA^P^^ROCK ROCK (608)322-7821^P^7~(999)999-9999^P^7 E SINGLE NON 54538529 557-23-6132 N PD1 ^^141901 60424^KEITH^RACHEL^^^^^^^^^^DHSSMDVSER NO RELIGIOUS PREFERENCE^^1371 MRG 31874908^^^10^DMC 31874908^^^10^DMC 5 of 12
Staff (Physician) Staff Message Type Message Type MFN^M02^MFN_M02 Segment Name OPT/REQ Repeated Count /Use MSH R N Message Header / Message Header STF R N Order details, Physician Staff Segment Definitions For MSH segment definition see ADT segment definition. (STF) SEQ Field name Max len Type OPT/ REQ Repeat count 2 Staff Identifier ID 64 XPN O PhysicianID^ Assigningauthority^ IdentifierTypeCode 3 StaffName 64 each XPN O Lastname^FirstName^Prefix^ Suffix^Degree Message Example MSH ^~\& MPV00 NCA IE00 KP 20070723192553.7460-0700 MFN^M02^MFN_M02 20070723092209606032 P 2.3 NE NE MFI STF^^HL70175 MPV.CPM UPD 20070723192553.7460-0700 20070723192553.7460-0700 NE MFE MAD 20070723092209606032 20070723192553.7460-0700 0006255^^99KP1014 CE STF 0006255^^99KP1014 0006255^^^KP1014^PRN~57999^^^KP1014^OPRN~A22385^^^CMS^UPIN~0 0A209270^^^CMS^MCR THIER^DAVID^D^^^M.D.^L~^M D THIER M.D.^^^^^D AA T 2425 GEARY BOULEVARD^^SAN FRANCISCO^CA^94115^3358^O 20030619 PRA 0006255^^99KP1014 6 of 12
Orders Message Type ORM^O01 Segment name OPT/REQ Repeated count /use MSH R N Message Header / Message Header PID R N Patient Identification / Patient Identification ORC R N Order details, Physician OBR R Y Order details Physician MUST be defined in ORC segment. If Patient or Physician DOES NOT exist in the database, it will be created. The software is flexible and able to conform to other message types and structures according to proper configuration. Order Segment Definitions For order segment definition for PID, MSH see ADT segment definition. For OBX segment definition, see Results segment definition. Common Order (ORC) SEQ Field name Max len Type OPT/ REQ Repeat count 2 Placer Order Number 3 Filler Order Number 22 EI R 22 EI R accession number 7 Quantity/timing 200 TQ R Order date\time 12 Ordering provider 120 XCN R ID^Last name^first Name^Middle name ORC Notes Control Order Types Code Inbound Outbound NW New order x 7 of 12
Observation Request (OBR) SEQ Field name Max len Type OPT/ REQ Repeat count 4 Universal service ID 200 CE R ProcID^ProcedureName 18 Placer field 1 60 ST O Accession Number Message Example MSH ^~\& 20070212165629609 ORM^O01 UC01_TR02A_0000010850 P 2.3.1 8859/1 PID 1 m010 000000000010 Simpson^^Lisa 19580715 F 145 Elm St^^Springfield^IL^35645 7065554343^^^m@m M 234908767 PV1 I ^^^FACILITY1 001280^^^HIS1 V ORC NW 0005742^HIS1 NW ^^^200702121656^070522145321^R^^Preferably in the afternoon PROVIDER-ID1234^Smith^George^^Junior^ ^MD^ OBR 1 RXTHORAX1^Red-Free 200702120830 200702121656 OBR 2 RXTHORAX2^Fundus Camera 200702120830 200702121656 Response Message Structure ACK: MSH MSA [ERR] Success acknowledgment message sample: MSH ^~\& NextGenEPM ACK 4 2.3 MSA AA 953310561 Failure acknowledgment message sample: MSH ^~\& NextGenEPM ACK 4 2.3 MSA AE 953310561 8 of 12
Order Result Messages New Visit Message Type MDM^T02, ORU^R01 Other message types that contain combination of supported fields can be defined (see table below for data that can be sent). Segment Name OPT/REQ Repeated Count /Use MSH R N Message Header / Message Header PID R N Patient Identification / Patient Identification PV1 O N Record info TXA O N OBX O Y Observation/text report The following data can be sent as NewRecord result: MRN Patient chart code Up to 5 Additional MRN's Sex Male, Female Current Date Visit Date PhysicianID VisitNumber Comments EyeCarePacs link Link to open EyeCarePacs Template Example MSH ^~\& Merge SCA TX04 SCA %s MDM^T02 %s P 2.3 AL NE EVN %s PID %s %s %s %s PV1 O ^^^ANA TXA 1 DS FT %s %s AU OBX MSH ^~\& Merge SCA TX04 SCA %s ORU^R01 %s P 2.3 AL NE 9 of 12
PID %s %s %s %s PV1 O ^^^ANA OBR 20 201204251055 OBX DigitalReporter Result (OBX) Message Type MDM^T02 Segment Name OPT/REQ Repeated Count /Use MSH R N Message Header / Message Header PID R N Patient Identification / Patient Identification TXA O N OBX R Y Observation/text report The following data can be sent: MRN Up to 5 additional MRN's FirstName LastName MiddleName Birthday Sex Address CurrentDate ProcedureDate All data from Digital reporter result EyeCarePacs link SymWebDigitalReportResult Table Link to open EyeCarePacs Message Example MSH ^~\& OIS01 SCA TX04 SCA 20030604144000 MDM^T02 0001234 P 2.3 AL NE EVN 20030604144000 PID 000015354346 JOHNSON^JOHN^J 20000101 M PV1 O ^^^ANA TXA 1 DS FT 20000101010101 PETERSON^ALAN^S^^^MD 15.1.14b352bd^Merge.Symphony AU 10 of 12
OBX 1 ST http://myserver/symphonyweb/vid=123456 OBX 2 ST Patient last name = Cohen F OBX 3 ST Patient birthdate = 06/07/02 F OBX 4 ST IOPL = 1 F OBX 5 ST Held by Alice Brown, MD on 2/5/2012 at 7:55 pm\.br\ ------------------------------------------------ \.br\ F OBX 6 ST Signed by Mark White, MD on 2/7/2012 at 3:45 pm\.br\ ------------------------------------------------.br\ F Expected Response Message Structure ACK: MSH MSA [ERR] DigitalReporter Append (OBX) Message Type MDM^T06 Segment name OPT/REQ Repeated count /use MSH R N Message Header / Message Header PID R N Patient Identification / Patient Identification TXA O N OBX R Y Observation/text report The following data can be sent: MRN Up to 5 additional MRN's PatientNmae Birthday Sex Address CurrentDate ProcedureDate ReportDate Doctor Record number Patient chart code First and Last name Date when report created 11 of 12
Message Example MSH ^~\& Merge Los Angeles SCA TX04 SCA 20120101144000 MDM^T06 0001234 P 2.3 AL NE EVN 20120101100000 PID 000015354346 JOHNSON^JOHN^J 20000101 M PV1 O ^^^ANA TXA 1 DS FT 20120101100000 PETERSON^ALAN^S^^^MD 15.1.14b352bd^Merge.Symphony AU OBX 1 ST This is an append sample text\.br\signed by John Smith, MD on February 09, 2012 at 16:14:32\.br\ F Expected Response Message Structure ACK: MSH MSA [ERR] 12 of 12