DICOMStore. HL7 Interface Specification. M7445 Version 5.1 rev1 August 2013

Transcription

1 DICOMStore HL7 Interface Specification M7445 Version 5.1 rev1 August

2 Document Reference Version DICOMStore HL7 Interface Specification M rev1 Date of issue August 2013 The information in this document is subject to change without notice. Please refer to the Release Notes for more current information on specific releases. BridgeHead Software makes no warranty of any kind with regard to this material, including, but not limited to the implied warranties of merchantability, performance, or fitness for a particular purpose. BridgeHead Software shall not be liable for errors contained herein or for any direct, incidental, or consequential damages resulting from the use of this material. Copyright 2013 BridgeHead Software Ltd. and its licensors. All rights reserved. You may view and print this publication solely for personal, informational, internal, non-commercial purposes. You must not change it in any way or remove any copyright of other proprietary notices. You may not reproduce, distribute or translate any part of the publication without the written permission of BridgeHead Software. These rights constitute a license and not a transfer of title. BRIDGEHEAD, BH, FileStore, FileStore EHR, MailStore, MediSafe, MediStore, OfficeStore, PACStore and BH FileStore EHR are all Trademarks of BridgeHead Software Ltd. BH FileStore, BH MailStore, BH MediStore, BH OfficeStore, and BH PACStore are all Registered Trademarks of BridgeHead Software Ltd. All other brand names, trademarks and registered trademarks are the properties of their respective owners. Contact us UK BridgeHead House, 215 Barnett Wood Lane Ashtead, Surrey KT21 2DF United Kingdom Tel: +44 (0) /Fax: +44 (0) Sales.UK@BridgeHeadSoftware.com USA 400 West Cummings Park, Suite 6050 Woburn, MA USA Tel: /Fax: Sales.US@BridgeHeadSoftware.com Germany Kaiserwerther Strasse 215 D Düsseldorf Ratingen Deutschland Tel: +49 (0) /Fax: +49 (0) Sales.DE@BridgeHeadSoftware.com Visit our website

3 1 Introduction 1.1 Revision Record Revision Date Comment August 2013 Initial version 1.2 Purpose of this Document This specification gives a technical overview of how the DICOMStore product receives and processes Health Level Seven (HL7) messages from other Hospital Information System, Radiology Information Systems or other applications. 1.3 Intended Audience This document is intended for use by Hospital Information System providers, Radiology Information System provider or other system integration specialists. 1.4 Scope This document relates specifically to DICOMStore version and above. However later versions may add or change functionality so please check for later revisions of this document. 1.5 References This document should be read in conjunction with the following references: 1.6 Health Level Seven (HL7) Messaging Standard Version 2.3 Digital Imaging and Communications in Medicine (DICOM) Standard Version 3.0 (2011) Related Documents This document should be read alongside the following documents: DICOMStore Administrator Guide DICOMStore User Guide DICOMStore HL7 Interface Specification 5.1 rev1 3

4 Introduction 1.7 ADT DICOM HIS RIS HL7 PACS TCP/IP MLLP Abbreviations Admission, Discharge and Transfer System Digital Imaging and Communications in Medicine Hospital Information System Radiology Information System Health Level Seven Interface Standard Picture Archiving and Communication System Transmission Control Protocol/Internet Protocol Minimal Lower Layer Protocol 4 DICOMStore HL7 Interface Specification 5.1 rev1

5 2 HL7 Service Overview The purpose of the HL7 service in DICOMStore is to receive and process patient information and reconciliation (PIR) messages from other systems in the healthcare environment. The DICOMStore HL7 service acts solely as a listener; it does not initiate any outgoing messages. Whilst there are thousands of different HL7 messages generated by clinical and administrations systems, DICOMStore will respond only to a certain subset of ADT messages: ADT A08 ADT A40 Patient Updated Merge Patient Patient Identifier List DICOMStore HL7 Interface Specification 5.1 rev1 5

6 HL7 Service Overview 6 DICOMStore HL7 Interface Specification 5.1 rev1

7 3 Communication Interface 3.1 Physical Interface The DICOMStore HL7 server can be configured to listen on one or more TCP/IP ports. By default the service will listen on port The HL7 server may also be configure to listen on a secure port configured to use the TLS protocol. See the DICOMStore User Guide for further information on configuration. 3.2 Message Structure DICOMStore supports Minimal Lower Layer Protocol for communication between HL7 systems. This defines the message structure as follows: Message Start Character Segment End Character Message Stop Characters 0x0B 0x0D 0x1C and 0x0D 3.3 Message Logging All received HL7 messages are logged in the DICOMStore database, and may be viewed using the DICOMStore Management Console. Detailed HL7 server log files are also generated and may be viewed using any text viewer. Please refer to the DICOMStore User Guide for further information on configuring and viewing logs. DICOMStore HL7 Interface Specification 5.1 rev1 7

