HL7 Outbound Interface (RIS_PD160) v1.13
HL7 Outbound Interface (RIS_PD160)
This document intends to define the transport protocols, message mappings and definitions for integration of CRIS with another system via HL7.
Author:Healthcare Software Systems
Version:v1.13
Issue Date:9th December2013
Copyright 2013 Healthcare Software Systems. All Rights Reserved
These materials are or comprise restricted and proprietary confidential information of Healthcare Software Systems. Disclosure to or use by the recipient shall not convey any intellectual property rights in these materials. The right to use these materials by the recipient is subject to restrictions and limitations contained in the Provision of Integrated Care Record System and Associated Services Agreement and related agreements.
Confidentiality
All information in this document is provided in confidence for the sole purpose of adjudication of the document and shall not be used for any other purpose and shall not be published or disclosed wholly or in part to any other party without HSS’s prior permission in writing and shall be held in safe custody. These obligations shall not apply to information which is published or becomes known legitimately from some source other than HSS.
Many of the product, service and company names referred to in this document are trademarks or registered trademarks.
They are all hereby acknowledged.
Document Control
Title / HL7 Outbound Interface (RIS_PD160)Author / Steve Verdon / Date 29/01/2012
File Ref. / RIS_PD160 CRIS-HL7.doc
Approval Sign-off (For formal issue)
Owner / Role / Signature / Date / Issue
Steven Verdon / Integration Services Manager
Approver / Role / Signature / Date / Issue
Dr Julia Paul / Software Developer
Review Panel
Name / Role
Nick Woods / Integration Specialist
Change History
Issue / Date / Author / Editor / Details of Change
1.0 / 01/06/2006 / Alan Shields / First Draft, created from PACS interface specification.
1.1 / 23/10/2006 / Alan Shields / Added SIU^S12 message. Added examination end time to OBR segment.
1.2 / 21/04/2008 / Alan Shields / Updated radiologist, secretary and technician fields
1.3 / 21/12/2008 / Neil Twist / Added information on a flag
1.4 / 14/01/2010 / Neil Twist / Updated to 2.09.10 specification
1.5 / 05/03/2010 / Steven Verdon / Added OBR:16
1.6 / 09/09/2010 / Alan Shields / Added transmission of scanned documents/images
1.7 / 28/02/2011 / Julia Paul / IEP additions
1.8 / 29/01/2012 / Steven Verdon / Title version corrected
PV1 segment, added OMG^O19 (12)
Urgency field added to OBX (16)
Added NHS formatting to configuration questionnaire (20)
OBX:14 + 16 changed to state “LAST” d&t or person
Added scanned documents (IEP) to configuration questionnaire (20)
Added event diagnostic codes to configuration questionnaire (20)
Added “Copy To” query to configuration questionnaire (20)
Added OBX:28 – Send copies to
1.9 / 19/09/2012 / Steven Verdon / OBR:16 not used
Updated review panel
1.10 / 25/09/2012 / Steven Verdon / PV1, Patient Type description misleading
1.11 / 18/04/2013 / Steven Verdon / Document review
1.12 / 28/05/2013 / Steven Verdon / Re-worded OBR:34 description
1.13 / 09/12/2013 / Steven Verdon / Document review
1Introduction
1.1Purpose
1.2Audience
2Implementation Model
2.1Overview
2.2Application Data Flow
2.3HL7 version
3Message and Activity mapping
3.1Register a patient
3.2Update a patients Demographic details
3.3Merge two patients
3.4Create an appointment
3.5Patient Attends
3.6Appointment/Examination Cancelled
3.7Appointment/Examination Changed
3.8Examination performed
3.9Report entered
3.10Report verified
3.11Report amended
3.12Pre Admit a Patient
4Message Transport
4.1Connections
4.2Transport level Acknowledgements
4.3Framing Characters
5Error handling
6Data Mappings
6.1Patient Identifiers
6.2Time Stamp values
6.3Messages
6.4ADT^A04 Patient registration
6.5ADT^A08 Patient demographic update
6.6ADT^A05 Pre Admit, SIU^S12 Scheduling
6.7ADT^A40 Patient Merge
6.8OMG^O19 Order Message
6.9ORU^R01 Clinical Report
6.10Order control and status summary
7MSH
8EVN
9PID
10MRG
11PD1
12PV1
13SCH
14ORC
15OBR
16OBX
17NTE
18ZDS
19Sample Messages
20Configuration Questionnaire
21Quick Reference
21.1Patient
21.2Referral
21.3Performing
21.4Reporting
21.5Pre fetching
1Introduction
1.1Purpose
This document intends to define the transport protocols, message mappings and definitions for integration of CRIS with another system via HL7.
This version of the specification applies to CRIS interface release 2.09.10k.
1.2Audience
This document is intended for system integrators, third party suppliers and potential customers. The reader is assumed to be familiar with the HL7 standard.
2Implementation Model
2.1Overview
CRIS sends HL7 messages in response to significant activity occurring on the CRIS database. Events such as patient registrations, updates, examination bookings, status changes and results may all generate messages which a connected system may use to maintain its patients database, manage work lists and store results. To reduce network traffic unnecessary messages may be suppressed, for instance a results feed system may only require the verified result messages, whereas a PACS or another RIS would likely require all messages.
This document does not describe messaging activity for use with an Order communications system.
2.2Application Data Flow
Messages flow from CRIS to the remote system as a result of user activity on CRIS. All messages are transmitted over TCP/IP using HL7 MLLP.
2.3HL7 version
All messages referenced in this document conform to the 2.4 version of the HL7 standard. Message transport is HL7 MLLP over TCP/IP.
3Message and Activity mapping
3.1Register a patient
When a patient is registered on CRIS an ADT^A04 message is sent to the connected system.
3.2Update a patients Demographic details
When a patients demographic details are changed on CRIS an ADT^A08 message is sent to the connected system.
3.3Merge two patients
When two patient records are found to refer to the same patient the two records are merged and an ADT^A40 message is sent to the connected system.
3.4Create an appointment
When a user on CRIS makes an appointment CRIS will send an OMG^O19 message with order control set to “NW” and a status value of “SC” (scheduled)
3.5Patient Attends
When a patient attends for their examination they will be booked in to the CRIS reception module, at this point CRIS will send an OMG^O19 message. For attendances that had an appointment booked order control will be set to “SC” (status changed), otherwise order control will be “NW” (new). Order status will be “IP” (in process).
3.6Appointment/Examination Cancelled
A user on CRIS may decide to cancel an appointment or an examination. At which point CRIS will send and OMG^O19 message with order control set to “CA” and a status of “CA”
3.7Appointment/Examination Changed
The radiology dept may decide to change the type of procedure being performed. At this point CRIS will send an OMG^O19 message with order control set to “XO” with the revised details.
If the connected system is unable to accept changes to orders working practice will need to be changed, and the previous exam cancelled and a new one entered.
3.8Examination performed
When the procedure has been performed the radiographer enters the screening and projection data on CRIS. At this point CRIS will send an OMG^O19 message with order control set to “SC” and a status of “CM” (complete).
3.9Report entered
When the clinical report is entered on CRIS an ORU^R01 message containing the preliminary report is sent with a result status of “P” (preliminary).
3.10Report verified
Once the Radiologist is satisfied with the clinical report it will be verified. At this point CRIS will send an ORU^R01 containing the report with a result status of “F” (final)
3.11Report amended
If for some reason the radiologist later needs to change a previously verified report and addendum will be added. If CRIS is configured to send unverified results then an ORU_R01 containing the report with a result status of “C” (changed) will be transmitted. When the report is subsequently re verified an ORU_R01 will be sent, again with a result status of “C”.
3.12Pre Admit a Patient
When a pre admit message is received from PAS CRIS can be configured to send either an ADT^A05 message or an SIU^S12 message. CRIS may also be configured to buffer these messages until a specified number of days prior to the patient attendance date.
4Message Transport
All Messages are transmitted over TCP/IP using MLLP.
4.1Connections
One socket connection is used for messages originating from CRIS. The port numbers to be used will be decided by mutual agreement. CRIS will initiate the connection (acting as client).
4.2Transport level Acknowledgements
Each message will be acknowledged by the receiving system prior to delivery of the next message. Messages that are NAK’d will by logged by CRIS and should also be logged by the receiving system.
4.3Framing Characters
Standard HL7 MLLP framing characters will be used, these are
<0B> start of message
<1C> end of message
In addition MLLP requires that each message be followed by the segment delimiter which is carriage return <0D>
5Error handling
CRIS logs errors that are encountered when generating and processing messages as well as any error messages in the MSA segments received in response to outbound messages. It is expected that the connected system will also maintain its own logs.
6Data Mappings
6.1Patient Identifiers
All known patient identifiers will be passed in PID:3. Components 1, 4 & 5 are populated, other components are left blank. The primary key to be used is determined at configuration time. The order of identifiers sent is configurable so that the remote systems preferred primary key can be sent first if necessary.
Sequence / Name / Usage1 / ID Number / Patient Identifier
4 / Assigning Authority / NameSpace ID contains:
“NHS” for nhs number
“CHI” for chi number
“CRIS” for CRIS number
Otherwise the code identifying a hospital for hospital numbers.
5 / Identifier Type Code / “NH” for nhs number/ chi number
“MR” for hospital numbers
“PI” for CRIS number
Note that on CRIS the only patient identifier that is guaranteed to be present at all times is the CRIS number. If another identifier (such as a hospital number for a particular hospital) is selected to be used as primary key CRIS will send a dummy value for that identifier if it is not present, when the required identifier is subsequently provided CRIS will send a merge message with the dummy value as the source patient id.
As an example suppose that hospital numbers for hospital RNZ04 have been selected as primary key, a patient attendance is entered on CRIS but no hospital number yet exists, however an NHS number and CRIS number are both available. In this case the PID:3 segment will be populated as so:
3289329^^^CRIS^PI~8772332778^^^NHS^NH~CRIS3289329^^^RNZ04^MR
As you can see the hospital number for RNZ04 was not available so CRIS generated a temporary dummy hospital number by inserting the string “CRIS” at the beginning of the CRIS number.
Some time later a hospital number of A786345 is allocated to the patient, CRIS will then generate a merge (ADT^A40) message with PID:3 populated as:
3289329^^^CRIS^PI~8772332778^^^NHS^NH~A786345^^^RNZ04^MR
and a merge segment as follows:
MRG|CRIS3289329^^^RNZ04^MR
6.2Time Stamp values
CRIS will always populate time stamps with as much data as is available, in some cases this will include year, month, day , hours, minutes, seconds, milliseconds and time zone offset, in other cases hours, minutes seconds milliseconds and time zone may not be available. The connected system should follow the standard HL7 guidelines for processing of time stamps.
6.3Messages
CRIS sends six messages, ADT^A04, ADT^A08, ADT^A05 or SIU^S12, ADT^A40, OMG^O19 and ORU^R01.
6.4ADT^A04 Patient registration
This message is sent when a patient is first registered on CRIS.
6.5ADT^A08 Patient demographic update
This message is sent when a patients demographic details are changed on CRIS.
6.6ADT^A05 Pre Admit, SIU^S12 Scheduling
If CRIS receives ADT^A05 or SIU^S12/S13 messages from PAS these messages are in turn passed through this outbound interface either as ADT^A05 or as SIU^S12 messages.
6.7ADT^A40 Patient Merge
Merge messages in sent either when two patients details are merged on CRIS, or when the connected systems preferred primary key changes for a patient.
6.8OMG^O19 Order Message
The order message is used to pass status information, new examinations booked on CRIS and cancellations. The meaning of an order message is specified in ORC:1 - Order Control.
Code / Message TypeNW / New order booked
CA / Cancellation of an existing order
XO / Change order request
SC / Status Changed
6.9ORU^R01 Clinical Report
The ORU^R01 message is used to transmit clinical reports to OCMS. ORC:1 will always contain “SC” for status change with a status value , ORC:5, of “CM” for complete.
On CRIS multiple examinations/orders may be performed in the same attendance, the clinical report entry screen allows the user to create a clinical report comprised of multiple sections, one section for the attendance summary plus one section for each examination.
For Example, two examinations are ordered, a Left Foot and a Right Arm. The radiology department decides to perform the two examinations on the one attendance the following three section report is entered.
Summary
This person can neither walk nor write.
Left Foot
Left foot appears to be missing
Right Arm
The right arm is mostly complete; however the patient is missing four fingers and a thumb.
CRIS has several configuration options available that affect the generation of clinical report messages and OBX segments, these are configured by HSS and should be chosen according to the capabilities and requirements of the receiving system.
Setting / DescriptionUnique By Event / Normally, a report message is generated for each exam, with this setting enabled one report message is generated for the event, so PACS would in the above example receive 1 message instead of two.
Send Report For All Exams / This setting is normally enabled and causes CRIS to send the entire report text for the attendance in each message, so for the above example each message would contain
This person can neither walk or write.
Left foot appears to be missing
The right arm is mostly complete, however the patient is missing four fingers and a thumb.
If this setting is disabled the message for the Left Foot exam would contain
This person can neither walk or write.
Left foot appears to be missing
And the message for the right arm would contain
This person can neither walk or write.
The right arm is mostly complete, however the patient is missing four fingers and a thumb.
Note that summary text is sent in each report message regardless.
This setting should not disabled if Unique By Event is enabled as report content would be missed.
Send Examination Names In Report / Normally only the text entered by the user is sent in OBX:5, with this setting enabled the above example would generate a message with the following contents
[Summary Report]
This person can neither walk or write.
[Left Foot]
Left foot appears to be missing
[Right Arm]
The right arm is mostly complete, however the patient is missing four fingers and a thumb.
Individual Exams In Observation ID / This setting affects the population of the OBX:3 segment, by default OBX:3 is populated with the examination code of the exam that generated the report message, so will contain the same value as OBR:4.
With this setting enabled each OBX:3 will contain the examination code of the exam relating to the report text contained in OBX:5, so in the example above, the following OBX segments would be generated (note that only OBX:3 and OBX:5 are shown for clarity and examination codes are examples only)
OBX|||SUMMARY^Report Summary||This person can neither walk or write
OBX|||SUMMARY^Report Summary||
OBX|||FOOL^Left Foot||Left foot appears to be missing
OBX|||FOOL^Left Foot||
OBX|||ARMR^Right Arm||The right arm is mostly complete, however the patient is missing four fingers and a thumb.
OBX|||ARMR^Right Arm||
ReportMargin / Specifies a right margin for the report text. By default there is no margin and each OBX:5 will contain text up to the next carriage return. If PACS is unable to wrap long lines a suitable manner for display purposes a suitable value should be chosen for ReportMargin. With margin set to 60 the report text would be as follows
This person can neither walk or write.
Left foot appears to be missing
The right arm is mostly complete, however the patient is
missing four fingers and a thumb.
Note that an additional line break is inserted between the words “is” and “missing”.
Send Unverified Reports / Normally CRIS will only transmit report messages for verified reports. This setting allows unverified reports to also be sent.
6.10Order control and status summary
The following table lists the order control and status value combinations that will be produced by CRIS.
Message Type / Order Control / Status / MeaningOMG^O19 / NW / SC / New appointment booked
IP / New attendance - patient in dept
SC / SC / Status change, appointment booked
IP / Status change, patient in dept
CM / Status change, examination performed
CA / CA / Order cancelled
XO / SC / Order changed, appointment booked
IP / Order changed, patient in dept
ORU^R01 / SC / CM / Clinical report
7MSH
MSH appears on all messages
Position / Name / Notes1 / Field Separator / Always Populated with “|”
2 / Encoding Characters / Always Populated with “^~\&”
3 / Sending Application / Defaults to “CRIS” may be configured to send any fixed value.
4 / Sending Facility / Defaults to “LIVE” may be configured to send any fixed value.
5 / Receiving Application / Default is empty, may be configured to send any fixed value.
6 / Receiving Facility / Default is empty, may be configured to send any fixed value.
7 / Date Time of Message / Populated with the date and time that the message was generated, century, year, month, day, hour, minute, second, millisecond and time zone offset are all present.
9 / Message Type / The type of the message. CRIS sends the messages
OMG^O19
ORG^O20
ORU^R01
10 / Message Control ID / Populated with a unique id for the message
11 / Processing ID / Set to “P”
12 / Version ID / Set to “2.4”
8EVN
EVN appears on ADT messages
Position / Name / Notes1 / Event Type Code / Contains the event type code (ADT)
2 / Recorded Date & Time / Contains the date the that the event occurred on CRIS
5 / Operator ID / The ID of the user on CRIS that performed the event that resulted in the transmission of this message
9PID
PID appears on all messages
Position / Name / Notes3 / Patient ID Internal / Will contain a list of the patient identifiers known by CRIS, refer to the notes on patient identifiers.
5 / Patient Name / <Family Name> is populated with surname from CRIS.
Forenames on CRIS is split at the first space character, the substring prior to the space is placed in <Given Name>, the substring after the space is placed in <Middle Initial Or Name>, patients title is placed in <prefix>
7 / Date Time Of Birth / Patients date of birth, only century, year, month and day are populated
8 / Patient Sex / This field may require translation, values on CRIS are
F Female
M Male
I Indeterminate
U Unknown
11 / Address / CRIS has four lines of address.
The first line is placed in <street address>
The second line is placed in <other designation>
The third line is placed in <city>
The Fourth line is placed in <province>
The two components of post code are combined and placed in <zip or postal code>
13 / Phone number home / Patients home telephone number, email address and mobile number.
Home Telephone number is the first sub field,
Email address is the 4th subfield
Mobile telephone number is placed in the next repeating instance
Eg
|0115874245^^^~07785342542|
14 / Phone number business / Patients work telephone number
22 / Ethnic Group / This field may require translation
29 / Patient Death Date and Time / For Deceased patients this will contain the date of death, century, year, month and day are present. Otherwise this field will contain null (“”)
30 / Patient Death Indicator / For deceased patients this field will contain “Y” otherwise it will be “N”
10MRG