iq-worklist€¦ · iq-worklist 2.0.0 hl7 conformance statement pub int en – 005r 2 1...

iQ-WORKLIST HL7 CONFORMANCE STATEMENT

Version 2.0.0 PUB INT EN 005R

Copyright © 2003-2015 IMAGE Information Systems Ltd.

PUBLIC

Released: 2015-12-15

Valid for software version 2.0.0 build 44 and higher

iQ-WORKLIST 2.0.0 HL7 Conformance Statement PUB INT EN – 005R 1

TABLE OF CONTENTS

1 INTRODUCTION.................................................................................................................................................... 2

1.1 General information ............................................................................................................................................ 2

1.2 Scope .................................................................................................................................................................... 2

1.3 Important considerations for the reader ......................................................................................................... 2

1.4 Reference material ............................................................................................................................................. 3

2 COMMUNICATION AND ACKNOWLEDGEMENT MODES .................................................................................. 4

3 SUPPORT HL7 MESSAGES ..................................................................................................................................... 5

3.1 Overview of inbound HL7 messages ................................................................................................................ 5

3.2 Overview of outbound HL7 messages ............................................................................................................. 5

4 INBOUND MESSAGES .......................................................................................................................................... 7

4.1 ORMÔ01 – general order message (event O01) ........................................................................................ 7

4.2 OMGÔ19 – general clinical order message (event O19).......................................................................... 9

4.3 ADTÂ08 – update patient information (event A08) .................................................................................. 12

4.4 ADTÂ40 – merge patient – patient identifier list (event A40) .................................................................. 13

5 OUTBOUND MESSAGES ..................................................................................................................................... 15

5.1 ORRÔ02 – general order response message (event O02) ...................................................................... 15

5.2 ORGÔ20 – general clinical order acknowledgement message (event O20) ..................................... 18

5.3 ACKÂ08 – acknowledge message to ADTÂ08 ....................................................................................... 21

5.4 ACKÂ40 – acknowledge message to ADTÂ40 ....................................................................................... 22

6 MESSAGE MAPPING .......................................................................................................................................... 24

1.1 MSH segment mapping ............................................................................................................................... 24

1.2 EVN segment mapping ................................................................................................................................ 25

1.3 PID segment mapping ................................................................................................................................. 25

1.4 PV1 segment mapping ................................................................................................................................ 26

1.5 MRG segment mapping .............................................................................................................................. 27

1.6 MSA segment mapping ............................................................................................................................... 28

1.7 ORC segment mapping............................................................................................................................... 28

1.8 OBR segment mapping ............................................................................................................................... 29

7 ABBREVIATIONS AND ACRONYMS .................................................................................................................. 31


1 INTRODUCTION

1.1 GENERAL INFORMATION

The Health Level Seven (HL7) standard - version 2.6 - is used as a basis for the HL7 communication. In this

document, the described behavior refers to the software release of iQ-WORKLIST 2.0.0.

The iQ-WORKLIST application is used to provide patient and study information to DICOM compatible

imaging devices (modalities) within a radiological network. It can receive this data in various formats

(e.g. HL7) and automatically convert it into a generalized format. On request, the application can

return the data to the modalities and inform other participants in the network (e.g. RIS, HIS, EMR or

PACS) about performed procedures and their statuses (in progress, complete, discontinued).

1.2 SCOPE

This document is the HL7 Conformance Statement for the HL7 service of the iQ-WORKLIST solution

developed by IMAGE Information Systems Ltd. and describes the supported messages. Furthermore, this

document demonstrates and describes the data interchange between information systems like HIS or

RIS and iQ-WORKLIST itself.

1.3 IMPORTANT CONSIDERATIONS FOR THE READER

HL7 is the software messaging standard in the healthcare environment. Several versions of this standard

are in use (2.1 – 2.6). These versions are backward compatible. iQ-WORKLIST does not fully support the

2.7 version because of further support of ORM/ORR messages. The latest version 3 of the HL7 standard

uses an XML-based structure and is currently not supported by the HL7 service of iQ-WORKLIST. Please

refer to the Administration Guide of iQ-WORKLIST to check other mapping possibilities for support of HL7

2.7 and 3.0.

The data interchange between a HIS/RIS and iQ-WORKLIST includes the order management (Order Entry

with ORM/OMG and Order Response with ORR/ORG), management of patient demographic data

(Patient Administration with ADT) and acknowledgement of patient changes (ACK).

The following HL7 message structure notation will be used in this document and for the configuration of

iQ-WORKLIST.

SEG-2.1.1

subcomponent number

component number

field number

name of the segment

Example

ORC-7.1.2

iQ-WORKLIST also supports this SEG-2-1-1 notation in the mapping configuration. Please refer to the

Administration Guide of iQ-WORKLIST to find out more about the configuration possibilities of incoming

mapping values.


1.4 REFERENCE MATERIAL

(1) Digital Imaging and Communications in Medicine (DICOM) 3.1-2009 – 3.20-2009

NEMA Standards Publications PS3.x (2009)

(2) HL7 Standard version 2.1 - 2.6 and 2.7

(3) IHE Radiology Technical Framework - Revision 10.0

(4) iQ-WORKLIST 2.0.0 Administration Guide


