orpheus hl7 specification documentorpheus-medical.com/wp-content/uploads/2020/03/psw-81... ·...

Orpheus

HL7 Specification Document

PSW-81-003

Rev.: 03 Pg. 1 of 36

Written or Updated by:

Name Title Date Signature

Tomer Ben-Sira VP Product Management 21-Oct-2017

Reviewed by:


Tomer Ben-Sira VP Product Management 21-Oct-2017

Approved by:


Tomer Ben-Sira VP Product Management 13-Mar-2019

Document Change History

Revision

Number Date

Responsible

Person Description of Change

01 01-Oct-2015 Assaf Gur First issue.

02 15-Aug-2017 Tomer Ben-Sira Update to include more supported messages and samples

03 13-Mar-2019 Tomer Ben-Sira Added support of MDM messages with link to files and embedded images/PDF.

Orpheus


PSW-81-003

Rev.: 03 Pg. 2 of 36

Contents

1. Introduction ................................................................................................................................. 4

1.1. Purpose and Audience .......................................................................................................... 4

1.2. Liability ................................................................................................................................ 4

1.3. Acronyms and Abbreviations ............................................................................................... 4

2. Inbound Messages ....................................................................................................................... 6

2.1. Acknowledge (ACK)............................................................................................................ 6

Example of ACK ......................................................................................................................... 6

2.2. HL7 ADT Messages to Orpheus ............................................................................................. 7

2.2.1. MSH Segment Mapping ................................................................................................ 7

2.2.2. PID Segment Mappings ................................................................................................ 7

2.2.3. PV1 Segments Mappings .............................................................................................. 8

2.2.4. Examples ....................................................................................................................... 9

2.3. HL7 ORM Messages to Orpheus .......................................................................................... 10

2.3.1. MSH Segment Mapping .............................................................................................. 10

2.3.2. PID Segment Mapping ................................................................................................ 11

2.3.3. PV1 Segments Mappings ............................................................................................ 12

2.3.4. ORC Segments Mappings ........................................................................................... 13

2.3.5. OBR Segments Mappings ........................................................................................... 14

2.3.6. Example ...................................................................................................................... 15

2.4. HL7 SIU Messages to Orpheus ............................................................................................. 15


2.4.2. SCH Segment Mapping ............................................................................................... 16


2.4.4. PV1 Segments Mappings ............................................................................................ 17

2.4.5. AIS Segment Mappings .............................................................................................. 19

2.4.6. AIP Segment Mappings .............................................................................................. 19

2.4.7. Examples ..................................................................................................................... 20

3. Outbound Messages ................................................................................................................... 22

3.1. HL7 ORU-R01 Message from Orpheus ................................................................................ 22



3.1.3. PV1 Segment Mapping ............................................................................................... 23

Orpheus


PSW-81-003

Rev.: 03 Pg. 3 of 36

3.1.4. OBR Segment Mapping .............................................................................................. 23

3.1.5. OBX Segment Mapping .............................................................................................. 24

3.1.6. Example ...................................................................................................................... 25

3.2. HL7 MDM T02 Message Image Availability from Orpheus ................................................... 25




3.2.4. TXA Segment Mapping .............................................................................................. 28


3.2.6. Example 1 – Video/Image file data ............................................................................. 29

3.3. HL7 MDM T02 Message with Embedded File from Orpheus ................................................. 30




3.3.4. TXA Segment Mapping .............................................................................................. 32


3.3.6. Example 1 - PDF ......................................................................................................... 33

3.3.7. Example 2 - Image ...................................................................................................... 34

4. Queries ....................................................................................................................................... 36

Orpheus


PSW-81-003

Rev.: 03 Pg. 4 of 36

1. Introduction

1.1. Purpose and Audience

This document is the HL7 Specifications for the HL7 Services of Orpheus System.

The user of this document is involved with system integration and/or software design.

It is assumed that the reader is familiar with the terminology and concepts that are used in the HL7 standard and the IHE Technical Framework.

Readers not familiar with HL7 terminology should first read the appropriate parts of the HL7 standard itself, prior to reading this conformance statement.

Although the use of this conformance statement in conjunction with the HL7 standard is intended to facilitate communication with Orpheus System, it is not sufficient to guarantee, by itself, the inter-operation of the connection between Orpheus System and the 3rd party HL7-based system.

The integration of any device into a system of interconnected devices goes beyond the scope of the HL7 standard and this conformance statement when interoperability is desired.

The responsibility for analyzing the applications requirements and developing a solution that integrates the Orpheus System with other vendors’ systems is the user’s responsibility and should not be underestimated.

1.2. Liability

Orpheus Medical is not be liable for errors contained herein or for incidental or consequential damages in connection with the furnishing, performance or use of this publication. This publication may only be used in connection with the promotion, sales, installation and use of Orpheus Medical equipment by Orpheus Medical personnel.

1.3. Acronyms and Abbreviations

Acronym Explanation

ADT An HL7 message group for admission, registration and transfer information at the patient and visit levels.

AIP Scheduled message segment

AIS Scheduled message segment

HL7 Health Level 7

IHE Integrating the Healthcare Enterprise

MSH Message Header segment

MVD The Orpheus System

OBR Observation Request segment

ORC Common Order segment

ORM An HL7 message type for scheduled orders

