HL7 Interface Specification. HL7 Interface 1.2

Transcription

1 Interface Specification Interface 1.2 May 2004

2 Interface 1.2 Specification TABLE OF CONTENTS 1 INTRODUCTION Purpose Related Documents IMPLEMENTATION COMMUNICATION PROFILE IMPLEMENTATION Version Message Delimiters Processing Rules Original Acknowledgement Mode Rejection Messages Error Messages MESSAGES Patient Update ADT^A08 update patient information ADT^A40 merge patient - patient identifier list Procedure Scheduled ORM^O01 general order message Procedure Update ORM ^O01 general order message

3 1 Introduction 1.1 Purpose This document describes the Interface v. 1.2 based on the IHE Year 3 Technical Framework. 1.2 Related Documents The following documents are related to the Interface 1.2 Specification document: NEMA 2003, The DICOM Standard: Parts Integrated Healthcare Enterprise (IHE) Technical Framework Year 3, revision 5.5 dated November 20, This document is available at: HL 7 Standard version This document is available at: 3

4 2 Implementation Interface 1.2 is implemented as a single application entity. Its main functionality is to facilitate HIS/RIS/PACS integration by converting messages to DICOM Data Sets. The interface implementation is in accordance with IHE Year 3 Technical Framework. The Interface 1.2 handles Procedure Scheduled, Patient Update and Procedure Update IHE-defined transactions from HIS/RIS and updates the necessary Emageon-UV products accordingly. Table 2.1 summarizes supported IHE transactions and their corresponding messages. Table 2.1 Supported IHE Transactions IHE Transactions Procedure Scheduled Patient Update Procedure Update Messages ORM^O01 (general order message) ADT^A08 (update patient information) ADT^A40 (merge patient - patient identifier list) ORM^O01 (general order message) The Interface 1.2 is administered with a remote administrative application. 4

5 3 Communication Profile v recommends Minimal Lower Layer Protocol (LLP) to provide an interface between the application and the network. Lower Layer Protocol is any protocol residing in OSI layers one to four. These protocols package, route, verify, and transmit datagrams. A prime example of one of the protocols is TCP/IP. Interface 1.2 implements TCP/IP Minimal LLP and operates in a TCP/ IP network environment. messages should conform to the Minimal LLP block format as follows: message starts with 0x0B and ends with 0x1C and 0x0D. Each segment is terminated by 0x0D. 5

6 4 Implementation 4.1 Version Interface 1.2 supports version as specified by IHE Year 3 Technical Framework. 4.2 Message Delimiters Interface 1.2 uses the delimiter values in Table 4.1 as specified by IHE Year 3 Technical Framework. Table 4.1 Delimiter Values Delimiter Value Segment Terminator <cr> Field Separator Component Separator ^ Subcomponent Separator & Repetition Separator ~ Escape Character \ 6

7 4.3 Processing Rules Interface 1.2 implements Original Acknowledge Mode. Upon receiving an message, Interface 1.2 implements original acknowledgment rules as follows: 1. Accepts the message. 2. Validates it against the following criteria, in addition to Message Delimiters: Field MSH-3-sending application MSH-4-sending facility MSH-5-receiving application MSH-6-receiving facility MSH-9-message type MSH-10-message control ID IHE Notes Namespace ID is the only sub component used in HD data type. This field is required. Namespace ID is the only sub component used in HD data type. This field is required. Namespace ID is the only sub component used in HD data type. This field is required. Namespace ID is the only sub component used in HD data type. This field is required. As defined by v This field is required. Unique identifier used to relate the response to the initial message. This field is required. MSH-11-processing ID The value should be the literal P. MSH-12-version ID The value should be the literal This field is required. If any of these fields fail, the Interface 1.2 generates a reject message with AR in MSA-1-acknowledgment code. 3. If the message passes validation, Interface 1.2 maps the message to DICOM Data Set and sends it to the necessary Emageon-UV products. The next action of the Interface 1.2 is conditional based on one of the following scenarios: If mapping the message and sending a Data Set to Emageon products passes, Interface 1.2 generates a successful response with AA in MSA-1-acknowledgment code. If mapping the message and sending a Data Set to Emageon products fails due to error in the message content or format, Interface 1.2 generates an error message with AE in MSA-1-acknowledgment code. 7