2 COMMUNICATION AND ACKNOWLEDGEMENT MODES

iQ-WORKLIST supports two different transport methods of HL7 messages.

Direct socket communication over HL7 Lower Layer Protocol (LLP)

The Lower Layer Protocol is the most common mechanism for sending unencrypted HL7 via

TCP/IP over a local area network, such as those found in a hospital.

Shared folder exchange with simple text-based file format

Another way of exchanging HL7 messages is to put them into a shared folder. This folder can be

configured in the configuration file of iQ-WORKLIST. Every new stored HL7 message will be read

and processed immediately. For more information about this transport mode, please refer to

the Administration Guide of iQ-WORKLIST.

iQ-WORKLIST supports both acknowledgement modes of HL7 messages:

Original Mode - Application Acknowledgement

Enhanced Mode - Accept and Application Acknowledgement (Event Acknowledgement, Event

Notification )

Please refer to the Administration Guide of iQ-WORKLIST to find out more about the configuration

possibilities of both communication and message transport modes and about configuration possibilities

of acknowledgement modes.


3 SUPPORT HL7 MESSAGES

3.1 OVERVIEW OF INBOUND HL7 MESSAGES

iQ-WORKLIST supports the following inbound HL7 messages from external systems (HIS/RIS):

MESSAGE TYPE MESSAGE PURPOSE TRIGGER EVENTS

ORMÔ01

(General Order)

Initiate the transmission of

information about an order.

Wide compatibility with HL7 2.1 - 2.6.

Request new imaging service

Cancel requested imaging

service

Update order information of

requested imaging service

OMGÔ19

(General Clinical

Order)

Initiate the transmission of

information about a general clinical

order

Wide compatibility with HL7 2.4 - 2.7

Request new imaging service

Cancel requested imaging

service

Update order information of

requested imaging service

ADTÂ08

(Update Patient

Information)

Update patient information Patient information has been

changed in the HIS/RIS

ADTÂ40

(Merge Patient)

Merge two patient records Two patient records where

merged in the HIS/RIS

3.2 OVERVIEW OF OUTBOUND HL7 MESSAGES

iQ-WORKLIST supports the following outbound HL7 messages to external systems (HIS/RIS):


ORRÔ02

(General Order

Response)

Respond to an ORM message

Send information about a status of

message processing

Send status information about

imaging service request


Order message processing

succeeded or failed

Imaging service status changed

ORGÔ20

(General Clinical

Order Response)

Respond to an OMG message


message processing

Send status information about

imaging service request


Order message processing

succeeded or failed

Imaging service status changed



ACKÂ08

(Acknowledgement -

Update Patient

Information)

Respond to an ADTÂ08 message


message processing

ADT message processing

succeeded or failed

ACKÂ40

(Acknowledgement -

Merge Patient)

Respond to an ADTÂ40 message


message processing

ADT message processing

succeeded or failed


4 INBOUND MESSAGES

This section describes the inbound HL7 messages that can be processed by iQ-WORKLIST.

4.1 ORM^O01 – GENERAL ORDER MESSAGE (EVENT O01)

An ORM^O01 message transmits information about an order. Such messages place a new order,

update or cancel an existing order. Receiving a new order message leads to the creation of a new

imaging service request in iQ-WORKLIST and the recording of new patient information if both do not

already exist in the database. Otherwise, the imaging service request information will be updated,

canceled or deleted from the database. The patient information will also be updated if iQ-WORKLIST

receives a new or update order.

For all operations mentioned above, the following identifiers are important to know and will be applied:

Placer Order Number by default with Entity Identifier component (ORC-2.1 and OBR-2.1) as individual

order identifier

iQ-WORKLIST uniquely identifies the order within the ORC-2 and OBR-2 fields. According to the Technical

Frameworks of Integrating the Healthcare Enterprise (IHE), it is recommended to use the unique

Accession Number.

Universal Service Identifier by default with Identifier component (OBR-4.1) as additional order

identifier and individual imaging service (procedure) identifier

iQ-WORKLIST identifies an imaging service (procedure) request within the OBR-4.1 field.

Patient Identifier List by default with ID Number component (PID-3.1 and alternative for backward

compatibility PID-2.1) as unique patient identifier

iQ-WORKLIST uniquely identifies a patient within the PID-3.1 field.

iQ-WORKLIST uses the Order Control (ORC-1) field for event request mapping.

HL7 ORC-1 DEFAULT VALUE* iQ-WORKLIST ACTION VALUE iQ-WORKLIST ACTION DESCRIPTION

NW new New database records with new

imaging service information will be

created.

CA delete The existing database records with


deleted.

XO modify The existing database records with


updated.


*(Please refer to HL7 Table 0119 - Order Control or HL7 standard 2.6 chapter 4.23.1 for more information about

possible order control codes.)


possibilities of incoming mapping values.

It is possible to send multiple order requests within one ORMÔ01 message. The sequence of ORC/OBR

segments allows ordering several imaging services for one patient.

Please see chapter 5 for information about complementary outbound ORRÔ02 messages.

An ORMÔ01 message is composed of the following segments:

MSH Message Header

[{ NTE }] Notes and Comments (for Header)

