and hrt spectralis, hep heyex 2 for integration hl7

HEYEX 2 forSPECTRALIS, HEPand HRT

Ophthalmic ImageManagement and DeviceIntegration HL7 InterfaceDescription and ConformanceStatement

July 2017© Heidelberg Engineering GmbHArticle No. 230068-002 GL.AE17

© Heidelberg Engineering GmbH

Corporate HeadquartersHeidelberg Engineering GmbHMax-Jarecki-Str. 869115 Heidelberg/GermanyTelephone: +49 (0) 6221 64 63 0Fax: +49 (0) 6221 64 63 62

AustraliaHeidelberg Engineering Pty Ltd404 Albert St.East Melbourne 3002VictoriaTelephone: +61 (396) 392 125Fax: +61 (396) 392 127

SwitzerlandHeidelberg Engineering GmbHAlte Winterthurerstrasse 888309 Nürensdorf/SwitzerlandTelephone: +41 (0) 44 8887 020Fax: +41 (0) 44 8887 024

UKHeidelberg Engineering Ltd.55 MarlowesHemel HempsteadHertfordshire HP1 1LETelephone: +44 (0) 1442 502 330Fax: +44 (0) 1442 242 386

USAHeidelberg Engineering, Inc.1808 Aston Avenue, Suite 130Carlsbad, CA 92008Telephone: +1 (800) 931 2230Fax: +1 (760) 536 7100

Email: [email protected]: http://www.HeidelbergEngineering.com

Table of contents1 Preface................................................................................. 4

1.1 Purpose and Audience of this Document..................... 41.2 Symbols used in this Document................................... 41.3 Terms and Definitions................................................... 6

2 Conformance Statement.................................................... 73 Message Types.................................................................... 9

3.1 Introduction................................................................... 93.2 Admit Discharge Transfer........................................... 103.2.1 ADT A01.................................................................. 103.2.2 ADT A08.................................................................. 133.2.3 ADT A40.................................................................. 143.3 Order Entry................................................................. 163.3.1 OMG O19................................................................ 163.3.2 OMI O23.................................................................. 213.3.3 ORM O01................................................................. 263.4 Notification.................................................................. 313.4.1 OMG O19................................................................ 313.4.2 ORM O01................................................................. 353.4.3 ORR O02................................................................. 373.5 Query.......................................................................... 393.5.1 QBP Q22................................................................. 393.6 Medical Document Management................................ 413.6.1 MDM T02................................................................. 413.7 Receiving Reports...................................................... 443.7.1 ORU R01................................................................. 44

Table of contents

© Heidelberg Engineering GmbH, Article No. 230068-002 GL 3

1 Preface1.1 Purpose and Audience of this Document

HEYEX 2 is a software module for ophthalmic image managementand device integration. As such it is an integrated part of theHeidelberg Engineering products.This document is intended for IT specialists with a comprehensiveknowledge of the HL7 standard, who are responsible for theintegration of HEYEX 2 with medical information systems.A medical information system might be:

▪ Hospital Information System▪ Electronic Medical Record▪ Reporting System▪ Order Entry System▪ Patient Scheduling System▪ Transcription System

1.2 Symbols used in this DocumentThis chapter describes the definition, formatting, and symbols usedin this document.

The code of, for example, the heyex.ini file is identified bymonospaced typeface, for example DefaultDevice=1.

Cross-references are identified by parentheses and a black arrow(°), for example: ( “Cross-references”, p. 4).

Examples are identified by a gray background over the entirewidth of the page.

Examples

Elements of the graphical user interface like buttons, windownames, or file names are identified by quoted “italic” font, forexample “Next” .

Keys are identified by their symbol, for example + .

Lists are used for structuring information and are marked by redsquares:

▪ List entry▪ List entry

Menu paths in the software are identified by quoted “italic” font.Each menu item is separated by a black triangle u, for example“File ► Save as”.

Code

Cross-references

Elements of the graphical userinterface

Keys

Lists

Menu paths

Preface

Symbols used in this Document

1

© Heidelberg Engineering GmbH, Article No. 230068-002 GL4

Procedures are used for supporting the reader in completing a taskand are marked by red triangles:

Step 1. Step 2.

Safety messages are indicated by symbols in this document. Theyare marked by a signal word and a safety alert symbol indicatingthe category of the hazard.

WARNING!Warning indicates a hazardous situation which, if notavoided, could result in death or serious injury.

CAUTION!Caution with the safety alert symbol indicates ahazardous situation which, if not avoided, couldresult in minor or moderate injury.

NOTICE!Notice is used to address practices not related topersonal injury.

This symbol indicates helpful hints for using thedevice and software.

Embedded safety messages are integrated into the step of theprocedure when they should be followed.L CAUTION! This is an embedded safety message of the type"Caution".

The embedded safety message includes the use of a signal word,the safety alert symbol, and the message.

This is an embedded safety message of the type "Note".

Safety messages answer the following questions:▪ What is the hazard?▪ What are possible consequences of not avoiding the hazard?▪ How should the hazard be avoided?