8 If an unexpected error happens during this process that is not related to the message content or format (e.g., hard disk out of space), Interface 1.2 generates a reject message with AR in MSA-1-acknowledgment code. 4. Interface 1.2 sends an ACK message to the initiator. 4.4 Original Acknowledgement Mode In all responses described above, Interface 1.2 implements the following acknowledgement message grammar: ACK General Acknowledgement v Chapter MSH Message Header 2 MSA Message Acknowledgement 3 With the following fields value: MSH Segment SEQ Element Name Value 1 Field Separator 2 Encoding Characters ^~\& 3 Sending Application MSH-5 Receiving Application from received message. 4 Sending Facility MSH-6 Receiving Facility from received message. 5 Receiving Application MSH-3 Sending Application from received message. 6 Receiving Facility MSH-4 Sending Application from received message. 7 Date/Time Of Message Time stamp when the message is sent 9 Message Type Event: ACK Type: Message Type of the received message. 10 Message Control ID Same value from the received message. 11 Processing ID P 12 Version ID

9 MSA Segment SEQ Element Name Item # 1 Acknowledgment Code Possible values: AA, AE, AR 2 Message Control ID MSH-10 Message Control ID from the received message. 3 Text Message Error description, if any Rejection Messages Rejection messages usually result from an unexpected exception, so the server logs a comprehensive message detailing the reason of rejection. Due to the nature of the exception, it is inadequate to send it in the MSA-3 Text Message. Instead, a descriptive message will be sent. The interface log should be consulted for full details Error Messages Error messages usually result from message format or context. An MSA-3 Text Message will have a detailed description of the error. 9

10 5 Messages messages related to Interface 1.2 are mentioned in Section 4 - Implementation. This section depicts each message grammar based on IHE Year 3 Technical Framework, describes required fields and fields to DICOM data elements mapping. An ACK message is sent to the initiator upon receiving any of these messages. Since a MSH segment is common to all messages, it will not be provided in the message s semantics. Segment fields required by IHE Year 3 Technical Framework will not be provided in this document. Since the interface required fields are a subset of IHE Year 3 Technical Framework, this document only discusses fields related to the interface. messages are grouped based on IHE Transaction naming convention. In describing messages semantics, the following conventions are used: Position (sequence within the segment) - Position of the data field within the segment. In the message semantics tables this information is provided in the column labeled SEQ. Optionality - Whether the field is required, or optional, the designations are: R - Required. O - Optional. In the message semantics tables, this information is provided in the column labeled OPT. Repetition - Whether the field may repeat. The designations are: Empty - No repetition. Y - The field may repeat an indefinite (or site-determined) number of times. In the message semantics tables, this information is provided in the column labeled RP/#. Value - The value, which is mapped to DICOM data element, is one of the following: <number> - The number indicates the field SEQ. It means the entire field is mapped into DICOM data element. <number.number> - The first part indicated the fields SEQ and the second indicate the component within that SEQ. For example to refer to a patient last name within a patient name in the PID segment:

11 5.1 Patient Update ADT^A08 update patient information Message Grammar ADT ADT Message v Chapter # MSH Message Header 2 EVN Event Type 3 PID Patient Identification 3 PV1 Patient Visit 3 [ {OBX} ] Observation/Result 7 [ {AL1} ] Allergy Information 3 11

