33
Merge Eye Station™ v. 11.6.1 HL7 INTERFACE SPECIFICATION Merge Healthcare 900 Walnut Ridge Drive Hartland, WI 53029

Merge Eye Station™ v. 11.6 · Merge Eye Station™ v. 11.6.1 HL7 INTERFACE SPECIFICATION Merge Healthcare 900 Walnut Ridge Drive Hartland, WI 53029

Embed Size (px)

Citation preview

Merge Eye Station™v. 11.6.1

HL7 INTERFACE SPECIFICATION

Merge Healthcare900 Walnut Ridge Drive

Hartland, WI 53029

© Copyright 2017 Merge Healthcare Incorporated, an IBM Company.

The content of this document is confidential information of Merge Healthcare Incorporated and its use and disclosure is subject to the terms of the agreement pursuant to which you obtained the software that accompanies the documentation.

Merge Healthcare® is a registered trademark of Merge Healthcare Inc.The Merge Healthcare logo is a trademark of Merge Healthcare Inc.All other names are trademarks or registered trademarks of their respective companies.

U.S. GOVERNMENT RESTRICTED RIGHTS:

This product is a “Commercial Item” offered with “Restricted Rights.” The Government’s rights to use, modify, reproduce, release, perform, display or disclose this documentation are subject to the restrictions set forth in Federal Acquisition Regulation (“FAR”) 12.211 and 12.212 for civilian agencies and in DFARS 227.7202-3 for military agencies. Contractor is Merge Healthcare.

INDICATIONS FOR USE:

Merge Eye Station is designed to be used in conjunction with the ophthalmic fundus cameras. As such, the indication for the system is to take images of the eye.

CAUTION: Not for diagnostic use on a mobile device such as a smart phone or a tablet.

CAUTION: U.S. federal law restricts this device to sale by, or on the order of, a physician.

CANADIAN DEVICE IDENTIFIER: MERGE EYE STATION

For application support or to report issues with user documentation, contact Customer Support:

● Direct Merge Eye Station Support: 877-741-5369

● Outside of North America: +31.40.299.0773

● Email: [email protected]

● Web site: http://www.merge.com/Solutions/Eye-Care/Merge-Eye-Station.aspx

The latest revision of this document can be found in Merge Communities.

Australian Sponsor IBM Australia LimitedLevel 13, IBM Centre601 Pacific HighwaySt Leonards, NSW, 2065 AustraliaABN 79 000 024 733Phone: 1800 117 425

Doc # Revision Date Description

WSTN-12253 1.0 5/25/17 Release 11.6.1.

EMERGO EUROPEPrinsessegracht 202514 AP, The HagueThe Netherlands

Manufacturer’s Address Merge Healthcare Incorporated900 Walnut Ridge DriveHartland, WI 53029

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION purpose

Merge

PurposeThis document is essential in order to evaluate whether an HL7 Information System (IS) can communicate with Eye Station. It only describes Segments and Fields that are used by Eye Station. Other segments and fields including those required by HL7 standards have been omitted from this document.

Acronyms and Abbreviations

Conventions

Term Description

R Required

O Optional

N Not used

HL7 Health Level 7

IS Information System - the system that Eye Station communicates with using HL7

UID Unique Identifier

Convention Description

{ } Curly braces indicate that a segment can repeat

[ ] Square brackets indicate that a segment is optional

3

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION contents

Merge

ContentsPurpose. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Acronyms and Abbreviations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Supported HL7 Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Message Trigger Events. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

HL7 Message Customization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Message Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Segment definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Message Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8