ORU An HL7 message type for order results

Orpheus


PSW-81-003

Rev.: 03 Pg. 5 of 36

Acronym Explanation

PID Patient ID segment

PV1 Patient Visit segment

SIU An HL7 message group for scheduling messages, cancellations, rescheduling and updates.

Orpheus


PSW-81-003

Rev.: 03 Pg. 6 of 36

2. Inbound Messages

The Orpheus System supports the following Inbound HL7 Messages:

No. HL7 Message Meaning Workflow Description

ADT A01 Admin/Visit notification A new patient visit is created

ADT A02 Transfer a patient Update of patient visit details

ADT A03 Discharge/end visit Update of patient visit

ADT A04 Patient registration A new patient visit is created

ADT A05 Pre-admit a patient A new patient visit is created

ADT A08 Update patient information Update of patient visit details

ADT A11 Cancel patient admission Update of patient visit status

ADT A12 Cancel patient transfer Update of patient visit status

ADT A13 Cancel patient discharge Update of patient visit status

ORM O01 Order Message A new scheduled procedure is

created in Orpheus

SIU S12 Notification of new appointment booking A new scheduled procedure is

created in Orpheus

SIU S13 Notification of appointment rescheduling The scheduled procedure’s

appointment date/time is

updated in Orpheus

SIU S14 Notification of appointment modification The details of a scheduled

procedure

SIU S15 Notification of appointment cancellation The scheduled procedure is

cancelled

ORM R01 Order Message

2.1. Acknowledge (ACK)

The Orpheus System provides and ACK (General Acknowledgement) message upon receipt of the HL7 message sent from the Sending System.

The ACK message is a Receive ACK

Example of ACK

The following is an example of an ACL message sent by the Orpheus System.

MSH|^~\&|Orpheus|Orpheus|CENTRIQ|HEALTHLAND|20170829154536||ACK^A08|08291715453620366576|P|2.3MSA|AA|08291715453620366576

Orpheus


PSW-81-003

Rev.: 03 Pg. 7 of 36

2.2. HL7 ADT Messages to Orpheus

The following sections describe the required segments and fields and the default mapping of data from an HL7 message to the Orpheus System data fields.

2.2.1. MSH Segment Mapping

Status: Mandatory segment to include in the message being sent to the Orpheus System.

Seq. HL7 Field Name Use (R – required; O

– optional)

Orpheus Mapping Comments

1 Field Separator R

2 Encoding Characters R

3 Sending Application O

4 Sending Facility O

5 Receiving Application O Could be “Orpheus”

6 Receiving Facility O Could be “Orpheus”

7 Date/time of Message R

8 Security O

9 Message Type R

10 Message Control ID R

11 Processing ID R

12 Version ID R

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

2.2.2. PID Segment Mappings



– optional)


1 Set ID – Patient ID O

2 Patient ID R

3 Patient ID List R Patient ID The patient’s unique

identifier

Orpheus


PSW-81-003

Rev.: 03 Pg. 8 of 36


– optional)


4 Alternate Patient ID O Patient Alternate ID

5 Patient Name R Patient Name

6 Mother’s Maiden

Name O

7 Date/Time of Birth O Patient DOB

8 Administrative Sex O Patient Gender

9 Patient Alias O

10 Race O

11 Patient Address O Patient Address

12 County Code O

13 Phone Number –

Home O Patient Phone

Number

14 Phone Number –

Business O

15 Primary Language O

16 Marital Status O Patient Marital Status

17 Religion O

18 Patient Account Number

O Visit Number

19 SSN Number –

Patient O

20 Mother’s Identifier O

21 Ethnic Group O

22 Birth Place O

23 Multiple Birth Indicator O

24 Birth Order O

25 Citizenship O

26 Veterans Military Status

O

27 Nationality O

28 Patient Death Date and Time

O

29 Patient Death Indicator

O

30 Identify Unknown Indicator

O

31 Identity Reliability Code

O

32 Last Update Date/Time

O

2.2.3. PV1 Segments Mappings


Orpheus


PSW-81-003

Rev.: 03 Pg. 9 of 36


– optional)


1 Set ID - Patient Visit O

2 Patient Class R

3 Assigned Patient Location

O Department Use department codes

to map into the

reciprocal

departments on the

Orpheus System

4 Admission Type O Admission Type

5 Pre-admit Number O

6 Prior Patient Location O

7 Attending Doctor O Attending Doctor Use physician codes

to map into the

reciprocal physician

name to be displayed

on the Orpheus

System

8 Referring Doctor O Use physician codes

to map into the



on the Orpheus

System

9 Consulting Doctor O

17 Admitting Doctor O Use physician codes

to map into the



on the Orpheus

System

18 Patient Type O

19 Visit Number R Visit Number Used by the Orpheus

System to

differentiate between

visits and is required

to properly build the

worklist

44 Admit Date/Time R Admission Date/Time

45 Discharge Date/Time O

2.2.4. Examples

The following are some examples of ADT messages sent to the Orpheus System.

ADT_A01

MSH|^~\&|CENTRIQ|HEALTHLAND|Orpheus|Orpheus|20170830211238||ADTÂ01|08301721123887083484|P|2.3||||||||