12 ADT^A08 Message Semantics Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value EVN 2 R/O TS Recorded Date/Time PID PV1 3 R/R Y CX Patient Identifier List (0010, 0020) Patient ID (LO) = 3.1 (0010, 0021) Issuer of Patient ID (LO) = 3.4 (0010, 1000) Other Patient ID (LO) = 3.1 repetition 5 R/R XPN Patient Name (0010, 0010) Patient Name (PN) = 5 6 O/O XPN Mother s Maiden Name (0010, 1060) Mother Birth Name (PN) = 6 7 O/O TS Date/Time of Birth (0010, 0030) Patient Birth Date (DA) = 7 (date part) (0010, 0032) Patient Birth Date (TM) = 7 (time part) 8 O/O IS Sex (0010, 0040) Patient Sex (CS) = 8 10 O/O CE Race (0010, 2160) Patient Ethnic Group (SH) = O/O XAD Patient Address (0010, 1040) Patient Address (LO) = R/O CX Patient Account Number (0038, 0010) Admission ID (LO) = 18.1 (0038, 0011) Issuer of Admission ID (LO) = O/O CE Citizenship (0010, 2152) Region of residence (LO) = O/O CE Veterans Military Status (0010, 1080) Military Rank (LO) = 27 3 O/O PL Assigned Patient Location (0038, 0300) Current Patient Location (LO) = 3 8 O/O XCN Referring Doctor (0008, 0090) Referring Physician s Name (PN) = 8 15 O/O IS Ambulatory Status (0010, 21c0) Pregnancy Status (US) = 15, if equal to B6 16 O/O IS VIP Indicator (0040, 3001) Confidentiality Constrain on Patient Date (LO) = 16 12

13 OBX 3 R/O CE Observation Identifier 3.2 = Body Weight or Body Height 5 R/O CE Observation Value (0010, 1030) Patient Weight (DS) = 5; if OBX:3.2 = Body Weight & OBX:6.2 = kg (0010, 2010) Patient Size (DS) = 5; If OBX:3.2 = Body Height & OBX:6.2 = m 6 R/O CE Units 6.2 = kg for Body Weight or m for Body Height AL1 3 R/O CE Allergy Code/ Mnemonic/ Description ADT^A40 merge patient - patient identifier list Message Grammar (0010, 2110) Contrast Allergies (LO) = 3 ADT ADT Message v Chapter # MSH Message Header 2 EVN Event Type 3 PID Patient Identification 3 MRG Merge Information 3 [ PV1 ] Patient Visit 3 13

14 ADT^A40 Message Semantics Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value EVN 2 R/O TS Recorded Date/Time PID PV1 3 R/R Y CX Patient Identifier List (0010, 0020) Patient ID (LO) = 3.1 (0010, 0021) Issuer of Patient ID (LO) = 3.4 (0010, 1000) Other Patient ID (LO) = 3.1 repetition 5 R/R XPN Patient Name (0010, 0010) Patient Name (PN) = 5 6 O/O XPN Mother s Maiden Name (0010, 1060) Mother Birth Name (PN) = 6 7 O/O TS Date/Time of Birth (0010, 0030) Patient Birth Date (DA) = 7 (date part) (0010, 0032) Patient Birth Date (TM) = 7 (time part) 8 O/O IS Sex (0010, 0040) Patient Sex (CS) = 8 10 O/O CE Race (0010, 2160) Patient Ethnic Group (SH) = O/O XAD Patient Address (0010, 1040) Patient Address (LO) = R/O CX Patient Account Number (0038, 0010) Admission ID (LO) = 18.1 (0038, 0011) Issuer of Admission ID (LO) = O/O CE Citizenship (0010, 2152) Region of residence (LO) = O/O CE Veterans Military Status (0010, 1080) Military Rank (LO) = 27 3 R/O PL Assigned Patient Location (0038, 0300) Current Patient Location (LO) = 3 8 O/O XCN Referring Doctor (0008, 0090) Referring Physician s Name (PN) = 8 15 O/O IS Ambulatory Status (0010, 21c0) Pregnancy Status (US) = 15, if equal to B6 16 O/O IS VIP Indicator (0040, 3001) Confidentiality Constrain on Patient Date (LO) = 16 14