[ --- PATIENT begin

PID Patient Identification

[ PD1 ] Additional Demographics

[{ NTE }] Notes and Comments (for Patient ID)

[ --- PATIENT_VISIT begin

PV1 Patient Visit

[ PV2 ] Patient Visit- Additional Info

] --- PATIENT_VISIT end

[{ --- INSURANCE begin

IN1 Insurance

[ IN2 ] Insurance Additional Information

[ IN3 ] Insurance Additional Information, Certification

}] --- INSURANCE end

[ GT1 ] Guarantor

[{ AL1 }] Allergy Information

] --- PATIENT end

{ --- ORDER begin

ORC Common Order

[ --- OBSERVATION_REQUEST begin

<OBR| Order Detail Segment OBR, etc.

RQD|

RQ1|

RXO|

ODS|

ODT>

[{ NTE }] Notes and Comments (for Detail)

[ CTD ] Contact Data

[{ DG1 }] Diagnosis

[{ --- OBSERVATION begin

OBX Observation/Result

[{ NTE }] Notes and Comments (for Results)

}] --- OBSERVATION end

] --- OBSERVATION_REQUEST end

[{ FT1 }] Financial Transaction

[{ CTI }] Clinical Trial Identification

[ BLG ] Billing Segment

} --- ORDER end


The current version of iQ-WORKLIST supports the following segments by default:

MSH

PID

PV1

ORC

OBR

Message example (with one imaging service request):

MSH|^~\&|HIS|HOSPITAL|||20131104090000.0||ORMÔ01|MSG0001|P|2.6|||AL|AL|

PID|1||P001||Dupoint^Jean^^^||19860208|M||2106-3||||||||||||H|

PV1||I|^C3^22^Surgery|||||P001^Doe^Jon^^^Dr|||||||B5|VIP|||V001|

ORC|NW|A0003|||||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|

OBR|1|A0003||PR0003^CT of the abdomen with contrast agent^^|HIGH|20131104130000.0|

Message example (with three imaging service requests):

MSH|^~\&|HIS|HOSPITAL|||20131104090000.0||ORMÔ01|MSG0001|P|2.6|||AL|AL|





ORC|CA|A0004|||||^^^20131104150000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|

OBR|2|A0004||PR0004^CT of abdomen^^|HIGH|20131104150000.0|

ORC|XO|A0005|||||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^ÛS|

OBR|3|A0005||PR0005ÛS of blain^^|HIGH|20131104130000.0|

4.2 OMGÔ19 – GENERAL CLINICAL ORDER MESSAGE (EVENT O19)

Receiving an OMGÔ19 message leads to the creation of an imaging service request in iQ-WORKLIST

and the recording of new patient information. This message type has a similar structure as ORMÔ01

and is supported by iQ-WORKLIST because of its forward compatibility to HL7 version 2.7.

The processing, mapping, identification of records and event request triggering of an OMGÔ19

message works in the same way as with ORMÔ01 messages. Please see more information in the

section about ORMÔ01.

Please see chapter 5 for information about complementary outbound ORGÔ20 messages.

An OMGÔ19 message is composed of the following segments:

MSH Message Header

[{ SFT }] Software

[ UAC ] User Authentication Credential



[ --- PATIENT begin




[{ NK1 }] Next of Kin/Associated Parties

[ --- PATIENT_VISIT begin

PV1 Patient Visit

[ PV2 ] Patient Visit- Additional Info

] --- PATIENT_VISIT end


IN1 Insurance

[ IN2 ] Insurance Additional Information

[ IN3 ] Insurance Additional Information, Certification


[ GT1 ] Guarantor


] --- PATIENT end

{ --- ORDER begin

ORC Common Order

[{ --- TIMING begin

TQ1 Timing/Quantity

[{TQ2}] Timing/Quantity Order Sequence

}] --- TIMING end

OBR Observation


[{ ROL }] Role (for Observation)

[ CTD ] Contact Data

[{ DG1 }] Diagnosis

[{ --- OBSERVATION begin

OBX Observation/Result

[{ NTE }] Notes and Comments (for Results)

}] --- OBSERVATION end

[{ --- SPECIMEN begin

SPM Specimen

[{OBX}] Observation/Result

[{ --- CONTAINER begin

SAC Specimen Container

[{OBX}] Observation/Result

}] ---- CONTAINER end

}] --- SPECIMEN end

[{ --- PRIOR_RESULT begin

[ --- PATIENT_PRIOR begin

PID Patient Identification - previous result

[ PD1 ] Additional Demographics - previous result

] --- PATIENT PRIOR end

[ --- PATIENT_VISIT_PRIOR begin

PV1 Patient Visit - previous result

[ PV2 ] Patient Visit Add. Info - previous result

] --- PATIENT_VISIT_PRIOR end

[{AL1}] Allergy Information - previous result

{ --- ORDER_PRIOR begin

[ ORC ] Common Order - previous result

OBR Order Detail - previous result

[{ --- TIMING_PRIOR begin

TQ1 Timing/Quantity



}] --- TIMING end

[{NTE}] Notes and Comments - previous result

[{ROL}] Role (for Observation) - previous result

[ CTD ] Contact Data - previous result

{

OBX

[{NTE}]

}

}

}]

[{ FT1 }] Financial Transaction


[ BLG ] Billing Segment

}