PID|1||77010||NEBARIS^TOMMY^L||19491223|M||2106-3|39 TOTANA 39^ÂltneulandÎL^6090839||^^^^001^^5555555555^|^^^^^^^|Ênglish|M|OTHER|770100027|25353772|||E2||||||||N|||||

PV1|1|30|OTÔPÔP^COUNTY MEM HOSPÂ|3|||1720053762^LANDIS^ROLAND^|^^^|^^^|CL

Orpheus


PSW-81-003

Rev.: 03 Pg. 10 of 36

||||1|||1720053762^LANDIS^ROLAND^|062|152||||||||||||||||||||COUNTY MEM HOSP|||||20170831155000|||||||||

ADT_A04



PV1|1|30|OTÔPÔP^COUNTY MEM HOSPÂ|3|||1720053762^LANDIS^ROLAND^|^^^|^^^|CL ||||1|||1720053762^LANDIS^ROLAND^|062|152||||||||||||||||||||COUNTY MEM HOSP|||||20170831155000|||||||||

ADT_A05




ADT_A08

MSH|^~\&|CENTRIQ|HEALTHLAND|Orpheus|Orpheus|20170830185746||ADTÂ08| 08301717422190066478|P|2.3||||||||



2.3. HL7 ORM Messages to Orpheus

The following sections describe the required fields and the default mapping of data from an HL7 message to the Orpheus System data fields.


Status: Mandatory


– optional)


1 Field Separator R

2 Encoding Characters R

3 Sending Application O


5 Receiving Application O

6 Receiving Facility O

7 Date/time of Message R

Orpheus


PSW-81-003

Rev.: 03 Pg. 11 of 36


– optional)


8 Security O

9 Message Type R

10 Message Control ID R

11 Processing ID R

12 Version ID R

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

2.3.2. PID Segment Mapping

Status: Mandatory


– optional)



2 Patient ID R


identifier



6 Mother’s Maiden

Name O



9 Patient Alias O

10 Race O


12 County Code O

13 Phone Number –


Number

14 Phone Number –

Business O



17 Religion O

18 Patient Account O Visit Number

Orpheus


PSW-81-003

Rev.: 03 Pg. 12 of 36


– optional)


Number

19 SSN Number –

Patient O


21 Ethnic Group O

22 Birth Place O


24 Birth Order O

25 Citizenship O


O

27 Nationality O


O


O


O


O


O




– optional)



2 Patient Class R



to map into the

reciprocal

departments on the

Orpheus System





to map into the



on the Orpheus

System


to map into the



Orpheus


PSW-81-003

Rev.: 03 Pg. 13 of 36


– optional)


on the Orpheus

System



to map into the



on the Orpheus

System

18 Patient Type O


System to




worklist



2.3.4. ORC Segments Mappings



– optional)


1 Order Control R

2 Placer Order ID R Unique identifier of

the message to be

used for responses

3 Filler Order ID R Accession Number

4 Placer Group ID O

5 Order Status R

9 Date/Time of Transaction

R The scheduled

procedure date/time

17 Entering Organization O Mapped to the

Department

18 Entering Device O Mapped to the

Orpheus CAST

station to be used in

the procedure

Physician Mappings

A physician mapping ideally will always have a name and an ID. This will correctly populate the mvd_person and mvd_person_id tables. New entries in each table are only created for new unique name and ID pairs.

If only a name is present, a new person table entry is always created and no entry is made in the mvd_person_id table. So for each ^Doe^John which shows up as a physician, you will get one new table entry.

If only an ID is present, the name is assumed to be blank. New entries are created for each unique ID. Each person_id has a reference to its own entry in the person table (which has a blank name).

Orpheus


PSW-81-003

Rev.: 03 Pg. 14 of 36

This logic applies to all physician mappings in the PV1, ORC, and OBR segments.

2.3.5. OBR Segments Mappings



– optional)


1 Set ID R 1

2 Placer Order ID R Unique identifier of

the message to be

used for responses

3 Filler Order ID O Accession Number Unique identifier of

the procedure for the

worklist. Used also in

the ORU message.

4 Universal Service ID O Description of the

procedure type.

Codes of procedure

types can be mapped

to meaningful text

during

implementation.

4.1 ID O Unique identifier of

the procedure to be

used to build the

worklist for the

Orpheus CAST

devices and

applications

4.3 Text O Procedure

Description

The text description

of the procedure

5 Priority O

6 Requested Date/Time R

7 Observation Date/Time

R Scheduled date time

16 Ordering Provider O Attending Physician Mapping can be done

according to

configuration and

associate codes to

physicians

32 Principal Result Interpreter

O Attending Physician Per configuration can

be mapped to the

attending physician.

36 Scheduled Date/Time O

Physician Mappings


If only a name is present, a new person table entry is always created and no entry is made in the mvd_person_id table. So for each ^Doe^John which shows up as a physician, you will get one new

Orpheus


PSW-81-003

Rev.: 03 Pg. 15 of 36

table entry.


This logic applies to all physician mappings in the PV1, ORC, and OBR segments.

2.3.6. Example

The following is an example of an ORM message that will be processed by the Orpheus System.

MSH|^~\&|iMedOne^BTS|Ein1^260511462|Orpheus|*|20170511142417||ORMÔ01|770002|P|2.4|||AL|NE