Order Messages (ORM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

PID Segment - Patient Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

PV1 Segment - Patient Visit Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

ORC Segment - Common Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

OBR Segment - Observation Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Order Result Messages (ORU) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

PID Segment - Patient Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

ORC Segment - Common Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

OBR Segment - Observation Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

OBX Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

OBX Segment for Order Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

OBX Segment for Digital Report Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

OBX Segment for Digital Report Append (Correction). . . . . . . . . . . . . . . . . . . . 18

OBX Segment for Interpretation Report Notification . . . . . . . . . . . . . . . . . . . . . 18

Medical Document Management (MDM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

PID Segment - Patient Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

TXA Segment - Patient Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

OBX Segment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

4

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION contents

Merge

OBX Segment for Digital Report Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

OBX Segment for Digital Report Append (Correction). . . . . . . . . . . . . . . . . . . . 24

OBX Segment for Interpretation Report Notification . . . . . . . . . . . . . . . . . . . . . 24

Patient Administration Message(ADT) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

PID Segment - Patient Identification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

MRG Segment - Patient Merge Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

Staff / Physician Information Message (MFN). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

STF Segment - Staff Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Acknowledgement Message (ACK) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

MSA Segment - Message Acknowledgement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Query Message (QRY) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

MSH Segment - Message Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

QRD Segment - Query Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32

5

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION supported hl7 messages

Merge

Supported HL7 MessagesMessage, segment and field definitions used by this interface are based on the HL7 2.5 standard and where possible match those specifications. The following messages/events are currently supported by Eye Station.

Message Trigger Events

The following activities should cause the Information System (IS) to initiate a message:

● The IS interface sends an order message (ORM) to EyeStation, when an order is created, updated, or cancelled. This message usually contains patient and physician information along with requested observation details.

● The IS interface sends an ADT message to EyeStation, whenever a patient's demographics are updated, or a patient is merged, or to send a response to demographics query.

● The IS interface sends an MFN message to EyeStation, whenever a physician information is added/updated.

The following activities cause the EyeStation to initiate a message:

● The EyeStation sends an order result message (ORU) to IS, whenever an order is fulfilled.

HL7 message Description

Orders ORM^O01 New/update/cancel order

Order Results ORU^R01 Result message

Digital Reports ORU^R01 Digital report document

MDM^T02

ORU^R01 Digital report correction/appendix document

MDM^T06

Patient ADT^A18 Merge patient/visit

ADT^A19 Patient query response

ADT^A28 Add person information

ADT^A31 Update person information

Patient Query QRY^Q01 Patient demographics query

QBP^Q11

Physicians MFN^M02 Add\Update physician

Acknowledgement ACK Message ACK or NACK response

Interpretation Reports

ORU^R01 Interpretation report document

MDM^T02

6

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION supported hl7 messages

Merge

● The EyeStation sends an MDM or ORU message to IS, when a digital or interpretation report is created or updated.

● The EyeStation sends a query message (QRY) to IS, whenever patient validation and additional demographic data is required.

● The EyeStation sends an ACK message (positive or negative acknowledgement) to IS, when an ORM, ADT, or MFN message is received and processed.

HL7 Message Customization

Message Rules

Eye Station uses message rules to define what segments are included in a particular message type.

For example a rule file may contain entries such as

MDM^T02:MSH EVN PID PV1 TXA {OBX}

ORM^O01:MSH PID ORC OBR

ORU^R01:MSH PID ORC OBR {OBX}

Each incoming and outgoing message must contain only those segments in the given sequence. If incoming messages contain extraneous segments the message will be rejected. It is therefore imperative that Merge implementation personnel configure the message rules to comply with the messages of the connected IS.

Segment definitions

Eye Station also uses segment definition files to define the structure of each segment used in messages and to define the mapping of fields to internal data structures. Eye Station fills internal variables from the field location as specified in segment definition file. This means that, for example, FillerOrderNumber could be received in ORC or OBR segment. It is therefore imperative that Merge implementation personnel configure the segment definition files to comply with the message standards of the connected IS.

7

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION supported hl7 messages

Merge

A complete list of variables that can be used in segment definitions is given below.

Message Templates

Eye Station generates messages using templates as shown below. It contains all segments, message type and fields that need to be sent with the message. Each %s is a place holder for variables and is replaced with values that are stored in the database. All other fixed fields and constants can also be pre-defined in these templates.

MSH|^~\&|Eye Station|SCA|HIS|SCA|%s||MDM^T02|%s|D|2.5|AL|AL|PID|||%s||%s||%s|%s|||||||||||||||||||||||PV1|%s|%s|TXA|1|DS-160|DS|%s|||%s|||||%s|||||AU|

patientId

AlternateId1

AlternateId2

AlternateId3

AlternateId4

AlternateId5

AssignAuthForPatientId1

AssignAuthForPatientId2

AssignAuthForPatientId3

AssignAuthForPatientId4

AssignAuthForPatientId5

LastName

FirstName

MiddleName

birthDate

sex

Religion

Ethnicity

Address

StreetAddress

OtherDesignation

City

StateOrProvince

ZipCode

Country

HomePhoneNum

Email

WorkPhoneNum

MessageId

MartialNameSuffix

MartialFamilyName

BirthNameSuffix

Language

// Staff Fields

StaffId

StaffName

StaffStatus

StaffFamilyName

StaffGivenName

StaffMiddlenName

StaffNameSuffix

StaffNamePrefix

StaffDegree

StaffAssigningAuthority

StaffIdentifierTypeCode

// Order Fields

OrderNumber

ProcedureCode

ProcedureName

AccessionNumber

OrderDateTime

OrderingPhysId

OrderingPhysFamilyName

OrderingPhysName

OrderingPhysGivenName

OrderingPhysMiddlenName

OrderingPhysNameSuffix

OrderingPhysNamePrefix

OrderingPhysDegree

OrderingPhysAssigningAuthority

OrderingPhysIdentifierTypeCode

InterpretingPhysId

InterpretingPhysFamilyName

InterpretingPhysName

InterpretingPhysGivenName

InterpretingPhysMiddlenName

InterpretingPhysNameSuffix

InterpretingPhysNamePrefix

InterpretingPhysDegree

InterpretingPhysAssigningAuthority

InterpretingPhysIdentifierTypeCode

PatientAccNum

StudyInstanceUID

PatientLocation

// Additional Patient fields

PreviousPatientID

8

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order messages (orm)

Merge

Order Messages (ORM)

The ORM^O01 message functions as a general order message that is used to transmit information about an order.

The trigger event for these messages is any change to an order. The IS will send an ORM message to Eye Station whenever an order is created, updated, or canceled.

When a new or update order message is received with an order number that does not exist in the Eye Station database, it is added to the database.

When an update order message is received with an order number that already exists in the Eye Station database, it is updated. If an order was previously matched to the visit record, the association is re-evaluated based on the updated information. The image file header of associated visits is also updated if needed.

When a cancel order message is received, it is removed from the Eye Station database. By default, order cancellation messages are rejected if any visits are already associated with the order. Optionally, the system can be configured to accept and process cancellations even if the order in question has associated visits.

When an order message is received for a patient that does not exist in the database, it is added as a result of the order. If the patient already exists, it is updated. Similar behavior applies to the physician record.

Multiple orders in the same ORM message are also supported. In this case, Order Control ID and other common data from ORC, PID, and PV1 segments are applicable to all subsequent OBR segments following the ORC segment.

Eye Station can process the following segments in this message. Note that the segments which need to be in the incoming message are defined by the message rule file.

Example

MSH|^~\&|RAD|RAD|OIFIN|PLW|20130124094643||ORM^O01|28475615|P|2.1|mgerena|EXSCHPID|||01002682||TEST^Carecast^^^^||19500608|M||||||||||250052941ORC|NW||20001119|||||||||000001^ABISSI^CHRISTOP^^^^OBR|||20001119OPHNERFIB|OPHNERFIB^^^^OCT- Nerve Fiber Layer^OT^Other^|||||Y|1.2.840.113745.101000.1018000.41296.4073.16513898|||^:||N|000001^ABISSI^C

Message Type Description

ORM^O01 General purpose order message

Segment name Required / Optional Description

MSH R Message Header

PID R Patient Identification

[PV1] O Patient Visit

{ORC} R Order control

{OBR} R Order details

9

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order messages (orm)

Merge

HRISTOP^^^^|718^409^4044^^|^^^^^|test^^^^|20001119|K722^Moses KLAU 7 722||OPHMAP|OPHT^Ophtalmology|O||^^^20130124095000||N|||||||20130124095000

The following sections describe details of fields used in each segment.

MSH Segment - Message Header

Message header contains the following information with ORM^O01 message type in MSH-9 field.

PID Segment - Patient Identification

This segment contains patient information.

Seq HL7 Field Name Required / Optional Description

1 Field Separator R Character “|”

2 Encoding Characters R Characters “^~\&”

3 Sending Application O Sending application name

4 Sending Facility O Sending facility name

5 Receiving Application O Receiving application name

6 Receiving Facility O Receiving facility name

7 Date/Time of Message R Date/time message was produced

9 Message Type R “ORM^O01”

10 Message Control ID R Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

Seq HL7 Field Name Required / Optional Description

3 Patient ID Internal R List of Patient IDs, MRN

5 Patient Name R Last^First^MI

7 Date Of Birth R YYYYMMDD

8 Sex R “F” is Female“M” is Male“U” is Unknown

10 Race O Ethnicity

11 Patient Address O Street1^Street2^City^State^Zip

10

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order messages (orm)

Merge

PV1 Segment - Patient Visit Information

This segment contains patient visit and physician information.

ORC Segment - Common Order

The Common Order segment (ORC) is used to transmit fields that are common to all orders (all types of services that are requested). The ORC segment is required in the Order (ORM) message.

13 Home Phone O

14 Business Phone O

15 Patient Language O

17 Religion O

18 Patient Account Number O Account number

Seq HL7 Field Name Required / Optional Description

3 Patient Location O Patient location

7 Attending Doctor O ID and name of attending doctor

8 Referring Doctor O ID and name of referring doctor

9 Consulting Doctor O ID and name of consulting/interpreting doctor

Seq HL7 Field Name Required / Optional Description

1 Order Control R “NW” if new“XO” if change“CA” if cancel

3 Filler Order Number O Order Number. Should be same in ORC and OBR

6.2 Order Laterality O Order laterality

7 Quantity/timing O Order date\time

12 Ordering Provider O Ordering PhysicianID^Last name^First Name^Middle name

Seq HL7 Field Name Required / Optional Description

11

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

OBR Segment - Observation Request

The Observation Request (OBR) segment is used to transmit information specific to an order for a diagnostic study or observation, physical exam, or assessment.

Expecting the following contents in these fields:

● Study Instance UID will be mapped to Seq 10

● Accession Number will be mapped to Seq 20

● Patient Location will be mapped to Seq 21

Order Result Messages (ORU)

The ORU^R01 message is for transmitting observation results from Eye Station to IS.

It can be triggered by these events.

● Order Filled Notification: When an order is fulfilled. In Eye Station this is the case when the images are imported or captured.

● Digital/Interpretation Report Notification: When Digital/Interpretation Report is generated.

Seq HL7 Field Name Required / Optional Description

1 Set ID O Sequence number

3 Filler Order Number R Order Number. Should be same in ORC and OBR

4 Universal Service ID R ExamCode^ExamDesc

10 Collector Identifier O Custom

16 Ordering Provider R Ordering Doctor (IDNum^Last^First^MI^^Title)

20 Filler Field 1 O Custom

21 Filler Field 2 O Custom

24 Diagnostic Service Sect ID R Modality ID such as OPHT - Ophthalmic

25 Results Status R For income messages it is normally O - Order Received

32 Principle Result Interpreter O Interpreting physician ID

36 Scheduled Date/Time R Date Time of scheduled procedure

Message Type Description

ORU^R01 Unsolicited Order Result message. Used for final results or correction/addendum

12

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

● Digital Report Append: Support MDM and ORU.

Eye Station can process the following segments in this message. Note that which segments need to be in the incoming message is defined by the message rule file.

Example

MSH|^~\&|RAD|RAD|OIFIN|PLW|20130124094643||ORU^R01|28475615|P|2.1|mgerena|EXSCHPID|||01002682||TEST^Carecast^^^^||19500608|M||||||||||250052941ORC|NW||20001119|||||||||000001^ABISSI^CHRISTOP^^^^OBR|||20001119OPHNERFIB|OPHNERFIB^^^^OCT- Nerve Fiber Layer^OT^Other^|||||Y|1.2.840.113745.101000.1018000.41296.4073.16513898|||^:||N|000001^ABISSI^CHRISTOP^^^^|718^409^4044^^|^^^^^|test^^^^|20001119|K722^Moses KLAU 7 722||OPHMAP|OPHT^Ophtalmology|F||^^^20130124095000||N|||||||20130124095000OBX|1|ST|||http://MyServer/SymphonyWeb/VID=123456|OBX|2|ST|||Patient last name = Cohen||||||FOBX|3|ST|||Patient birthdate = 06/07/02||||||F

The following sections describe details of fields used in each segment.

MSH Segment - Message Header

Message header contains the following information with ORU^R01 message type in MSH-9 field.

Segment name Required / Optional Description

MSH R Message Header

PID O Patient Identification

ORC O Order control

OBR R Order details

{OBX} R Observation

Seq HL7 Field Name Required / Optional Description

1 Field Separator R “|”

2 Encoding Characters R “^~\&”

3 Sending Application O Sending application nameFixed value in template

4 Sending Facility O Sending facility nameFixed value in template

5 Receiving Application O Receiving application nameFixed value in template

6 Receiving Facility O Receiving facility nameFixed value in template

13

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

PID Segment - Patient Identification

This segment contains patient information.

ORC Segment - Common Order

7 Date/Time of Message R Current Date/time when message was produced

9 Message Type R “ORU^R01”

10 Message Control ID R Generated by Eye Station. Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

Seq HL7 Field Name Required / Optional Description

3 Patient ID Internal R List of Patient IDs, MRN

5 Patient Name R Last^First^MI

7 Date Of Birth R YYYYMMDD

8 Sex R “F” is Female“M” is Male“U” is Unknown

10 Race O Ethnicity

11 Patient Address O Street1^Street2^City^State^Zip

13 Home Phone O

14 Business Phone O

15 Patient Language O

17 Religion O

18 Patient Account Number O Account number

Seq HL7 Field Name Required / Optional Description

1 Order Control R “NW” if new“XO” if change“CA” if cancel

Seq HL7 Field Name Required / Optional Description

14

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

OBR Segment - Observation Request

3 Filler Order Number O Defines Order Number in Eye Station database. Should be same in ORC and OBR

6.2 Order Laterality O Order laterality received from order

7 Quantity/timing O Order Result date\time

12 Ordering Provider O Ordering PhysicianID^Last name^First Name^Middle name

Seq HL7 Field Name Required / Optional Description

1 Set ID O OBR Segment count. Generated by Eye Station

3 Filler Order Number R Order Number taken from original message. Should be same in ORC and OBR

4 Universal Service ID R ExamCode^ExamDescTaken from original message

10 Collector Identifier O Custom

16 Ordering Provider R Ordering Doctor (IDNum^Last^First^MI^^Title)Taken from original message

20 Filler Field 1 O Custom

21 Filler Field 2 O Custom

24 Diagnostic Service Sect ID R Modality ID such as OPHT - OphthalmicTaken from original message

25 Results Status R Generated by Eye Station:P - Preliminary (for Order Filled Notification)F - Final (for DR Notification)C - Correction (For DR Append)

32 Principle Result Interpreter O Interpreting physician IDGenerated by Eye Station - ID of logged in user signing the report.

36 Scheduled Date/Time R Date Time of scheduled procedureGenerated by Eye Station

Seq HL7 Field Name Required / Optional Description

15

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

Expecting following contents in these fields:

● Study Instance UID will be mapped to Seq 10 - Taken from original order message.

● Accession Number will be mapped to Seq 20 - Taken from original order message.

● Patient Location will be mapped to Seq 21- Taken from original order message.

OBX Segment

The OBX segment is used to transmit an observation or post-exam notes from the technologist/physician. Depending on the use, it can contain various fields as listed below.

OBX Segment for Order Notification

Seq HL7 Field Name Required / Optional Description

1 Set ID O OBX segment count. Generated by Eye Station

2 Value Type R Value type identifier generated by Eye Station such asST - StringTX - TextFT - Formatted TextNM - Numeric

5 Observation Value R Observation text / comment generated by Eye Station. By default the following fields are configured to be sent:

● Eye / Laterality

● Diagnostic

● Procedure

● Visit / Record Number

● Photographer

● Allergy

● Comments

● URL Link to open visit in Eye Care PACS

11 Results Status R Generated by Eye StationC - CorrectionF - FinalO - Order Received

16

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

OBX Segment for Digital Report Notification

Seq HL7 Field Name Required / Optional Description

1 Set ID O OBX segment count. Generated by Eye Station

2 Value Type R Value type identifier generated by Eye Station such asST - StringTX - TextFT - Formatted TextNM - Numeric

5 Observation Value R Observation text / comment generated by Eye Station. By default the following fields are configured to be sent:

● Eye / Laterality● Diagnostic● Visit / Record Number● Allergy● MRN / Patient Chartcode● Patient Name● Photographer Code● Procedure Name● Procedure Date● DilationR● DilationL● VATypeR● VATypeL● IOPR● IOPL● IOPMethodR● IOPMethodL● Doctor Name● Insulin Indication● HgbA1c● HgbA1cDate● Interpretation● Follow up● Comments● URL Link to open visit in Eye

Care PACS

11 Results Status R Generated by Eye StationC - CorrectionF - FinalO - Order Received

17

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

OBX Segment for Digital Report Append (Correction)

Digital report append supports ORU or MDM messages.

OBX Segment for Interpretation Report Notification

Seq HL7 Field Name Required / Optional Description

1 Set ID O OBX segment count. Generated by Eye Station

2 Value Type R Value type identifier generated by Eye Station such asST - StringTX - TextFT - Formatted TextNM - Numeric

18

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION order result messages (oru)

Merge

5 Observation Value R Observation text / comment generated by Eye Station. By default the following fields are configured to be sent:

● Eye / Laterality● Diagnostic● Visit / Record Number● Allergy● MRN / Patient Chartcode● Patient Name● Photographer Code● Procedure Name● Procedure Date● DilationR● DilationL● VATypeR● VATypeL● IOPR● IOPL● IOPMethodR● IOPMethodL● Doctor Name● Insulin Indication● HgbA1c● HgbA1cDate● Interpretation● Follow up● Comments● URL Link to open visit in Eye

Care PACS● ICD-10 Codes

11 Results Status R Generated by Eye StationC - CorrectionF - FinalO - Order Received

Seq HL7 Field Name Required / Optional Description

19

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION medical document management (mdm)

Merge

Medical Document Management (MDM)

MDM message helps manage medical records by transmitting new or updated documents. It can be triggered by these events.

● Digital/Interpretation Report Notification: When Digital/Interpretation Report is generated

● Digital Report Append: When Digital report is updated with a comment

Eye Station can process the following segments in this message. Note that which segments need to be in the incoming message is defined by the message rule file.

Example

MSH|^~\&|RAD|RAD|OIFIN|PLW|20130124094643||MDM^T02|28475615|P|2.1|mgerena|EXSCHPID|||01002682||TEST^Carecast^^^^||19500608|M||||||||||250052941TXA|1|PN|TX|200601051800|50041^SMITH^CHRIS^M|200601051800|200601051800|200601051800|||SC^ROBINSON^JESSICA^A|1234567890||||FILE0001.TXT|PROBX|1|ST|||http://MyServer/SymphonyWeb/VID=123456|OBX|2|ST|||Patient last name = Cohen||||||FOBX|3|ST|||Patient birthdate = 06/07/02||||||F

The following sections describe details of fields used in each segment.

MSH Segment - Message Header

Message header contains following information with MDM^T02 or MDM^T06 message types in MSH-9 field.

Message Type Description

MDM^T02 Transmission of new results

MDM^T06 Transmission of addendum comments

Segment name Required / Optional Description

MSH R Message Header

PID O Patient Identification

TXA R Document notification

{OBX} R Observation

Seq HL7 Field Name Required / Optional Description

1 Field Separator R “|”

2 Encoding Characters R “^~\&”

3 Sending Application O Sending application name

20

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION medical document management (mdm)

Merge

PID Segment - Patient Identification

This segment contains patient information.

4 Sending Facility O Sending facility name

5 Receiving Application O Receiving application name

6 Receiving Facility O Receiving facility name

7 Date/Time of Message R Date/time message was produced

9 Message Type R “MDM^T02 or MDM^T06”

10 Message Control ID R Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

Seq HL7 Field Name Required / Optional Description

3 Patient ID Internal R List of Patient IDs, MRN

5 Patient Name R Last^First^MI

7 Date Of Birth R YYYYMMDD

8 Sex R “F” is Female“M” is Male“U” is Unknown

10 Race O Ethnicity

11 Patient Address O Street1^Street2^City^State^Zip

13 Home Phone O

14 Business Phone O

15 Patient Language O

17 Religion O

18 Patient Account Number O Account number

Seq HL7 Field Name Required / Optional Description

21

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION medical document management (mdm)

Merge

TXA Segment - Patient Identification

The TXA segment contains information specific to a transcribed document but does not include the text of the document.

OBX Segment

Depending on the use, OBX segment can contain various fields as listed below.

OBX Segment for Digital Report Notification

Following fields can be sent in OBX segment when transmitting a digital report using MDM^T02 message.

Seq HL7 Field Name Required / Optional Description

1 Set ID O

2 Document Type R A document identifier such asDS - Discharge summaryPN - Procedure NotesTN - Transfer NotesCN - Consultation

3 Document Content type R A document content identifier such asFT - Formatted textTX - Text Document

4 Activity Date R Date time of Activity

9 Originator ID O Physician ID and Name

14 Placer Order Number O Accession Number

15 Filler Order Number R Order number

17 Document Completion Status

A value such asAU - AuthenticatedDI - DictatedIP - In progress

Seq HL7 Field Name Required / Optional Description

1 Set ID O OBX segment count. Generated by Eye Station

22

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION medical document management (mdm)

Merge

2 Value Type R Value type identifier generated by Eye Station such asST - StringTX - TextFT - Formatted TextNM - Numeric

5 Observation Value R Observation text / comment generated by Eye Station. By default the following fields are configured to be sent:

● Eye / Laterality● Diagnostic● Visit / Record Number● Allergy● MRN / Patient Chartcode● Patient Name● Photographer Code● Procedure Name● Procedure Date● DilationR● DilationL● VATypeR● VATypeL● IOPR● IOPL● IOPMethodR● IOPMethodL● Doctor Name● Insulin Indication● HgbA1c● HgbA1cDate● Interpretation● Follow up● Comments● URL Link to open visit in Eye

Care PACS

11 Results Status R Generated by Eye StationC - CorrectionF - FinalO - Order Received

Seq HL7 Field Name Required / Optional Description

23

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION medical document management (mdm)

Merge

OBX Segment for Digital Report Append (Correction)

Digital report appendix results can be sent with MDM^T06 message when a comment is added to the Digital Report. OBX segment of this message only contains appendix comments as opposed to ORU in which complete report is re-sent.

OBX Segment for Interpretation Report Notification

Following fields can be sent in OBX segment when transmitting a digital report using MDM^T02 message.

Seq HL7 Field Name Required / Optional Description

1 Set ID O OBX segment count. Generated by Eye Station

2 Value Type R Value type identifier generated by Eye Station such asST - StringTX - TextFT - Formatted TextNM - Numeric

24

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION medical document management (mdm)

Merge

5 Observation Value R Observation text / comment generated by Eye Station. By default the following fields are configured to be sent:

● Eye / Laterality● Diagnostic● Visit / Record Number● Allergy● MRN / Patient Chartcode● Patient Name● Photographer Code● Procedure Name● Procedure Date● DilationR● DilationL● VATypeR● VATypeL● IOPR● IOPL● IOPMethodR● IOPMethodL● Doctor Name● Insulin Indication● HgbA1c● HgbA1cDate● Interpretation● Follow up● Comments● URL Link to open visit in Eye

Care PACS● ICD-10 Codes

11 Results Status R Generated by Eye StationC - CorrectionF - FinalO - Order Received

Seq HL7 Field Name Required / Optional Description

25

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION patient administration message(adt)

Merge

Patient Administration Message(ADT)The ADT message is sent by HIS to Eye Station when Patient information is updated.

When an ADT message is received and the patient does not already exist in the Eye Station database, a new patient record is created. Otherwise if the patient already exists, it is updated according to the message content.

It has following segments. Note that MRG segment is only used with A18 event.

Example

MSH|^~\&|EPIC|BRIDGES|||20101108094412|JM5405|ADT^A18|16657447|P|2.3|||PID|1|E936045^^^^EPI~000548340^^^^STMH~35226295^^^^DMC~5322974^^^^SMDV|5322974^^^50^SMDV||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|||||||||||NMRG|31874908^^^10^DMC|||31874908^^^10^DMC|

The following sections describe details of fields used in each segment.

MSH Segment - Message Header

Message header contains following information with ADT message types such as ADT^A18, ADT^A28, or ADT^A31 in MSH-9 field.

Message Type Description

ADT^A28 Add Person or Patient Information

ADT^A31 Update Person Information

ADT^A18 Merge Patient Information

Segment name Required / Optional Description

MSH R Message Header

PID R Patient Identification

[MRG] R Merge Information (Used with A18 event only)

Seq HL7 Field Name Required / Optional Description

1 Field Separator R Character “|”

2 Encoding Characters R Characters “^~\&”

3 Sending Application O Sending application name

4 Sending Facility O Sending facility name

26

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION patient administration message(adt)

Merge

PID Segment - Patient Identification

This segment contains patient information.

5 Receiving Application O Receiving application name

6 Receiving Facility O Receiving facility name

7 Date/Time of Message R Date/time message was produced

9 Message Type R “ADT^A31”

10 Message Control ID R Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

Seq HL7 Field Name Required / Optional Description

3 Patient ID Internal R List of Patient IDs, MRN

5 Patient Name R Last^First^MI

7 Date Of Birth R YYYYMMDD

8 Sex R “F” is Female“M” is Male“U” is Unknown

10 Race O Ethnicity

11 Patient Address O Street1^Street2^City^State^Zip

13 Home Phone O

14 Business Phone O

15 Patient Language O

17 Religion O

18 Patient Account Number O Account number

Seq HL7 Field Name Required / Optional Description

27

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION staff / physician information message (mfn)

Merge

MRG Segment - Patient Merge Information

This segment contains information to merge. The PID segment contains the surviving patient ID information. The MRG segment contains the non-surviving information.

Staff / Physician Information Message (MFN)The MFN message is used to receive physician information.

When an MFN message is received and the physician does not already exist in the Eye Station database, a new physician record is created. Otherwise if the physician already exists, it is updated according to the message content.

It has following segments. Note that MRG segment is only used with A18 event.

Example

MSH|^~\&|MPV00|NCA|IE00|KP|20070723192553.7460-0700||MFN^M02|20070723092209606032|P|2.3|||NE|NESTF|0006255^^99KP1014|0006255^^^KP1014^PRN~57999^^^KP1014^OPRN~A22385^^^CMS^UPIN~00A209270^^^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||||||

The following sections describe details of fields used in each segment.

Seq HL7 Field Name Required / Optional Description

1 Prior Patient ID List R List of Patient IDs, MRN

3 Prior patient Account Number

O Account number

4 Prior patient ID R

5 Prior Visit number O Visit Number

7 Prior patient Name O Last^First^MI

Message Type Description

MFN^M02 Staff/Physician Information

Segment name Required / Optional Description

MSH R Message Header

STF R Staff/Physician Identification

28

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION acknowledgement message (ack)

Merge

MSH Segment - Message Header

Message header contains following information with MFN^M02 message type in MSH-9 field.

STF Segment - Staff Identification

This segment contains physician information.

Acknowledgement Message (ACK)Eye Station sends an ACK message to IS in response to receiving an Order message (ORM), Patient demographics (ADT), or Physician information (MFN).

Seq HL7 Field Name Required / Optional Description

1 Field Separator R Character “|”

2 Encoding Characters R Characters “^~\&”

3 Sending Application O Sending application name

4 Sending Facility O Sending facility name

5 Receiving Application O Receiving application name

6 Receiving Facility O Receiving facility name

7 Date/Time of Message R Date/time message was produced

9 Message Type R “MFN^M02^MFN_M02”

10 Message Control ID R Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

Seq HL7 Field Name Required / Optional Description

2 Staff Identifier R PhysicianID^ Assigningauthority^ IdentifierTypeCode

3 Staff Name R Lastname^FirstName^Prefix^Suffix^Degree

29

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION acknowledgement message (ack)

Merge

When the message is successfully processed, a positive ACK is sent. Otherwise a negative ACK with an error description is sent to the IS.

The acknowledgement message contains following segments.

Example

MSH|^~\&|||||20031004034618757||ACK|79182||2.3||||||| MSA|AA|68164||||

MSH Segment - Message Header

Message header contains following information with ACK message type in MSH-9 field.

Message Type Description

ACK Acknowledgment message

Segment name Required / Optional Description

MSH R Message Header

MSA R Message Acknowledgement

Seq HL7 Field Name Required / Optional Description

1 Field Separator R Character “|”

2 Encoding Characters R Characters “^~\&”

3 Sending Application O Sending application name

4 Sending Facility O Sending facility name

5 Receiving Application O Receiving application name

6 Receiving Facility O Receiving facility name

7 Date/Time of Message R Date/time message was produced

9 Message Type R ACK

10 Message Control ID R Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

30

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION query message (qry)

Merge

MSA Segment - Message Acknowledgement

This segment contains the ACK code and the error message.

Query Message (QRY)Eye Station sends a query message (QRY) to the IS whenever patient validation and additional demographic data is required.

The query message contains following segments.

Example

MSH|^~\&|||||20031004034618757|| QRY^Q01|79182||2.3||||||| QRD|20031004034618757|R|I|Q123||||Pat123|DEM|WINSTN||TQRF|WINSTN||||

Seq HL7 Field Name Required / Optional Description

1 Acknowledgement Code

R AA = Application Accept

AE = Application Error

2 Message Control ID R Message Control ID of the MSH segment (field 10) that was sent with the order.

3 Text Message In case of negative ACK, error description or reason

Message Type Description

QRY^Q01 Query message

Segment name Required / Optional Description

MSH R Message Header

QRD R Query Definition

[QRF] O Query Filter

31

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION query message (qry)

Merge

MSH Segment - Message Header

Message header contains following information with QRY^Q01 message type in MSH-9 field.

QRD Segment - Query Definition

This segment contains the requested query.

Seq HL7 Field Name Required / Optional Description

1 Field Separator R Character “|”

2 Encoding Characters R Characters “^~\&”

3 Sending Application O Sending application name

4 Sending Facility O Sending facility name

5 Receiving Application O Receiving application name

6 Receiving Facility O Receiving facility name

7 Date/Time of Message R Date/time message was produced

9 Message Type R QRY^Q01

10 Message Control ID R Unique id for this message (e.g., a time stamp)

11 Processing ID O D -debugging, P-production, T-teaching

12 Version ID R HL7 version such as “2.5”

Seq HL7 Field Name Required / Optional Description

1 Query Date/Time R Date/time of query

2 Query format code R D - Response is in display format

R - Response is in record-oriented format

T - Response is in tabular format

3 Query priority R D - Deferred

I - Immediate

4 Query ID R ID of the query

8 Who subject filter R ID and name of the person being queried

9 What subject filter R What is being queried such as DEM, ORD, APN

32

Healthcare Confidential

MERGE EYE STATION™ V. 11.6.1 HL7 INTERFACE SPECIFICATION query message (qry)

Merge

11 Query results level R O - Order plus order status

R - Results without bulk text

S - Status only

T - Full results

Seq HL7 Field Name Required / Optional Description

33

Healthcare Confidential