MSH

PID

PV1

ORC

OBR

Message example (with one imaging service request):

MSH|^~\&|HIS|HOSPITAL|||20131104090000.0||OMGÔ19|MSG0001|P|2.6|||AL|AL|





Message example (with three imaging service requests):

MSH|^~\&|HIS|HOSPITAL|||20131104090000.0||OMGÔ19|MSG0001|P|2.6|||AL|AL|





ORC|CA|A0004|||||^^^20131104150000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|

OBR|2|A0004||PR0004^CT of abdomen^^|HIGH|20131104150000.0|

ORC|XO|A0005|||||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^ÛS|

OBR|3|A0005||PR0005ÛS of blain^^|HIGH|20131104130000.0|


4.3 ADTÂ08 – UPDATE PATIENT INFORMATION (EVENT A08)

Receiving an ADTÂ08 message leads to the update of existing patient information in iQ-WORKLIST. The

incoming message will be rejected if the patient does not exist in iQ-WORKLIST.

According to the HL7 standard, this trigger event is used when any patient information has changed,

but no other trigger event has occurred. For example, an A08 event can be used to notify the receiving

systems of an address or name change.

For this update operation, iQ-WORKLIST uniquely identifies a patient within the PID-3.1 field.

Please see chapter 5 for information about complementary outbound ACKÂ08 messages.

An ADTÂ08 message is composed of the following segments:

MSH Message Header

[{ SFT }] Software Segment


EVN Event Type



[{ ARV }] Access Restrictions

[{ ROL }] Role

[{ NK1 }] Next of Kin / Associated Parties

PV1 Patient Visit

[ PV2 ] Patient Visit - Additional Info.

[{ ARV }] Access Restrictions

[{ ROL }] Role

[{ DB1 }] Disability Information

[{ OBX }] Observation/Result


[{ DG1 }] Diagnosis Information

[ DRG ] Diagnosis Related Group

[{ --- PROCEDURE begin

PR1 Procedures

[{ ROL }] Role

}] --- PROCEDURE end

[{ GT1 }] Guarantor


IN1 Insurance

[ IN2 ] Insurance Additional Info.

[{ IN3 }] Insurance Additional Info - Cert.

[{ ROL }] Role


[ ACC ] Accident Information

[ UB1 ] Universal Bill Information

[ UB2 ] Universal Bill 92 Information

[PDA] Patient Death and Autopsy



MSH

EVN

PID

PV1

Message example:

MSH|^~\&|HIS|HOSPITAL|||20131104100000.0||ADTÂ08|MSG0001|P|2.6|||AL|AL|

EVN|A08|20131104100000.0|||||

PID|1||P001||Duepoint^Jean^^^||19860208|M||2106-3||||||||||||H|


4.4 ADTÂ40 – MERGE PATIENT – PATIENT IDENTIFIER LIST (EVENT A40)

Receiving an ADTÂ40 message leads to the merging of two patient records based on the patient IDs

of iQ-WORKLIST. The incoming message will be rejected if the patient does not exist in iQ-WORKLIST.

According to the HL7 standard, an A40 event is used to signal a merging of records for a person that

was incorrectly registered under two different identifiers.

For this merging operation, iQ-WORKLIST identifies the prior patient ID with the MRG-1.1 field and the

correct patient ID with the PID-3.1 field. All imaging service requests will be allocated to the correct

patient before the prior patient will be deleted.

Please see chapter 5 for information about complementary outbound ACKÂ40 messages.

An ADTÂ40 message is composed of the following segments:

MSH Message Header



EVN Event Type

{ --- PATIENT begin



MRG Merge Information

[ PV1 ] Patient Visit

} --- PATIENT end


The following segments are processed by this version of iQ-WORKLIST:

MSH

EVN

PID

MRG

Message example:

MSH|^~\&|HIS|HOSPITAL|||20131104110000.0||ADT^A08|MSG0001|P|2.6|||AL|AL|

EVN|A40|20131104110000.0|||||

PID|1||P077||Duepoint^Jean^^^||19860208|M||2106-3||||||||||||H|

MRG|P001||||||


5 OUTBOUND MESSAGES

This section describes the outbound HL7 messages that can be processed by iQ-WORKLIST.

5.1 ORRÔ02 – GENERAL ORDER RESPONSE MESSAGE (EVENT O02)

A general order response message (ORRÔ02) will be send from iQ-WORKLIST to HIS/RIS to respond to

any ORM message and is the Enhanced Mode of Acknowledgements. An ORR message is the event

acknowledgement and can also be used for the event notification in case of order status changes (IN

PROGRESS, COMPLETED, DISCONTINUED).

The trigger event for sending the ORRÔ02 message back is an incoming ORMÔ01 message. By

default, iQ-WORKLIST uses the following acknowledgement codes in the MSA-1 field.

HL7 MSA-1 DEFAULT VALUE* iQ-WORKLIST ACTION VALUE iQ-WORKLIST ACTION DESCRIPTION

CA - Commit Accept accept The incoming message was

processed successfully at a logical

application level.

CR - Commit Reject reject The incoming message could not

be processed. There might be an

error with the message structure,

missing information or not