Information available on websites is identified by underlined text,for example http://www.heidelbergengineering.com. Click on theURL to open the corresponding website.

Procedures

Safety messages

Embedded safety messages

URL

Preface

Symbols used in this Document

1


1.3 Terms and DefinitionsThis chapter defines the abbreviations and terms used in thisdocument.

The accession number is a number that uniquely identifies theimaging order that was requested for a patient.

Digital Imaging and Communications in MedicineA standard image file format and communication protocol inmedicine for the exchange of medical images and data betweensystems.

DICOM Modality WorklistDICOM standard for the query and import of orders and patientdemographics into the modality's patient database.

Data interchange format of the Heidelberg Eye Explorer

An examination consists of a set of series.

Heidelberg Eye Explorer

Hospital Information System

Health Level 7A set of international standards for transfer of clinical andadministrative data between software applications used by varioushealthcare providers.

Imaging device or imaging mode of an imaging device

Picture Archiving and Communication SystemSystems which store, and often display, medical images in DICOMformat.

A series generally equates to a specific type of data. A set of seriesis an examination.

Minimum Lower Layer Protocol

Accession number

DICOM

DICOM MWL

E2E

Examination

HEYEX

HIS

HL7

Modality

PACS

Series

MLLP

Preface

Terms and Definitions

1


2 Conformance StatementThe HEYEX 2 HL7 interface converts inbound HL7 messages toDICOM data readable by HEYEX 2. The interface implementationis in accordance with the IHE framework for the Image Manager /Archive actor, supporting the Scheduled Workflow and PatientInformation Reconciliation profiles. The message types areimplemented according to either version 2.5.1 or version 2.3.1 ofthe HL7 standard.

HEYEX 2 uses a Windows service as an HL7 interface listener onthe following ports:

▪ 5678, internal▪ 5679, general▪ 5680, ADT messages▪ 5681, ORM, OMG, and OMI messages

This Windows service monitors, interprets, and reacts to inboundHL7 messages.

Message transport between HEYEX 2 and an external system isimplemented by default by a TCP/IP socket connection.

▪ TCP/IP socket connection▪ File transfer method

A file transfer method needs access to a commonnetwork share.

HEYEX 2 conforms to the message hierarchy defined by the HL7standard.

HEYEX 2 recognizes selected message types defined in the HL7standard ( “Message types recognized by HEYEX 2”, p. 7). Fordetails on the message types, segments, fields and mapping ofthose parameters to DICOM, refer to ( Chapter 3 “MessageTypes”, p. 9).

Message types recognized by HEYEX 2

MessageType

Description

ACK General acknowledgment message

ADT A01 Admit/visit notification

ADT A08 Update patient information

ADT A040 Merge patient - patient identifier list

MDM T02 Original document notification and content

OMG O19 General clinical order

OMI O23 Imaging order

Implementation Model

Message Transport

Message Hierarchy

Message types

Conformance Statement 2


MessageType

Description

ORM O01 Order message

ORR O02 Order response

ORU R01 Unsolicited transmission of an observationmessage

QBP Q22 Query by parameter

HEYEX 2 conforms to the HL7 MLLP block format as follows:▪ An HL7 message starts with a vertical tab.▪ An HL7 segment ends with a segment separator.▪ An HL7 message ends with a file separator and a segment

separator.HEYEX 2 uses delimiters as specified by the HL7 standard( “HL7 delimiters used by HEYEX 2”, p. 8).

HL7 delimiters used by HEYEX 2

Delimiter ASCII -Decimal

ASCII -Hexadecimal

Description

<VT> 11 0B Vertical tab

<FS> 28 1C File separator

<CR> 13 0D Segment separator

| 124 7C Field separator

^ 94 5E Componentseparator

& 38 26 Subcomponentseparator

~ Repetition separator

\ 92 5C Escape character

If a message acknowledgment is requested, HEYEX 2 will send anACK message.

Message Syntax

Acknowledgment

Conformance Statement2


3 Message Types3.1 Introduction

For each message type, the following information is given:▪ the revision of the HL7 standard to which the respective message

type conforms to▪ the message structure▪ an example message▪ the specification of the required and optional data fields for HEYEX

2 and their mapping to DICOM elements.

Abbreviation Description

SEQ Original position of the data field within thesegment

LEN Maximum number of characters that oneoccurrence of the data field might occupy

DT Basic building block used to construct or restrictthe contents of a data field

R/O Required/Optional

ID ID number for the data field

Description Descriptive name for the data field

The data type CE includes information according to ( “CE datastructure”, p. 9).

CE data structure

No. Description DT

1 Identifier ST

2 Text ST

3 Name of coding system ST

4 Alternate identifier ST

5 Alternate text ST

6 Name of alternate codingsystem

ST

CE data structure

Message Types

Introduction

3


The StudyInstanceUID (ZDS-1) is a DICOM-specifickey for examinations. It can be generated by themedical information system or by HEYEX 2. If themedical information system cannot generate this key,it might use the following four keys instead:

▪ Patient identifier list (PID-3)▪ Placer field 1 (OBR-18)▪ Placer field 2 (OBR-19)▪ Filler field 1 (OBR-20)