PID|1||1409613^^Êin1^PI||EDVTP_2017_HSÔrpheus-Test^^^^^LÂ~^^^^^^BÂ||20001212|M|||^^^^^DEU^H~^^^^^DEUÔ||^PRN^PH^~^PRN^FX^~^PRN^CP^~^NET^X.400^|^WPN^PH|Deu|A|ABC|||||||N|||||

PV1|1|I|00000004^^ÛC^^N|A||^^^^^N|||||UC|J|||||||4000224530^^Êin1^VN|||||K||||||||||||||||||||20170731000000|

ORC|XO|2256154|||||^^^||||||00000004^^ÛC||||||||||||OP_AXRayModÛnfallChirOP

OBR|1|2256154||UC-T_002Ârthroskopie Schulter^^10013977^10013977|||||||||||^^^^|||||||20170511142402|||S||1^^^|||||||||20170731080000|||||||

2.4. HL7 SIU Messages to Orpheus

The following sections describe the required fields and the default mapping of data from an HL7 message to the Orpheus System data fields.

The following SIU message types are supported:

SIU S12

SIU S13

SIU S14

SIU S15


Status: Mandatory


– optional)


1 Field Separator R |

2 Encoding Characters R ^~\&

3 Sending Application R The name of the application sending the HL7 message


5 Receiving Application O


7 Date /Time of Message

R Date and time of the message

9 Message Type R SIU^S12, SIU^S13, SIU^S14, SIU^S15

10 Message Control ID O Unique ID of the message

11 Processing ID R

Orpheus


PSW-81-003

Rev.: 03 Pg. 16 of 36


– optional)


12 Version ID R

2.4.2. SCH Segment Mapping

Status: Mandatory


– optional)


1 Placer Appointment ID O

2 Filler Appointment ID R Filler Appointment ID

6 Event Reason O Per configuration


Status: Mandatory


– optional)



2 Patient ID R


identifier



6 Mother’s Maiden

Name O



9 Patient Alias O

10 Race O


12 County Code O

13 Phone Number –


Number

14 Phone Number –

Business O



17 Religion O


O Visit Number

19 SSN Number –

Patient O


21 Ethnic Group O

22 Birth Place O


24 Birth Order O

25 Citizenship O

Orpheus


PSW-81-003

Rev.: 03 Pg. 17 of 36


– optional)



O

27 Nationality O


O


O


O


O


O




– optional)



2 Patient Class R



to map into the

reciprocal

departments on the

Orpheus System





to map into the



on the Orpheus

System


to map into the



on the Orpheus

System



to map into the



on the Orpheus

System

18 Patient Type O


System to


Orpheus


PSW-81-003

Rev.: 03 Pg. 18 of 36


– optional)




worklist



Orpheus


PSW-81-003

Rev.: 03 Pg. 19 of 36

Physician Mappings


If only a name is present, a new person table entry is always created and no entry is made in the mvd_person_id table. So for each ^Doe^John which shows up as a physician, you will get one new table entry.


This logic applies to all physician mappings in the PV1, ORC, OBR and AIP segments.

2.4.5. AIS Segment Mappings



– optional)


1 Set ID O

2 Segment Action

Code

O

3 Universal Service

Identifier

3.1 Identifier R Used to uniquely

identify the scheduled

procedure.

3.2 Text O

3.3 Name of Coding

System

O

3.4 Alternate

Identifier

O

3.5 Alternate Text O Procedure

Description

Map the text codes to

meaningful

description or use as

is

4 Start Date/Time O Admission Date and

Time

2.4.6. AIP Segment Mappings



– optional)


1 Set ID O

2 Segment Action

Code

O

Orpheus


PSW-81-003

Rev.: 03 Pg. 20 of 36


– optional)


3 Personnel Resource

ID

O Attending Physician Use the code or entire

text to map to the

Attending Physician

field.

3.1 ID Number O Attending Physician Use the code or entire

text to map to the

Attending Physician

field.

2.4.7. Examples

The following is an example of an SIU message sent from a scheduling system to Orpheus.

SIU 12

MSH|^~\&|PCS|SCM|ADT_OUT||20170821125243||SIU^S12|9001259272503310|D|2.3

SCH||508285||||NP LEG INJ|NP LEG INJ|ORT NEW PATIENT 20|20|||||||Dean, Eddie|||Hospital|Dean, Eddie||Hospital|||Booked

PID|||5555555^^^MRN||LASTNAME^FIRSTNAME||20020905|M||||||||||40535785^^^Visit|UNKNOWN

PV1||D|7145^^^PCH|Elective|||||||||||||||40535785^^^Visit|||||||||||||||||||||||||20170822111000

AIS|||1048ÔRTNP20^^ÔRT NEW PATIENT 20|20170822111000|||20

AIP|||PHYSICIANID, PHYSICIANLASTNAME, PHYSICIANFIRSTNAME|Physician||20170822111000|||20

SIU 13


SCH||502671~481839||||ESServices|EXAM/LABS|HEM FOLLOW UP 30|30|||4444^John^Vockler~1902896590^^^^^^^^^^^^NPI||||Murcia, Levante||| Hospital| Murcia, Levante|| Hospital|||Booked

PID|||5555555^^^MRN||LASTNAME^FIRSTNAME||20170127|M||||||||||40509080^^^Visit|UNKNOWN