configured communication settings

in the “configuration.xml”.

CE - Commit Error error The incoming message could not


internal error of iQ-WORKLIST (e.g.

missing configuration file, missing

mapping file, HL7 server is not

running).

*(For more information, please refer to Table 0008 Acknowledgement Code of HL7 standard 2.6 chapter 2.14.8.1.)

By default, the HL7 field ORC-1 (Order Control) is used for more detailed information about the

acknowledgement.


OC order canceled The imaging service request was

successfully canceled after

receiving an ORMÔ01 with delete

(CA) event request.



UC unable to cancel It was unable to cancel an imaging

service request after receiving an

ORMÔ01 with delete (CA) event

request.

OK order accepted The imaging service request was

successfully accepted after

receiving an ORMÔ01 with new

(NW) event request.

UA unable to accept order It was unable to accept an imaging


ORMÔ01 with new (NW) event

request.

XR changed as requested The imaging service request was

successfully changed after

receiving an ORMÔ01 with modify

(XO) event request.

UX unable to change It was unable to change an

imaging service request after

receiving an ORMÔ01 with modify

(XO) event request.

DE data error It was unable to process or to

operate the receiving ORMÔ01

message. This value occurs after an

internal error of iQ-WORKLIST.

SC status changed This value is part of an event

notification ORRÔ02 (unsolicited) if

the order status was changed by

an incoming MPPS information of

iQ-WORKLIST.

*(Please refer to HL7 Table 0119 - Order Control Codes or HL7 standard 2.6 chapter 4.23.1 for more information about

order control codes.)

iQ-WORKLIST also uses an event notification of incoming ORMÔ02 messages to forward the changed

MPPS status of an imaging service request to the corresponding information systems (HIS/RIS).

If the status of an MPPS instance changes (-> in progress, in progress -> completed, in progress ->

discontinued), iQ-WORKLIST will forward this information within ORC-5 (Order Status ID) field of the

ORRÔ02 message. The following order status value mapping will be applied:

MPPS STATUS CHANGES HL7 ORC-5 DEFAULT VALUE DESCRIPTION

IN PROGRESS IP In process, unspecified.



IN PROGRESS COMPLETED CM Order is completed.

IN PROGRESS DISCONTINUED DC Order was discontinued.

*(Please refer to HL7 Table 0038 - Order status or HL7 standard 2.6 chapter 4.5.1.5 for more information about order

status codes.)

An ORRÔ02 message is composed of the following segments:

MSH Message Header

MSA Message Acknowledgment

[{ ERR }] Error


[ --- RESPONSE begin

[ --- PATIENT begin



] --- PATIENT end

{ --- ORDER begin

ORC Common Order

<OBR| [Order Detail Segment] OBR, etc.

RQD|

RQ1|

RXO|

ODS|

ODT>



} --- ORDER end

] --- RESPONSE end


MSH

MSA

PID

ORC

OBR

Message example (for event acknowledgement - imaging service request was accepted):

MSH|^~\&|HIS|HOSPITAL|IQWKL|RAD|20131104090000.0||ORRÔ02| MSG20131015163021240|P|2.6|||AL|AL| MSA|CA|MSG0001|accepted



ORC|OK|A0003|||||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|



Message example (for event notification - imaging service request was completed):

MSH|^~\&|HIS|HOSPITAL|IQWKL|RAD|20131104090000.0||ORRÔ02| MSG20131015163843344|P|2.6|||AL|AL| MSA|CA|MSG0001|accepted



ORC|SC|A0003|||CM||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|


5.2 ORGÔ20 – GENERAL CLINICAL ORDER ACKNOWLEDGEMENT MESSAGE (EVENT O20)

A general clinical order acknowledgement message (ORGÔ20) will be send from iQ-WORKLIST to

HIS/RIS to respond to any OMG message and is the Enhanced Mode of Acknowledgements. An ORG

message is the application acknowledgement to any OMG. An OMG message is the event

acknowledgement and can also be used for the event notification in case of order status changes (IN

PROGRESS, COMPLETED, DISCONTINUED).

The trigger event for sending the ORGÔ02 message back is an incoming OMGÔ01 message. By

default, iQ-WORKLIST uses the following acknowledgement codes in the MSA-1 field.


CA - Commit Accept accept The incoming message was

processed successfully at a logical

application level.

CR - Commit Reject reject The incoming message could not


error with missing information or

mapping issues.

CE - Commit Error error The incoming message could not


internal error of iQ-WORKLIST. (E.g.

HL7 server is not running, database

connection is lost).

*(For more information, please refer to Table 0008 Acknowledgement Code of HL7 standard 2.6 chapter 2.14.8.1.)


By default, the HL7 field ORC-1 (Order Control) is used for more detailed information about the

acknowledgement.


OC order canceled The imaging service request was

successfully canceled after

receiving an OMGÔ01 with delete

(CA) event request.

UC unable to cancel It was unable to cancel an imaging


OMGÔ01 with delete (CA) event

request.

OK order accepted The imaging service request was

successfully accepted after

receiving an OMGÔ01 with new

(NW) event request.

UA unable to accept order It was unable to accept an imaging


OMGÔ01 with new (NW) event

request.

XR changed as requested The imaging service request was