DICOM and HL7 might have different restrictionsregarding the length of a specific field. For HL7 fieldsthat are mapped to DICOM fields, refer to theDICOM standard for information about the allowedfield length.

The maximum length for AE Title and AccessionNumber is 16.

3.2 Admit Discharge Transfer3.2.1 ADT A01

This message type is implemented according torevision 2.3.1 of the HL7 standard.

Message Types

Admit Discharge Transfer

3


Fig. 1: Structure of message type ADT A01

Segment Required segment[ Segment] Optional segment{Segment } Repeating segment[{Segment }] Optional repeating segment

Segment evaluated by HEYEX 2

MSH|^~\&|HIS_PA|HIS_PP|HEYEX|HE_ADT|20150707143503||ADT^A01|123|P|2.5|||AL|NE||UNICODE UTF-8||||EVN|A01|20150707143601 PID|1||PID12345^HIS||Test^Patient||20001125|M|||UNKNOWN^^UNKNOWN^^99999^D||||||||||||||||||||||||||||PV1|1|I|OPH1||||||||||||||||V0008111111||||||||||||||||||||||||||||||||||IN1||0000409605|0104212505|TestKK|Teststr.25^^Testcity^DE^12121|||||||19381124|99991231||M|||00000000

Example message ADT A01

MSH fields

SEG LEN Description ID DT DICOM Tag DICOM Description /Comment

R/O

1 1 Field separator 1 ST - - R

2 4 Encoding characters 2 ST - - R

3 180 Sending application 3 HD - - O

4 180 Sending facility 4 HD 0008,0080 Part of institution name R

5 180 Receiving application 5 HD - - O

6 180 Receiving facility 6 HD - - O

9 7 Message type 9 MSG - - R

Message Types


3



R/O

10 20 Message control ID 10 ST - - R

11 3 Processing ID 11 PT - - R

12 60 Version ID 12 VID - - R

15 2 Accept acknowledgmenttype

15 ID - NE = NeverAL = Always

O

18 16 Character set 692 ID - Unicode UTF-8 O

PID fields


R/O

3 20 Patient identifier list 106 CX 0100,0020 Patient ID R

5 48 Patient name 108 XPN 0010,0010 Patient's name R

6 48 Mother´s maiden name 109 XPN - - O

7 26 Date/Time of birth 110 TS 0010,0030 Patient's birth date R

8 1 Administrative sex 111 IS 0010,0040 Patient's sex R

9 48 Patient alias 112 XPN - - O

10 80 Race 113 CE - - O

11 106 Patient address 114 XAD - - R

12 4 County code 115 IS - - O

13 40 Phone number - home 116 XTN - - O

14 40 Phone number - business 117 XTN - - O

18 20 Patient account number 121 CX 0038,0010 Admission ID (see PV1) O

19 16 SSN number - patient 122 ST 0038,0011 Issuer of admission ID O

20 25 Driver´s license number -patient

123 DLN - - O

PV1 fields


R/O

8 60 Referring doctor 138 XCN 0008,0090 Referring physician's name O

19 20 Visit number 149 CX 0038,00100038,0011

Admission ID, issuer ofAdmission ID

O

Message Types


3


IN1 fields


R/O

1 4 Set ID - IN1 426 SI - - O

2 60 Insurance plan ID 368 CE - - O

3 59 Insurance company ID 428 CX - - O