8 Communication Interface 8 DICOMStore HL7 Interface Specification 5.1 rev1

9 4 Message Details The following sections describe in detail the message structures expected by the DICOMStore HL7 server. For full details about HL7 messages and data types, please refer to the relevant HL7 specification. 4.1 ADT A08 Update Patient Information This message is used to update the demographic information of a specific patient. MSH Segment Item Element Name Data Type Value 0001 Field Separator ST For this element is expected Encoding Characters ST For this element ^~\& is expected Message Type CM For this element ADT^A08 is expected Message Control ID ST Used to fill the acknowledge message Processing ID PT Used to fill the acknowledge message Version ID VIT Used for HL7 version check and to fill the acknowledge message. PID Segment Item Element Name Data Type Value 0003 Patient Identifier List CX Used to identify the patient for the update process. If this field contains more than one identifier only the first one is used for patient identification Patient Name XPN New name for the specified patient. If this field contains more than one name only the first one is used for the update process Date/Time Of Birth TS New date/time of birth for the specified patient Sex IS New sex for the specified patient. Constraints: A PIR process can only be performed for patients with a valid Patient ID. PIR requests for patients which are not available in DICOMStore are ignored. DICOMStore cannot perform a PIR process if it results in two or more identical patients. Although the original information for the patient is preserved, DICOMStore will only respond to queries using the updated information. DICOMStore HL7 Interface Specification 5.1 rev1 9

10 Message Details 4.2 ADT A40 Merge Patient This message type is used to merge two patients identified by the Patient ID or to modify the Patient ID value of a specific patient. MSH Segment Item Element Name Data Type Value 0001 Field Seperator ST For this element is expected Encoding Characters ST For this element ^~\& is expected Message Type CM For this element ADT^A40 is expected Message Control ID ST Used to fill the acknowledge message Processing ID PT Used to fill the acknowledge message Version ID VIT Used for HL7 version check and to fill the acknowledge message. PID Segment Item Element Name Data Type Value 0003 Patient Identifier List CX Used to identify the resulting patient of the merge process. MRG Segment Item Element Name Data Type Value 0001 Prior Patient Identifier List CX Used to identify the patient to be merged into the resulting patient. Notes: DICOMStore can handle only one merge request contained in an ADT A40 message. The Patient ID of the patient specified by the Patient Identifier List element of the PID segment is updated with the Patient ID of the patient specified by the Prior Patient Identifier List element of the MRG segment if the Prior Patient does not exist in DICOMStore. The patient demographics (Patient ID) of the patient specified by the Prior Patient Identifier List element of the MRG segment are updated if the patient specified by the Patient Identifier List element of the PID segment does not exist in DICOMStore. Constraints: A PIR process can only be performed for patients with a valid Patient ID. PIR requests for patients which are not available in DICOMStore are ignored. DICOMStore cannot perform a PIR process if it results in two or more identical patients. A patient cannot be merged into another patient with the same Patient ID. 10 DICOMStore HL7 Interface Specification 5.1 rev1

11 Message Details 4.3 Acknowledgement Messages Message Contents The DICOMStore HL7 server will respond to each received HL7 message with an appropriate acknowledgement message. The acknowledgement messages contain the segments listed in the following tables: MSH Segment Item Element Name Data Type Value Field Seperator ST This element is always set to Encoding Characters ST This element is always set to ^~\& Date/Time Of Message TS Current date and time when the acknowledge message is created Message Type CM This element is always set to ACK Message Control ID ST Message Control ID value from the received message Processing ID PT Processing ID value from the received message Version ID VIT Version ID value from the received message. MSA Segment Item Element Name Data Type Value Acknowledgement Code ID See Error! Reference source not found. section for values Message Control ID ST Message Control ID value from the received message Message Status The final result of the processing of the received HL7 message is return as a status, as follows: Status Ack. Code Description Success AA Message accepted Reject AR Message rejected (could not be processed) DICOMStore HL7 Interface Specification 5.1 rev1 11

12 Message Details 12 DICOMStore HL7 Interface Specification 5.1 rev1