successfully changed after

receiving an OMGÔ01 with

modify (XO) event request.

UX unable to change It was unable to change an

imaging service request after

receiving an OMGÔ01 with

modify (XO) event request.

DE data error It was unable to process or to

operate the receiving OMGÔ01

message. This value occurs after an

internal error of iQ-WORKLIST.

SC status changed This value is part of an event

notification ORGÔ02 (unsolicited)

if the order status was changed by

an incoming MPPS information of

iQ-WORKLIST.

*(Please refer to HL7 Table 0119 - Order Control Codes or HL7 standard 2.6 chapter 4.23.1 for more information about

order control codes.)


iQ-WORKLIST also uses an event notification of incoming OMGÔ02 messages to forward the changed

MPPS status of imaging service requests to the corresponding information systems (HIS/RIS).

If the status of an MPPS instance changes (-> in progress, in progress -> completed, in progress ->

discontinued), iQ-WORKLIST will forward this information within the ORC-5 (Order Status ID) field of the

ORGÔ02 message. The following order status value mapping will be applied:


IN PROGRESS IP In process, unspecified.

IN PROGRESS COMPLETED CM Order is completed.

IN PROGRESS DISCONTINUED DC Order was discontinued.

*(Please refer to HL7 Table 0038 - Order status or HL7 standard 2.6 chapter 4.5.1.5 for more information about order

status codes.)

An ORGÔ02 message is composed of the following segments:

MSH Message Header


[{ ERR }] Error

[{ SFT }] Software



[ --- RESPONSE begin

[ --- PATIENT begin



] --- PATIENT end

{ --- ORDER begin

ORC Common Order

[{ --- TIMING begin

TQ1 Timing/Quantity


}] --- TIMING end

[ --- OBSERVATION_GROUP begin

OBR [Order Detail Segment] OBR, etc.

[{ROL}] Role (for Observation)

] --- OBSERVATION_GROUP end

[{NTE}] Notes and Comments (for Detail)

[{CTI}] Clinical Trial Identification

[{ --- SPECIMEN begin

SPM Specimen

[{SAC}] Specimen Container Details

}] --- SPECIMEN end

} --- ORDER end

] --- RESPONSE end



MSH

MSA

PID

ORC

OBR

Message example (imaging service request was accepted as requested):

MSH|^~\&|HIS|HOSPITAL|IQWKL|RAD|20131104090000.0||ORGÔ20| MSG20131015163021240|P|2.6|||AL|AL| MSA|CA|MSG0001|accepted



ORC|OK|A0003|||||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|


Message example (imaging service request was completed):

MSH|^~\&|HIS|HOSPITAL|IQWKL|RAD|20131104090000.0||ORGÔ20| MSG20131015163843344|P|2.6|||AL|AL| MSA|CA|MSG0001|accepted



ORC|SC|A0003|||CM||^^^20131104130000.0|||||P002^NeumanÂlice^^^Dr||||||AET^^^CT|


5.3 ACKÂ08 – ACKNOWLEDGE MESSAGE TO ADTÂ08

Each ADTÂ08 message received by iQ-WORKLIST will be answered with an acknowledge message

ACKÂ08 (Accept Acknowledgement). The sending system of the ADTÂ08 is now informed that the

message was accepted or rejected.

By default, iQ-WORKLIST uses the following acknowledgement codes in the MSA-1 field.


AA - Application Accept accept The incoming message was

received successfully by the HL7

server of iQ-WORKLIST.



AR - Application Reject reject The incoming message could not

be received. There might be an

error with the message structure or

a non-configured communication


AE - Application Error error The incoming message could not





running).

*(For more information please refer to Table 0008 Acknowledgement Code of HL7 standard 2.6 chapter 2.14.8.1.)

An ACKÂ08 message is composed of the following segments:

MSH Message Header




[{ ERR }] Error

Every acknowledge message is composed of the following segments:

MSH

MSA

Message example:

MSH|^~\&|HIS|HOSPITAL|IQWKL|RAD|20131104090000.0||ACKÂ08| MSG20131015164027557|P|2.6|||AL|AL| MSA|AA|MSG0001|accepted

5.4 ACKÂ40 – ACKNOWLEDGE MESSAGE TO ADTÂ40

Each ADTÂ40 message received by iQ-WORKLIST will be answered with an acknowledge message

ACKÂ40 (Accept Acknowledgement). The sending system of the ADTÂ40 is now informed that the

message was accepted or rejected.


By default, iQ-WORKLIST uses the following acknowledgement codes in the MSA-1 field.


AA - Application Accept accept The incoming message was

received successfully by the HL7

server of iQ-WORKLIST.

AR - Application Reject reject The incoming message could not


error with the message structure or

a non-configured communication


AE - Application Error error The incoming message could not





running).

*(For more information please refer to Table 0008 Acknowledgement Code of HL7 standard 2.6 chapter 2.14.8.1.)

An ACK^A08 message is composed of the following segments:

MSH Message Header




[{ ERR }] Error

Every acknowledge message is composed of the following segments:

MSH

MSA

Message example:

MSH|^~\&|HIS|HOSPITAL|IQWKL|RAD|20131104090000.0||ACK^A40| MSG20131015164027557|P|2.6|||AL|AL| MSA|AA|MSG0001|accepted