49 12 Insured`s ID number 1230 CX - - O

3.2.2 ADT A08





MSH|^~\&|HIS_PA|HIS_PP|HEYEX|HE_ADT|20150708143503||ADT^A08|123|P|2.5|||AL|NE||EVN|A08|20150708143601PID|1||PID12345^HIS||Test^Patient||19741125|M|||Teststreet1^^Testcity^^12345^D||||||||||||||||||||||||||||PV1|1|I|OPH1||||||||||||||||V0008111111||||||||||||||||||||||||||||||||||


Message Types


3


The patient to be updated is identified using thePatient ID (PID-3.1).

MSH fields


R/O



4 227 Sending facility 4 HD 0008,0080 Part of institution name O







O

PID fields


R/O


4 20 Alternate Patient ID - PID 107 CX 0010,1000 Other patient ID O






22 80 Ethnic group 125 CE - - O

3.2.3 ADT A40


Message Types


3





MSH|^~\&|HIS_PA|HIS_PP|HEYEX|HE_ADT|20150709143503||ADT^A40|123|P|2.5|||AL|NE||EVN|A40|20150709143601PID|1||PID0815^HIS||Test^Patient||19741125|M|||Teststreet1^^Testcity^^12345^D||||||||||||||||||||||||||||MRG|PID12345^^||


The patient to be merged is identified using the priorpatient identifier list (MRG-1). This patient will bemerged into the patient identified by the patientidentifier list (PID-3).

MSH fields


R/O










O

Message Types


3


PID fields


R/O


4 20 Alternate patient ID - PID 107 CX 0010,1000 Other patient ID O






22 80 Ethnic group 125 CE - - O

MRG fields


R/O

1 20 Prior patient identifier list 211 CX 0100,0020 Patient ID R

3.3 Order EntryHEYEX 2 uses ORM O01 as the default message type for orderentries.

3.3.1 OMG O19


Message Types

Order Entry

3


Fig. 4: Structure of message type OMG O19



MSH|^~\&|||HEYEX|HE_MWL|20150624163617||OMGÔ19ÔMG_O19|2|P|2.5|||AL|NE||UNICODE UTF-8PID||P0300028|P0300028||Test^Patient||19741008|M|||UNKNOWN^ÛNKNOWN^^99999^D|||||||V300022|||||||||PV1||I|43S05|A||||Dr. Jackson||||||||0|||V300022||K|||||||||||||||||||||||20150624000000|||||||||ORC|NW|AN39152168|AN39152168|||| |||SUPERVISOR||||203||||||TQ1|||||||20150624120000||R^ROUTINE^1.3.6.1.4.1.21367.100.1OBR|1|AN39152168|AN39152168||||||||||PATIENT IS ...||Spectralis-OCT^^^^|||AN39152168|2|123|OPH1|||OPT||||||||||||||||||||1^Spectralis OCT^0^0^Spectralis OCT^||L|

Example message OMG O19

Message Types

Order Entry

3


MSH fields


R/O




9 15 Message type 9 MSG - OMG^O19^OMG_O19 R






O


PID fields


R/O


4 Alternate patient ID - PID 107 CX 0100,1000 Other patient ID O






22 250 Ethnic 125 CE - - O

PV1 fields


R/O

3 80 Assigned patient location 133 PL 0038,03000040,0100 -> 0040,0011

Current patient locationScheduled procedure steplocation

O

8 250 Referring doctor 138 XCN 0008,0090 Referring physician's name R

15 2 Ambulatory status 145 IS 0010,21c00038,0050

Pregnancy status specialneeds

O

16 2 VIP Indicator 146 IS 0040,3001 Confidentiality constraint onpatient

O

Message Types

Order Entry

3



R/O

19 250 Visit number 149 CX 0038,00100038,0011


R

21 2 Charge price indicator 151 IS - Can be used to indicate theaccounting status of thepatient, such as privatepayment or insurancecoverage.

R

AL1 fields


R/O

3 250 Allergen code/mnemonic/description

205 CE 0010,2110 Contrast allergy O

ORC fields


R/O

1 2 Order control 215 ID - ▪ NE - New▪ CA - Cancel▪ XO - Change▪ DC - Discontinue

R

2 22 Placer order number 216 EI 0040,2016 Placer order number /imaging service request

O

3 22 Filler order number 217 EI 0040,2017 Filler order number /imaging service request

R

5 2 Order status 219 ID - - R

10 250 Entered by 224 XCN 0040,2008 Entered By... O

14 250 Call back phone number 228 XTN 0040,2010 Order callback phonenumber

O

17 250 Entering organization 231 CE 0040,2009 Order entering location O

TQ1 fields


R/O

7 26 Start date/time 1633 TS 0040,00020040,0003

Start dateStart time

R

9 250 Priority 1635 CWE - - O

Message Types

Order Entry

3


OBR fields


R/O


O


R

12 250 Danger Code 246 CE 0038,0500 Patient state O

13 300 Relevant Clinical Info. 247 ST 0010,2000 Medical alert O

15 300 Specimen source 249 CM 0032,1060 Use OBR-46.1 RequestedProcedure Description (add5th component "L/R")

O

16 250 Ordering provider 226 XCN 0032,1032 Requesting physician O

18 60 Placer field 1 251 ST 0008,0050 Accession number R

19 60 Placer field 2 252 ST 0040,1001 Requested procedure ID O

20 60 Filler field 1 253 ST 0040,0009 Scheduled procedure stepID

O

21 60 Filler field 2 254 ST 0040,00010040,0010

Scheduled station AE titleScheduled station name

R

24 10 Diagnostic serv sect ID 257 ID 0008,0060 ModalityExamples:

▪ AR, Autorefraction▪ KER, Keratometry▪ IOL, Intraocular Lens

Data▪ LEN, Lensometry▪ OAM, Ophthalmic Axial

Measurements▪ OPM, Ophthalmic

Thickness Map▪ OP, Ophthalmic

Photography▪ OPT, Ophthalmic

Tomography▪ OPV, Ophthalmic Visual

Field▪ OT, Other▪ US, Ultrasound

R

30 20 Transportation mode 262 ID 0040,1004 Patient transportarrangements

O

31 250 Reason for study 263 CE 0040,2001 Reason for imaging request O

34 200 Technician 266 CM 0040,0006 Scheduled performingphysician's name

O

Message Types

Order Entry

3



R/O

44 250 Procedure code 393 CE 0032,10600032,10640040,00070040,0008

Requested proceduredescriptionRequested procedure codeScheduled proceduredescriptionScheduled protocol code

R

46 250 Placer supplementalservice information

1474 CWE 0032,1060 Shall contain the laterality(left/right) indicator (whenapplicable).

R

*CE data structure

No. Description DT

1 Identifier ST

2 Text ST

3 Name of coding system ST

4 Alternate identifier ST

5 Alternate text ST

6 Name of alternate codingsystem

ST

OBX fields


R/O

2 2 Value type 570 ID - ST O

3 250 Observation identifier 571 CE - - O

5 99999

Observation value* 573 Varies 0010,10300010,1020

Patient´s weightPatient´s size

O

6 250 Units 574 CE - - O

11 1 Observation resultstatus

579 ID - F = Final O

OBX||ST|^BODY WEIGHT||62|kg|||||FOBX||ST|^BODY HEIGHT||1.80|m|||||F

* To distinguish between weightand size, use the following

segment structure:

3.3.2 OMI O23


Message Types

Order Entry

3


Fig. 5: Structure of message type OMI O23



MSH|^~\&|||HEYEX|HE_MWL|20150421163617||OMIÔ23ÔMI_O23|2|P|2.5|||AL|NE||UNICODE UTF-8PID||P0300027|P0300027||Test^Patient||19781008|M|||UNKNOWN^ÛNKNOWN^^99999^D|||||||0300022|||||||||PV1||I|43S05|A||||Dr. Jackson||||||||0|||0300022||K|||||||||||||||||||||||20150420000000|||||||||ORC|NW|AN39152166|AN39152166|||| |||SUPERVISOR||||203||||||TQ1|||||||20150421120000||R^ROUTINE^1.3.6.1.4.1.21367.100.1OBR|1|AN39152166|AN39152166||||||||||PATIENT IS ...||Spectralis-OCT^^^^|||AN39152166|2|123|OPH1|||OPT||||||||||||||||||||1^Spectralis OCT^0^0||L|IPC|AN39152166|OMRP49|1.3.6.1.4.1.12559.11.11.4.7.2.49^Âpplication^DICOM|OMSPS50|OPT|1^Spectralis OCT^0^|OPH|OPHTHALMOLOGY|AE_OCT

Example message OMI O23

Message Types

Order Entry

3


MSH fields


R/O










O


PID fields


R/O


4 20 Alternate Patient ID - PID 107 CX 0010,1000 Other patient ID O






22 250 Ethnic group 125 ST - - O

PV1 fields


R/O

3 80 Assigned patient location 133 PL 0038,0300,0040,0100 -> 0040,0011

Current patient locationScheduled procedureStep location

O



Pregnancy statusSpecial needs

O

16 2 VIP indicator 146 IS 0040,3001 Confidentiality constraint onpatient

O

19 250 Visit number 149 CX 0038,00100038,0011


R

Message Types

Order Entry

3



R/O


R

44 26 Admin Date/Time 174 TS - - O

AL1 fields


R/O



ORC fields


R/O

1 2 Order control 215 ID - ▪ NW - New▪ CA - Cancel▪ XO - Change▪ DC - Discontinue

R


O


O

5 2 Order status 219 ID - - O

10 250 Entered by 224 XCN 0040,2080 Entered by... O

14 250 Callback phone number 228 XTN 0040,2010 Order callback phonenumber

O


TQ1 fields


R/O



R

9 250 Priority 1635 CWE - - O

Message Types

Order Entry

3


OBR fields


R/O


O


O

12 250 Danger code 246 CE 0038,0500 Patient state O

13 300 Relevant clinical info 247 ST 0010,2000 Medical alerts O


O

16 250 Ordering provider 226 XCN 0032,1032 Requesting physician R


O


34 200 Technician 266 CM 0040,0006 Scheduled performingphysician´s name

O

44 250 Procedure code 393 CE 0032,10640032,1060

Requested procedure codeRequested proceduredescription

RO

46 250 Placer supplementalservice information

1474 CE 0032,1060 Shall contain the laterality(left/right) indicator (whenapplicable).

R

OBX fields


R/O

2 2 Value type 570 ID - - O


5 99999



O

6 250 Units 574 CE - - O


579 ID - F = Final O



segment structure:

Message Types

Order Entry

3


IPC fields


R/O

1 80 Accession identifier 1330 EI 0008,0050 Accession number R

2 22 Requested procedure ID 1658 EI 0040,1001 Requested procedure ID O

3 70 Study instance UID 1659 EI 0020,000d Study instance UID O

4 22 Scheduled procedure stepID

1660 EI 0040,0009 Scheduled procedure stepID

O

5 16 Modality 1661 CE 0008,0060 Modality R

6 250 Protocol code 1662 CE 0040,00080040,0007

Scheduled protocol code(6.1)Scheduled proceduredescription (6.2)

R

7 22 Scheduled station name 1663 EI 0040,0010 - R

8 250 Scheduled procedure steplocation

1664 CE 0040,0011 - O

9 16 Scheduled AE title 1665 ST 0040,0001 - R

3.3.3 ORM O01


Message Types

Order Entry

3


Fig. 6: Structure of message type ORM O01



MSH|^~\&|||HEYEX|HE_MWL|20031107132132||ORMÔ01|2|P|2.5|||AL|NE|EVN|O01|20031107132132|||||PID||0300025|0300025||Test^Patient||19831007|M|||UNKNOWN^ÛNKNOWN^^99999^D|||||||0300022|||||||||||||PV1||S|43S05|A||||Dr. Jackson||||||||0|||0300022||K|||||||||||||||||||||||20031007000000|||||||||ORC|NW|0039152166|0039152166||||^^^20031028115300^^HIGH|||SUPERVISOR||||203||||||OBR|1|0039152166|0039152166||||||||||PATIENT IS ...||OP-GLAUCOMA^^^^L|||0039152166|2|123|OPH1|||OP||||||||||||||||||||1^GLAUCOMA^0^0^GLAUCOMA||OBX||ST|^BODY WEIGHT||76|kg|||||F|||||||OBX||ST|^BODY HEIGHT||190|cm|||||F|||||||ZDS|1.2.276.0.30.2.10000000002347838.0.0.39152166.90208^Âpplication^DICOM

Example message ORM O01

Message Types

Order Entry

3


MSH fields


R/O










O

PID fields


R/O


4 Alternate patient ID - PID 107 CX 0100,1000 Other patient ID O






22 250 Ethnic 125 CE - - O

PV1 fields


R/O

3 80 Assigned patient location 133 PL 0038,03000040,0100 -> 0040,0011

Current patient locationScheduled procedure steplocation

O



Pregnancy status specialneeds

O

16 2 VIP Indicator 146 IS 0040,3001 Confidentiality constraint onpatient

O

Message Types

Order Entry

3



R/O

19 250 Visit number 149 CX 0038,00100038,0011


R


R

AL1 fields


R/O



ORC fields

SEG LEN Description ID DT DICOM tag DICOM description /comment

R/O

1 2 Order control 215 ID - ▪ NE - New▪ CA - Cancel▪ XO - Change▪ DC - Discontinue

R


O


O

5 2 Order status 219 ID - - O

7 200 Quantity/timing 221 TQ 0040,10030040,00020040,0003

Requested ProcedurePriorityStart DateStart Time

R

10 250 Entered by 224 XCN 0040,2008 Entered By... O

14 250 Call back phone number 228 XTN 0040,2010 Order callback phonenumber

O


OBR fields


R/O


O


O

12 250 Danger code 246 CE 0038,0500 Patient state O

Message Types

Order Entry

3



R/O

13 300 Relevant clinicalinformation

247 ST 0010,2000 Medical alert O


R

16 250 Ordering provider 226 XCN 0032,1032 Requesting physician R

18 60 Placer field 1 251 ST 0008,0050 Accession number R

19 60 Placer field 2 252 ST 0040,1001 Requested procedure ID O

20 60 Filler field 1 253 ST 0040,0009 Scheduled procedure stepID

O

21 60 Filler field 2 254 ST 0040,0001 0040,0010

Scheduled station AE titleScheduled station name

R

24 10 Diagnostic serv sect ID 257 ID 0008,0060 ModalityExamples:

▪ AR, Autorefraction▪ KER, Keratometry▪ IOL, Intraocular Lens

Data▪ LEN, Lensometry▪ OAM, Ophthalmic Axial

Measurements▪ OPM, Ophthalmic

Thickness Map▪ OP, Ophthalmic

Photography▪ OPT, Ophthalmic

Tomography▪ OPV, Ophthalmic Visual

Field▪ OT, Other▪ US, Ultrasound

R


O


34 200 Technician 266 CM 0040,0006 Scheduled performingphysician's name

O

44 250 Procedure code 393 CE 0032,10600032,10640040,00070040,0008

Requested proceduredescriptionRequested procedure codeScheduled proceduredescriptionScheduled protocol code

R

OBX fields


R/O



Message Types

Order Entry

3



R/O

5 99999



O

6 250 Units 574 CE - - O

11 1 Observation result status 579 ID - F = Final O



segment structure:

ZDS fields


R/O

1 200 Study instance UID Z0001

RP 0020,000D Study Instance UID O

3.4 Notification3.4.1 OMG O19


HEYEX 2 uses ORR O02 as default message type for notifications.

Message Types

Notification

3


Fig. 7: Structure of message type OMG O19



MSH|^~\&|HEYEX|NOTIFY|||20150623101256.5738||OMGÔ19ÔMG_O19|154765|P|2.5|||AL|NEPID||P76895|P76895||Test^Patient||19110227|MPV1|1|||||||Dr. Jackson|||||||||||V1234567||||||TQ1|||||||20150623111500||R^ROUTINE^1.3.6.1.4.1.21367.100.1ORC|SC|A1223334455|A1223334455||CM||^^^||20150623115942OBR|1|A1223334455|A1223334455|||||||||||||||A1223334455|900|Test image|||||F|OBX||RP|1899^MCSTARTWEB||MCStartWeb -u http://HeyexPacsServerName/Ashvins/StudyCallViewer.asp?SUID=1.2.392.200036.9116.2.2.2.1762655046.1009678457.911919||||||F|ZDS|1.2.392.200036.9116.2.2.2.1762655046.1009678457.911919^Âpplication^DICOM

Example message OMG O19

Message Types

Notification

3


MSH fields


R/O










O

PID fields


R/O

2 20 Patient ID 105 CX 0010,0020 Patient ID O






PV1 fields


R/O


19 250 Visit number 149 CX 0038,00100038,0011


O

ORC fields


R/O

1 2 Order control 215 ID - SC - Status changed R


O


R

5 2 Order status 219 ID - CM = Order completed R

Message Types

Notification

3


TQ1 fields


R/O



R

12 10 Conjunction 1638 ID - - O

OBR fields


R/O


O


R

19 60 Placer field 2 252 ST - - O

20 60 Filler field 1 + 253 ST - - O

25 1 Result status 258 ID - F = Final R

OBX fields


R/O

2 2 Value type 570 ID - - R

3 250 Observation identifier 571 CE - - R

4 20 Observation sub-ID 572 ST - - O

5 99999



R


579 ID - F = Final R



segment structure:

ZDS fields


R/O


RP 0020,000D Study Instance UID R

Message Types

Notification

3


3.4.2 ORM O01


Fig. 8: Structure of message type ORM O01



MSH|^~\&|HEYEX|NOTIFY|||20150605161256.5738||ORM^O01|154765|P|2.5|||AL|NEPID||76895|76895||Test^Patient||19790227|MPV1|1|||||||Dr. Jackson|ORC|SC|11223334455|11223334455||CM||^^^20150605171736.0000||20150505145942OBR|1|11223334455|11223334455|||||||||||||||11223334455|900|Testbild|||||F|ZDS|1.2.392.200036.9116.2.2.2.1762655046.1009678457.911919^^Application^DICOM

Example message ORM O01

Message Types

Notification

3


MSH fields


R/O










O

PID fields


R/O

2 20 Patient ID 105 CX 0100,0020 Patient ID O






PV1 fields


R/O


19 20 Visit number 149 CX - - O

ORC fields


R/O


3 22 Filler order number 217 EI 0040,2017 Accession numer R

5 2 Order status 219 ID - CM - Order completed R

7 200 Quantity/timing 221 TQ 0040,00020040,0003


O

Message Types

Notification

3


OBR fields


R/O

3 22 Filler order number 217 EI 0040,2017 Accession numer O

19 60 Placer field 2 252 ST 0020,0010 Study ID O

20 60 Filler field 1 + 253 ST 0008,1030 Study description O


ZDS fields


R/O



3.4.3 ORR O02


Fig. 9: Structure of message type ORR O02



Message Types

Notification

3


MSH|^~\&|HEYEX|NOTIFY|||20150605161256.5738||ORR^O02|154765|P|2.5|||AL|NEMSA|AA|20150605161556.5738|||||PID||76895|76895||Test^Patient||19790227|MORC|SC|11223334455|11223334455||CM||^^^20150605171736.0000||20150505145942OBR|1|11223334455|11223334455|||||||||||||||11223334455|900|Test image|||||F|ZDS|1.2.392.200036.9116.2.2.2.1762655046.1009678457.911919^^Application^DICOM

Example message ORR O02

MSH fields


R/O










O

MSA fields


R/O

1 2 Acknowledgment code 18 ID - AA = acknowledgmentaccept

R


PID fields


R/O

2 20 Patient ID 105 CX - - O






Message Types

Notification

3


ORC fields


R/O



R

5 2 Order status 219 ID - - R

7 200 Quantity/timing 221 TQ - - O

OBR fields


R/O

3 22 Filler order number 217 EI 0040,2017 Accession number O


20 60 Filler field 1 253 ST 0008,1030 Study description O


ZD1 fields


R/O


RP 0020,000D Study Instance UID R

3.5 Query3.5.1 QBP Q22


Fig. 10: Structure of message type QBP Q22



Message Types

Query

3


MSH|^~\&|HEYEX|HE_PQDC|PDQ|PDQS|20150721122930||QBP^Q22^QBP_Q21|20150721122930.29|P|2.5QPD|IHE PDQ Query|QRY20150721122930.29|@PID.5.1.1^[email protected]^PIERRE|||||RCP|I|

Example message QBP Q22

MSH fields


R/O



3 227 Sending application 3 HD - - R


5 227 Receiving application 5 HD - - R

6 227 Receiving facility 6 HD - - R

7 26 Date/Time of message 7 TS - - R

9 15 Message type 9 MSF - - R






O


QPD fields


R/O

1 250 Message query name 1375 CE - IHE PDQ Query R

2 32 Query tag 696 ST - - R

3 256 Demographic fields QIP - - R

8 What domain returned CX - What domain returned O

RCP fields


R/O

1 1 Query priority 27 ID - - R

2 10 Quantity limited request 31 CQ - Number of increments RD O

Message Types

Query

3


DSC fields


R/O

1 180 Continuation pointer 14 ST - Echo value from RSP K22DSC-1

O

2 1 Continuation style 1354 ID - - O

3.6 Medical Document Management3.6.1 MDM T02


Fig. 11: Structure of message type MDM T02



Message Types

Medical Document Management

3


MSH|^~\&|HEYEX 2||MC_MDM||201109042026||MDM^T02|2|P|2.5|||AL|NE|EVN|T02|201109042026|||||PID||0300025|0300025||Test^Patient||19831007|M|||UNBEKANNT^ÛNBEKANNT^^99999^D|||||||0300022|||||||||||||PV1||S|43S05|A||||Dr. Jackson||||||||0|||0300022||K|||||||||||||||||||||||20031007000000|||||||||TXA|1|transferReport|application/pdf|||201109042026|201109042026|||||28145|||R0000170||AU|U|AVOBX|1|ED|^DocumentContent|1|âpplication/pdf^^Base64^JVBERi0xLjUNCiW1tbW1DQoxIDAgb2JqDQo8PC9UeXBlL0NhdGFsb2cvUGFnZ...u.s.w. ...||||||FZDS|1.2.276.0.30.2.10000000002347838.0.0.39152166.90208Âpplication^DICOM

Example message MDM T02

MSH fields


R/O










O

PID fields


R/O


4 20 Alternate patient ID - PID 107 CX 0010,1000 Other patient ID O

5 250 Patient name 108 XPN 0010,0010 Patient's name O

7 26 Date/Time of birth 110 TS 0010,0030 Patient's birth date O

8 1 Administrative sex 111 IS 0010,0040 Patient's sex O

Message Types


3


PV1 fields


R/O


19 250 Visit number 149 CX 0038,00100038,0011


O

TXA fields


R/O

1 4 Set ID TXA 914 SI - - R

2 30 Document type 915 IS - - R

3 2 Document contentpresentation

916 ID - - R

6 26 Origination date/time 919 TS - - R

12 30 Unique document number 925 EI - - R

15 22 Filler order number 217 EI 0800,0050 Accession number R

17 2 Document completionstatus

928 ID - - R

18 2 Document confidentialitystatus

929 ID - - O

19 2 Document availabilitystatus

930 ID - - R

OBX fields


R/O

2 2 Value type 570 ID - ED - Encapsulated data** R

3 250 Observation identifier 571 CE - - R

5 99999



R

** The following MIME types are allowed:▪ application/pdf▪ image/bmp▪ image/png▪ image/jpeg



segment structure:

Message Types


3


ZDS fields


R/O



3.7 Receiving Reports3.7.1 ORU R01


If no images are available for the result included inthis message, the result will be discarded.

Fig. 12: Structure of message type ORU R01



Message Types

Receiving Reports

3


MSH|^~\&|HEYEX|MC_ORU||201109042026||ORU^R01|2|P|2.5|||AL|NE|PID||0300025|0300025||Test^Patient||19831007|M|||UNBEKANNT^ÛNBEKANNT^^99999^D|||||||0300022|||||||||||||PV1||I|4208^Z4.025^B5Z4025^4200|AU|||||||||||||||1638621^1^M11||P|||||||||||||||||||||||20060316094717||||||1|AORC|RE|2974830ÎSHMED||319061ÎSHMED-VKGIDOBR||2974830ÎSHMED||RL_2111110^CCT nativeOBX|1||Examination|1|Thorax digital Exspiration pa of08.04.04||||||||||||OBX|2||Clinical information|1|||||||||||||OBX|3||Indication for examination|1|Here you find the indicationfor the examination\.br\after a line break...||||||||||||OBX|4||Examination finding|1|Here you find the examinationfinding.\.br\after a line break...\.br\and in the third line||||||||||||OBX|5||Diagnosis|1|Here you find the diagnosis\.br\after a linebreak...\.br\and in the third line||||||||||||

Example message ORU R01

MSH fields


R/O




9 15 Message type 9 MSF - - R






O

PID fields


R/O

2 20 Patient ID 105 CX - - O





Message Types

Receiving Reports

3


PV1 fields


R/O


19 250 Visit number 149 CX 0038,00100038,0011


O

39 2 Servicing facility 169 IS 0008,1010 Station name O

ORC fields


R/O

1 2 Order control 215 ID - ▪ NW - New▪ RE - Result following▪ CN - Combined result

O


R

7 200 Quantity/timing 221 TQ 0040,00020040,0003

ORC.7.4 start dateORC.7.5 start time

O

15 26 Order effective date/time 229 TS 0008,0020 Study date R

OBR fields


R/O


O


O

4 200 Universal service ID 238 CE 0008,1030 OBR 4.1 Study description O


20 60 Filler field 1 253 ST 0008,1030 Study description O

22 26 Results Rpt/Status ChngData/Time +

255 TS 0008,00210008,0031

Series dateSeries time

O

OBX fields


R/O


3 250 Observation identifier 571 CE - Observation type as string R

5 65536

Observation value* 573 Varies - Report text R

Message Types

Receiving Reports

3


* German names used by specific medical informationsystems

Name Description

Untersuchung Title of the examination

Klinische Angaben Clinical details of theexamination

Fragestellung Questions of the referringphysician

Befund

Beurteilung

ZD1 fields


R/O



Message Types

Receiving Reports

3


and hrt spectralis, hep heyex 2 for integration hl7

Documents