PV1||D|7551^^^PCH|Elective|||||||||||||||40509080^^^Visit|||||||||||||||||||||||||20170817100000

AIS|||665^HEMFU30^^^HEM FOLLOW UP 30|20170817100000|||30

SIU 14


SCH||503508||||PT EVAL (IP-OP)|PT EVAL (IP-OP)|RHB PT EVAL 60|60|||555555^Tommy^VokklreÂ~MJ0714685^^^^^^^^^^^^DEA~1134105950^^^^^^^^^^^^NPI||||Tommy, Roland|||Hospital|Tommy, Roland||Hospital|||Cancelled

PID|||5555555^^^MRN||LASTNAME^FIRSTNAME||20140507|M|||||||||||UNKNOWN

AIS|||427^RHBPTEV60^^^RHB PT EVAL 60|20170911160000|||60

AIP|||PHYSICIANID, PHYSICIANLASTNAME, PHYSICIANFIRSTNAME|Ancillary||20170911160000|||60|||OVERBOOKED

Orpheus


PSW-81-003

Rev.: 03 Pg. 21 of 36

SIU 15


SCH||462657||||RESC|ONG PT|RHB PT ONGOING TX 60|60|||5555^PlaceLast^PlacerFirst^M~AB9218517^^^^^^^^^^^^DEA~1700848868^^^^^^^^^^^^NPI||||Roland, Gilead|||Hospital|Roland, Gilead||Hospital|||Cancelled

PID|||5555555^^^MRN||LASTNAME^FIRSTNAME||20100623|M|||||||||||UNKNOWN

AIS|||432^RHBPTRX60^^^RHB PT ONGOING TX 60|20170901150000|||60

Orpheus


PSW-81-003

Rev.: 03 Pg. 22 of 36

3. Outbound Messages

The Orpheus System supports the following Outbound (from Orpheus) HL7 Messages:

No. HL7 Message Meaning Workflow Description

ORU-R01 Observation Result Triggered by an event such as

finalization of a report on Orpheus Physician Report to export a result message with the PDF embedded in the message.

3.1. HL7 ORU-R01 Message from Orpheus

The Orpheus ORU-R01 message has the following segments:

MSH

PID

PV1

OBR

OBX – in these segments Orpheus can include a PDF (encoded in Base-64), Image or URL links to the Orpheus Web application.


Status: Mandatory


– optional)




3 Sending Application R Orpheus

4 Sending Facility O Orpheus

5 Receiving Application O Configurable




9 Message Type R ORU^R01

10 Message Control ID R Unique ID of the message

11 Processing ID R T

12 Version ID R 2.3


Status: Mandatory


– optional)


1 Set ID O

2 Patient ID O

3 Patient ID R The patient medical record number

4 Alternate Patient ID O

Orpheus


PSW-81-003

Rev.: 03 Pg. 23 of 36


– optional)


5 Patient Name R The patient’s name

5.1 Family Name R Patient’s last name

5.2 Given Name R Patient’s first name

5.3 Middle Name O Patient’s middle name

5.4 Suffix O

5.5 Prefix O

7 Date of Birth O Patient’s date of birth

8 Sex O Patient’s sex

10 Race O Patient’s Rage

11 Patient Address O Patient’s address

12 County Code O

13 Phone Number –


Number

14 Phone Number –

Business O



17 Religion O


O Visit Number

19 SSN Number –

Patient O


21 Ethnic Group O

22 Birth Place O


24 Birth Order O

25 Citizenship O


O

27 Nationality O


O


O


O


O


O

3.1.3. PV1 Segment Mapping

Status: Optional


– optional)


1 Set ID O 1

3.1.4. OBR Segment Mapping

Orpheus


PSW-81-003

Rev.: 03 Pg. 24 of 36

Status: Mandatory


– optional)


1 Set ID R 1

3 Filler Order Number R Accession Number Or the unique identifier of the study

4 Universal Service Identifier

R

4.1 Identifier O Code defining the procedure

4.2 Text O The text describing the procedure

Usually received from the external system (e.g. DICOM worklist, ORM/SIU messages)

4.3 Name of Coding System

O Configurable

7 Observation Date/Time

R The date and time of the procedure

22 Results Rpt/Status Change Date/Time

O

22.1 The date and time of the procedure

25 Result Status P = Preliminary

F = Final

A = Addendum

3.1.5. OBX Segment Mapping

Status: Mandatory


– optional)


1 Set ID R 1

2 Value Type R RP RP = Report

3 Observation Identifier O

3.1 Identifier

3.2 Text Usually the name of the report template used to create the PDF

3.3 Name of Coding System

Orpheus

4 Observation Sub-ID O

5 Observation Value R

5.1 Pointer R Application

5.2 Application ID R PDF – when exporting

PDF file

5.3 Type of Data O Empty

5.4 Subtype R Base64

5.5 String containing the PDF in Base 64

11 Observation Result Status

R P = Preliminary

F = Final

A = Addendum

Orpheus


PSW-81-003

Rev.: 03 Pg. 25 of 36

3.1.6. Example

The following is an example of an ORU-R01 message sent from Orpheus to Epic with a PDF embedded in Base-64 encoding in the OBX segment.

NOTE: the PDF encoding has been concatenated due to the document limitations.