6 MESSAGE MAPPING

This section describes the default mapping of all supported segments and fields of used HL7 messages

that can be processed by iQ-WORKLIST.


possibilities of incoming mapping values.

According to the HL7 standard, the fields are marked in the REQUIRED column with R = for Required, O =

for Optional, and as deviation from HL7 standard with the marker O/R = for Required by iQ-WORKLIST.

1.1 MSH SEGMENT MAPPING

SEQ HL7 FIELD NAME REQUIRED* COMMENTS / VALUE / DICOM

1 Field Separator R ‘|’

2 Encoding characters R ‘^~\&’

3 Sending Application O

4 Sending Facility O

5 Receiving Application O

6 Receiving Facility O

7 Date Time Of Message R ‘YYYYMMDDhhmmss’

8 Security O

9 Message Type R related message type

10 Message Control ID R unique message control ID

11 Processing ID O ‘P’

12 Version ID O ‘2.6’

13 Sequence Number O

14 Continuation Pointer O

15 Accept Acknowledgement Type O

16 Application Acknowledgement Type O

17 Country Code O

18 Character Set O

19 Principal Language Of Message O

20 Alternate Character Set Handling Scheme O

21 Message Profile Identifier O

22 Sending Responsible Organization O

23 Receiving Responsible Organization O

24 Sending Network Address O

25 Receiving Network Address O

*(HL7 Standard 2.6, R = Required, O = Optional, O/R = Required by iQ-WORKLIST)


1.2 EVN SEGMENT MAPPING


1 Event Type Code O trigger type

2 Recorded Date/Time R ‘YYYYMMDDhhmmss’

3 Date/Time Planned Event O

4 Event Reason Code O

5 Operator ID O

6 Event Occurred O

7 Event Facility O


1.3 PID SEGMENT MAPPING


1 Set ID O ‘1’

2 Patient ID O (0010,0020)

3 Patient Identifier List R (0010,0020)

4 Alternate Patient ID O (0010,1000)

5 Patient Name R (0010,0010)

6 Mother O

7 Date of Birth O/R (0010,0030)

8 Sex O/R (0010,0040)

9 Patient Alias O

10 Race O (0010,2160)

11 Patient Address O

12 Country Code O

13 Phone Number Home O

14 Phone Number Business O

15 Primary Language O

16 Marital Status O

17 Religion O

18 Patient Account Number O

19 SSN Number O

20 Driver O

21 Mother O

22 Ethnic Group O (0010,2160)

23 Birth Place O

24 Multiple Birth Indicator O

25 Birth Order O


26 Citizenship O

27 Veterans Military Status O

28 Nationality O

29 Patient Death Date and Time O

30 Patient Death Indicator O

31 Identity Unknown Indicator O

32 Identity Reliability Code O

33 Last Update Date/Time O

34 Last Update Facility O

35 Species Code O

36 Breed Code O

37 Strain O

38 Production Class Code O

39 Tribal Citizenship O


1.4 PV1 SEGMENT MAPPING


1 Set ID - Patient Visit O ‘1’

2 Patient Class R ‘I’

3 Assigned Patient Location O (0038,0300)

4 Admission Type O

5 Pre-admit Number O

6 Prior Patient Location O

7 Attending Doctor O

8 Referring Physician O (0008,0090)

9 Consulting Doctor O

10 Hospital Service O

11 Temporary Location O (0038,0300)

12 Pre-admit Test Indicator O

13 Re-admission Indicator O

14 Admit Source O

15 Ambulatory Status O (0038,0500), (0010,21C0), (0038,0050)

16 VIP Indicator O (0040,3001)

17 Admitting Doctor O

18 Patient Type O

19 Visit Number O (0038,0010)

20 Financial Class O

21 Charge Price Indicator O

22 Courtesy Code O


23 Credit Rating O

24 Contract Code O

25 Contract Effective Date O

26 Contract Amount O

27 Contract Period O

28 Interest Code O

29 Transfer to Bad Debt Code O

30 Transfer to Bad Debt Date O

31 Bad Debt Agency Code O

32 Bad Debt Transfer Amount O

33 Bad Debt Recovery Amount O

34 Delete Account Indicator O

35 Delete Account Date O

36 Discharge Disposition O

37 Discharged to Location O

38 Diet Type O

39 Servicing Facility O

40 Bed Status O

41 Account Status O

42 Pending Location O

43 Prior Temporary Location O

44 Admit Date/Time O

45 Discharge Date/Time O

46 Current Patient Balance O

47 Total Charges O

48 Total Adjustments O

49 Total Payments O

50 Alternate Visit ID O

51 Visit Indicator O

52 Other Healthcare Provider O


1.5 MRG SEGMENT MAPPING


1 Prior Patient Identifier List R patient identifier which identifies the

patient before (‘incorrect source

identifier’)

2 Prior Alternate Patient ID O

3 Prior Patient Account Number O

4 Prior Patient ID O


5 Prior Visit Number O

6 Prior Alternate Visit ID O

7 Prior Patient Name O


1.6 MSA SEGMENT MAPPING


1 Acknowledgement Code R application acknowledgement

