Documenti di Didattica
Documenti di Professioni
Documenti di Cultura
HL7 integration
Rev. 2.0
FINAL
1 / 37
PROPRIETÀ DELLE INFORMAZIONI
Il contenuto di questo manuale è basato sul rilascio del software ELEKTRA.
Questo manuale d’uso, i disegni e tutti gli altri documenti forniti con il software sono di proprietà Dedalus
che riserva tutti i diritti. Pertanto, la ricezione o il possesso degli stessi non conferiscono alcun diritto di
riprodurre i contenuti descritti in esso.
I disegni e/o i documenti non possono essere resi disponibili e/o assegnati a terzi senza autorizzazione
scritta di Dedalus. La vendita o la visione, anche parziale, è vietata dalla legge.
Dedalus non si assume alcuna responsabilità per un uso improprio del dispositivo e/o per i danni causati
da operazioni non coperte da questo manuale. © 2021 Dedalus
Via di Collodi 6c
50141 FIRENZE
ITALIA
2 / 37
3 / 37
DOCUMENT REVISION
APPROVALS
4 / 37
Sommario
1 Introduction ........................................................................................................................ 8
2 Supported Messages ......................................................................................................... 8
5 / 37
4.1.4 OBR - common order information segment .....................................................................................19
4.1.5 Expected Actions in ELEKTRA ....................................................................................................................20
5 ORU Messages.................................................................................................................. 24
6 / 37
7 / 37
1 INTRODUCTION
This document provides a list of HL7 messages supported in the ELEKTRA release 4.0.
2 SUPPORTED MESSAGES
Each message shall be acknowledged by the HL7 ACK message. (See §11).
8 / 37
2.2 OUTGOING MESSAGES
Each subscriber should be registered into ELEKTRA with his ACK Policy (See Appendix A).
Message Segment
ADTA04 MSH / EVN / PID / PD1 / NK1/ PV1 / AL1 / OBX
ADTA08 MSH / EVN / PID / PD1 / NK1/ PV1 / AL1 / OBX
ADTA28 MSH / EVN / PID / PD1 / NK1/ PV1 / AL1 / OBX
ADTA31 MSH / EVN / PID / PV1
ADTA40 MSH / EVN / PID / MRG / PV1
ORMO01 MSH / PID / PV1 / PV2 / ORC / OBR / FT1 (/ZDS)
ORUR01 MSH / EVN / PID / OBR / OBX
MDMT02 MSH / EVN / PID / PV1 / TXA / OBX
MDMT10 MSH / EVN / PID / PV1 / TXA / OBX
MDMT01 MSH / EVN / PID / PV1 / TXA / OBX
9 / 37
MDMT09 MSH / EVN / PID / PV1 / TXA / OBX
10 / 37
3 ADT MESSAGES
11 / 37
Note: field MSH-9 Message Type shall have at least two components. The first component shall
have a value of “ADT”; the second component shall have values of A04. The third component is
optional; however, if present, it shall have a value of ADT_A01.
12 / 37
3.1.4 PD1 - patient additional demographic segment
The patient additional demographic segment contains demographic information that is likely to
change about the patient. We will use it for GPs.
If a person or organization fulfills multiple contact roles, for example, a person is an emergency
contact and a next of kin, it is recommended to send a NK1 segment for each contact role (field
7).
13 / 37
3.1.6 PV1 - Patient Visit Segment
SEQ LEN DT OPT ELEMENT NAME NOTES
2 1 IS R Patient Class See USR0004 Table (Appendix B)
3 80 PL O Assigned Patient <point of care>^^^^^^
Location <building>^^
<location description>
Table 7: ADT A04 PV1 segment
1 4 SI R Set ID – AL1
3 60 CE R Allergy <ID>^<description>
Code/Mnemonic/Descripti
on
6 8 DT O Identification Date ISO Format:
YYYYMMDD[HHMMSS]
Table 8: ADT A04 AL1 segment
Note: currently RIS does not manage the patient “observations” data, but Hospital System can
send this segment for completeness as it does have these details and would send them to any
consumer of our HL7 messages. HL7 RIS interface will ignore these observations.
14 / 37
3.3 ADT A08 PATIENT INFORMATION UPDATE MESSAGE SEMANTIC
This trigger event is used when any patient information has changed but when no other trigger
event has occurred. For example, an A08 event can be used to notify the receiving systems of a
change of address or a name change. We recommend that the A08 transaction be used to update
fields that are not related to any of the other trigger events. The A08 event can include information
specific to an episode of care, but it can also be used for demographic information only.
15 / 37
3.4 ADT A31 PERSON UPDATE INFORMATION
See 3.6
An A40 message indicates that a merge has been done at the internal identifier level. That is, PID-
3-patient ID identifier has been merged with MRG-1 Patient ID. This message is initiated by Elektra
RIS.
16 / 37
correct target patient was not known to the receiving system, it is expected that the receiving
system will create a patient record using the patient identifiers and demographics from the available
PID segment data.
4 ORM MESSAGES
The order start date/time or exam date/time is required in the “Quantity/Timing” field of both the
ORC and OBR segments.
17 / 37
19 60 CX O Visit Number Recover number (inpatients) or
episode number (outpatients,
emergency patients)
20 FC O Financial Class PV1.20^0 = Institution type /
disbursement regime
CE.3 = 'PRIVACY'
CE.3 = '10'
18 / 37
4.1.3 ORC - common order information segment
SEQ LEN DT O ELEMENT NAME NOTES
P
T
1 2 ID R Order Control <NW> (new order) or <CA> (cancel
order)
2 22 EI C Place Order Number Placer order number
19 / 37
16 80 XCN R Ordering Provider <ID>
^<Family Name>
^<Given Name>
^<Middle Initial or name>
^<Suffix>
^<Prefix>
24 10 ID O Diagnostic Serv <ID>
^<description> or modality name
Sect ID
30 20 ID O Transportation
mode
31 250 CE O Reason for study
32 200 NDL O Principal Result
Interpreter +
34 200 NDL O Technician +
36 200 TS R Date of booking
Date in ISO Format: YYYYMMDD
Scheduled
[HHMMSS]. It defines booking
Date/Time
date for outpatient or request
date for Inpatient
Table 30: ORM O01 OBR segment
Note: Field OBR-13 Relevant Clinical Info shall be populated if patient record contains any medical
alerts that may be relevant to the order and, in particular, need to be communicated to the
technologist. Also the LMP date will be included here.
Identical Element Mappings between ORC and OBR Segments are listed below.
After receiving the ORM message with the control code “CA”, Order Filler shall discard the record
of the order and shall not attempt to schedule or otherwise to fulfill it.
20 / 37
ORM O01 Order Message Notes
21 / 37
3 22 EI R Filler Order Filler order number
Number
5 2 ID R Order Status SC
22 / 37
24 10 ID O Diagnostic Serv <ID>
^<description> or modality name
Sect ID
Date in ISO Format: YYYYMMDD
27 200 TQ R Quantity Timing
[HHMMSS]
Table 34: ORM O01 OBR segment
1 255 ST R StudyInstanceUID
Table 35: ORM O01 ZDS segment
PV1||O|E||||||||||||||||AN0000268464||||||||||||||||||||||||||||||||V
ORC|NW||0000268479||SC||1^once^^20110730073453||20110730073500|||FER^MEDICO^REF
ERENTE^M^^DOTTOR|||||
ZDS|1.2.826.0.1.3802357.101.70000268479
23 / 37
5 ORU MESSAGES
3 80 CE R Observation REPORT ID
Identifier
5 8000 TX R Observation Value <report text>
See Note
24 / 37
Note: Report text will have rows delimited by “\x0d\\x0a\” (CR and LF) special characters.
3 80 CE R Observation REPORT ID
Identifier
5 8000 RF R Observation Value <images web link address>
6 MDM MESSAGES
25 / 37
1 4 SI R Id - TXA
2 30 IS R Document Type CN
3 80 CE R Observation REPORT ID
Identifier
26 / 37
6.3 MDM T01 ORIGINAL DOCUMENT NOTIFICATION MESSAGE SEMANTICS
When Reports are verified and finalized by the RIS system, it will send MDM transactions to the
EMR.
27 / 37
6.3.2 OBX - segment
SEQ LEN DT OPT ELEMENT NAME NOTES
2 3 ID R Value Type <RP>
3 80 CE R Observation REPORT ID
Identifier
28 / 37
7 ORU IMPORT MESSAGES
The ORU message is used for importing results from other systems. With the OBX and the OBR
segments, one can construct almost any clinical report as a three-level hierarchy, with the Patient
Context within the PID segment at the upper level, an order record within the OBR segment at the
next level and one or more observation records within the OBX at the bottom. The third OBX
contains the report PDF in B64 stream.
29 / 37
The message contains the:
• report in plain text format is conveyed within the OBX2-5 Observation Value
• the report in PDF format is encoded as Base64 string within the OBX3-5 Observation
Value
• the structured finding and study information in CDA format is sent within the OBX4-5
Observation Value
When RIS Elektra receives ORU message, decodes the stream present in OBX3-5 and attaches the
report PDF at the study with the Accession Number contained in OBR-3.
ORU Sample
The MDM message is used for importing results from other systems. With the OBX and the OBR
segments, one can construct almost any clinical report as a three-level hierarchy, with the Patient
Context within the PID segment at the upper level, an order record within the OBR segment at the
next level and one or more observation records within the OBX at the bottom. The second OBX
contains the report PDF in B64 stream.
30 / 37
Next table lists all managed required and optional segments.
• the report in PDF format is encoded as Base64 string within the OBX2-5 Observation
Value
When RIS Elektra receives MDM message, decodes the stream present in OBX2-5 and attaches the
report PDF at the study with the Accession Number contained in OBR-3.
31 / 37
9 COMUNICATION PROTOCOL
Communication protocol is based on HL7 v.2.5 in conformance with previous issues of same
standard.
Transport protocol of HL7 messages is TCP/IP. ELEKTRA exposes a TCP/IP server listener on a
configurable port of one or all IP addresses of hosting machine.
RIS system and network infrastructure must be configured in a way that allows connection to
previously mentioned server. TCP/IP must be closed after message is sent ( Keep-alive=false).
HL7 communication follows “Minimal Lower Layer Protocol” guidelines – Appendix C – “Lower Layer
Protocols”, section “Implementation Support Guide”, HL7 version 2.5.
32 / 37
APPENDIX A
ACK (ACKNOWLEDGE)
Applications that receive HL7 messages shall send acknowledgments using the HL7 Original Mode.
The segments of the ACK message listed below are required, and their detailed descriptions are
provided in the following tables, and corresponding notes. ERR segment shall be present if MSA-1
field is “AE” or “AR”.
MSA Segment
33 / 37
2 20 ST R Message Control Shall contain the Message
ID ID from the MSH-10
Message Control ID of the
incoming message .
6 100 CE O Error Condition < ID >^< TEXT >
See table HL70357
Table 60: ACK MSA segment
ERR Segment
34 / 37
APPENDIX B
HL7 / USER TABLES
35 / 37
VALUE DESCRIPTION COMMENT
SUCCESS
Success. Optional, as the AA conveys
0 Message accepted success. Used for systems that must
always return a status code.
ERRORS
The message segments were not in
Segment sequence
100 the proper order, or required
error
segments are missing.
A required field is missing from a
101 Required field missing
segment
The field contained data of the wrong
102 Data type error data type, e.g. an NM field contained
"FOO".
A field of data type ID or IS was
103 Table value not found compared against the corresponding
table, and no match was found.
REJECTION
Unsupported message
200 The Message Type is not supported.
type
201 Unsupported event code The Event Code is not supported.
Unsupported processing
202 The Processing ID is not supported.
id
203 Unsupported version id The Version ID is not supported.
The ID of the patient, order, etc., was
not found. Used for transactions
204 Unknown key identifier
other than additions, e.g. transfer of
a non-existent patient.
The ID of the patient, order, etc.,
already exists. Used in response to
205 Duplicate key identifier
addition transactions (Admit, New
Order, etc.).
36 / 37
HL7 user Table USR0002 marital status
1 nubile
2 celibe
3 coniugato/a
4 Vedovo/a
5 Separato/a
I Interno (Ricoverato)
O Esterno
E Pronto soccorso
P Post Ricovero
R Pre Ricovero
D Day Hospital
END OF DOCUMENT
37 / 37