MSH|^~\&|ORPHEUS|ORPHEUS|EPIC||20170907052106||ORU^R01|20170907052106000093|T|2.3

PID|||00000138||Imaging^Cds^^^||19730205|F

PV1|1||||||||||||||||||

OBR|1||P6000132|XRGIIMG^GI LAB IMAGING^IMAGING|||20170907052104|||||||||||||||20170907052104|||F|||||||00001

OBX|1|RP|302^SFMC - GI - COLONOSCOPY WITH SEDATION^ORPHEUS|10| Application^pdf^^Base64^JVBERi0xLjQKJeLjz9MKMSAwIG9iaiA8PC9UeXBlL1hPYmplY3QvQml0c1BlckNvbXBvbmVudCA4L1N1YnR5cGUvSW1hZ2UvV2lkdGggMTUzL0NvbG9yU3BhY2UvRGV2aWNlUkdCL0ZpbHRlci9EQ1REZWNvZGUvTGVuZ3RoIDE0Mjk0L0hlaWdodCA5NT4+c3RyZWFtCv/Y/OJi9S8yYezTkTDI53KlynH6uoX7L3Jt8F21g5X5ophYrYPaHHwcfE3V7Bn+2wULceBbfVgyk0in42qVfoWP6xB0ylVSLbQtaq1ajGkPBQcUzJ2N2MbGsUkWrVBMOo9ClDuMImHqYREZpFFFBGsMKhIlFgALAD4CuV5OTkZk75WU7SZMjXZmJLEnxJOpqtJlLwO7PUDZTImy2he87rDNjyXbrdbpSLtMbPwz6NG5WJ5ZpStr2Onqy0bcawlJvTGQbScIIEKBe/3Dl9w0DyOz+QhznzuGzDE8jMxBBFtxuRdbhhfwK12HB/M7hsrh4uH7n4wZEMMaqCpUg7FChtr2KNYalX+eT/MVg9rx84oazZvefI9mmmLvAAzNC1ymnddWdlE3YBmycvryzOuAn9OpQH19OWpIDCbTZ0qk+ZhH98dZMGWMo==||||||F

3.2. HL7 MDM T02 Message Image Availability from Orpheus

The Orpheus MDM-T02 message Image Availability is used to provide information to an external application such as Epic. For example, Epic uses this information to invoke the Image Retrieval API.

The MDM-T02 message has the following segments:

MSH

PID

PV1

TXA

OBX


Status: Mandatory


– optional)










9 Message Type R MDM^T2

Orpheus


PSW-81-003

Rev.: 03 Pg. 26 of 36


– optional)



11 Processing ID R P

12 Version ID R 2.3.1


Status: Mandatory


– optional)


1 Set ID O

2 Patient ID O







5.4 Suffix O

5.5 Prefix O





12 County Code O

13 Phone Number –


Number

14 Phone Number –

Business O



17 Religion O


O Visit Number

19 SSN Number –

Patient O Patient ID


21 Ethnic Group O

22 Birth Place O


24 Birth Order O

25 Citizenship O


O

27 Nationality O


O

29 Patient Death O

Orpheus


PSW-81-003

Rev.: 03 Pg. 27 of 36


– optional)


Indicator


O


O


O


Status: Optional


– optional)


1 Set ID - Patient Visit R 1

2 Patient Class R As received in the

Order, SIU, ADT

message



to map into the

reciprocal

departments on the

Orpheus System





to map into the



on the Orpheus

System


to map into the



on the Orpheus

System



to map into the



on the Orpheus

System

18 Patient Type O


System to




worklist


Orpheus


PSW-81-003

Rev.: 03 Pg. 28 of 36


– optional)



3.2.4. TXA Segment Mapping

Status: Mandatory


– optional)


1 Set ID R 1

2 Document Type R Image, Data, Video Image – when an

image is sent

Data – when a PDF is

sent

3 Type of Referenced Data

O IM = Image Data

SI = Scanned image

4 Activity Date/Time R

5 Primary Activity Provider

5.1 Provider ID O Code defining the provider

5.2 Provider Name O First name and last name of the Attending Doctor

5.9 Provider Namespace ID

O Configurable

5.13 Provider Code/Name ID type code

O PROVID Configurable

6 Origination Date/Time R The date and time of the message

7 Transcription Date/Time

R The date and time of the message

9 Originator Code/Name O

12.3 Unique Document Number

R The unique filename of the document in the Orpheus System

15 Filler Order Number R The unique number of the document in the Orpheus System

17 Document Completion Status

R AU = Authenticated

19 Document Availability Status

R AV = Available


Status: Optional. Will be included when exporting an image or PDF file.

Repeatable segment of 76 bytes in length.


– optional)


1 Set ID R 1, 2, 3, etc. Increasing number according to the size of the file.

Orpheus


PSW-81-003

Rev.: 03 Pg. 29 of 36


– optional)


2 Value Type R RP = Reference Pointer

5 Observation Value R The unique filename of the document in the Orpheus System

3.2.6. Example 1 – Video/Image file data

The following is an example of an MDM-T02 message sent from Orpheus to Epic with information regarding the video/image TXA and OBX segments.

MSH|^~\&|ORPHEUS|ORPHEUS|EPIC|NCA|20190306124936||MDM^T02|20190306124936006844|P|2.3.1|