15 Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value MRG 1 R/R Y CX Prior Patient Identifier List (Internal) (0010, 0020) Patient ID = 1.1 (0010, 0021) Issuer of Patient ID = O/R CX Prior Patient ID (External) (0010, 0020) Patient ID = 3.1 (0010, 0021) Issuer if Patient ID =

16 5.2 Procedure Scheduled ORM^O01 general order message Message Grammar ADT ADT Message v Chapter # MSH Message Header 2 PID Patient Identification 3 PV1 Patient Visit 3 { ORC Common Order 4 OBR Order Detail 4 } ORM^O01 Message Semantics Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value PID 3 R/R Y CX Patient Identifier List (0010, 0020) Patient ID (LO) = 3.1 (0010, 0021) Issuer of Patient ID (LO) = 3.4 (0010, 1000) Other Patient ID (LO) = 3.1 repetition 5 R/R XPN Patient Name (0010, 0010) Patient Name (PN) = 5 6 O/O XPN Mother s Maiden Name (0010, 1060) Mother Birth Name (PN) = 6 16

17 Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value PV1 7 R/`R TS Date/Time of Birth (0010, 0030) Patient Birth Date (DA) = 7 (date part) (0010, 0032) Patient Birth Date (TM) = 7 (time part) 8 R/R IS Sex (0010, 0040) Patient Sex (CS) = 8 10 O/O CE Race (0010, 2160) Patient Ethnic Group (SH) = O/O XAD Patient Address (0010, 1040) Patient Address (LO) = R/O CX Patient Account Number (0038, 0010) Admission ID (LO) = 18.1 (0038, 0011) Issuer of Admission ID (LO) = O/O CE Citizenship (0010, 2152) Region of residence (LO) = O/O CE Veterans Military Status (0010, 1080) Military Rank (LO) = 27 3 R/O PL Assigned Patient Location (0038, 0300) Current Patient Location (LO) = 3 8 O/O XCN Referring Doctor (0008, 0090) Referring Physician s Name (PN) = 8 15 O/O IS Ambulatory Status (0010, 21c0) Pregnancy Status (US) = 3, if 15 equal to B6 16 O/O IS VIP Indicator (0040, 3001) Confidentiality Constrain on Patient Date (LO) = 16 ORC 1 R/R ID Order Control = NW 17

18 Segment SEQ OPT IHE/ Archive OBR RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value 4 R/O CE Universal Service ID (0032, 1064) Requested Procedure Coding Sequence (SQ): >(0008, 0100) Requested Procedure Code Value (SH) = 4.1 >(0008, 0104) Requested Procedure Code Meaning (LO)= 4.2 >(0008, 0102) Requested Procedure Coding Scheme (SH)= 4.3 (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0040, 0008) Scheduled Protocol Code Sequence >>(0008, 0100) Scheduled Procedure Code value (SH)= 4.4 >>(0008, 0104) Scheduled Procedure Code Meaning (LO) = 4.5 >>(0008, 0102) Scheduled Procedure Coding Scheme (SH)= 4.6 (0040, 0007) Scheduled Procedure Description (LO)= O/O CM Specimen Source (0032, 1060) Requested Procedure Description (LO)= O/O ST Placer Field 1 (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0008, 0050) Accession Number (SH) = O/O ST Placer Field 2 (0040, 1001) Requested Procedure ID (SH) = O/O ST Filler Field 1 + (0040, 0009) Scheduled Requested Procedure ID (SH) = O/O ID Diagnostic Serv Sect ID (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0008, 0060) Modality (CS) = O/O TS Quantity/Timing (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0040, 0002) Scheduled Procedure Start Date (DA) = 27.4 (date part) >(0040, 0003) Scheduled Procedure Start Time (TM) = 27.4 (time part) SCH 11 R/O TQ Appointment Timing Quantity (0008, 0020) Appointment Start Date (DA) = 11.4 (date part) (0008, 0030) Appointment Start Time (TM) = 11.4 (time part) 18

19 Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value ZDS 1 R/R RP Study Instance UID (0020, 000D) Study Instance UID (UI) =

20 5.3 Procedure Update ORM ^O01 general order message Message Grammar ADT ADT Message v Chapter # MSH Message Header 2 PID Patient Identification 3 PV1 Patient Visit 3 { ORC Common Order 4 OBR Order Detail 4 } ORM^O01 Message Semantics Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value PID 3 R/R Y CX Patient Identifier List (0010, 0020) Patient ID (LO) = 3.1 (0010, 0021) Issuer of Patient ID (LO) = 3.4 (0010, 1000) Other Patient ID (LO) = 3.1 repetition 5 R/R XPN Patient Name (0010, 0010) Patient Name (PN) = 5 6 O/O XPN Mother s Maiden Name (0010, 1060) Mother Birth Name (PN) = 6 20

21 Segment SEQ OPT IHE/ Archive RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value PV1 7 R/R TS Date/Time of Birth (0010, 0030) Patient Birth Date (DA) = 7 (date part) (0010, 0032) Patient Birth Date (TM) = 7 (time part) 8 R/R IS Sex (0010, 0040) Patient Sex (CS) = 8 10 O/O CE Race (0010, 2160) Patient Ethnic Group (SH) = O/O XAD Patient Address (0010, 1040) Patient Address (LO) = R/O CX Patient Account Number (0038, 0010) Admission ID (LO) = 18.1 (0038, 0011) Issuer of Admission ID (LO) = O/O CE Citizenship (0010, 2152) Region of residence (LO) = O/O CE Veterans Military Status (0010, 1080) Military Rank (LO) = 27 3 R/O PL Assigned Patient Location (0038, 0300) Current Patient Location (LO) = 3 8 O/O XCN Referring Doctor (0008, 0090) Referring Physician s Name (PN) = 8 15 O/O IS Ambulatory Status (0010, 21c0) Pregnancy Status (US) = 3, if 15 equal to B6 16 O/O IS VIP Indicator (0040, 3001) Confidentiality Constrain on Patient Date (LO) = 16 ORC 1 R/R ID Order Control = DC, CA, XO 21

22 Segment SEQ OPT IHE/ Archive OBR RP/# Data Type Element Name DICOM Data Element (group, element) Name (VR) = Value 4 R/O CE Universal Service ID (0032, 1064) Requested Procedure Coding Sequence (SQ): >(0008, 0100) Requested Procedure Code Value (SH) = 4.1 >(0008, 0104) Requested Procedure Code Meaning (LO)= 4.2 >(0008, 0102) Requested Procedure Coding Scheme (SH)= 4.3 (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0040, 0008) Scheduled Protocol Code Sequence >>(0008, 0100) Scheduled Procedure Code value (SH)= 4.4 >>(0008, 0104) Scheduled Procedure Code Meaning (LO) = 4.5 >>(0008, 0102) Scheduled Procedure Coding Scheme (SH)= 4.6 (0040, 0007) Scheduled Procedure Description (LO)= O/O CM Specimen Source (0032, 1060) Requested Procedure Description (LO)= O/O ST Placer Field 1 (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0008, 0050) Accession Number (SH) = O/O ST Placer Field 2 (0040, 1001) Requested Procedure ID (SH) = O/O ST Filler Field 1 + (0040, 0009) Scheduled Requested Procedure ID (SH) = O/O ID Diagnostic Serv Sect ID (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0008, 0060) Modality (CS) = O/O TS Quantity/Timing (0040, 0100) Scheduled Procedure Step Sequence (SQ) >(0040, 0002) Scheduled Procedure Start Date (DA) = 27.4 (date part) >(0040, 0003) Scheduled Procedure Start Time (TM) = 27.4 (time part) ZDS 1 R/R RP Study Instance UID (0020, 000D) Study Instance UID (UI) =

23 23