2 Message Control ID R contains the message control ID of the

message sent by the sending system

3 Text Message O short description of acknowledgement

code (e.g. ‘SUCCESS’ or ‘ERROR’ or

‘REJECTED’)

4 Expected Sequence Number O

5 Delayed Acknowledgment Type O

6 Error Condition O

7 Message Waiting Number O

8 Message Waiting Priority O

*(HL7 Standard 2.6.0, R = Required, O = Optional, O/R = Required by iQ-WORKLIST)

1.7 ORC SEGMENT MAPPING


1 Order Control R event request or event acknowledgement

2 Placer Order Number O/R (0008,0050)^^(0020,000D)

3 Filler Order Number O (0008,0050)

4 Placer Group Number O

5 Order Status O event notification (MPPS status)

6 Response Flag O

7 Quantity/Timing O ^^^(0040,0100)>(0040,0002)

(0040,0100)>(0040,0003)

8 Parent Order O

9 Date/Time of Transaction O

10 Entered By O

11 Verified By O

12 Ordering Provider O (0032,1032)

13 Enterer's Location O

14 Call Back Phone Number O

15 Order Effective Date/Time O


16 Order Control Code Reason O

17 Entering Organization O

18 Entering Device O “(0040,0100)>(0040,0001)^

(0040,0100)>(0040,0010)^^

(0040,0100)>(0008,0060)”

19 Action By O

20 Advanced Beneficiary Notice Code O

21 Ordering Facility Name O (0032,1033)

22 Ordering Facility Address O

23 Ordering Facility Phone Number O

24 Ordering Provider Address O

25 Order Status Modifier O

26 Advanced Beneficiary Notice

Override Reason

O

27 Filler's Expected Availability Date/Time O

28 Confidentiality Code O

29 Order Type O

30 Enterer Authorization Mode O

31 Parent Universal Service Identifier O


1.8 OBR SEGMENT MAPPING


1 Set ID - Observation Request O ‘1’

2 Placer Order Number O/R (0008,0050)^^(0020,000D)

3 Filler Order Number O (0008,0050)

4 Universal Service ID R “(0040,0100)>(0040,0008)>(0008,0100)^

(0040,0100)>(0040,0007) ^^

(0040,0100)>(0040,0009)^

(0040,0100)>(0040,0008)>(0008,0104)^

(0040,0100)>(0040,0008)>(0008,0102)^^

(0040,0100)>(0040,0008)>(0008,0103)”

5 Priority O (0040,1003)

6 Requested Date/Time O

7 Observation Date/Time O

8 Observation End Date/Time O

9 Collection Volume O

10 Collector Identifier O

11 Specimen Action Code O

12 Danger Code O (0010,2000), (0010,2110)

13 Relevant Clinical Information O (0040,2400), (0040,1400)


14 Specimen Received Date/Time O

15 Specimen Source O

16 Ordering Provider O

17 Order Callback Phone Number O

18 Placer Field 1 O

19 Placer Field 2 O

20 Filler Field 1 O

21 Filler Field 2 O

22 Results Rpt./Status Chg. - Date/Time O

23 Charge to Practice O

24 Diagnostic Serv Sect ID O

25 Result Status O

26 Parent Result O

27 Quantity/Timing O

28 Result Copies To O (0040,1010)

29 Parent Number O

30 Transportation Mode O (0040,1004)

31 Reason for Study O

32 Principal Result Interpreter O

33 Assistant Result Interpreter O

34 Technician O (0040,0100)>(0040,0006)

35 Transcriptionist O

36 Scheduled Date/Time O

37 Number of Sample Containers O

38 Transport Logistics of Collected

Sample

O

39 Collector's Comment O

40 Transport Arrangement Responsibility O

41 Transport Arranged O

42 Escort Required O

43 Planned Patient Transport Comment O

44 Procedure Code O

45 Procedure Code Modifier O

46 Placer Supplemental Service

Information

O

47 Filler Supplemental Service Information O

48 Medically Necessary Duplicate

Procedure Reason

O

49 Result Handling O

50 Parent Universal Service Identifier O



7 ABBREVIATIONS AND ACRONYMS

ABBREVIATION MEANING

AL1 Allergy Information segment

ADT Admission, Discharge and Transfer message

DFT Detail Financial Transaction

DNS Domain Name System

DICOM Digital Information and Communication in Medicine

EVN Event Type segment

FT1 Financial Transaction

HIS Hospital Information System

HL7 Health Level 7

IHE Integrating the Healthcare Enterprise

JPEG The .jpeg image format

LLP Lower Level Protocol (HL7)

MPPS Modality Performed Procedure Step (DICOM)

MRG Merge Information segment

MSA Message Acknowledgement segment

MSH Message Header segment

OBR Observation Request segment

OBX Observation/Result segment

ORC Common Order segment

ORM Order Request message

ORU Observation Results - Unsolicited message

ORR General Order Response message

PID Patient ID segment

PV1 Patient Visit segment

RIS Radiology Information System

SR Structured Report (persistent object - DICOM)

XML Extensible Markup Language

ZDS Study Instance UID segment

iq-worklist€¦ · iq-worklist 2.0.0 hl7 conformance statement pub int en – 005r 2 1...

Documents