PID|||test trns2||test^trns2|||A|||||||||||test trns2||||||

PV1|1||||||||||||||||||

TXA|1|Video||20190226113050|1234^^^^^^^ÊPIC^^^^PROVID|20190306124936|20190306124936||2000ÎNPATIENT^PHYSICIAN^^^^^ÊPIC^^^^PROVID| ||^^30f976df-9a5a-4993-a2e6-fb4de1c85d52|||||AU||AV|

OBX|1|RP|||30f976df-9a5a-4993-a2e6-fb4de1c85d52|

Orpheus


PSW-81-003

Rev.: 03 Pg. 30 of 36

3.3. HL7 MDM T02 Message with Embedded File from Orpheus

The Orpheus MDM-T02 message with an embedded file (image, PDF) has the following segments:

MSH

PID

PV1

TXA

OBX – in these segments Orpheus can include a PDF or Image (encoded in Base-64)


Status: Mandatory


– optional)










9 Message Type R MDM^T2


11 Processing ID R P

12 Version ID R 2.3.1


Status: Mandatory


– optional)


1 Set ID O

2 Patient ID O







5.4 Suffix O

5.5 Prefix O




Orpheus


PSW-81-003

Rev.: 03 Pg. 31 of 36


– optional)



12 County Code O

13 Phone Number –


Number

14 Phone Number –

Business O



17 Religion O


O Visit Number

19 SSN Number –

Patient O Patient ID


21 Ethnic Group O

22 Birth Place O


24 Birth Order O

25 Citizenship O


O

27 Nationality O


O


O


O


O


O


Status: Optional


– optional)


1 Set ID - Patient Visit R 1

2 Patient Class R As received in the

Order, SIU, ADT

message



to map into the

reciprocal

departments on the

Orpheus System





Orpheus


PSW-81-003

Rev.: 03 Pg. 32 of 36


– optional)


to map into the



on the Orpheus

System


to map into the



on the Orpheus

System



to map into the



on the Orpheus

System

18 Patient Type O


System to




worklist



3.3.4. TXA Segment Mapping

Status: Mandatory


– optional)


1 Set ID R 1

2 Document Type R Image or Data Image – when an

image is sent

Data – when a PDF is

sent

3 Type of Referenced Data

O IM = Image Data

SI = Scanned image

4 Activity Date/Time R

5 Primary Activity Provider

5.1 Provider ID O Code defining the provider

5.2 Provider Name O First name and last name of the Attending Doctor

5.9 Provider Namespace ID

O Configurable

5.13 Provider Code/Name ID type

O PROVID Configurable

Orpheus


PSW-81-003

Rev.: 03 Pg. 33 of 36


– optional)


code

6 Origination Date/Time R The date and time of the message

7 Transcription Date/Time

R The date and time of the message

9 Originator Code/Name O Similar to segment 5

12.3 Unique Document Number

R The unique number of the document in the Orpheus System

15 Filler Order Number R The unique number of the document in the Orpheus System

16 Unique Document File Name

R The file name of the image/PDF as it is stored in the Orpheus System

Will contain the extension (i.e. jpg, pdf).

Relevant when sending an image.

17 Document Completion Status

R AU = Authenticated

19 Document Availability Status

R AV = Available


Status: Optional. Will be included when exporting an image or PDF file.

Repeatable segment of 76 bytes in length.


– optional)


1 Set ID R 1, 2, 3, etc. Increasing number according to the size of the file.

2 Value Type R ED = Encapsulated Data

5 Observation Value R

5.1 Pointer O

5.2 Application ID O

5.3 Type of Data O Empty

5.4 Subtype O

5.5 Observation Value R Base 64 String containing the PDF in Base 64

3.3.6. Example 1 - PDF

The following is an example of an MDM-T02 message sent from Orpheus to Epic with a PDF embedded in Base-64 encoding in the OBX segment.

NOTE: the PDF encoding has been concatenated due to the document limitations.


PID|1||123456||Sue^Fernandez-c||19840825|F|||||||||||123456||||||

PV1|1|Elective|Prostatectomy||||^^2||||||||||||3DC8CF9159584D86B330F4EAA7B08EE5

TXA|1|Data||20190227143250|1234^2^^^^^^^EPIC^^^^PROVID|20190310103832|20190310103832||1234^2^^

Orpheus


PSW-81-003

Rev.: 03 Pg. 34 of 36

^^^^ÊPIC^^^^PROVID|||^^3DC8CF9159584D86B330F4EAA7B08EE5|||3DC8CF9159584D86B330F4EAA7B08EE5|0854e236-0939-4736-82de-20ca2c0c3da4.pdf|AU||AV|

OBX|1|ED|||^^^^JVBERi0xLjQKJeLjz9MKMSAwIG9iago8PC9UeXBlL1hPYmplY3QvRGVjb2RlUGFybXM8PC9QcmVk| OBX|2|ED|||^^^âWN0b3IgMTUvQ29sdW1ucyA3NS9CaXRzUGVyQ29tcG9uZW50IDgvQ29sb3JzIDE+Pi9TdWJ0eXBl| OBX|3|ED|||^^^^L0ltYWdlL1dpZHRoIDc1L0NvbG9yU3BhY2VbL0luZGV4ZWRbL0NhbFJHQjw8L01hdHJpeFswLjQx| OBX|4|ED|||^^^^MjM3IDAuMjEyNjQgMC4wMTkzMyAwLjM1NzU5IDAuNzE1MTggMC4xMTkyIDAuMTgwNDcgMC4wNzIx| OBX|5|ED|||^^^ÔCAwLjk1MDQ5XS9XaGl0ZVBvaW50WzAuOTUwNDMgMSAxLjA5XS9HYW1tYVsyLjIgMi4yIDIuMl0+| OBX|6|ED|||^^^^Pl0gMjU1KP///yN4sv7+//z9/vv8/d/n7enx9xteixhTexdQdxVJbCN3sSJ1riJzqyFxpx9qnB5m| OBX|7|ED|||^^^^lx1jkxxgjxpZhRpYgxlWgBlUfhhSeRdPdRZLcBREZiFuoxtbhxpXgRlUfBhRdxdNchVHaSFsoCZ6| OBX|8|ED|||^^^^s1woe7QXR2cgXFyGLX61GkhoK3WoHEtsIld8NIK4KmOLMnOfPIe6OHysNm6UK1Z0S5C/SYKpWpnE| OBX|9|ED|||^^^^R3aWQGmFaaLJWIOgeq3PZ4ukcpexjLfWfZ+3ncLcjKe5rs3imbTGo73PvdbntsnWy97r0+Ls4+30| OBX|10|ED|||^^^^8Pb6F1B1IFxcgx5Pb9vp8snY4fX5+/n7/O/09v3+/okAAIUAAIIAAH4AAHkAAHMAAGwAAGUAAJEB| OBX|11|ED|||^^^ÂY0BAZUCApgEBJYEBIsEBJ8FBZsFBXYEBKIGBqYHB4QGBqhcYlxiqlx0XHStXG5cbq8LC7FcZlxm| OBX|12|ED|||^^^^s1xyXHK2Dg65Dw96XG5cbr0QEIxcZlxmaVx0XHTBEhKQXHJccsQTE5wPD3VcZlxmxxUVzBcXyRYW|

…

3.3.7. Example 2 - Image

The following is an example of an MDM-T02 message sent from Orpheus to Epic with an Image embedded in Base-64 encoding in the OBX segment.

NOTE: the Image encoding has been concatenated due to the document limitations.


PID|1||123456||Sue^Fernandez-c||19840825|F|||||||||||123456||||||

PV1|1|Elective|Prostatectomy||||^^2||||||||||||3DC8CF9159584D86B330F4EAA7B08EE5

TXA|1|Image||20190205120522|1234^2^^^^^^ÊPIC^^^^PROVID|20190310103813|20190310103813||1234^2^^^^^^ÊPIC^^^^PROVID|||^^3DC8CF9159584D86B330F4EAA7B08EE5|||3DC8CF9159584D86B330F4EAA7B08EE5|7b3e8c89-12e1-4db1-abb3-e1df54a437c0.jpg|AU||AV|

OBX|1|ED|||^^^^/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAIBAQIBAQICAgICAgICAwUDAwMDAwYEBAMFBwYHBwcG| OBX|2|ED|||^^^^BwcICQsJCAgKCAcHCg0KCgsMDAwMBwkODw0MDgsMDAz/2wBDAQICAgMDAwYDAwYMCAcIDAwMDAwM| OBX|3|ED|||^^^^DAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAz/wAARCAQ4B4ADASIA| OBX|4|ED|||^^^ÂhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQA| OBX|5|ED|||^^^ÂAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3| OBX|6|ED|||^^^ÔDk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWm| OBX|7|ED|||^^^^p6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEA| OBX|8|ED|||^^^ÂwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSEx| OBX|9|ED|||^^^^BhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElK| OBX|10|ED|||^^^Û1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsr

Orpheus


PSW-81-003

Rev.: 03 Pg. 35 of 36

O0tba3| OBX|11|ED|||^^^ûLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwD+f+ii| OBX|12|ED|||^^^îgAooooAKKKKACiiigAooooAKKKKACiivob/AIJ3fsPx/tjfEDxBfeJNaHhH4XfDnTG8QeNPEDAM| OBX|13|ED|||^^^^1hZJk+VCvO+4l2ssagHJBODjBAPnpVLthQSfQUjKVOCMEdjX6JaN/wAFa9c8OfErR/ht+xz8J/Cf| OBX|14|ED|||^^^^w9026vE07SLmTTE1PxL4ilbCLJdTTFo97nnaqAD1ouP+CtVx8QviTqnw8/bJ+E/hfx9ptteS6Zqm| OBX|15|ED|||^^^ô2mmrpfibw3MpMbS28sJWMshydrIQwHXmkK5+dtFfQn/AAUV/Yc/4Yp+KukjQ9dj8ZfDXx3pya/4| OBX|16|ED|||^^^^K8TRJsTWNPkAI3r/AAzR7gsi4GGxwM4r57pjCivdv2Hf+Cafxq/4KL+MJtH+EvgfUvES2hxeaiwF|

Orpheus


PSW-81-003

Rev.: 03 Pg. 36 of 36

4. Queries

The Orpheus System does not support any queries.

orpheus hl7 specification documentorpheus-medical.com/wp-content/uploads/2020/03/psw-81... ·...

Documents