You are on page 1of 144

Vision Series RIS 5.

0 HL7 Interface Guide

Vision Series RIS 5.0 HL7 Interface Guide

Copyright 2007-2009 AMICAS, Inc. All rights reserved.


Use, duplication, or disclosure by licensee is subject to restrictions as set forth in the AMICAS, Inc. contract. Information contained in this document is subject to change without notice and does not represent a commitment on the part of AMICAS, Inc. The software and processes described in this document are furnished under the contract or nondisclosure agreement. No part of this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording, for any purpose other than the purchasers personal use without the written permission of AMICAS, Inc. This document contains proprietary information of AMICAS, Inc. The contents are exempt from disclosure to the public under the Freedom of Information Act 35, U.S.C. 552 (6)(4) and unlawful disclosure thereof is a violation of the Trade Secrets Act, 18 U.S.C. 1905. Public disclosure of any information contained herein shall not be made without prior written permission of AMICAS, Inc. AMICAS is a registered trademark or trademark of AMICAS, Inc. All other names and products are trademarks or registered trademarks of their respective companies. RESTRICTED RIGHTS LEGEND: Use, duplication or disclosure by the Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at DFARS 252.227-7013. AMICAS, Inc.

Date 3/28/08 8/29/08 10/31/08 11/24/08 06/05/09 08/18/09

Revision A B B.1 C D D.1

Description Initial Release for 5.0 Maintenance Release 1 Maintenance Release 1, Critical Update 1 Maintenance Release 2 Maintenance Release 4 Maintenance Release 4, Critical Update 1

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

Table of Contents
Preface ......................................................................................................................................................... v 1. HL7 Overview...................................................................................................................................... 1 1.1 Messages ............................................................................................................................... 1 1.2 Segments ............................................................................................................................... 1 1.3 Fields ...................................................................................................................................... 1 1.3.1 Sequence........................................................................................................................ 1 1.3.2 Field Name ..................................................................................................................... 2 1.3.3 Length ............................................................................................................................. 2 1.3.4 Optionality....................................................................................................................... 2 1.4 MSH-9 Message Types....................................................................................................... 2 1.5 Message Delimiters............................................................................................................... 2 1.6 Message Details .................................................................................................................... 3 1.7 Warning to the Reader ..........................................................................................................4 HL7 Support Tables Definition....................................................................................................... 5 Inbound Messages ............................................................................................................................. 6 3.1 ADT^A01, A02, A03, A04, A05, A06, A07 or ADT^A08 Registering / Updating a Patient 6 3.1.1 Message Definition ......................................................................................................... 6 3.1.2 MSH (Message Header Segment) - ADT ^A01 - ADT^A08 ........................................... 6 3.1.3 PID (Patient Identification Definition Segment) - ADT ^A01 - ADT^A08 ........................ 8 3.1.4 GT1 (Guarantor Segment) - ADT ^A01 - ADT^A08 ..................................................... 10 3.1.5 IN1 (Insurance Segment) - ADT ^A01 - ADT^A08 ....................................................... 14 3.1.6 IN2 (Insurance Segment) - ADT ^A01 - ADT^A08 ....................................................... 17 3.2 ADT^A34 or ADT^A40 HL7 Message Merge Type ........................................................ 20 3.2.1 Message Definition .......................................................................................................20 3.2.2 MSH (Message Header Segment) ADT^A34 or ADT^A40 ....................................... 21 3.2.3 EVN (Event Type Segment) - ADT^A34 or ADT^A40 .................................................. 22 3.2.4 PID (Patient Identification Definition Segment) - ADT ^A34 or ADT^A40 .................... 22 3.2.5 MRG (Patient Merge Information Segment) - ADT^A34 or ADT^40 ............................ 24 3.3 BAR^P05 Billing Account Update Message Type......................................................... 25 3.3.1 Message Definition .......................................................................................................25 3.3.2 MSH (Message Header Segment) BAR^P05............................................................ 25 3.3.3 EVN (Event Type Segment) BAR^P05...................................................................... 26 3.3.4 PID (Patient Identification Definition Segment) BAR^P05......................................... 28 3.3.5 PV1 (Patient Visit Segment) BAR^P05 ..................................................................... 30 3.4 MFN - Master File Update Message Type.......................................................................... 33 3.4.1 Message Definition .......................................................................................................33 3.4.2 MSH (Message Header Segment) MFN.................................................................... 34 3.4.3 MFI (Message File Identification Segment) MFN ...................................................... 35 3.4.4 MFE (Message File Entry Segment) MFN................................................................. 36 3.4.5 ZL7 (Insurance Data to Post Segment) MFN ............................................................ 37 3.5 ORM^O01 Order Message Type...................................................................................... 38 3.5.1 Message Definition .......................................................................................................38 3.5.2 MSH (Message Header Segment) ORM^O01 .......................................................... 38 3.5.3 PID (Patient Identification Definition Segment) - ORM^O01 ........................................ 39 3.5.4 PV1 (Patient Visit Segment) ORM^O01 .................................................................... 42 3.5.5 NTE (Notes and Comments Segment) ORM^O01.................................................... 45 3.5.6 ORC (Common Order Segment) - ORM^O01.............................................................. 46 3.5.7 OBR (Observation Request Segment) ORM^O01 .................................................... 48 3.5.8 OBX (Observation Result Segment) - ORM^O01 ........................................................ 52 3.6 ORR^O02 - General Order Acknowledgment Message Type ......................................... 53

2. 3.

AMICAS, Inc. Proprietary and Confidential

ii

Vision Series RIS 5.0 HL7 Interface Guide

4.

3.6.1 Message Definition .......................................................................................................53 3.6.2 MSA (Message Acknowledgment Segment) ORR^O02 ........................................... 54 3.6.3 MSH (Message Header Segment) - ORR^O02............................................................ 54 3.6.4 ORC (Common Order Segment) - ORR^O02 .............................................................. 55 3.6.5 PID (Patient Identification Definition Segment) ORR^O02........................................ 56 3.7 ORU^R01 - Results Message Type.................................................................................... 56 3.7.1 Message Definition .......................................................................................................56 3.7.2 MSH (Message Header Segment) - ORU^R01............................................................ 57 3.7.3 PID (Patient Identification Definition Segment) - ORU^R01......................................... 58 3.7.4 OBR (Observation Request Segment) - ORU^R01...................................................... 60 3.7.5 OBX (Observation/Result Segment) - ORU^R01 ......................................................... 63 3.8 ACK Acknowledgment Message Type ........................................................................... 64 3.8.1 Definition....................................................................................................................... 64 3.8.2 MSH (Message Header Segment) - ACK..................................................................... 64 3.8.3 MSA (Message Acknowledgment Segment) - ACK ..................................................... 65 Outbound Messages ........................................................................................................................ 66 4.1 Interface Monitor ................................................................................................................. 66 4.2 Trigger Points and Trigger Events ....................................................................................66 4.2.1 Definition....................................................................................................................... 66 4.3 ADT^A08 Update Patient Information ............................................................................ 68 4.3.1 Definition....................................................................................................................... 68 4.3.2 MSH (Message Header Segment) - ADT^A08............................................................. 68 4.3.3 PID (Patient Identification Definition Segment) - ADT^A08.......................................... 69 4.3.4 PV1 (Patient Visit Segment) - ADT^A08 ...................................................................... 71 4.4 ADT^A34 Merge Patient Information (Patient ID Only)................................................. 73 4.4.1 Definition....................................................................................................................... 73 4.4.2 MSH (Message Header Segment) - ADT^A34............................................................. 73 4.4.3 EVN (Event Type Segment) - ADT^A34....................................................................... 74 4.4.4 PID (Patient Identification Definition Segment) - ADT^A34.......................................... 75 4.4.5 MRG (Patient Merge Information Segment) - ADT^A34 .............................................. 76 4.5 MFN - Master File Update Message Type.......................................................................... 77 4.5.1 Message Definition .......................................................................................................77 4.5.2 MSH (Message Header Segment) MFN.................................................................... 78 4.5.3 MFI (Message File Identification Segment) MFN ...................................................... 79 4.5.4 MFE (Message File Entry Segment) MFN................................................................. 80 4.5.5 ZL7 (Insurance Data to Post Segment) MFN ............................................................ 81 4.6 ORM^O01 Order Message Type...................................................................................... 81 4.6.1 Definition....................................................................................................................... 81 4.6.2 MSH (Message Header Segment) - ORM^O01 ........................................................... 82 4.6.3 PID (Patient Identification Definition Segment) - ORM^O01 ........................................ 83 4.6.4 PV1 (Patient Visit Segment) - ORM^O01..................................................................... 84 4.6.5 ORC (Common Order Segment) - ORM^O01.............................................................. 87 4.6.6 OBR (Order Detail /Observation Request) - ORM^O01 ............................................... 88 4.7 ORU^R01 Results Message Type ................................................................................... 91 4.7.1 Definition....................................................................................................................... 91 4.7.2 MSH (Message Header Segment) - ORU^R01............................................................ 92 4.7.3 PID (Patient Identification Definition Segment) - ORU^R01......................................... 93 4.7.4 PV1 (Patient Visit Segment) - ORU^R01 ..................................................................... 94 4.7.5 ORC (Common Order Segment) - ORU^R01 .............................................................. 96 4.7.6 OBR (Order Detail /Observation Request) - ORU^R01................................................ 98 4.7.7 OBX (Observation/Result Segment) - ORU^R01 ....................................................... 101 4.8 ORU^R01 HL7 HTML Result Message Type ................................................................ 102 4.8.1 Definition.....................................................................................................................102 4.8.2 MSH (Message Header Segment) - ORU^R01.......................................................... 103 4.8.3 PID (Patient Identification Definition Segment) - ORU^R01....................................... 104

AMICAS, Inc. Proprietary and Confidential

iii

Vision Series RIS 5.0 HL7 Interface Guide

4.8.4 PV1 (Patient Visit Segment) - ORU^R01 ................................................................... 105 4.8.5 ORC (Common Order Segment) - ORU^R01 ............................................................ 107 4.8.6 OBR (Order Detail /Observation Request) - ORU^R01.............................................. 109 4.8.7 OBX (Observation/Result Segment) - ORU^R01 ....................................................... 112 4.9 ORM^O01 HL7 Batch Charge Out Message Type.......................................................113 4.9.1 Definition.....................................................................................................................113 4.9.2 MSH (Message Header Segment) - ORM^O01 ......................................................... 114 4.9.3 PID (Patient Identification Definition Segment) - ORM^O01 ...................................... 115 4.9.4 PV1 (Patient Visit Segment) - ORM^O01...................................................................116 4.9.5 PV2 (Patient Visit Segment) - ORM^O01...................................................................118 4.9.6 GT1 (Guarantor Segment) - ORM^O01 ..................................................................... 120 4.9.7 ACC (Accident Segment) - ORM^O01 ....................................................................... 123 4.9.8 DB1 (Disability Segment) - ORM^O01 ....................................................................... 123 4.9.9 IN1 (Insurance Segment) - ORM^O01 ....................................................................... 124 4.9.10 IN2 (Insurance Segment) - ORM^O01 ................................................................... 126 4.9.11 PR1 (Procedure Segment) - ORM^O01.................................................................129 4.10 ACK Acknowledgment Message Type .........................................................................130 4.10.1 Definition.................................................................................................................130 4.10.2 MSH (Message Header Segment) - ACK ..............................................................130 4.10.3 MSA (Message Acknowledgment Seg.) - ACK ......................................................131 Glossary ................................................................................................................................................... 132 Appendix A: Data Types......................................................................................................................... 137

AMICAS, Inc. Proprietary and Confidential

iv

Vision Series RIS 5.0 HL7 Interface Guide

Preface
The Vision Series RIS 5.0 HL7 Interface Guide contains the procedures for configuring the HL7 component of the Vision Series RIS application.

Purpose and Audience


This document is intended to serve as a procedure manual for the technical staff responsible for setting up the Vision Series RIS application, as well as a guide for third-party systems to interface with Vision Series RIS.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

HL7 Overview

1.

HL7 Overview

1.1 Messages
Within the HL7 protocol, data is broken up into groups called messages. A message is the atomic unit of data transferred between systems. Each message consists of a group of segments in a defined sequence. Each message has a message type (three-character code) that defines its type. Refer to the Glossary for message type definitions. The real-world event that initiates an exchange of messages is called a trigger event. These triggers represent actions such as a patient is admitted or an order is placed. The same trigger event code may not be associated with more than one message type; however a message type may be associated with more than one trigger event. Only the HL7 fields that are used exclusively are listed in this document.

1.2 Segments
A segment is a logical grouping of data fields. Segments of a message may be required or optional. They may occur only once in a message or they may be allowed to repeat. Each segment is given a name. For example, the ADT message may contain the following segments: Message Header (MSH) Event Type (EVN) Patient ID (PID) Patient Visit (PV1)

Each segment is identified by a unique three-character code known as the Segment ID.

1.3 Fields
A field is a string of characters. When fields are transmitted, they are sent as character strings. Except where noted, HL7 data fields may take on the null value. Sending the null value, which is transmitted as two double quote marks (), is different from omitting an optional data field. The difference appears when the contents of a message will be used to update a record in a database rather than create a new one. If no value is sent, (i.e., it is omitted) the old value should remain unchanged. A null value will be ignored. If you want to remove a value, you need to send a space. In defining a segment, the following information is specified about each field.

1.3.1 Sequence
The sequence is the position of the data field within the segment. For Example: MSH-1, MSH-9.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

HL7 Overview

In the segment attribute tables (beginning in Subsection 3.1.2) this information is provided in the column labeled Seq.

1.3.2 Field Name


The field name is the descriptive name for the data item. In the segment attribute tables this information is provided in the column labeled HL7 Field Name.

1.3.3 Length
The length is designated by HL7 or the system, whichever is the smallest. In the segment attribute tables this information is in a column labeled Len (beginning in Subsection 3.1.2).

1.3.4 Optionality
Optionality designates if the field is required, optional, or conditional in a segment. The designations for both Inbound and Outbound Messages are: R = this designation means required. O = this designation means optional. C = this designation means conditional (as described in the Comments column beginning in Subsection 3.1.2). B = this designation means backward compatibility with previous versions of HL7. The Vision Series RIS application allows the user to configure optional demographic data to be required in the System Properties. These constraints are imposed specifically upon manual data entry and editing of patient data and will not be enforced upon data received through the inbound interface. In the segment attribute tables this information is provided in the column labeled Opt (beginning in Subsection 3.1.2).

1.4 MSH-9 Message Types


Each HL7 message header has a message type (MSH-sequence 9) that defines the purpose of the message. This MSH-9 data field contains two components: 1. A three-character message type code. 2. An alphanumeric trigger event type.

1.5 Message Delimiters


Message delimiters are special characters used in constructing a message. They are the segment initiator, segment terminator, field separator, component separator, subcomponent separator, repetition separator, and escape character. The escape character is only used in charge out.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

HL7 Overview

The segment terminator is always a carriage return (in ASCII, a hex 0D). The other delimiters are defined in the MSH segment, with the field delimiter in the 4th character position, and the other delimiters occurring as in the field called Encoding Characters, which is the first field after the segment ID. The delimiter values used in the MSH segment are the delimiter values used throughout the entire message. At any given site, the subset of the possible delimiters may be limited by negotiations between applications. This implies that the receiving applications will use the agreed upon delimiters, as they appear in the Message Header segment (MSH), to parse the message. In the absence of other considerations, HL7 recommends the following suggested values:
Delimiter Message Initiator Message Terminator Suggested Value Vertical Tabulation File separator <CR> carriage return <CR> carriage return Hex Value 0B 1C 0D 0D Usage Initiates a message record. Terminates a message record. This value cannot be changed by implementers. Terminates a segment record. The message is wrapped between 0B and 1C 0D. Separates two adjacent data fields within a segment. It also separates the Segment ID from the first data field in each segment. Separates adjacent components of data fields where allowed. Separates adjacent subcomponents of data fields where allowed. If there are no subcomponents, this character may be omitted. Separates multiple occurrences of a field where allowed. The escape character is for use with any field represented by an ST, TX or FT data type, or for use with the data (fourth) component of the ED data type If no escape characters are used in a message, this character may be omitted. However, it must be present if subcomponents are used in the message.

Segment Terminator

Field Separator

| (pipe)

7C

Component Separator

^ (carat)

5E

Subcomponent Separator

& (ampersand)

26

Repetition Separator

~ (tilde)

7E

Escape Character

\ (backslash)

5C

1.6 Message Details


A message is a unit of data transferred between two systems. HL7 data will be received via TCP/IP socket or shared folder. All messages sent or received via Vision Series RIS will be constructed according to the Minimal Lower Layer Protocol (MLLP). Messages are prefixed with a character of <0B> hex. Segments are terminated with a character of <0D> hex. Messages are terminated by an end block character sequence of <1C><0D> hex. All acknowledgment messages from the remote server will need to follow the same format.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

HL7 Overview

An empty string or NULL will be treated as an ignore field. This means that it will not be used to update the database. The old value will remain unchanged. In order to designate a change, it should be represented by pipes || with at least one space in between. The filler could ignore data fields that are present, but were not expected, rather than treat such a circumstance with an error. HL7 messages consist of data fields. A data field is a string of characters that are of variable length and separated by delimiters as listed below. Transmitted fields should be sent as character strings.

1.7 Warning to the Reader


Message, segment and field definitions used by this interface are based on the HL7 2.3 standard and where possible match those specifications. However, differences exist and thus the reader is cautioned: where the specifications differ between the HL7 standard and this document, the specifications in this document take precedence. For general information on HL7 messages, please consult the HL7 Version 2.3 Standard available through www.hl7.org.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

HL7 Support Tables Definition

2.

HL7 Support Tables Definition


You must synchronize Vision Series RIS with a receiving system by configuring the PMIS for the following Support Tables: Support Table Gender Martial Status Ethnicity Relationship Type Code Location Referring Physician Reason Exam Code Insurance Interface All interfaces All interfaces All interfaces All interfaces Inbound Order Entry Inbound Order Entry Inbound Order Entry Inbound Order Entry Inbound ADT and MFN

For more information on Support Tables, see the Vision Series RIS 5.0 Administration Guide.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.

Inbound Messages
The AMICAS interface will be a one-way (unidirectional) inbound data transfer. Messages received shall conform to the Health Level Seven (HL7) Standard, version 2.3 for electronic data exchange. The following inbound interfaces are supported: ADT BAR MFN ORM ORR ORU ACK

See the Glossary for definitions of each interface.

3.1 ADT^A01, A02, A03, A04, A05, A06, A07 or ADT^A08 Registering /
Updating a Patient
3.1.1 Message Definition
Vision Series RIS shall receive the patient message event type ADT^A01 through ADT^A08 which will create or update patient demographics. All message types will be treated the same. The following table lists each supported message segment and their description:
Message Segment MSH PID GT1 IN1 IN2 Segment Description Message Header Patient Identification Guarantor Insurance Insurance

Refer to the Glossary for the complete message segment definitions.

3.1.2 MSH (Message Header Segment) - ADT ^A01 - ADT^A08


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MSH Seq 1 2 3

HL7 Field Name Field Separator Encoding Characters Sending Application

Opt R R O

RIS Req

Length 1 4 180

Data Type ST ST HD

Rejection Rules

Vision Series Data Mapping/ Comments "|" "^~\& <name of the originating application> <name of the originating facility> <name of the receiving application> <name of the receiving facility> Current date/time. <yyyymmddhhmmss>

4 5 6 7 8

Sending Facility Receiving Application Receiving Facility Date/time of Message Security

O O O O O

180 180 180 26 40

HD HD HD TS ST

Message Type

CM

ADT^A04 or ADT^A08 Rejected if field is empty. Register or update a patient. Message unique identifier for the ADT message which will be Rejected if field is empty. echoed back in the MSA_2 of the acknowledgment message. P Production Environment 2.3 HL7 version number

10

Message Control ID

20

ST

11

Processing ID

PT

12 13 14 15 16 17 18 19 20

Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

R O O O O O O O O

8 15 180 2 2 2 16 60 20

ID NM ST ID ID ID ID CE ID

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.1.3 PID (Patient Identification Definition Segment) - ADT ^A01 - ADT^A08


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PID segment per message. 1

Set ID - Patient ID

SI If the unique ID is not PMIS, this is rejected if the PID 2 and 3 fields are empty.

Patient ID (External ID)

20

CX

Patient Unique Identifier <Internal Patient ID Number> Patient Jacket Number <Jacket Number> This field is required if the interface is using the jacket number as the unique identifier. Patient SS Number <#########> Patient Name <last name^ first name^ middle name> Excess length will be truncated.

Patient ID (Internal ID)

20

CX

If the unique ID is not PMIS and this field is empty, the data must be in the PID 2 field.

Alternate Patient ID

20

CX

Patient Name last name first name middle initial Mothers Maiden Name Date of Birth

90 total 30 30 30 48

XPN

Rejected if field is empty.

6 7

O O R

XPN TS Rejected if field is empty and if not at least <yyyymmdd>. Will not be set if PMIS code does not match Patient DOB <yyyymmdd> Patient Gender <PMIS code only> (reference the RIS Gender support table)

26

Sex

ST

Patient Alias

48

XPN Patient Ethnicity <PMIS code only> (reference the RIS Ethnicity support table)

10

Race

IS

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Patient Address <address 1^ address 2^ city^ state (standard abbreviation only)^ zip (alphanumeric with no validation) Excess length will be truncated. Country does not update.

11

Patient Address

151 total 60 40 40 2 9

XAD

12

County Code

IS Patient Home Phone numeric only <area code and phone number> Patient Work Phone numeric only <area code and phone number>

13

Phone Number - Home

12

XTN

14

Phone Number - Business

12

XTN

15

Language - Patient

60

CE Patient Marital Status <PMIS code only> (reference the RIS Marital Status support table)

16

Marital Status

IS

17

Religion

IS Patient Unique Identifier <Patient File PMIS> This field is required if the interface is configured to use the patient PMIS number as the unique If the PMIS is used as the identifier. If the PMIS unique ID, reject if blank is used as the unique and PID 3 must be NULL ID, then PID_3 Jacket if you do not wish to Number must be modify the jacket. NULL on the inbound message if the patient jacket should not be changed. The patient PMIS must be unique to all patients, guarantors and insureds. Alphanumeric.

18

Patient Account Number

20

CX

AMICAS, Inc. Proprietary and Confidential

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Patient Social Security Number <#########> Numeric with no special characters. No validation is performed for length or duplicates.

19

SSN Number - Patient

16

ST

Rejected if not 9 sequential numbers.

20 21 22 23 24 25 26 27 28 29 30

Drivers License NumberPatient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

O O O O O O O O O O O

25 20 3 60 2 2 4 60 80 26 1

CM CX IS ST ID NM IS CE CE TS ID Reject if not at least <yyyymmdd>. Patient Date of Death <yyyymmdd>

3.1.4 GT1 (Guarantor Segment) - ADT ^A01 - ADT^A08


The following table lists each Guarantor segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

GT1 Seq 1

HL7 Field Name

Opt

RIS Req

Length

Data Type SI

Rejection Rules

Vision Series Data Mapping/ Comments One GT1 segment per message. "1"

Set ID - GT1

AMICAS, Inc. Proprietary and Confidential

10

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

GT1 Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments

Guarantor Number

59

CX

Guarantor Unique Identifier <Guarantor PMIS> This field is required if If this field is the the interface is guarantors ID then configured to accept rejected if field is empty or guarantors. The if the PMIS code does not guarantor PMIS match. number must be unique to all patients, guarantors and insureds. Alphanumeric. Guarantor Name <last name^ first name^ middle name> Excess length will be truncated. Suffix does not update. Guarantor Spouse Name Guarantor Address <address 1^ address 2^ city^ state (standard abbreviation only)^ zip (alphanumeric with no validation)> Excess length will be truncated. Country does not update. Guarantor Home Phone numeric only <area code and phone number> Guarantor Work Phone numeric only

Guarantor Name

90 total 30 30 30 48

XPN

If this field is blank, it will associate the patient as the guarantor..

Guarantor Spouse Name

XPN

Guarantor Address

151 total 60 40 40 2 9

XAD

Guarantor Ph Num - Home

12

XTN

Guarantor Ph Num Business

12

XTN

If not found in GT1-7.7 then it will be read from GT1-7.1

GT1-7.7 <^^^^^^area code and phone number>

Guarantor Date/Time Of Birth

26

TS

If this field is configured to identify the guarantor or if Guarantor DOB GT1-3 is other than the patient, reject if blank. <yyyymmdd> Rejected if format is not at least <yyyymmdd>. Will be ignored if code does not match Guarantor Gender <PMIS code only> (reference the RIS Gender support table)

Guarantor Administrative Sex

ST

AMICAS, Inc. Proprietary and Confidential

11

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

GT1 Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Guarantor Qualifier 1 if person and 2 if non-person. 1 is the default.

10

Guarantor Type

IS

Required if GT1-3 is other than the patient. 11 Guarantor Relationship O C 80 CE Rejected if the field is empty or if the relationship code does not match.

Guarantor Relationship Patient relation to Guarantor <PMIS code only> (reference the RIS Relationship support table)

12

Guarantor SSN

11

ST

Guarantor SS Number <#########> If this field is configured to Numeric with no identify the guarantor, special characters. reject if blank. No validation is performed for length or duplicates.

13 14 15 16

Guarantor Date Begin Guarantor Date End Guarantor Priority Guarantor Employer Name

O O O O

8 8 2 130

DT DT NM XPN Guarantor Employer Name <Employer Name> Guarantor Employer Address <Address 1^^City^State^Zip> Employer Phone, Fax, Email <(Area Code)Phone Number^Fax Number^Email Address>

17

Guarantor Employer Address

106

XAD

18

Guarantor Employer Phone Number

40

XTN

19 20 21 22 23 24 25 26

Guarantor Employee ID Number Guarantor Employment Status Guarantor Organization Name Guarantor Billing Hold Flag Guarantor Credit Rating Code Guarantor Death Date And Time Guarantor Death Flag Guarantor Charge Adjustment Code

O O O O O O O O

20 2 130 1 80 26 1 80

CX IS XON ID CE TS ID CE

AMICAS, Inc. Proprietary and Confidential

12

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

GT1 Seq 27 28

HL7 Field Name Guarantor Household Annual Income Guarantor Household Size

Opt O O

RIS Req

Length 10 3

Data Type CP NM

Rejection Rules

Vision Series Data Mapping/ Comments

29

Guarantor Employer ID Number

20

CX

Guarantor Employer ID <PMIS code only> (Reference the RIS Employer support table.)

30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54

Guarantor Marital Status Code Guarantor Hire Effective Date Employment Stop Date Living Dependency Ambulatory Status Citizenship Primary Language Living Arrangement Publicity Code Protection Indicator Student Indicator Religion Mothers Maiden Name Nationality Ethnic Group Contact Persons Name Contact Persons Telephone Number Contact Reason Contact Relationship Job Title Job Code/Class Guarantor Employers Organization Name Handicap Job Status Guarantor Financial Class

O O O O O O O O O O O O O O O O O O O O O O O O O

80 8 8 2 2 80 60 2 80 1 2 80 48 80 80 48 40 80 2 20 20 130 2 2 50

CE DT DT IS IS CE CE IS CE ID IS CE XPN CE CE XPN XTN CE IS ST JCC XON IS IS FC Guarantor Ethnicity <PMIS code only> (reference the RIS Ethnicity support table)

55

Guarantor Race

IS

Will be ignored if code does not match.

AMICAS, Inc. Proprietary and Confidential

13

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.1.5 IN1 (Insurance Segment) - ADT ^A01 - ADT^A08


The following table lists each Insurance segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Information provided will not update the insurance support tables.

Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

IN1 Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Insurance Patient Plan Rank <sequence identifier> 1 = primary 2 = secondary, etc.

Set ID - IN1

SI

Rejected if field is empty.

No limit. This field will determine insurance ranking for the patient. Segments can be sent non-sequential. May send 2 and not 1. Insurance Coverage Plan Code <Plan Code> Insurance Company ID <Insurance Coverage Plan PMIS code>

Insurance Plan ID

60

CE

Refer to IN1-3 if blank

Insurance Company ID

59

CX

(reference the RIS Insurance Coverage If IN1-2 is blank and IN1support table.) 3 does not match, then reject. The ADT will fail if this PMIS code is invalid. If using SelfPay, a Self-Pay Insurance Coverage and PMIS is required in the support table.

4 5

Insurance Company Name Insurance Company Address

O O

130 106

XON XAD

AMICAS, Inc. Proprietary and Confidential

14

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

IN1 Seq 6 7 8 9 10 11 12

HL7 Field Name Insurance Co Contact Person Insurance Co Phone Number Group Number Group Name Insureds Group Emp ID Insureds Group Emp Name Plan Effective Date

Opt O O O O O O O

RIS Req

Length 48 40 12 130 12 130 8

Data Type XPN XTN ST XON CX XON DT

Rejection Rules

Vision Series Data Mapping/ Comments

Member Number <Member Number>

Plan Effective Start Date <yyyymmdd> Plan Expiration Date <yyyymmdd>

13 14

Plan Expiration Date Authorization Information

O O

8 55

DT CM

15

Plan Type

IS

Insurance Coverage Type <Coverage Type Name> Insured Name <last name^first name^ middle name> Suffix does not update.

16

Name Of Insured

90 total 30 30 30

XPN

If this field is blank, it will associate the patient as the insured.

Excess length will be truncated. Though RIS only displays First and Last, the First, Middle and Last are sent through standard charge out. Patient name is used if this field is left blank.

Required if IN1-16 is other than the patient. 17 Insureds Relationship To Patient O C 80 CE Rejected if the field is empty or if the relationship code does not match

Patient Relation to Insured <PMIS code only> (reference the RIS Relationship support table)

AMICAS, Inc. Proprietary and Confidential

15

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

IN1 Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules Required if IN1-16 is provided or If this field is configured to identify the insured, reject if blank.

Vision Series Data Mapping/ Comments Insured DOB <yyyymmdd> Insured Address

18

Insureds Date Of Birth

26

TS

19

Insureds Address

151 total 60 40 40 2 9

<address 1^address 2^city^ XAD state (standard abbreviation only)^zip (alphanumeric with no validation)> Excess length will be truncated. Country does not update.

20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

Assignment Of Benefits Coordination Of Benefits Coord Of Ben. Priority Notice Of Admission Flag Notice Of Admission Date Report Of Eligibility Flag Report Of Eligibility Date Release Information Code Pre-Admit Cert (PAC) Verification Date/Time Verification By Type Of Agreement Code Billing Status Lifetime Reserve Days Delay Before L.R. Day Company Plan Code

O O O O O O O O O O O O O O O O

2 2 2 1 8 1 8 2 15 26 60 2 2 4 4 8

IS IS ST ID DT ID DT IS ST TS XCN IS IS NM NM IS Policy Number

36

Policy Number

15

ST

<Policy Number> Alphanumeric

37 38 39

Policy Deductible Policy Limit Amount Policy Limit Days

O B O

12 12 4

CP CP NM

AMICAS, Inc. Proprietary and Confidential

16

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

IN1 Seq 40 41 42

HL7 Field Name Room Rate - Semi-Private Room Rate Private Insureds Employment Status

Opt B B O

RIS Req

Length 12 12 60

Data Type CP CP CE

Rejection Rules

Vision Series Data Mapping/ Comments

Insured Gender 43 Insureds Administrative Sex O O 1 IS Will be ignored if code does not match <PMIS code only> (reference the RIS Gender support table) Insureds Employer Address <Address 1^^City^ State^Zip>

44

Insureds Employers Address

151

XAD

45 46 47 48

Verification Status Prior Insurance Plan ID Coverage Type Handicap

O O O O

2 8 3 2

ST IS IS IS Insured Unique Identifier <Insured PMIS code only> This field is required if If this field is configured to the interface is identify the insured, reject configured to accept if blank. the Insured. The insured PMIS number must be unique to all patients, guarantors and insureds. Alphanumeric.

49

Insureds ID Number

12

CX

3.1.6 IN2 (Insurance Segment) - ADT ^A01 - ADT^A08


The following table lists each Insurance segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

IN2 Seq 1

HL7 Field Name Insured's Employee ID

Opt O

RIS Req

Length 59

Data Type CX

Rejection Rules

Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

17

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

IN2 Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments

Insured's Social Security Number

11

ST

If this field is configured to Insured's SS Number identify the insured, reject <SS Number format if blank. #########> Insured's Employer Name and ID <Employer Name^PMIS or Unique Identification Number>

Insured's Employer Name and ID

130

XCN

4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

Employer Information Data Mail Claim Party Medicare Health Ins Card Number Medicaid Case Name Medicaid Case Number Military Sponsor Name Military ID Number Dependent Of Military Recipient Military Organization Military Station Military Service Military Rank/Grade Military Status Military Retire Date Military Non-Avail Cert On File Baby Coverage Combine Baby Bill Blood Deductible Special Coverage Approval Name Special Coverage Approval Title Non-Covered Insurance Code Payor ID Payor Subscriber ID Eligibility Source

O O O O O O O O O O O O O O O O O O O O O O O O

1 1 15 48 15 48 20 80 25 25 14 2 3 8 1 1 1 1 48 30 8 59 59 1

IS IS ST XPN ST XPN ST CE ST ST IS IS IS DT ID ID ID ST XPN ST IS CX CX IS

AMICAS, Inc. Proprietary and Confidential

18

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

IN2 Seq 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

HL7 Field Name Room Coverage Type/Amount Policy Type/Coverage Daily Deductible Living Dependency Ambulatory Status Citizenship Primary Language Living Arrangement Publicity Code Protection Indicator Student Indicator Religion Mother's Maiden Name Nationality Ethnic Group Marital Status Insured's Employment Start Date Employment Stop Date Job Title Job Code/Class

Opt O O O O O O O O O O O O O O O O O O O O

RIS Req

Length 25 25 25 2 2 80 60 2 80 1 2 80 48 80 80 80 8 8 20 20

Data Type CM CM CM IS IS CE CE IS CE ID IS CE XPN CE CE CE DT DT ST JCC

Rejection Rules

Vision Series Data Mapping/ Comments

48

Job Status

IS

Insured's Employment Status <PMIS Code or Employment Status Code>

49 50 51 52 53 54

Employer Contact Person Name Employer Contact Person Phone Number Employer Contact Reason Insured Contact Person Name Insured Contact Person's Phone Number Employer Contact Person Reason

O O O O O O

48 40 2 48 40 2

XPN XTN IS XPN XTN IS

AMICAS, Inc. Proprietary and Confidential

19

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

IN2 Seq 55 56 57 58 59 60 61 62

HL7 Field Name Relationship To The Patient Start Date Relationship To The Patient Stop Date Insurance Co. Contact Reason Insurance Co. Contact Phone Number Policy Scope Policy Source Patient Member Number Guarantor's Relationship To Insured Insured's Phone Number Home Insured's Employer Phone Number Military Handicapped Program Suspend Flag Copay Limit Flag Stoploss Limit Flag Insured Organization Name and ID Insured Employer Organization Name and ID Race HCFA Patient's Relationship to Insured

Opt O O O O O O O O

RIS Req

Length 8 8 2 40 2 2 60 80

Data Type DT DT IS XTN IS IS CX CE

Rejection Rules

Vision Series Data Mapping/ Comments

63

40

XTN

Insured Phone Number <(Area Code)Phone Number>

64 65 66 67 68 69 70 71 72

O O O O O O O O O

40 60 1 1 1 130 130 80 60

XTN CE ID ID ID XON XON CE CE

3.2 ADT^A34 or ADT^A40 HL7 Message Merge Type


3.2.1 Message Definition
These messages will allow the RIS to merge two patients. Patients will be identified by using either the PMIS code or the Patient Jacket number. Patient Demographics will not be modified using a merge message. The following table lists each supported message segment and their description:
Message Segment MSH Segment Description Message Header

AMICAS, Inc. Proprietary and Confidential

20

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

Message Segment EVN PID MRG

Segment Description Event Type Segment Patient Identification Patient Merge Information

See the Glossary for definitions of each interface.

3.2.2 MSH (Message Header Segment) ADT^A34 or ADT^A40


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MSH Seq 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Opt R R O O O O O O R R R R O O O O O O O R R R R R RIS Req Length 1 4 180 180 180 180 26 40 7 20 3 60 15 180 2 2 2 16 60 Data Type ST ST HD HD HD HD TS ST CM ST PT ID NM ST ID ID ID ID CE AL NE Rejected if field is empty. Rejected if field is empty. ADT^A34 or ADT^A40 System date/time. <yyyymmddhhmmss> P 2.3 HL7 version number Rejected if field is empty. Current date/time <yyyymmddhhmmss> Rejected if field is empty. Rejected if field is empty. Rejection Rules Vision Series Data Mapping/ Comments "|" "^~\&" <Sending Application> <Sending Facility> <Receiving Application>

AMICAS, Inc. Proprietary and Confidential

21

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

20

Alternate Character Set Handling Scheme

20

ID

3.2.3 EVN (Event Type Segment) - ADT^A34 or ADT^A40


The following table lists each Event Type segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

EVNSeq 1 2 3 4

HL7 Field Name Event Type Code Recorded Date/Time Date/Time Planned Event Event Reason Code

Opt O O O O

RIS Req

Length 3 26 26 3

Data Type ID TS TS IS

Rejection Rules

Vision Series Data Mapping/ Comments A34 or A40 Current Date/Time <yyyymmddhhmmss>

Operator ID & Name 5 Operator ID O 60 XCN <User ID^User Name (FML)> Current Date/Time <yyyymmddhhmmss>

Event Occurred

26

TS

3.2.4 PID (Patient Identification Definition Segment) - ADT ^A34 or ADT^A40


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PID segment per message. 1

1 2

Set ID - Patient ID Patient ID (External ID)

O O

4 20

SI CX

AMICAS, Inc. Proprietary and Confidential

22

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Patient Unique Identifier <Defined Unique ID> PMIS, SSN, Jacket, RIS Internal ID Patient Unique Identifier <Defined Unique ID>

Patient ID (Internal ID)

20

CX

Rejected if field is empty.

Alternate Patient ID Patient Name last name first name middle initial Mothers Maiden Name Date of Birth

20

CX

48

XPN

Rejected if field is empty or if suffix code does not match this field.

Patient Name <last name^ first name^ middle name^suffix>

6 7

O O R

48 26

XPN TS Rejected if field is empty and if not at least <yyyymmdd>. Rejected if the field is empty or if the gender code does not match this field. Patient DOB <yyyymmdd> Patient Gender (F, M, O, U) <PMIS code or gender code? Patient Alias <Alias field> Rejected if the race code does not match this field. Patient Ethnicity <PMIS code or ethnicity code> Patient Address <address 1^address 2^city^ state^zip^country> Country Code <Country field> Patient Home Phone, Fax, Email <(Area Code)Phone Number^Additional text in phone number field^Fax Number^Email Address> Patient Work Phone <(Area Code)Phone Number^Additional text in phone number field>

Sex

ST

Patient Alias

48

XPN

10

Race

80

IS

11

Patient Address

106

XAD

12

County Code

IS

13

Phone Number - Home

40

XTN

14

Phone Number - Business

12

XTN

15 16 17

Language - Patient Marital Status Religion

O O O

60 80 80

CE IS IS Rejected if the martial status code does not match this field. Patient Marital Status <PMIS code for Marital Status Code>

AMICAS, Inc. Proprietary and Confidential

23

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq 18

HL7 Field Name

Opt

RIS Req C

Length

Data Type CX

Rejection Rules

Vision Series Data Mapping/ Comments

Patient Account Number

20

If the PMIS is used as the Patient PMIS unique ID, reject if blank and PID 3 must be NULL. <Patient File PMIS> Rejected if not 9 sequential numbers. Patient Social Security Number <#########>

19

SSN Number - Patient

16

ST

20 21 22 23 24 25 26 27 28 29 30

Drivers License NumberPatient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

O O O O O O O O O O O

25 20 80 60 1 2 80 60 80 26 1

CM CX IS ST ID NM IS CE CE TS ID Reject if not at least <yyyymmdd>. Patient Date of Death <yyyymmdd>

3.2.5 MRG (Patient Merge Information Segment) - ADT^A34 or ADT^40


The following table lists each Patient Merge Information segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MRG Seq HL7 Field Name Opt RIS Req Length Data Type Rejection Rules Vision Series Data Mapping/ Comments Patient Unique Identifier <Defined Unique ID> Patient Unique Identifier <Defined Unique ID> Prior Patient PMIS <Patient File PMIS> Prior Patient Unique Identifier <Internal Patient ID Number>

Prior Patient ID - Internal

20

CX

Prior Alternate Patient ID

20

CX

Prior Patient Account Number

20

CX

Prior Patient ID - External

20

CX

5 6 7

Prior Visit Number Prior Alternate Visit ID Prior Patient Name

O O O

20 20 48

AMICAS, Inc. Proprietary and Confidential

24

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.3 BAR^P05 Billing Account Update Message Type


3.3.1 Message Definition
The financial system sends the patients billing/accounts information to the Vision Series RIS The P05 event is sent when an existing account is being updated with financial information. From Standard Version 2.3 onward, the P01 (add account) event should not longer be used for updating an existing account with financial information, but only for creating a new financial account. Update of the Patient Demographics will not be done from this message type. An ADT message must be used to update the Patient Demographics. The following table lists each supported message segment and their description:
Message Segment MSH EVN PID PV1 Segment Description Message Header Event Type Patient Identification Patient Visit

See the Glossary for definitions of each interface.

3.3.2 MSH (Message Header Segment) BAR^P05


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSH Seq 1 2 3 4 5

HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application

Opt R R O O O

Req by RIS R R R

Length 1 4 180 180 180

Data Type ST ST HD HD HD

Rejection Rules Must always be pipe "|". "|" Must always be "^~\&". Rejected if not acceptable sending application.

Vision Series Data Mapping/ Comments "^~\&" <Sending Application> <Sending Facility> <Receiving Application> <Interface Engine Name for new customers> or <AMICAS RIS for existing customers>

Receiving Facility

180

HD

AMICAS, Inc. Proprietary and Confidential

25

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MSH Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments

Date/time of Message

26

TS

Current date/time <yyyymmddhhmmss>or Rejected if field is <yymmddhhmmssss>or empty or date/time is in <yyymmddhhmmssss> the incorrect format. or <yymmddhhmmss>

Security

40

ST Rejected if the value is not a defined message type (ORM^O01). If it is a define message type, then the BAR^P05 appropriate specification and logic will be applied to the message. Rejected if field is empty. Rejected if not P. Rejected if not 2.0, 2.1, 2.2 or 2.3. Unique Message Identifier P 2.3 HL7 version number

Message Type

CM

10 11 12 13 14 15 16 17 18 19 20

Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

O R R O O O O O O O O

R R R

20 3 60 15 180 2 2 2 16 60 20

ST PT ID NM ST ID ID ID ID CE ID

AL

3.3.3 EVN (Event Type Segment) BAR^P05


The following table lists each Event Type segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

EVNSeq 1

HL7 Field Name Event Type Code

Opt O

RIS Req

Length 3

Data Type ID

Rejection Rules

Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

26

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

EVNSeq

HL7 Field Name

Opt

RIS Req

Length

Data Type TS TS IS

Rejection Rules

Vision Series Data Mapping/ Comments Current Date/Time <yyyymmddhhmmss>

2 3 4

Recorded Date/Time Date/Time Planned Event Event Reason Code

O O O

26 26 3

Operator ID & Name 5 Operator ID O 250 XCN <User ID^User Name (FML)> Current Date/Time <yyyymmddhhmmss>

6 7

Event Occurred Event Facility

O O

26 241

TS HD

AMICAS, Inc. Proprietary and Confidential

27

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.3.4 PID (Patient Identification Definition Segment) BAR^P05


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PID segment per message. 1

Set ID - Patient ID

SI If the unique ID is not PMIS, this is rejected if the PID 2 and 3 fields are empty. If the unique ID is not PMIS and this field is empty, the data must be in the PID 2 field.

Patient ID (External ID)

20

CX

Patient Unique Identifier <Internal Patient ID Number> Patient Internal ID from RIS. PID 3.1. Patient Jacket Number Patient Name <last name^ first name^ middle name> Excess length will be truncated.

Patient ID (Internal ID)

20

CX

Alternate Patient ID Patient Name last name first name middle initial Mothers Maiden Name Date of Birth

20 90 total 30 30 30 48 R 26

CX

XPN

Rejected if field is empty or if suffix code does not match this field.

6 7

X O

XPN TS Rejected if field is empty and if not at least <yyyymmdd>. Rejected if the field is empty or if the gender code does not match this field. Patient DOB <yyyymmdd> Patient Gender <PMIS code only> (reference the RIS Gender support table) Patient Alias <Alias field> Patient Ethnicity <PMIS code only> (reference the RIS Ethnicity support table)

Sex

ST

Patient Alias

48

XPN

10

Race

IS

Rejected if the race code does not match this field.

AMICAS, Inc. Proprietary and Confidential

28

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Patient Address <address 1^ address 2^ city^ state (standard abbreviation only)^ zip (alphanumeric with no validation) Excess length will be truncated. Country does not update. Country Code <Country field> Patient Home Phone numeric only <area code and phone number> Patient Work Phone numeric only <area code and phone number>

11

Patient Address

151 total 60 40 40 2 9

XAD

12

County Code

IS

13

Phone Number - Home

12

XTN

14

Phone Number - Business

12

XTN

15

Language - Patient

60

CE Rejected if the martial status code does not match this field. Patient Marital Status <PMIS code only> (reference the RIS Marital Status support table)

16

Marital Status

IS

17 18

Religion Patient Account Number

X O C

3 20

IS CX If the PMIS is used as the Patient Unique unique ID, reject if blank Identifier and PID 3 must be NULL. <Patient File PMIS> Patient Social Security Number <#########> Numeric with no special characters. No validation is performed for length or duplicates.

19

SSN Number - Patient

16

ST

Rejected if not 9 sequential numbers.

20 21 22 23 24 25 26

Drivers License NumberPatient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship

X X X X X X X

25 20 3 60 2 2 4

CM CX IS ST ID NM IS

AMICAS, Inc. Proprietary and Confidential

29

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq 27 28 29 30

HL7 Field Name Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

Opt X X O O

RIS Req

Length 60 80 26 1

Data Type CE CE TS ID

Rejection Rules

Vision Series Data Mapping/ Comments

Reject if not at least <yyyymmdd>.

Patient Date of Death <yyyymmdd>

3.3.5 PV1 (Patient Visit Segment) BAR^P05


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

PV1 Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PV1 Segment per message. 1 Appointment Code, for example: O = Outpatient I = Inpatient <PMIS Code or Service Type> Patient location <point of care or nursing station>^<room>^<bed> All other PV1-3 sub components will be ignored. Displayed in RIS separated by a space colon ( :).

Set ID PV1

SI

Patient Class

IS

Reject if empty or the PMIS code does not match.

Assigned Patient Location

80

PL

4 5 6

Admission Type Pre-admit Number Prior Patient Location

O O O

2 20 80

IS CX PL

AMICAS, Inc. Proprietary and Confidential

30

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PV1 Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Attending (referring) Provider. A tilde (~) separates referring from any/all cc physicians. <Physician Location PMIS Code or Physician Location Unique Identifier^Last Name^First^Middle Name^Suffix^~PMIS^Last Name^First Name^Middle Name^Suffix> Referring (cc) Provider <Physician Location PMIS Code or Physician Location Unique Identifier ^Last Name^First^Middle Name^Suffix^~PMIS^Last Name^First Name^Middle Name^Suffix> Consulting (cc) Provider <Physician Location PMIS Code or Physician Location Unique Identifier ^Last Name^First^ Middle Name^Suffix^ ~PMIS^Last Name^ First Name^Middle Name^Suffix>

Attending Doctor

60

XCN

Reject if empty or PMIS code does not match.

Referring Doctor

60

XCN

Consulting Doctor

60

XCN

10 11 12 13 14 15 16 17 18

Hospital Service Temporary Location Preadmit Test Indicator Readmission Indicator Admit Source Ambulatory Status VIP Indicator Admitting doctor Patient Type

O O O O O O O O O

3 80 2 2 3 2 2 60 2

IS PL IS IS IS IS IS XCN IS Service Type <PMIS Code for Service Type Code> Visit Number will populate the Order Number field. Pregnancy Indicator <B6 if flag Y else other>

19 20 21 22

Visit Number Financial Class Charge Price Indicator Courtesy Code

O O O O

20 50 2 2

CX CM IS IS

AMICAS, Inc. Proprietary and Confidential

31

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PV1 Seq 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

HL7 Field Name Credit Rating Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount Bad Debt Recovery Amount Delete Account Indicator Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status Pending Location Prior Temporary Location Admit Date/Time Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

Opt O O O O O O R O O R O O O O O O O B O O O O O O O O O O O O

Req by RIS

Length 2 2 8 12 3 2 1 8 10 12 12 1 8 3 25 80 2 1 2 80 80 26 26 12 12 12 12 20 1 60

Data Type IS IS DT NM NM IS IS DT IS NM NM IS DT IS CM IS IS IS IS PL PL TS TS NM NM NM NM CX IS XCN

Rejection Rules

Vision Series Data Mapping/ Comments

Collection Indicator <Y> or <N>

Collection Balance

Admit Date <yyyymmdd> Discharge Date <yyyymmdd> Patient Account Balance

Patient Weight <Patient Weight>

AMICAS, Inc. Proprietary and Confidential

32

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.4 MFN - Master File Update Message Type


3.4.1 Message Definition
In an open-architecture healthcare environment there is often a set of common reference files used by one or more application systems. These files are called master files. Some common examples of master files in the healthcare environment include: staff and health practitioner master file system user (and password) master file location (census and clinic) master file device type and location (e.g., workstations, terminals, printers, etc.) lab test definition file exam code (radiology) definition file charge master file patient status master patient type master service item master file

These common reference files need to be synchronized across the various applications at a given site. The Master Files Notification (MFN) message provides a way of maintaining this synchronization by specifying a standard for the transmission of this data between applications. In many implementations, one application system will "own" a particular master file such as the staff and practitioner master file. The changes (e.g., adds, deletes, updates) to this file are made available to various other applications on a routine basis. The MFN message supports this common case, but also supports the situation where an application not "owning" a particular master file, transmits update information to other systems (usually to the "owning" system), for review and possible inclusion. The MFN message supports the distribution of changes to various master files between systems in either online or batch modes, and allows the use of either original or enhanced acknowledgment modes, as well as providing for a delayed application acknowledgment mode. These messages use the MSH segment to pass the basic event code (master files notification or acknowledgment). The Master File Identification (MFI) segment identifies the master file being updated as well as the initial and requested dates for file-level events (such as replace file). For each record being changed, the Master File Entry (MFE) segment carries the record-level event code (such as add, update, etc.), the initial and requested dates for the event, and the recordlevel key identifying the entry in the master file. The Master File Acknowledgment (MFA) segment returns record-specific acknowledgment information. The following table lists each supported message segment and their description:
Message Segment MSH MFI MFE ZL7 Segment Description Message Header Master File Identification Master File Entry Insurance Data to Post

See the Glossary for definitions of each interface.

AMICAS, Inc. Proprietary and Confidential

33

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.4.2 MSH (Message Header Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSH Seq 1 2 3 4 5

HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application

Opt R R O O O

Req by RIS R R R

Length 1 4 180 180 180

Data Type ST ST HD HD HD

Rejection Rules Must always be pipe "|". Must always be "^~\&". Rejected if not acceptable sending application. "|"

Vision Series Data Mapping/ Comments "^~\&" <Sending Application> <Sending Facility> <Receiving Application> <Interface Engine Name for new customers> or <AMICAS RIS for existing customers> Current date/time <yyyymmddhhmmss>or <yymmddhhmmssss>or <yyymmddhhmmssss> or <yymmddhhmmss>

Receiving Facility

180

HD

Date/time of Message

26

TS

Rejected if field is empty or date/time is in the incorrect format.

Security

40

ST Rejected if the value is not a defined message type (ORM^O01). If it is a define message type, then the appropriate specification and logic will be applied to the message. Rejected if field is empty.

Message Type

CM

MFN

10 11 12 13 14 15 16

Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type

O R R O O O O

R R R

20 3 60 15 180 2 2

ST PT ID NM ST ID ID

Unique Message Identifier

Rejected if not P or T. P or T Rejected if not 2.0, 2.1, 2.2 or 2.3. 2.3 HL7 version number

AMICAS, Inc. Proprietary and Confidential

34

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MSH Seq 17 18 19 20

HL7 Field Name Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

Opt O O O O

Req by RIS

Length 2 16 60 20

Data Type ID ID CE ID

Rejection Rules

Vision Series Data Mapping/ Comments

3.4.3 MFI (Message File Identification Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MFI Seq HL7 Field Name Opt Req by RIS Length Data Type Rejection Rules Vision Series Data Mapping/ Comments INS <INS^Insurance Master File> Note: See HL7 Table: Master File Identifier Codes.

Message File Identifier

250

CE

2 3 4 5 6

Master File Application Identifier File-Level Event Code Entered Date/Time Effective Date/Time Response Level Code

O R O O R

180 3 26 26 2

HD ID TS TS ID UPD <yyyymmddhhmmss> <yyyymmddhhmmss> AL Always sends an ACK.

a.

HL7 Table: Master File Identifier Codes


Value CDM CLN CMA CMB Description Charge Description Master File Clinic Master File Clinical Study with Phases and Scheduled Master File Clinical Study without Phases but with Scheduled Master File Procedure Master File Comment

CPT

AMICAS, Inc. Proprietary and Confidential

35

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

Value DEP DXC INS INV LOC MOD OMA OMB OMC OMD OME PHY PRA STF ZIP

Description Procedure Category Code Master File Diagnosis Code Master Record Insurance Master File Inventory Master File Location Master file CPT Code Modifier Master File Numerical Observation Master File Categorical Observation Master File Observation Batteries Master File Calculated Observations Master File Other Observation/Service Item Master File Physician Master File Practitioner Master File Staff Master File Zip Code Master File

Comment

AMICAS currently updates this file.

3.4.4 MFE (Message File Entry Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MFE Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments MAD, MDL, MUP, MDC,MAC Note: See HL7 Table: Actions Performed on Master Files. <yyyymmddhhmmss> <yyyymmddhhmmss>

Record-Level Event Code

ID

2 3

MFN Control ID Effective Date/Time

C O

20 26

ST TS

AMICAS, Inc. Proprietary and Confidential

36

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MFE Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments <Identifier -Location PMIS> This is the search key for the PMIS Code depending upon the support table. DX and ZIP use Code all others use the PMIS Code.

Primary Key Value MFE

200

Varies

a.

HL7 Table: Actions Performed on Master Files


Value MAD MDL MUP MDC Description Add the record to the master file. Delete the record from the master file. Update the record for the master file. Deactivate. Discontinue using the record in the master file, but do not delete it from the database. Reactivate the deactivated record.

MAC

3.4.5 ZL7 (Insurance Data to Post Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MFN Seq HL7 Field Name Opt Req by Length RIS Data Type Rejection Rules Vision Series Data Mapping/ Comments Location <PMIS^Name^ Address1& Address2&City& State& ZipCode^Phone&&&Email&&&fax^ Contact^^Plan Insurance Type Code^^^>

Location

400

CE

AMICAS, Inc. Proprietary and Confidential

37

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.5 ORM^O01 Order Message Type


3.5.1 Message Definition
Per HL7, the function of this message is to initiate the transmission of information about an order. This includes placing new orders, canceling existing orders, discontinuing orders, holding orders, etc. The trigger event for this message is any change to an order. Such changes include submission of new orders, cancellations, updates, patient and non-patient specific orders, etc. The following table lists each supported message segment and their description:
Message Segment MSH PID PVI NTE ORC OBR OBX Segment Description Message Header Patient Identification Patient Visit Notes Common Order Observation Request Observation Result

See the Glossary for definitions of each interface.

3.5.2 MSH (Message Header Segment) ORM^O01


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSH Seq 1 2 3 4 5

HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application

Opt R R O O O

Req by RIS R R R

Length 1 4 180 180 180

Data Type ST ST HD HD HD

Rejection Rules Must always be pipe "|". "|" Must always be "^~\&". Rejected if not acceptable sending application.

Vision Series Data Mapping/ Comments "^~\&" <Sending Application> <Sending Facility> <Receiving Application> <Interface Engine Name for new customers> or <AMICAS RIS for existing customers>

Receiving Facility

180

HD

AMICAS, Inc. Proprietary and Confidential

38

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MSH Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments

Date/time of Message

26

TS

Current date/time <yyyymmddhhmmss>or Rejected if field is <yymmddhhmmssss>or empty or date/time is in <yyymmddhhmmssss> the incorrect format. or <yymmddhhmmss>

Security

40

ST Rejected if the value is not a defined message type (ORM^O01). If it is a define message type, then the ORM^O01 appropriate specification and logic will be applied to the message. Rejected if field is empty. Rejected if not P or T. Rejected if not 2.0, 2.1, 2.2 or 2.3. Unique Message Identifier P or T 2.3 HL7 version number

Message Type

13

CM

10 11 12 13 14 15 16 17 18 19 20

Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

R R R O O O O O O O O

R R R

20 3 60 15 180 2 2 2 16 60 20

ST PT ID NM ST ID ID ID ID CE ID

3.5.3 PID (Patient Identification Definition Segment) - ORM^O01


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

AMICAS, Inc. Proprietary and Confidential

39

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules Rejected if not empty or 1. MSA1 = [ACK Code], MSA6 = [Field] [Field Name] [error]

Vision Series Data Mapping/ Comments One PID segment per message. 1

Set ID - Patient ID

SI

Patient ID (External ID)

20

CX Reject if empty. MSA1 = [ACK Code], MSA6 = [Field] [Field Name] [error] Reject if not formatted correctly. MSA1 = [ACK Code], MSA6 = [Field] [Field Name] [error] Reject if empty, not formatted correctly or the suffix code does not match. MSA1 = [ACK Code], MSA6 = [Field] [Field Name] [error] Patient Identifier Number <Patient Identifier Number>

Patient Identifier List

250

CX

Alternate Patient ID - PID

20

CX

Patient Name last name first name middle name suffix prefix Mothers Maiden Name Date/Time of Birth

250

XPN

<last name^first name^ middle name^suffix^prefix>

6 7

O O R

48 26

XPN TS Rejected if field is empty and if not formatted correctly. Rejected if the gender code does not match. Patient DOB <yyyy^mm^dd> or <yyyymmdd> Patient Gender <PMIS code only> (reference the Gender support table) Patient Alias <Alias field> Patient Ethnicity Rejected if the ethnicity <PMIS code only> code does not match this (reference the RIS field. Ethnicity support table) Patient Address <address 1^ address 2^ city^ state (standard abbreviation only)^ zip (alphanumeric with no validation) Excess length will be truncated. Country does not update.

Administrative Sex

ST

Patient Alias

48

XPN

10

Race

250

IS

11

Patient Address

250

XAD

AMICAS, Inc. Proprietary and Confidential

40

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq 12

HL7 Field Name

Opt

Req by RIS

Length

Data Type IS

Rejection Rules

Vision Series Data Mapping/ Comments Country Code <Country field> <home phone number^fax number^^email address> Patient Work Phone numeric only <area code and phone number>

County Code

13

Phone Number - Home

250

XTN

14

Phone Number - Business

250

XTN

15

Language - Patient

60

CE Patient Marital Status <PMIS code> or <Jacket Number> or <SSN> (reference the RIS Marital Status support table)

16

Marital Status

250

IS

Rejected if the marital status code does not match this field.

17

Religion

IS Patient Unique Identifier <Patient File PMIS> or <Jacket Number> or <SSN> This field is required if the interface is configured to use the patient PMIS number as the unique identifier. If the PMIS is used as the unique ID, then PID_3 Jacket Number must be NULL on the inbound message. The patient PMIS must be unique to all patients, guarantors and insureds. Alphanumeric. Patient Social Security Number <nnnnnnnnn> or <nnn-nnn-nnn> Numeric with no special characters. No validation is performed for length or duplicates.

18

Patient Account Number

250

CX

Rejected if not formatted correctly. MSA1 = [ACK Code], MSA6 = [Field] [Field Name] [error]

19

SSN Number - Patient

16

ST

Rejected if formatted correctly. MSA1 = [ACK Code], MSA6 = [Field] [Field Name] [error]

AMICAS, Inc. Proprietary and Confidential

41

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq 20 21 22 23 24 25 26 27 28

HL7 Field Name Drivers License NumberPatient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality

Opt O O O O O O O O O

Req by RIS

Length 25 20 3 60 2 2 4 60 80

Data Type CM CX IS ST ID NM IS CE CE

Rejection Rules

Vision Series Data Mapping/ Comments

29

Patient Death Date/Time

26

TS

Patient Death Date and Time <yyyy^mm^dd> or <yyyymmdd>

30

Patient Death Indicator

ID

3.5.4 PV1 (Patient Visit Segment) ORM^O01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS. If the PV1 segment is missing, the value in OBR.16 will be used for the referring physician.

PV1 Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PV1 Segment per message. 1 Patient type, for example: E = Emergency Room O = Outpatient I = Inpatient If PV1 is not included, then Global Service Type will be selected by default.

Set ID PV1

SI

Patient Class

IS

Reject if empty or the PMIS code does not match.

AMICAS, Inc. Proprietary and Confidential

42

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PV1 Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Patient location <point of care or nursing station>^<room>^<bed> All other PV1-3 sub components will be ignored. Displayed in RIS separated by a space colon ( :).

Assigned Patient Location

80

PL

4 5 6

Admission Type Pre-admit Number Prior Patient Location

O O O

2 20 80

IS CX PL Reject if the PMIS or Last Name empty. The first name is also required if RIS creates the physician record from the message. Physician matching will occur only on PMIS.

Attending Doctor

60

XCN

Attending (referring) Provider. A Tilde (~) separates reffering from any/all cc physicians. <Physician Location If the PV1 segment has PMIS Code or a value for PV1.7 and Physician Location PV1.8, PV1.7 will be Unique Identifier ^Last used as the referring Name^First^ physician and PV1.8 will Middle Name^Suffix^ be used as the CC ~PMIS^Last Name^ physician. If the PV1 First Name^Middle segment is not found Name^Suffix> then the value in OBR16 will be used as the referring physician. Reject if the PMIS or Last Name empty. The first name is also required if RIS creates the physician record from the message. Physician Referring (cc) Provider matching will occur only <Physician Location on PMIS. PMIS Code or Physician Location If the PV1 segment has a Unique Identifier ^Last Name^First^ value for PV1.7 and Middle Name^Suffix^ PV1.8, PV1.7 will be ~PMIS^Last Name^ used as the referring physician and PV1.8 will First Name^Middle Name^Suffix> be used as the CC physician. If the PV1 segment is not found then the value in OBR16 will be used as the referring physician.

Referring Doctor

60

XCN

AMICAS, Inc. Proprietary and Confidential

43

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PV1 Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules Reject if the PMIS or Last Name is empty. The first name is also required if RIS creates the physician record from the message. Physician matching will occur only on PMIS. PV1-9 will be used as the CC physician.

Vision Series Data Mapping/ Comments Consulting (cc) Provider <Physician Location PMIS Code or Physician Location Unique Identifier ^Last Name^First^ Middle Name^Suffix^ ~PMIS^Last Name^ First Name^Middle Name^Suffix>

Consulting Doctor

60

XCN

10 11 12 13 14 15

Hospital Service Temporary Location Preadmit Test Indicator Readmission Indicator Admit Source Ambulatory Status

O O O O O O

3 80 2 2 3 2

IS PL IS IS IS IS Reject if empty or PMIS code does not match last name. Service Type <PMIS Code for Service Type Code> Visit Number will populate the Order Number field. Pregnancy Indicator <B6 if flag Y else other>

16 17 18

VIP Indicator Admitting doctor Patient Type

O O O

2 60 2

IS XCN IS

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

Visit Number Financial Class Charge Price Indicator Courtesy Code Credit Rating Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount Bad Debt Recovery Amount Delete Account Indicator

O O O O O O O O O O O O O O O O

20 50 2 2 2 2 8 12 3 2 1 8 10 12 12 1

CX CM IS IS IS IS DT NM NM IS IS DT IS NM NM IS

AMICAS, Inc. Proprietary and Confidential

44

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PV1 Seq 35 36 37 38 39 40 41

HL7 Field Name Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status

Opt O O O O O B O

Req by RIS

Length 8 3 25 2 2 1 2

Data Type DT IS CM IS IS IS IS

Rejection Rules

Vision Series Data Mapping/ Comments

42

Pending Location

80

PL

Rejected if empty and schedule directly is selected and always schedule to is empty.

Location to schedule the exam. <^^^code ^^^^^ description>

43 44 45 46 47 48 49 50 51 52

Prior Temporary Location Admit Date/Time Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

O O O O O O O O O O

80 26 26 12 12 12 12 20 1 60

PL TS TS NM NM NM NM CX IS XCN Patient Weight <Patient Weight> Admit Date <yyyymmdd> Discharge Date <yyyymmdd>

3.5.5 NTE (Notes and Comments Segment) ORM^O01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

NTE Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PV1 Segment per message. 1 <comment text> NTE following the PID will be a Patient comment.

Set ID OBR

SI

Comment

64k

FT

AMICAS, Inc. Proprietary and Confidential

45

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.5.6 ORC (Common Order Segment) - ORM^O01


The following table lists each Common Order segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
ORC Seq HL7 Field Name Opt Req by RIS Length Data Type Rejection Rules Vision Series Data Mapping/ Comments NW = New Order CA = Cancel Order XO = Change/ Update Order DC = Canceled Order (discontinued) HD = Hold Order IP = In Process Order SC = Scheduled Order RL = Release Hold Order RP = Order Replace 2 Placer Order Number C 16 EI Accession Number <Accession Number> Accession Number <Accession Number>

Order Control

ID

Rejected if not a valid code.

3 4

Filler Order Number Placer Group Number

C O

16 22

EI EI

Blank if New Order 5 Order Status O 2 ID CM if Order sent at Tech End CA if Cancel Order XO if Change Order 6 Response Flag Quantity/Timing quantity interval duration start date/time end date/time Priority condition text conjunction order sequencing Parent Date/Time of Transaction O 1 ID

Scheduled Exam Date/Time O 200 TQ <^^^yyyymmddhhmm^ ^s> if urgent or <R> if not urgent

8 9

O O

200 26

CM TS Current Date/Time <yyyymmddhhmmss>

AMICAS, Inc. Proprietary and Confidential

46

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

ORC Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments User ID & Name <User ID^Last Name^First Name^^>

10

Entered By

250

XCN

Do not store in our database. This is for information purposes only.

The following table lists the valid ORC-1 / 5 pairs and what happens to the message:
ORC-1 / ORC-5 RIS Visit Status ORM^001 Messages: NW / blank Order or Scheduled if schedule directly is selected NW / SC NW / IP NW / CM Scheduled Check in Check out RIS Exam Status Comments

Order or Scheduled if schedule directly is selected Scheduled Check in Ended Schedules in the first available resource, if no openings, it will force the appointment to a resource. Schedules in the first available resource, if no openings, it will force the appointment to a resource. Always force the appointment - this will not show in the appointment book since the procedure was not performed at the location.

SC / blank

SC / SC SC / IP SC / CM

Order or Scheduled if schedule directly is selected Scheduled Check in Check out

Order or Scheduled if schedule directly is selected Scheduled Check in Ended Schedules in the first available resource, if no openings, it will force the appointment to a resource. Schedules in the first available resource, if no openings, it will force the appointment to a resource. Always force the appointment this will not show in the appointment book since the procedure was not performed at the location

If no NW or SC is received to create the order, all message types below are rejected CA / CA CA / DC Cancel Cancel Whatever the status is Whatever the status is Whatever the status is Whatever the status is Whatever the status is Whatever the status is Whatever the status is Whatever the status is See comments Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached Can cancel all orders and appointments unless there is a report attached This will only update orders that are configured to automatically

DC / DC DC / CA

Cancel Cancel

OC / CA OC / DC

Cancel Cancel

OD / CA OD / DC

Cancel Cancel

XO / XO

See comments

AMICAS, Inc. Proprietary and Confidential

47

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

ORC-1 / ORC-5

RIS Visit Status

RIS Exam Status

Comments schedule, if order is at the status of schedule, then sending an XO/XO will take it to the next step which will be checkin, then if we continue sending this status, the order will move through the RIS workflow, Inprocess, checkout This will only update orders that are configured to automatically schedule, order must be at a schedule status, sending this will move it to checkin This will only update orders that are configured to automatically schedule, order must be at either schedule, checkin or inProcess, this will take the order to a checkout status See XO/XO See XO/IP See XO/CM only supported for orders that have not been scheduled; otherwise NACK with error message order must be canceled, this message will be seen in the monitor, since we do not process HL7 messages in advanced mode only supported for orders that have not been scheduled; otherwise NACK with error message order must be canceled this message will be seen in the monitor, since we do not process HL7 messages in advanced mode Release an order on hold in the work queue

XO / IP

Check in

Check in

XO / CM

Check out

Ended

XX / XO XX / IP XX / CM OH / HD

See comments Check in Check out Order hold

See comments Check in Ended Order

HD / HD

Order hold

Order

RL / ORC-5 ignored OE / ORC-5 ignored

Order

Hold Order

Order

Hold Order

Release an order on hold in the work queue

ORR^002 Message: NA / ORC-5 Any status ignored

Any status

The only reason for this message is to add the Order Number. And patient account number Logic: An order created in RIS will send an ORM^001 with ORC-1 = SN, OBR2 is blank, and OBR-3 = accession #. HIS will return an ORR^O02 with ORC-1 = NA, OBR-2 has order number and OBR.3 will have the RIS accession number

3.5.7 OBR (Observation Request Segment) ORM^O01


The following table lists each Observation Request segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

OBR Seq 1

HL7 Field Name Set ID Observation Request

Opt

Req by RIS

Length

Data Type SI

Rejection Rules

Vision Series Data Mapping/ Comments Sequence number for one or more OBR Segments per message.

AMICAS, Inc. Proprietary and Confidential

48

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBR Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments <order number from the external system> A value that uniquely identifies the procedure to the host system for this patient.

Placer Order Number

22

EI

Rejected if field is empty or code does not match.

Filler Order Number

22

EI <exam being ordered or canceled> Optionally, this can be followed by two carets (^^) to include a modifier. 4.1 = Code 4.2 = Description 4.3 = Modifier

Universal Service ID identifier text

250

CE

Rejected if field is empty or code does not match.

5 6

Priority Requested Date/Time

B B O

2 26

ID TS Date/time the order was started. <yyyymmddhhmmss> or <yyyy^mm^dd^hh^mm^ss>

Observation Date/Time

26

TS

Rejected if not formatted correctly.

8 9 10 11 12 13 14

Obs End Date/Time Collection Volume Collector Identifier Specimen Action Code Danger Code Relevant Clinical Info. Specimen Rec'd Date/Time Specimen Source Source Code Additives Source Description Body Site

O O O O O O C

26 20 60 1 60 300 26

TS CQ XCN ID CE ST TS

15

300

CM

AMICAS, Inc. Proprietary and Confidential

49

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBR Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules Reject if the PMIS or Last Name empty. The first name is also required if RIS creates the physician record from the message. Physician matching will occur only on PMIS.

Vision Series Data Mapping/ Comments Ordering (referring) provider. Tilde (~) separates referring from any or all CC physicians. <Physician Location PMIS Code or Physician Location Unique Identifier

16

Ordering Provider

250

XCN

^ Last Name ^ First Name ^ Middle Name ^ Suffix ^ If the PV1 segment has a value for PV1.7 and PMIS ^ Last Name ^ First Name ^ Middle Name ^ PV1.8, PV1.7 will be Suffix ^> used as the referring physician and PV1.8 will be used as the CC physician. If the PV1 segment is not found then the value in OBR-16 will be used as the referring physician.

17

Order Callback Phone No. Placer Field 1 Placer Field 2 Filler Field 1 Filler Field 2 Result Rpt/Status Change - Date/Time Charge To Practice

40

XTN A definable field that the placing (ordering) system can use.

18 19 20 21

O O O O

60 60 60 60

ST ST ST ST Rejected if not formatted correctly.

A definable field that the filling (RIS) system can use.

22

26

TS

Date/time of order or status change. <yyyymmddhhmmss> or <yyyy^mm^dd^hh^mm^ss>

23

40

CM

AMICAS, Inc. Proprietary and Confidential

50

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBR Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Schedule Resource <Resource Category Code> Note: If OBR-24 does

24

Diagnostic Serv Sect ID

10

ID

not match an active resource for the provided exam, the exam will be scheduled in the first available resource during the given appt time or it will be forced into the timeslot on the appointment book if the given time is not available.
Rejected if not P, F or A. P for Preliminary F for Final A for Addendum

25 26

Result Status Parent Result

C O

1 400

ID CM

27

Quantity/Timing

200

TQ

Can identify quantity of this exam to be ordered, start and end date/time and priority. <quantity ^ ^ ^ start_date/time ^ end_date/time ^ priority> Priority = S (STAT) or A (ASAP) will se the urgent flag otherwise normal priority. R (Routine).

28 29 30

Result Copies To Parent Number Transportation Mode

O O O C

150 200 20

XCN CM ID <reason code ^ reason text> If code, then try to match. If not match, use the reason text in the Other Reason field. Note that, in a multiple OBR segment, only one appointment reason is allowed per order. Reading Radiologist <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix> Dictated Date and Time <^^yyyymmddhhmmss>

31

Reason For Study

250

CE

Reject if empty or if schedule directly is selected and always schedule to is empty.

32

Principal Result Interpreter Assistant Result Interpreter

200

CM

Reject if empty or if PMIS codes does not match.

33

200

CM

AMICAS, Inc. Proprietary and Confidential

51

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBR Seq 34

HL7 Field Name Technician

Opt O

Req by RIS

Length 200

Data Type CM

Rejection Rules

Vision Series Data Mapping/ Comments Transcriptionist ID <PMIS Code or Unique ID^Last Name^First name^Middle^Suffix>

35

Transcriptionist

200

CM

36

Scheduled Date/Time

26

TS

Reject if not formatted correctly.

Schedule date/time of the exam. <yyyymmddhhmmss> or <yyyy^mm^dd^hh^mm^ss>

37 38 39 40 41 42 43 44 45

Number of Sample Containers Transport Logistics of Collected Samples Collectors Comment Transport Arrangement Responsibility Transport Arranged Escort Required Planned Patient Transport Comment Procedure Code Procedure Code Modifier

O O O O O O O O O

4 60 200 60 30 1 200 80 80

NM CE CE CE ID ID CE CE CE

3.5.8 OBX (Observation Result Segment) - ORM^O01


The following table lists each Observation/Result segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

OBX Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Sequence number for one or more OBX segments per message.

Set ID OBR

SI

Value Type

ID Treated as a lead in to an order comment. Likely to be combined with OBX 5.

Observation Identifier

80

CE

Observation Sub-ID

20

ST

AMICAS, Inc. Proprietary and Confidential

52

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBX Seq

HL7 Field Name

Opt

Req by RIS

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Treated as an order comment. If OBX-3 is sent, will concatenate with OBX-3.

Observation Value

4k

6 7 8 9 10 11 12 13 14 15 16 17

Units References Range Abnormal Flags Probability Nature of Abnormal Test Observation Result Status Date Of Last Obs Normal Values User Defined Access Checks Date-Time of the Observation Producers ID Responsible Observer Observation Method

O O O O O R O O O O O O C R

60 60 5 5 2 1 26 20 26 60 80 60

CE ST ID NM ID ID TS ST TS CE XCN CE

3.6 ORR^O02 - General Order Acknowledgment Message Type


3.6.1 Message Definition
The function of this message is to respond to an ORM message. An ORR message is the application acknowledgment to an ORM message. In ORR the PID and ORC segments are optional, particularly in case of an error response. However, ORC segments are always required in ORR when an order detail segment is present. For example, a response ORR might include only the MSH and MSA. The following table lists each supported message segment and their description:
Message Segment MSA MSH ORC PID Segment Description Message Acknowledgment Message Header Common Order Patient Identification

See the Glossary for definitions of each interface.

AMICAS, Inc. Proprietary and Confidential

53

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.6.2 MSA (Message Acknowledgment Segment) ORR^O02


The following table lists each Observation/Result segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MSA Seq HL7 Field Name Opt RIS Req Length Data Type Rejection Rules If the code is not AA then no updates will occur. Vision Series Data Mapping/ Comments AA if Accepted AE if Error AR if Rejected If the code is equal to AE or AR then the reason for its failure will be in this field

Acknowledgment Code

ID

Text Message

80

ST

3.6.3 MSH (Message Header Segment) - ORR^O02


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSH Seq 1 2

HL7 Field Name Field Separator Encoding Characters

Opt R R

Req by Length RIS R R 1 4

Data Type ST ST

Rejection Rules Must always be pipe "|". Must always be "^~\&". Rejected if not acceptable sending application. "|"

Vision Series Data Mapping/ Comments

"^~\&"

3 4 5

Sending Application Sending Facility Receiving Application

O O O

180 180 180

HD HD HD

<Sending Application> <Sending Facility> <Receiving Application> <Interface Engine Name for new customers> or <AMICAS RIS for existing customers>

Receiving Facility

180

HD

AMICAS, Inc. Proprietary and Confidential

54

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MSH Seq

HL7 Field Name

Opt

Req by Length RIS

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Current date/time <yyyymmddhhmmss>or <yymmddhhmmssss>or <yyymmddhhmmssss> or <yymmddhhmmss>

Date/time of Message

26

TS

Rejected if field is empty or date/time is in the incorrect format.

Security

40

ST Rejected if the value is not a defined message type (ORM^O01). If it is a define message type, ORM^O01 then the appropriate specification and logic will be applied to the message. Rejected if field is empty. Rejected if not P or T. Rejected if not 2.0, 2.1, 2.2 or 2.3. Unique Message Identifier P or T 2.3 HL7 version number

Message Type

13

CM

10 11 12 13 14 15 16 17 18 19 20

Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

R R R O O O O O O O O

R R R

20 3 60 15 180 2 2 2 16 60 20

ST PT ID NM ST ID ID ID ID CE ID

3.6.4 ORC (Common Order Segment) - ORR^O02


The following table lists each Common Order segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
ORC Seq HL7 Field Name Opt Req by RIS Length Data Type Rejection Rules Vision Series Data Mapping/ Comments Trigger event identifier for orders. NA =Number Assigned

Order Control

ID

Rejected if not a valid code. NA is the only valid code.

AMICAS, Inc. Proprietary and Confidential

55

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

ORC Seq 2 3

HL7 Field Name

Opt

Req by RIS R R

Length

Data Type EI EI

Rejection Rules

Vision Series Data Mapping/ Comments Order number from placer. Accession number.

Placer Order Number Filler Order Number

C C

22 16

Rejected if empty. Rejected if empty.

3.6.5 PID (Patient Identification Definition Segment) ORR^O02


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
PID Seq 3 5 18 HL7 Field Name Opt RIS Req Length Data Type CX XPN CX Rejected if empty. Rejection Rules Vision Series Data Mapping/ Comments Patient Internal ID. The Patient MRN, Jacket, etc Patient Name. Patient Account Number.

Patient ID (Internal ID) Patient Name Patient Account Number

R R O R

22 90 22

3.7 ORU^R01 - Results Message Type


3.7.1 Message Definition
Vision Series RIS will receive the patient message event type ORU^R01 which will create or update patient reports. The AMICAS interface will be a one-way (unidirectional) data transfer. Message received shall conform to the Health Level Seven (HL7) Standard, version 2.3 for electronic data exchange. The following table lists each supported message segment and their description:
Message Segment MSH PID OBR OBX Segment Description Message Header Patient Identification Observation Request Observation/Result

See the Glossary for definitions of each interface.

AMICAS, Inc. Proprietary and Confidential

56

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.7.2 MSH (Message Header Segment) - ORU^R01


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSH Seq 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

Opt R R O O O O O O R R R R O O O O O O O O

RIS Req

Length 1 4

Data Type ST ST HD HD HD HD TS ST CM ST PT ID NM ST ID ID ID ID CE ID

Rejection Rules

Vision Series Data Mapping/ Comments "|" "^~\&"

180 180

Rejected if field is empty.

<Sending Application> <Sending Facility>

180 180

Rejected if field is empty.

<Receiving Application>

26 40

Rejected if field is empty.

Current date/time <yyyymmddhhmmss>

R R

7 20 3 60 15 180 2 2 2 16 60 20

Rejected if field is empty. Rejected if field is empty.

ORU^R01 Unique Message Identifier P 2.3 HL7 version number

AMICAS, Inc. Proprietary and Confidential

57

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.7.3 PID (Patient Identification Definition Segment) - ORU^R01


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments One PID segment per message. 1

1 2

Set ID - Patient ID Patient ID (External ID)

O B

4 20

SI CX Rejected if PID 3 does not match this field. If this field is empty then refer to PID 2. If PID 2 is empty or does not match, then reject.

Patient ID (Internal ID)

20

CX

Patient Identifier Number <Patient Identifier Number>

Alternate Patient ID Patient Name last name first name middle initial Mothers Maiden Name Date of Birth

20

CX <last name^first name^ middle name>

48

XPN

6 7

O O R

48 26

XPN TS Rejected if field is empty Patient DOB and if not at least <yyyymmdd> <yyyymmdd>. Rejected if the field is empty or if the gender code does not match this field. Patient Gender <PMIS code only> (reference the RIS Gender support table) Patient Alias <Alias field> Rejected if the race code does not match this field. Patient Ethnicity <PMIS code only> (reference the RIS Ethnicity support table) Patient Address <address 1^ address 2^ city^ state (standard abbreviation only)^ zip (alphanumeric with no validation)>

Sex

ST

Patient Alias

48

XPN

10

Race

IS

11

Patient Address

151 60 40 40 2 9

XAD

AMICAS, Inc. Proprietary and Confidential

58

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Excess length will be truncated. Country does not update.

12

County Code

IS

Country Code <Country field> Patient Home Phone numeric only <area code and phone number> Patient Work Phone numeric only <area code and phone number>

13

Phone Number - Home

12

XTN

14

Phone Number Business Language - Patient

12

XTN

15

60

CE Patient Marital Status <PMIS code only> (reference the RIS Marital Status support table)

16

Marital Status

IS

Rejected if the martial status code does not match this field.

17

Religion

IS Patient Unique Identifier <Patient File PMIS> This field is required if the interface is configured to use the patient PMIS number as the unique identifier. If the PMIS is used as the unique ID, then PID_3 Jacket Number must be NULL on the inbound message. The patient PMIS must be unique to all patients, guarantors and insureds. Alphanumeric. Patient Social Security Number <#########> Numeric with no special characters. No validation is performed for length or duplicates.

18

Patient Account Number

20

CX

If the PMIS is used as the unique ID, reject if blank and PID 3 must be NULL.

19

SSN Number - Patient

16

ST

Rejected if not 9 sequential numbers.

AMICAS, Inc. Proprietary and Confidential

59

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

PID Seq 20 21 22 23 24 25 26 27 28 29 30

HL7 Field Name Drivers License NumberPatient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

Opt O O O O O O O O O O O

RIS Req

Length 25 20 3 60 2 2 4 60 80 26 1

Data Type CM CX IS ST ID NM IS CE CE TS ID

Rejection Rules

Vision Series Data Mapping/ Comments

Reject if not at least <yyyymmdd>.

Patient Date of Death <yyyymmdd>

3.7.4 OBR (Observation Request Segment) - ORU^R01


The following table lists each Observation Request segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

OBR Seq 1

HL7 Field Name Set ID Observation Request Placer Order Number Filler Order Number Universal Service ID identifier text Priority Requested Date/Time Observation Date/Time Obs End Date/Time Collection Volume Collector Identifier Specimen Action Code

Opt

RIS Req

Length

Data Type SI

Rejection Rules

Vision Series Data Mapping/ Comments Sequence number for one or more OBR Segments per Message

2 3 4 5 6 7 8 9 10 11

C C R B B C O O O O

16 22 200 2 26 26 26 20 60 1

EI EI CE ID TS TS TS CQ XCN ID

Rejected if field is empty or does not match.

Accession Number <Accession Number>

AMICAS, Inc. Proprietary and Confidential

60

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBR Seq 12

HL7 Field Name Danger Code

Opt O

RIS Req

Length 60

Data Type CE

Rejection Rules

Vision Series Data Mapping/ Comments

13

Relevant Clinical Info.

300

ST

Updates information for mammography procedures. The assessment, biopsy If 13.1 has a value and recall flags are set then 13.3 is for the patient's required and the mammography message will be procedure(s) rejected. If 13.2 is associated with the not populated it will report. default to N. Bi-rad PMIS^ N (New) C (Compare Film) F (Need Film)^ Recall PMIS code If an invalid date is applied, the current date will serve as the approval date. Approval Date <yyyymmdd>

14

Specimen Rec'd Date/Time Specimen Source Source Code Additives Source Description Body Site

26

TS

15

300

CM

Ordering (referring) provider. Tilde (~) separates referring from any or all CC physicians. Ordering Provider physician ID family name given name middle initial or name <Physician Location PMIS Code or Physician Location Unique Identifier ^ Last Name ^ First Name ^ Middle Name ^ Suffix ^ - PMIS ^ Last Name ^ First Name ^ Middle Name ^ Suffix ^>

16

80

XCN

17 18 19 20 21 22 23

Order Callback Phone No. Placer Field 1 Placer Field 2 Filler Field 1 Filler Field 2 Result Rpt/Status Change - Date/Time Charge To Practice

O O O O O C O

40 60 60 60 60 26 40

XTN ST ST ST ST TS CM

AMICAS, Inc. Proprietary and Confidential

61

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

OBR Seq

HL7 Field Name

Opt

RIS Req

Length

Data Type

Rejection Rules

Vision Series Data Mapping/ Comments Schedule Resource

24

Diagnostic Serv Sect ID

10

ID

<Resource Category Title> Rejected if not P, F or A. P for Preliminary If it is an A or a P F for Final and OBX 11 is an S, A for Addendum the report will be placed on hold.

25

Result Status

ID

26 27 28 29 30 31

Parent Result Quantity/Timing Result Copies To Parent Number Transportation Mode Reason For Study Principal Result Interpreter Assistant Result Interpreter Technician

O O O O O O

400 200 150 200 20 300

CM TQ XCN CM ID CE Reject if empty or if PMIS codes does not match. Reading Radiologist <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix> Dictated Date and Time <^^yyyymmddhhmmss>

32

200

CM

33 34

O O

200 200

CM CM

35

Transcriptionist

200

CM

Transcriptionist ID <PMIS Code or Unique ID^Last Name^First name^Middle^Suffix>

36 37 38 39 40 41 42 43 44 45

Scheduled Date/Time Number of Sample Containers Transport Logistics of Collected Samples Collectors Comment Transport Arrangement Responsibility Transport Arranged Escort Required Planned Patient Transport Comment Procedure Code Procedure Code Modifier

O O O O O O O O O O

26 4 60 200 60 30 1 200 80 80

TS NM CE CE CE ID ID CE CE CE

AMICAS, Inc. Proprietary and Confidential

62

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.7.5 OBX (Observation/Result Segment) - ORU^R01


The following table lists each Observation/Result segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
OBX Seq HL7 Field Name Opt RIS Req Length Data Type Rejection Rules Vision Series Data Mapping/ Comments Sequence number for one or more OBX segments per message.

Set ID - Observation Simple Value Type Observation Identifier Observation Sub-ID

SI

2 3 4

C R C

3 80 20

ID CE ST Line(s) of text from report. Tildes (~) and carats (^) are recognized as carriage returns.

Observation Value

65536

6 7 8 9 10

Units References Range Abnormal Flags Probability Nature of Abnormal Test

O O O O O

60 60 5 5 2

CE ST ID NM ID Rejected if not P or F. Also reject if this field does not coincide P Preliminary with OBR 25. F Final If OBX 11 is an S, S Partial Results OBR 25 must be a P or an A.

11

Observation Result Status

ID

12 13 14 15

Date Of Last Obs Normal Values User Defined Access Checks Date-Time of the Observation Producers ID

O O O O

26 20 26 60

TS ST TS CE Reject if the field is empty and if OBX 11 is F. Approving Radiologist <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix>

16

Responsible Observer

80

XCN

17

Observation Method

60

CE

AMICAS, Inc. Proprietary and Confidential

63

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

3.8 ACK Acknowledgment Message Type


3.8.1 Definition
The HL7 Acknowledgment Message Type, ACK is sent from Vision Series RIS with a success or error message via the interface. When Vision Series RIS receives an HL7 message, it will validate the message syntactically. If validation fails, a reject message is constructed and returned to the placer. If validation does not fail, the message will be sent to a process which will update the database and Vision Series RIS will generate a functional response message. If an error occurs during processing, Vision Series RIS will send an error response. If it processes correctly, Vision Series RIS will send a successful response. The following table lists each supported message segment and their description:
Message Segment MSH MSA Segment Description Message Header Message Acknowledgment

See the Glossary for definitions of each interface.

3.8.2 MSH (Message Header Segment) - ACK


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSHSeq 1 2 3 4 5 6 7 8 9 10 11 12 13

HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number

Opt R R O O O O O O R R R R O

RIS Length Req 1 4 180 180 180 180 26 40 13 20 3 60 15

Data Type ST ST HD HD HD HD TS ST CM ST PT ID NM

Rejection Rules

Vision Series Data Mapping/ Comments "|" "^~\&" Vision Series RIS

Current date/time <yyyymmddhhmmss> ACK System Date/Time <yyyymmddhhmmss> P 2.3 HL7 version number

AMICAS, Inc. Proprietary and Confidential

64

Vision Series RIS 5.0 HL7 Interface Guide

Inbound Messages

MSHSeq 14 15 16 17 18 19 20

HL7 Field Name Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

Opt O O O O O O O

RIS Length Req 180 2 2 2 16 60 20

Data Type ST ID ID ID ID CE ID

Rejection Rules

Vision Series Data Mapping/ Comments

"AL"

3.8.3 MSA (Message Acknowledgment Segment) - ACK


The following table lists each Observation/Result segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MSA Seq HL7 Field Name Opt RIS Req Length Data Type Rejection Rules Vision Series Data Mapping/ Comments AA if Accepted AE if Error AR if Rejected Unique identifier echoed back from the received HL7 message, MSH_10. If MSA_1 is AA this field will be empty, otherwise this will contain text.

Acknowledgment Code

ID

Message Control ID

20

ST

Text Message

80

ST

4 5 6

Expected Sequence Number Delayed Acknowledgment Type Error Condition

O B O

15 1 100

NM ID CE

AMICAS, Inc. Proprietary and Confidential

65

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.

Outbound Messages
The AMICAS interface will be a one-way (unidirectional) outbound data transfer. Patient demographic and appointment information will be sent from Vision Series RIS at several points within the application workflow. The results report (Transcription Report) will be sent for each preliminary and/or approved report. Messages sent shall conform to the Health Level Seven (HL7) Standard, version 2.3 for electronic data exchange. All outbound messages will fail if the jacket number is empty. The following outbound interfaces are supported: ADT MFN ORM ORU ORM (Charge Out) ACK

See the Glossary for definitions of each interface.

4.1 Interface Monitor


A distribution entry is created for each message and is monitored through the HL7 Interface Monitor page. The HL7 Message Type is appended in parentheses to the transmission mode (Online-socket (ORM^O01)) in the Patient Files: Audit Trail window, as shown below. The monitor page displays each of the messages sent and the status of each message. This page also provides the ability to resend a message.

4.2 Trigger Points and Trigger Events


4.2.1 Definition
A trigger point is a location in the workflow in which a trigger event will occur. A trigger event is an event which initiates the flow of information among application systems. The trigger event is only sent if the corresponding trigger event is sent.

AMICAS, Inc. Proprietary and Confidential

66

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

The following table lists each workflow item and their associated trigger events:
Workflow/ Workflow Event Schedule Trigger Event Check-In/Out New orders (O01) sent at time of scheduling visits if schedule trigger set. Cancel orders (O01) sent at time of canceling visits. Reschedule orders (O01) will send cancel message followed by new order message. Patient Information Update (A08) sent for demographic registration data change.

New orders (O01) sent at the time patient checks-in if schedule trigger is not set, otherwise a change order is sent when the patient is checked-in. New orders (O01) sent for added procedures/exams. Change orders (O01) sent for changed procedures/exams. Completed orders (O01) sent for procedures in a Check Out status. Cancel orders (O01) sent on canceled procedures/exams. Patient Information Update (A08) sent for demographic registration data change.

Tech Entry

Change orders (O01) sent when all procedures are started on the same exam. New orders (O01) sent for added procedures. Cancel orders (O01) sent on deleted procedures. Completed orders (O01) sent for procedures in an Ended status.

Patient File and/or Patient History

New orders (O01) sent for added procedures or visits. Change orders (O01) sent for changed procedures. Cancel orders (O01) sent on canceled procedures. Patient Information Update (O01) sent for changes to demographic registration data. Merge patient (A34) sent when merge occurs. Results (R01) sent for preliminary reports or addendums. Completed orders (O01) added for outside reads. Results sent for approved reports or addendums. Completed orders (O01) added check-in films. If the interface is configured for Multi-OBR, cancel orders (O01) are sent for each cancelled or deleted exam. If the interface is not configured for Multi-OBR, cancel orders (O01) are sent for each cancelled or deleted procedure. If the interface is configured for Multi-OBR, new orders (O01) are sent for each for each added exam. If the interface is not configured for Multi-OBR, new orders (O01) are sent for each added procedure.

Transcription

Report Review Film Canceling/ Deleting an Exam or Procedure Adding an Exam or Procedure

Replacing an Exam Canceling a Visit

Cancel orders (O01) are sent followed by New Orders (O01) when replacing an exam. If the interface is configured for Multi-OBR set for the Exam level, cancel orders

AMICAS, Inc. Proprietary and Confidential

67

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

Workflow/ Workflow Event

Trigger Event (O01) are sent for each cancelled exam. If the interface is configured for Multi-OBR set to the Visit level, cancel orders (O01) are sent for each cancelled procedure.

4.3 ADT^A08 Update Patient Information


4.3.1 Definition
Vision Series RIS shall send the patient message event type ADT^A08 which will update patient information. This trigger event is used when any patient information has changed when no other trigger event has occurred. The A08 event can include information specific to an episode of care, but it can also be used for demographic information only. Do not send any guarantor or insured updates. The following table lists each supported message segment and their description:
Message Segment MSH PID PV1 Segment Description Message Header Patient Identification Patient Class

See the Glossary for definitions of each interface.

4.3.2 MSH (Message Header Segment) - ADT^A08


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 3 4 5 6 7 8 9 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Opt R R O O O O O O R Length 1 4 180 180 180 180 26 40 7 Data Type ST ST HD HD HD HD TS ST CM ADT^A08 Current date/time <yyyymmddhhmmss> "|" "^~\&" Vision SeriesRIS <Corporation Name> PACS Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

68

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MSH Seq 10 11 12 13 14 15

HL7 Field Name Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Country Code Character Set Principal Language of Message Alternate Character Set Handling Scheme

Opt O R R O O O

Length 20 3 60 15 180 2

Data Type ST PT ID NM ST ID "AL"

Vision Series Data Mapping/ Comments System date/time <yyyymmddhhmmss> P 2.3 HL7 version number

16 17 18 19 20

O O O O O

2 2 16 60 20

ID ID ID CE ID

"NE"

4.3.3 PID (Patient Identification Definition Segment) - ADT^A08


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PID Seq 1 HL7 Field Name Set ID - Patient ID Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PID segment per message. 1 Patient Unique Identifier <Internal Patient ID Number> Patient Unique Identifier 3 Patient ID (Internal ID) R 20 CX <Internal Generated Patient ID, Jacket, PMIS or Social Security> Patient Unique Identifier <Jacket, PMIS or Social Security >

Patient ID (External ID)

20

CX

Alternate Patient ID Patient Name

20

CX

last name first name middle initial

48

XPN

Patient Name <last name^first^middle^suffix>

AMICAS, Inc. Proprietary and Confidential

69

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq 6 7

HL7 Field Name Mothers Maiden Name Date of Birth

Opt O O

Length 48 26

Data Type XPN TS

Vision Series Data Mapping/ Comments

Patient DOB - Date portion only <yyyymmdd> Patient Gender (F, M, O, U) <PMIS Code or Gender Code> Patient Alias <Alias field> Patient Ethnicity <PMIS code or Ethnicity Code> Patient Address

Sex

ST

Patient Alias

48

XPN

10

Race

80

IS

11

Patient Address

106

XAD

<Address 1^Address 2^ City^State^Zip^Country>

12

County Code

IS

County Code <County Field> Patient Home Phone, Fax, Email

13

Phone Number - Home

40

XTN

<(Area Code)Phone Number^Additional text in phone number field^Fax Number^Email Address> Work Phone

14

Phone Number - Business

40

XTN

<(Area Code)Phone Number^Additional text in phone number field>

15 16 17 18

Language - Patient Marital Status Religion Patient Account Number

O O O O

60 80 80 20

CE IS IS CX Patient Unique Identifier <PMIS> Patient SS Number <SS Number> Patient Marital Status <PMIS Code for Marital Status Code>

19 20 21 22 23 24 25

SSN Number - Patient Drivers Lic Num - Patient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order

O O O O O O O

16 25 20 80 60 2 1

ST CM CX IS ST ID NM

AMICAS, Inc. Proprietary and Confidential

70

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq 26 27 28 29 30

HL7 Field Name Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

Opt O O O O O

Length 80 60 80 26 1

Data Type IS CE CE TS ID

Vision Series Data Mapping/ Comments

Patient Date of Death <yyyymmdd>

4.3.4 PV1 (Patient Visit Segment) - ADT^A08


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PV1 Seq 1 HL7 Field Name Set ID PV1 Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PV1 Segment per message. 1 Service Type <PMIS Code for Service Type Code> Patient Location 3 Assigned Patient Location O 80 PL <Location Name^^^PMIS Code^^^^^Location Name>

Patient Class

IS

4 5 6 7

Admission Type Preadmit Number Prior Patient Location Attending Doctor

O O O O

2 20 80 60

IS CX PL XCN Rank 1 Physician

Referring Doctor

60

XCN

<Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix>

Consulting Doctor

60

XCN

10 11 12 13

Hospital Service Temporary Location Preadmit Test Indicator Readmission Indicator

O O O O

3 80 2 2

IS PL IS IS

AMICAS, Inc. Proprietary and Confidential

71

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 14 15 16 17 18

HL7 Field Name Admit Source Ambulatory Status VIP Indicator Admitting doctor Patient Type

Opt O O O O O

Length 3 2 2 60 2

Data Type IS IS IS XCN IS

Vision Series Data Mapping/ Comments

Pregnancy Indicator <B6 if flag Y else other>

Service Type <PMIS Code for Service Type Code> Unique Visit Number <System Generated Number>

19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42

Visit Number Financial Class Charge Price Indicator Courtesy Code Credit Rating Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount Bad Debt Recovery Amount Delete Account Indicator Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status Pending Location

O O O O O O O O O O O O O O O O O O O O O B O O

20 50 2 2 2 2 8 12 3 2 1 8 10 12 12 1 8 3 25 80 2 1 2 80

CX CM IS IS IS IS DT NM NM IS IS DT IS NM NM IS DT IS CM IS IS IS IS PL

AMICAS, Inc. Proprietary and Confidential

72

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 43 44

HL7 Field Name Prior Temporary Location Admit Date/Time

Opt O O

Length 80 26

Data Type PL TS

Vision Series Data Mapping/ Comments

Admit Date <yyyymmdd> Discharge Date <yyyymmdd>

45 46 47 48 49 50 51 52

Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

O O O O O O O O

26 12 12 12 12 20 1 60

TS NM NM NM NM CX IS XCN

<Order Number>

Patient Weight <Patient Weight>

4.4 ADT^A34 Merge Patient Information (Patient ID Only)


4.4.1 Definition
Vision Series RIS shall send the patient message event type ADT^A34 which will merge patient information. An A34 event is used to signal a merge of records for a patient that was incorrectly created under two different identifiers. This merge is done to change patient identifiers on all of the patients incorrect accounts. The following table lists each supported message segment and their description:
Message Segment MSH EVN PID MRG Segment Description Message Header Event Type Patient Identification Merge Information

See the Glossary for definitions of each interface.

4.4.2 MSH (Message Header Segment) - ADT^A34


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 HL7 Field Name Field Separator Encoding Characters Opt R R Length 1 4 Data Type ST ST "|" "^~\&" Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

73

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MSH Seq 3 4 5 6 7 8 9 10 11 12 13 14 15

HL7 Field Name Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Country Code Character Set Principal Language of Message Alternate Character Set Handling Scheme

Opt O O O O O O R R R R O O O

Length 180 180 180 180 26 40 7 20 3 60 15 180 2

Data Type HD HD HD HD TS ST CM ST PT ID NM ST ID "AL"

Vision Series Data Mapping/ Comments Vision SeriesRIS <Corporation Name> PACS

Current date/time <yyyymmddhhmmss>

ADT^A34 System date/time <yyyymmddhhmmss> P 2.3 HL7 version number

16 17 18 19 20

O O O O O

2 2 16 60 20

ID ID ID CE ID

"NE"

4.4.3 EVN (Event Type Segment) - ADT^A34


The following table lists each Event Type segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
EVN Seq 1 2 3 HL7 Field Name Event Type Code Recorded Date/Time Date/Time Planned Event Opt B R O Length 3 26 26 Data Type ID TS TS A34 Current Date/Time <yyyymmddhhmmss> Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

74

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

EVN Seq 4 5

HL7 Field Name Event Reason Code Operator ID

Opt O O

Length 3 60

Data Type IS XCN

Vision Series Data Mapping/ Comments

Operator ID & Name <User ID^User Name (FML)> Current Date/Time <yyyymmddhhmmss>

Event Occurred

26

TS

4.4.4 PID (Patient Identification Definition Segment) - ADT^A34


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PID Seq 1 HL7 Field Name Set ID - Patient ID Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PID segment per message. 1 Patient Unique Identifier <Internal Patient ID Number> Patient Unique Identifier 3 Patient ID (Internal ID) R 20 CX Destination Patient Identifier <Defined Unique ID> 4 Alternate Patient ID Patient Name 5 last name first name middle initial 6 7 Mothers Maiden Name Date of Birth O O 48 26 XPN TS Patient DOB - Date portion only <yyyymmdd> Patient Gender (F, M, O,U) <PMIS code or Gender Code> Patient Alias <Alias field> Patient Ethnicity <PMIS code or Ethnicity Code> R 48 XPN Patient Name <last name^first^middle^suffix> B 20 CX Patient Unique Identifier <Jacket, PMIS or Social Security >

Patient ID (External ID)

20

CX

Sex

ST

Patient Alias

48

XPN

10

Race

80

IS

AMICAS, Inc. Proprietary and Confidential

75

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Patient Address

11

Patient Address

106

XAD

<Address 1^Address 2^ City^State^Zip^Country>

12

County Code

IS

County Code <County Field> Patient Home Phone, Fax, Email

13

Phone Number - Home

40

XTN

<(Area Code)Phone Number^Additional text in phone number field^Fax Number^Email Address> Work Phone

14

Phone Number - Business

40

XTN

<(Area Code)Phone Number^Additional text in phone number field>

15 16 17 18

Language - Patient Marital Status Religion Patient Account Number

O O O O

60 80 80 20

CE IS IS CX Patient Unique Identifier <PMIS> Patient SS Number <SS Number> Patient Marital Status <PMIS Code for Marital Status Code>

19 20 21 22 23 24 25 26 27 28 29 30

SSN Number - Patient Drivers Lic Num - Patient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

B O O O O O O O O O O O

16 25 20 80 60 1 2 80 60 80 26 1

ST CM CX IS ST ID NM IS CE CE TS ID

Patient Date of Death <yyyymmdd>

4.4.5 MRG (Patient Merge Information Segment) - ADT^A34


The following table lists each Patient Merge Information segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:

AMICAS, Inc. Proprietary and Confidential

76

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MRG Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Patient Unique Identifier

Prior Patient ID - Internal

20

CX

Source Patient Identifier <Defined Unique ID> Patient Unique Identifier <Defined Unique ID> Prior Patient PMIS <Patient File PMIS> Prior Patient Unique Identifier <Internal Patient ID Number>

Prior Alternate Patient ID Prior Patient Account Number Prior Patient ID - External Prior Visit Number Prior Alternate Visit ID Prior Patient Name

20

CX

20

CX

4 5 6 7

O O O O

20 20 20 48

CX

4.5 MFN - Master File Update Message Type


4.5.1 Message Definition
In an open-architecture healthcare environment there is often a set of common reference files used by one or more application systems. These files are called master files. Some common examples of master files in the healthcare environment include: staff and health practitioner master file system user (and password) master file location (census and clinic) master file device type and location (e.g., workstations, terminals, printers, etc.) lab test definition file exam code (radiology) definition file charge master file patient status master patient type master service item master file

These common reference files need to be synchronized across the various applications at a given site. The Master Files Notification (MFN) message provides a way of maintaining this synchronization by specifying a standard for the transmission of this data between applications. In many implementations, one application system will "own" a particular master file such as the staff and practitioner master file. The changes (e.g., adds, deletes, updates) to this file are made available to various other applications on a routine basis. The MFN message supports this common case, but also supports the situation where an application not "owning" a particular master file, transmits update information to other systems (usually to the "owning" system), for review and possible inclusion.

AMICAS, Inc. Proprietary and Confidential

77

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

The MFN message supports the distribution of changes to various master files between systems in either online or batch modes, and allows the use of either original or enhanced acknowledgment modes, as well as providing for a delayed application acknowledgment mode. These messages use the MSH segment to pass the basic event code (master files notification or acknowledgment). The Master File Identification (MFI) segment identifies the master file being updated as well as the initial and requested dates for file-level events (such as replace file). For each record being changed, the Master File Entry (MFE) segment carries the record-level event code (such as add, update, etc.), the initial and requested dates for the event, and the recordlevel key identifying the entry in the master file. The Master File Acknowledgment (MFA) segment returns record-specific acknowledgment information. The following table lists each supported message segment and their description:
Message Segment MSH MFI MFE ZL7 Segment Description Message Header Master File Identification Master File Entry Insurance Data to Post

See the Glossary for definitions of each interface.

4.5.2 MSH (Message Header Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MSH Seq 1 2 3 4 5 6

HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility

Opt R R O O O O

Length 1 4 180 180 180 180

Data Type ST ST HD HD HD HD "|" "^~\&"

Vision Series Data Mapping/ Comments

<Sending Application> <Sending Facility> <Receiving Application> <Interface Engine Name for new customers> or <AMICAS RIS for existing customers> Current date/time <yyyymmddhhmmss>or <yymmddhhmmssss>or <yyymmddhhmmssss> or <yymmddhhmmss>

Date/time of Message

26

TS

8 9 10 11

Security Message Type Message Control ID Processing ID

O R O R

40 7 20 3

ST CM ST PT ORM^O01 Unique Message Identifier P or T

AMICAS, Inc. Proprietary and Confidential

78

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MSH Seq 12 13 14 15 16 17 18 19 20

HL7 Field Name Version ID Sequence Number Continuation Pointer Accept Acknowledgement Type Application Acknowledgement Type Country Code Character Set Principal Language Of Message Alternate Character Set Handling Scheme

Opt R O O O O O O O O

Length 60 15 180 2 2 2 16 60 20

Data Type ID NM ST ID ID ID ID CE ID

Vision Series Data Mapping/ Comments 2.3 HL7 version number

4.5.3 MFI (Message File Identification Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MFI Seq HL7 Field Name Opt Length Data Type Vision Series Data Mapping/ Comments INS <INS^Insurance Master File> Note: See HL7 Table: Master File Identifier Codes.

Message File Identifier

250

CE

2 3 4 5 6

Master File Application Identifier File-Level Event Code Entered Date/Time Effective Date/Time Response Level Code

O R O O R

180 3 26 26 2

HD ID TS TS ID UPD <yyyymmddhhmmss> <yyyymmddhhmmss> AL Always sends an ACK.

a.

HL7 Table: Master File Identifier Codes


Value CDM CLN CMA Description Charge Description Master File Clinic Master File Clinical Study with Phases and Scheduled Master File Comment

AMICAS, Inc. Proprietary and Confidential

79

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

Value CMB

Description Clinical Study without Phases but with Scheduled Master File Procedure Master File Procedure Category Code Master File Diagnosis Code Master Record Insurance Master File Inventory Master File Location Master file CPT Code Modifier Master File Numerical Observation Master File Categorical Observation Master File Observation Batteries Master File Calculated Observations Master File Other Observation/Service Item Master File Physician Master File Practitioner Master File Staff Master File Zip Code Master File

Comment

CPT DEP DXC INS INV LOC MOD OMA OMB OMC OMD OME PHY PRA STF ZIP

AMICAS currently updates this file.

4.5.4 MFE (Message File Entry Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.

MFE Seq 1 2 3

HL7 Field Name Record-Level Event Code MFN Control ID Effective Date/Time

Opt R C O

Length 3 20 26

Data Type ID ST TS

Vision Series Data Mapping/ Comments MAD, MDL, MUP, MDC, MAC Note: See HL7 Table: Actions Performed on Master Files. <yyyymmddhhmmss> <yyyymmddhhmmss>

AMICAS, Inc. Proprietary and Confidential

80

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MFE Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments <Identifier -Location PMIS>

Primary Key Value MFE

200

Varies

This is the search key for the PMIS Code depending upon the support table. DX and ZIP use Code all others use the PMIS Code.

a.

HL7 Table: Actions Performed on Master Files


Value MAD MDL MUP MDC Description Add the record to the master file. Delete the record from the master file. Update the record for the master file. Deactivate. Discontinue using the record in the master file, but do not delete it from the database. Reactivate the deactivated record.

MAC

4.5.5 ZL7 (Insurance Data to Post Segment) MFN


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments: Any field name that has a blank cell in the Rejection Rules column does not have any rejections. The RIS Req column designates which fields are required by Vision Series RIS.
MFE Seq HL7 Field Name Data Opt Length Typ e Vision Series Data Mapping/ Comments

Location

400

Location CE <PMIS^Name^Address1& Address2&City&State&ZipCode^Phone&&&Email&&&fax^Contact^^Plan Insurance Type Code^^^>

4.6 ORM^O01 Order Message Type


4.6.1 Definition
Vision Series RIS sends the order message event type ORM^O01 which contains patient orders. The function of this message is to initiate the transmission of information about an order. Orders are associated with a particular patient and usually contain a set of one or more procedures to be performed on a patient. Supported order messages include the Common Order Segment (ORC) and the Observation Request Segment (OBR).

AMICAS, Inc. Proprietary and Confidential

81

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

The following table lists each supported message segment and their description:
Message Segment MSH PID PV1 ORC OBR Segment Description Message Header Patient Identification Patient Visit (optional) Common Order Order Detail /Observation Request

See the Glossary for definitions of each interface.

4.6.2 MSH (Message Header Segment) - ORM^O01


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Opt R R O O O O O O R R R R O O O Length 1 4 180 180 180 180 26 40 7 20 3 60 15 180 2 Data Type ST ST HD HD HD HD TS ST CM ST PT ID NM ST ID "AL" ORM^O01 System date/time <yyyymmddhhmmss> P 2.3 HL7 version number Current date/time <yyyymmddhhmmss> "|" "^~\&" Vision SeriesRIS <Corporation Name> PACS Vision Series Data Mapping/ Comments

16

ID

"NE"

AMICAS, Inc. Proprietary and Confidential

82

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MSH Seq 17 18 19 20

HL7 Field Name Country Code Character Set Principal Language of Message Alternate Character Set Handling Scheme

Opt O O O O

Length 2 16 60 20

Data Type ID ID CE ID

Vision Series Data Mapping/ Comments

4.6.3 PID (Patient Identification Definition Segment) - ORM^O01


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PID Seq 1 HL7 Field Name Set ID - Patient ID Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PID segment per message. 1 Patient Unique Identifier <Internal Patient ID Number> Patient Unique Identifier 3 Patient ID (Internal ID) R 20 CX <Internal Generated Patient ID, Jacket, PMIS or Social Security> Patient Unique Identifier <Jacket, PMIS or Social Security > Patient Name <last name^first^middle^suffix>

Patient ID (External ID)

20

CX

Alternate Patient ID Patient Name last name first name middle initial Mothers Maiden Name Date of Birth Sex

20

CX

48

XPN

6 7 8

O O O

48 26 1

XPN TS ST Patient DOB - Date portion only (YYYYMMDD) Patient Gender (F, M, O, U) <PMIS code or Gender Code> Patient Alias <Alias field> Patient Ethnicity <PMIS code or Ethnicity Code> Patient Address

Patient Alias

48

XPN

10

Race

80

IS

11

Patient Address

106

XAD

<Address 1^Address 2^City^State^Zip^Country> County Code <County Field>

12

County Code

IS

AMICAS, Inc. Proprietary and Confidential

83

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Patient Home Phone, Fax, Email

13

Phone Number - Home

40

XTN

<(Area Code)Phone Number^Additional text in phone number field^Fax Number^Email Address> Work Phone

14

Phone Number - Business

40

XTN

<(Area Code)Phone Number^Additional text in phone number field>

15 16 17 18

Language - Patient Marital Status Religion Patient Account Number

O O O O

60 80 80 20

CE IS IS CX Patient Unique Identifier <PMIS> Patient SS Number <SS Number> Patient Marital Status <PMIS Code for Marital Status Code>

19 20 21 22 23 24 25 26 27 28 29 30

SSN Number - Patient Drivers Lic Num - Patient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

B O O O O O O O O O O O

16 25 20 80 60 1 2 80 60 80 26 1

ST CM CX IS ST ID NM IS CE CE TS ID

Patient Date of Death <yyyymmdd>

4.6.4 PV1 (Patient Visit Segment) - ORM^O01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PV1 Seq 1 HL7 Field Name Set ID PV1 Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PV1 segment per message. 1

AMICAS, Inc. Proprietary and Confidential

84

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 2

HL7 Field Name Patient Class

Opt R

Length 1

Data Type IS

Vision Series Data Mapping/ Comments Service Type <PMIS Code for Service Type Code> Patient Location

Assigned Patient Location

80

PL

< Location Name ^^^PMIS Code^^^^^Location Name>

4 5 6 7

Admission Type Preadmit Number Prior Patient Location Attending Doctor

O O O O

2 20 80 60

IS CX PL XCN Rank 1 Physician

Referring Doctor

60

XCN

<Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix>

Consulting Doctor

60

XCN

10 11 12 13 14 15 16 17 18

Hospital Service Temporary Location Preadmit Test Indicator Readmission Indicator Admit Source Ambulatory Status VIP Indicator Admitting doctor Patient Type

O O O O O O O O O

3 80 2 2 3 2 2 60 2

IS PL IS IS IS IS IS XCN IS Service Type <PMIS Code for Service Type Code> Unique Visit Number <System Generated Number> Pregnancy Indicator <B6 if flag Y else other>

19 20 21 22 23

Visit Number Financial Class Charge Price Indicator Courtesy Code Credit Rating

O O O O O

20 50 2 2 2

CX CM IS IS IS

AMICAS, Inc. Proprietary and Confidential

85

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

HL7 Field Name Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount Bad Debt Recovery Amount Delete Account Indicator Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status Pending Location Prior Temporary Location Admit Date/Time

Opt O O O O O O O O O O O O O O O O B O O O O

Length 2 8 12 3 2 1 8 10 12 12 1 8 3 25 80 2 1 2 80 80 26

Data Type IS DT NM NM IS IS DT IS NM NM IS DT IS CM IS IS IS IS PL PL TS

Vision Series Data Mapping/ Comments

Admit Date <yyyymmdd> Discharge Date <yyyymmdd>

45 46 47 48 49 50 51 52

Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

O O O O O O O O

26 12 12 12 12 20 1 60

TS NM NM NM NM CX IS XCN

<Order Number>

Patient Weight <Patient Weight>

AMICAS, Inc. Proprietary and Confidential

86

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.6.5 ORC (Common Order Segment) - ORM^O01


The following table lists each Common Order segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
ORC Seq HL7 Field Name Opt Length Data Type Vision Series Data Mapping/ Comments NW if New Order 1 Order Control R 2 ID CA if Cancel Order XO if Change Order 2 Placer Order Number C 16 EI Accession Number <Accession Number> Accession Number <Accession Number> Group Number for grouping procedures 4 Placer Group Number O 22 EI Blank if no grouping, or Unique Group Number for Exam level or Unique Group Number for Visit level <Group Order Number> Blank if New Order 5 Order Status O 2 ID CM if Order sent at Tech End CA if Cancel Order XO if Change Order 6 Response Flag Quantity/Timing quantity interval duration start date/time end date/time Priority condition text conjunction order sequencing Parent Date/Time of Transaction O 1 ID

Filler Order Number

16

EI

Scheduled Exam Date/Time O 200 TQ <^^^yyyymmddhhmm^^s> if urgent or <R> if not urgent

8 9

O O

200 26

CM TS Current Date/Time <yyyymmddhhmmss> User ID & Name

10

Entered By

120

XCN

<User ID^Last Name^First Name^Middle^Suffix>

11

Verified By

120

XCN

AMICAS, Inc. Proprietary and Confidential

87

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

ORC Seq

HL7 Field Name Ordering Provider physician id family name given name middle initial or name Enterers Location

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Rank 1 Physician

12

120

XCN

<Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Location ID & Name ^^^<PMIS^^^^^Location Name> Rank 1 Physician Phone # & Fax # <Phone Number^Fax Number>

13

80

PL

14 15 16

Call Back Phone Number Order Effective Date/Time Order Control Reason

O O O

40 26 200

XTN TS CE

Reason <Reason or Free Text if Other Reason> Rank 1 Physician Location <PMIS or Unique ID^Phy Location Name>

17 18 19 20 21 22 23 24

Entering Organization Entering Device Action By Advanced Beneficiary Notice Code Ordering Facility Name Ordering Facility Address Ordering Facility Phone Number Ordering Provider Address

O O O O O O O O

60 60 120 40 60 106 48 106

CE CE XCN CE XON XAD XTN XAD

4.6.6 OBR (Order Detail /Observation Request) - ORM^O01


The following table lists each Order Detail/Observation Request segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
OBR Seq 1 HL7 Field Name Set ID Observation Request Placer Order Number Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One OBR Segment per Message 1 Accession Number <Accession Number> Accession Number <Accession Number>

16

EI

Filler Order Number

16

EI

AMICAS, Inc. Proprietary and Confidential

88

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Procedure Code Procedure Description

Universal Service ID identifier text

200

CE

Exam Code Exam Description <Procedure Code^Procedure Description^Exam Code^Exam Description>

5 6

Priority Requested Date/Time

B B

2 26

ID TS Scheduled Date/Time ^^^<yyyymmddhhmmss^^s> Scheduled Date/Time ^^^<yyyymmddhhmmss^^s>

7 8 9 10 11 12

Observation Date/Time Obs End Date/Time Collection Volume Collector Identifier Specimen Action Code Danger Code

C O O O O O

26 26 20 60 1 60

TS TS CQ XCN ID CE

Comments 13 Relevant Clinical Info. O 300 ST <Visit Comment~Visit Comment^Patient Comments~Patient Comments^Exam Comments~Exam Comments^Schedule Comments>

14

Specimen Rec'd Date/Time Specimen Source Source Code Additives Source Description Body Site

26

TS

15

300

CM

16

Ordering Provider physician ID family name given name middle initial or name

Ordering (referring) provider. Tilde (~) separates referring from any or all CC physicians. O 80 XCN <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Rank 1 Physician Phone number and Fax number <Phone Number^Fax Number>

17

Order Callback Phone No.

40

XTN

AMICAS, Inc. Proprietary and Confidential

89

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Group Number for grouping procedures

18

Placer Field 1

60

ST

Blank if no grouping, or Unique Group Number for Exam level or Unique Group Number for Visit level <Group Order Number> Procedure Category & Resource

19

Placer Field 2

60

ST

<Procedure Category Description^Resource Category Title>

20 21 22 23 24 25 26

Filler Field 1 Filler Field 2 Result Rpt/Status Change Date/Time Charge To Practice Diagnostic Serv Sect Id Result Status Parent Result Quantity/Timing quantity interval duration start date/time end date/time priority condition text conjunction order sequencing

O O C O O C O

60 60 26 40 10 1 400

ST ST TS CM ID ID CM Schedule Resource <Resource Category Title> Application Entity Title <Modality Name>

Scheduled Date/Time O 200 TQ ^^^<yyyymmddhhmmss^^s> if urgent else <R>

27

Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix>

28

Result Copies To

150

XCN

28 29 30

Result Copies To Parent Number Transportation Mode

O O O

150 200 20

XCN CM ID Reason for Visit

31

Reason For Study

300

CE

<Reason or Free form if Other Reason^ Reason or Free form if Other Reason>

32

Principal Result Interpreter

200

CM

AMICAS, Inc. Proprietary and Confidential

90

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq 33 34 35 36 37 38 39 40 41 42 43 44 45

HL7 Field Name Assistant Result Interpreter Technician Transcriptionist Scheduled Date/Time Number of Sample Containers Transport Logistics of Collected Sample Collectors Comment Transport Arrangement Responsibility Transport Arranged Escort Required Planned Patient Transport Comment Procedure Code Procedure Code Modifier

Opt O O O O O O O O O O O O O

Length 200 200 200 26 4 60 200 60 30 1 200 80 80

Data Type CM CM CM TS NM CE CE CE ID ID CE CE CE

Vision Series Data Mapping/ Comments

Scheduled Date/Time ^^^<yyyymmddhhmmss^^s>

4.7 ORU^R01 Results Message Type


4.7.1 Definition
Vision Series RIS sends the order message event type ORU^R01 which is the Observational Report Unsolicited. The ORU will send preliminary, final or addendum reports based upon a trigger define in Vision Series RIS. The HL7 message will consist of the following message segments. The following table lists each supported message segment and their description:
Message Segment MSH PID PV1 ORC OBR OBX Segment Description Message Header Patient Identification Patient Visit Common Order (optional) Order Detail /Observation Request Observation Results (may have repetitions)

See the Glossary for definitions of each interface.

AMICAS, Inc. Proprietary and Confidential

91

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.7.2 MSH (Message Header Segment) - ORU^R01


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Country Code Character Set Principal Language of Message Alternate Character Set Handling Scheme Opt R R O O O O O O R O R R O O O O O O O O Length 1 4 180 180 180 180 26 40 7 20 3 60 15 180 2 2 2 16 60 20 Data Type ST ST HD HD HD HD TS ST CM ST PT ID NM ST ID ID ID ID CE ID "AL" ORU^R01 System date/time <yyyymmddhhmmss> P 2.3 HL7 version number Current date/time <yyyymmddhhmmss> "|" "^~\&" Vision SeriesRIS <Corporation Name> PACS Vision Series Data Mapping/ Comments

"NE"

AMICAS, Inc. Proprietary and Confidential

92

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.7.3 PID (Patient Identification Definition Segment) - ORU^R01


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PID Seq 1 HL7 Field Name Set ID - Patient ID Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PID segment per message 1 Patient Unique Identifier <Internal Patient ID Number> Patient Unique Identifier 3 Patient ID (Internal ID) R 20 CX <Internal Generated Patient ID, Jacket, PMIS or Social Security> Patient Unique Identifier <Jacket, PMIS or Social Security > Patient Name <lastname^first^middle^suffix>

Patient ID (External ID)

20

CX

Alternate Patient ID Patient Name last name first name middle initial Mothers Maiden Name Date of Birth

20

CX

48

XPN

6 7

O O

48 26

XPN TS Patient DOB - Date portion only (YYYYMMDD) Patient Gender (F, M, O, U) <PMIS code or Gender Code> Patient Alias <Alias field> Patient Ethnicity <PMIS code or Ethnicity Code> Patient Address

Sex

ST

Patient Alias

48

XPN

10

Race

80

IS

11

Patient Address

106

XAD

<Address 1^Address 2^ City^State^Zip^Country> County Code <County Field> Patient Home Phone, Fax, Email

12

County Code

IS

13

Phone Number - Home

40

XTN

<(Area Code)Phone Number^Additional text in phone number field^Fax Number^Email Address> Work Phone

14

Phone Number - Business

40

XTN

<(Area Code)Phone Number^Additional text in phone number field>

15

Language - Patient

60

CE

AMICAS, Inc. Proprietary and Confidential

93

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq 16 17 18

HL7 Field Name Marital Status Religion Patient Account Number

Opt O O O

Length 80 80 20

Data Type IS IS CX

Vision Series Data Mapping/ Comments Patient Marital Status <PMIS Code for Marital Status Code>

Patient Unique Identifier <PMIS> Patient SS Number <SS Number>

19 20 21 22 23 24 25 26 27 28 29 30

SSN Number - Patient Drivers Lic Num - Patient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

B O O O O O O O O O O O

16 25 20 80 60 1 2 80 60 80 26 1

ST CM CX IS ST ID NM IS CE CE TS ID

Patient Date of Death <yyyymmdd>

4.7.4 PV1 (Patient Visit Segment) - ORU^R01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PV1 Seq 1 HL7 Field Name Set ID PV1 Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PV1 Segment per Message 1 Service Type <PMIS Code for Service Type Code> Patient Location 3 Assigned Patient Location O 80 PL < Location Name ^^^PMIS Code^^^^^Location Name>

Patient Class

IS

4 5

Admission Type Preadmit Number

O O

2 20

IS CX

AMICAS, Inc. Proprietary and Confidential

94

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 6 7

HL7 Field Name Prior Patient Location Attending Doctor

Opt O O

Length 80 60

Data Type PL XCN

Vision Series Data Mapping/ Comments

Rank 1 Physician 8 Referring Doctor O 60 XCN <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix>

Consulting Doctor

60

XCN

10 11 12 13 14 15 16 17 18

Hospital Service Temporary Location Preadmit Test Indicator Readmission Indicator Admit Source Ambulatory Status VIP Indicator Admitting doctor Patient Type

O O O O O O O O O

3 80 2 2 3 2 2 60 2

IS PL IS IS IS IS IS XCN IS Service Type <PMIS Code for Service Type Code> Unique Visit Number <System Generated Number> Pregnancy Indicator <B6> if flag <Y> else other

19 20 21 22 23 24 25 26 27 28 29

Visit Number Financial Class Charge Price Indicator Courtesy Code Credit Rating Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code

O O O O O O O O O O O

20 50 2 2 2 2 8 12 3 2 1

CX CM IS IS IS IS DT NM NM IS IS

AMICAS, Inc. Proprietary and Confidential

95

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

HL7 Field Name Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount Bad Debt Recovery Amount Delete Account Indicator Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status Pending Location Prior Temporary Location Admit Date/Time

Opt O O O O O O O O O O B O O O O

Length 8 10 12 12 1 8 3 25 80 2 1 2 80 80 26

Data Type DT IS NM NM IS DT IS CM IS IS IS IS PL PL TS

Vision Series Data Mapping/ Comments

Admit Date <yyyymmdd> Discharge Date <yyyymmdd>

45 46 47 48 49 50 51 52

Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

O O O O O O O O

26 12 12 12 12 20 1 60

TS NM NM NM NM CX IS XCN

Patient Weight <Patient Weight>

4.7.5 ORC (Common Order Segment) - ORU^R01


The following table lists each Common Order segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
ORC Seq 1 HL7 Field Name Order Control Opt R Length 2 Data Type ID RE Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

96

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

ORC Seq 2

HL7 Field Name Placer Order Number

Opt C

Length 16

Data Type EI

Vision Series Data Mapping/ Comments Accession Number <Accession Number> Accession Number <Accession Number>

3 4 5 6

Filler Order Number Placer Group Number Order Status Response Flag Quantity/Timing quantity interval duration start date/time end date/time Priority condition text conjunction order sequencing Parent Date/Time of Transaction

C O O O

16 22 2 1

EI EI ID ID

CM Complete order

Scheduled Exam Date/Time O 200 TQ <yyyymmddhhmm^s> if urgent or <R> if not urgent

8 9

O O

200 26

CM TS Current Date/Time <yyyymmddhhmmss> User ID & Name

10

Entered By

120

XCN

<User ID^Last Name^First Name^Middle^ Suffix>

11

Verified By Ordering Provider physician id family name given name middle initial or name Enterers Location

120

XCN Rank 1 Physician

12

120

XCN

<Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Location ID & Name <^^^PMIS Code^^^^^Location Name> Rank 1 Physician Phone # & Fax # <Phone Number^Fax Number>

13

80

PL

14 15

Call Back Phone Number Order Effective Date/Time

O O

40 26

XTN TS

Reason 16 Order Control Reason O 200 CE <Reason> or <Free Text if Other Reason^Reason> Rank 1 Physician Location <PMIS> or <Unique ID^Phy Location Name>

17 18

Entering Organization Entering Device

O O

60 60

CE CE

AMICAS, Inc. Proprietary and Confidential

97

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

ORC Seq 19 20 21 22 23 24

HL7 Field Name Action By Advanced Beneficiary Notice Code Ordering Facility Name Ordering Facility Address Ordering Facility Phone Number Ordering Provider Address

Opt O O O O O O

Length 120 40 60 106 48 106

Data Type XCN CE XON XAD XTN XAD

Vision Series Data Mapping/ Comments

4.7.6 OBR (Order Detail /Observation Request) - ORU^R01


The following table lists each Order Detail/Observation Request segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
OBR Seq 1 HL7 Field Name Set ID Observation Request Placer Order Number Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One OBR Segment per Message 1 Accession Number <Accession Number> Accession Number <Accession Number> Procedure Code Procedure Description 4 Universal Service ID identifier text R 200 CE Exam Code Exam Description <Procedure Code^Procedure Description^Exam Code^Exam Description> 5 6 Priority Requested Date/Time B B 2 26 ID TS Scheduled date/time <yyyymmddhhmm> Scheduled date/time <yyyymmddhhmm>

16

EI

Filler Order Number

16

EI

7 8 9 10 11 12

Observation Date/Time Obs End Date/Time Collection Volume Collector Identifier Specimen Action Code Danger Code

C O O O O O

26 26 20 60 1 60

TS TS CQ XCN ID CE

AMICAS, Inc. Proprietary and Confidential

98

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq 13

HL7 Field Name

Opt

Length

Data Type ST

Vision Series Data Mapping/ Comments Comments

Relevant Clinical Info.

300

<Patient Comments^Visit Comments^Exam Comments^Schedule Comments>

14

Specimen Rec'd Date/Time Specimen Source Source Code Additives Source Description Body Site

26

TS

15

300

CM

Ordering (referring) provider. Tilde (~) separates referring from any or all CC physicians. Ordering Provider physician ID family name given name middle initial or name <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Rank 1 Physician Phone # & Fax # <Phone Number^Fax Number> Group Number for grouping procedures 18 Placer Field 1 O 60 ST Blank if no grouping, or Unique Group Number for Exam level or Unique Group Number for Visit level <Group Order Number> Procedure Category & Resource 19 Placer Field 2 O 60 ST <Procedure Category Description^Resource Category Title>

16

80

XCN

17

Order Callback Phone No.

40

XTN

20 21 22 23 24

Filler Field 1 Filler Field 2 Result Rpt/Status Change Date/Time Charge To Practice Diagnostic Serv Sect Id

O O C O O

60 60 26 40 10

ST ST TS CM ID Schedule Resource <Resource Category Title> Application Entity Title <Modality Name>

AMICAS, Inc. Proprietary and Confidential

99

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments F for Final A for Addendum P for Preliminary

25

Result Status

ID

Final is not appended to the addendum. If Report Deleted HL7 trigger point has been selected: A if Addendum C for Correction

26

Parent Result Quantity/Timing quantity interval duration start date/time end date/time priority condition text conjunction order sequencing priority condition text conjunction order sequencing

400

CM

Scheduled Date/Time O 200 TQ ^^^<yyyymmddhhmmss^^s> if urgent else <R>

27

Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> <Parent Report Id>^<Child Report Id>

28

Result Copies To

150

XCN

29 30

Parent Number Transportation Mode

O O

200 20

CM ID

Reason for Visit 31 Reason For Study O 300 CE <Reason or Free form if Other Reason^Reason or Free form if Other Reason> Dictating Radiologist 32 Principal Result Interpreter O 200 CM <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix> Approving Radiologist 33 Assistant Result Interpreter O 200 CM <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix>

AMICAS, Inc. Proprietary and Confidential

100

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq 34

HL7 Field Name

Opt

Length

Data Type CM

Vision Series Data Mapping/ Comments Technologist

Technician

200

<PMIS Code or Unique ID^Last Name^First name^Middle^Suffix> Transcriptionist

35

Transcriptionist

200

CM

<PMIS Code or Unique ID^Last Name^First name^Middle^Suffix> Scheduled Date/Time <yyyymmddhhmmss>

36 37 38 39 40 41 42 43 44 45

Scheduled Date/Time Number of Sample Containers Transport Logistics of Collected Sample Collectors Comment Transport Arrangement Responsibility Transport Arranged Escort Required Planned Patient Transport Comment Procedure Code Procedure Code Modifier

O O O O O O O O O O

26 4 60 200 60 30 1 200 80 80

TS NM CE CE CE ID ID CE CE CE

4.7.7 OBX (Observation/Result Segment) - ORU^R01


The following table lists each Observation/Result segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
OBX Seq 1 2 3 4 5 6 7 8 9 10 HL7 Field Name Set ID - Observation Simple Value Type Observation Identifier Observation Sub-ID Observation Value Units References Range Abnormal Flags Probability Nature of Abnormal Test Opt O C R C C O O O O O Length 4 3 80 20 65536 60 60 5 5 2 Data Type SI ID CE ST * CE ST ID NM ID Vision Series Data Mapping/ Comments Sequence number 'TX' Accession Number <Accession Number> '1' Line of text from report.

AMICAS, Inc. Proprietary and Confidential

101

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBX Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments P if Preliminary Report F if Approved/Final

11

Observe Result Status

ID

If Report Deleted HL7 trigger point has been selected: C for Correction D for Delete W for Wrong

12 13 14 15 16 17

Date Of Last Obs Normal Values User Defined Access Checks Date-Time of the Observation Producers ID Responsible Observer Observation Method

O O O O O O

26 20 26 60 80 60

TS ST TS CE XCN CE Transcribed Date/Time <yyyymmddhhmm>

4.8 ORU^R01 HL7 HTML Result Message Type


4.8.1 Definition
This is an HTML version of the order results message type. It allows the same report in Vision Series RIS to be viewed in other AMICAS products. Vision Series RIS sends the order message event type ORU^R01 which is the Observational Report Unsolicited. The ORU will send preliminary, final or addendum reports based upon a trigger define in Vision Series RIS. The HL7 message will consist of the following message segments. OBX 2 Formatted Text OBX 5 is an Html report representation The following table lists each supported message segment and their description:
Message Segment MSH PID PV1 ORC OBR OBX Segment Description Message Header Patient Identification Patient Visit Common Order (optional) Order Detail /Observation Request Observation Results (may have repetitions)

AMICAS, Inc. Proprietary and Confidential

102

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

See the Glossary for definitions of each interface.

4.8.2 MSH (Message Header Segment) - ORU^R01


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Country Code Character Set Principal Language of Message Alternate Character Set Handling Scheme Opt R R O O O O O O R O R R O O O O O O O O Length 1 4 180 180 180 180 26 40 7 20 3 60 15 180 2 2 2 16 60 20 Data Type ST ST HD HD HD HD TS ST CM ST PT ID NM ST ID ID ID ID CE ID "AL" ORU^R01 System date/time <yyyymmddhhmmss> P 2.3 HL7 version number Current date/time <yyyymmddhhmmss> "|" "^~\&" Vision SeriesRIS <Corporation Name> PACS Vision Series Data Mapping/ Comments

"NE"

AMICAS, Inc. Proprietary and Confidential

103

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.8.3 PID (Patient Identification Definition Segment) - ORU^R01


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PID Seq 1 HL7 Field Name Set ID - Patient ID Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PID segment per message 1 Patient Unique Identifier <Internal Patient ID Number> Patient Unique Identifier 3 Patient ID (Internal ID) R 20 CX <Internal Generated Patient ID, Jacket, PMIS or Social Security> Patient Unique Identifier <Jacket, PMIS or Social Security > Patient Name <lastname^first^middle^suffix>

Patient ID (External ID)

20

CX

Alternate Patient ID Patient Name last name first name middle initial Mothers Maiden Name Date of Birth

20

CX

48

XPN

6 7

O O

48 26

XPN TS Patient DOB - Date portion only (YYYYMMDD) Patient Gender (F, M, O, U) <PMIS code or Gender Code> Patient Alias <Alias field> Patient Ethnicity <PMIS code or Ethnicity Code> Patient Address

Sex

ST

Patient Alias

48

XPN

10

Race

80

IS

11

Patient Address

106

XAD

<Address 1^Address 2^ City^State^Zip^Country> County Code <County Field> Patient Home Phone, Fax, Email

12

County Code

IS

13

Phone Number - Home

40

XTN

<(Area Code)Phone Number^Additional text in phone number field^Fax Number^Email Address> Work Phone

14

Phone Number - Business

40

XTN

<(Area Code)Phone Number^Additional text in phone number field>

15

Language - Patient

60

CE

AMICAS, Inc. Proprietary and Confidential

104

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq 16 17 18

HL7 Field Name Marital Status Religion Patient Account Number

Opt O O O

Length 80 80 20

Data Type IS IS CX

Vision Series Data Mapping/ Comments Patient Marital Status <PMIS Code for Marital Status Code>

Patient Unique Identifier <PMIS> Patient SS Number <SS Number>

19 20 21 22 23 24 25 26 27 28 29 30

SSN Number - Patient Drivers Lic Num - Patient Mothers Identifier Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date/Time Patient Death Indicator

B O O O O O O O O O O O

16 25 20 80 60 1 2 80 60 80 26 1

ST CM CX IS ST ID NM IS CE CE TS ID

Patient Date of Death <yyyymmdd>

4.8.4 PV1 (Patient Visit Segment) - ORU^R01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PV1 Seq 1 HL7 Field Name Set ID PV1 Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PV1 Segment per Message 1 Service Type <PMIS Code for Service Type Code> Patient Location 3 Assigned Patient Location O 80 PL < Location Name ^^^PMIS Code^^^^^Location Name>

Patient Class

IS

4 5

Admission Type Preadmit Number

O O

2 20

IS CX

AMICAS, Inc. Proprietary and Confidential

105

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 6 7

HL7 Field Name Prior Patient Location Attending Doctor

Opt O O

Length 80 60

Data Type PL XCN

Vision Series Data Mapping/ Comments

Rank 1 Physician 8 Referring Doctor O 60 XCN <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix>

Consulting Doctor

60

XCN

10 11 12 13 14 15 16 17 18

Hospital Service Temporary Location Preadmit Test Indicator Readmission Indicator Admit Source Ambulatory Status VIP Indicator Admitting doctor Patient Type

O O O O O O O O O

3 80 2 2 3 2 2 60 2

IS PL IS IS IS IS IS XCN IS Service Type <PMIS Code for Service Type Code> Unique Visit Number <System Generated Number> Pregnancy Indicator <B6> if flag <Y> else other

19 20 21 22 23 24 25 26 27 28 29

Visit Number Financial Class Charge Price Indicator Courtesy Code Credit Rating Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code

O O O O O O O O O O O

20 50 2 2 2 2 8 12 3 2 1

CX CM IS IS IS IS DT NM NM IS IS

AMICAS, Inc. Proprietary and Confidential

106

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

HL7 Field Name Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount Bad Debt Recovery Amount Delete Account Indicator Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status Pending Location Prior Temporary Location Admit Date/Time

Opt O O O O O O O O O O B O O O O

Length 8 10 12 12 1 8 3 25 80 2 1 2 80 80 26

Data Type DT IS NM NM IS DT IS CM IS IS IS IS PL PL TS

Vision Series Data Mapping/ Comments

Admit Date <yyyymmdd> Discharge Date <yyyymmdd>

45 46 47 48 49 50 51 52

Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

O O O O O O O O

26 12 12 12 12 20 1 60

TS NM NM NM NM CX IS XCN

Patient Weight <Patient Weight>

4.8.5 ORC (Common Order Segment) - ORU^R01


The following table lists each Common Order segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
ORC Seq 1 HL7 Field Name Order Control Opt R Length 2 Data Type ID RE Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

107

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

ORC Seq 2

HL7 Field Name Placer Order Number

Opt C

Length 16

Data Type EI

Vision Series Data Mapping/ Comments Accession Number <Accession Number> Accession Number <Accession Number>

3 4 5 6

Filler Order Number Placer Group Number Order Status Response Flag Quantity/Timing quantity interval duration start date/time end date/time Priority condition text conjunction order sequencing Parent Date/Time of Transaction

C O O O

16 22 2 1

EI EI ID ID

CM Complete order

Scheduled Exam Date/Time O 200 TQ <yyyymmddhhmm^s> if urgent or <R> if not urgent

8 9

O O

200 26

CM TS Current Date/Time <yyyymmddhhmmss> User ID & Name

10

Entered By

120

XCN

<User ID^Last Name^First Name^Middle^ Suffix>

11

Verified By Ordering Provider physician id family name given name middle initial or name Enterers Location

120

XCN Rank 1 Physician

12

120

XCN

<Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Location ID & Name <^^^PMIS Code^^^^^Location Name> Rank 1 Physician Phone # & Fax # <Phone Number^Fax Number>

13

80

PL

14 15

Call Back Phone Number Order Effective Date/Time

O O

40 26

XTN TS

Reason 16 Order Control Reason O 200 CE <Reason> or <Free Text if Other Reason^Reason> Rank 1 Physician Location <PMIS> or <Unique ID^Phy Location Name>

17 18

Entering Organization Entering Device

O O

60 60

CE CE

AMICAS, Inc. Proprietary and Confidential

108

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

ORC Seq 19 20 21 22 23 24

HL7 Field Name Action By Advanced Beneficiary Notice Code Ordering Facility Name Ordering Facility Address Ordering Facility Phone Number Ordering Provider Address

Opt O O O O O O

Length 120 40 60 106 48 106

Data Type XCN CE XON XAD XTN XAD

Vision Series Data Mapping/ Comments

4.8.6 OBR (Order Detail /Observation Request) - ORU^R01


The following table lists each Order Detail/Observation Request segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
OBR Seq 1 HL7 Field Name Set ID Observation Request Placer Order Number Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One OBR Segment per Message 1 Accession Number <Accession Number> Accession Number <Accession Number> Procedure Code Procedure Description 4 Universal Service ID identifier text R 200 CE Exam Code Exam Description <Procedure Code^Procedure Description^Exam Code^Exam Description> 5 6 Priority Requested Date/Time B B 2 26 ID TS Scheduled date/time <yyyymmddhhmm> Scheduled date/time <yyyymmddhhmm>

16

EI

Filler Order Number

16

EI

7 8 9 10 11 12

Observation Date/Time Obs End Date/Time Collection Volume Collector Identifier Specimen Action Code Danger Code

C O O O O O

26 26 20 60 1 60

TS TS CQ XCN ID CE

AMICAS, Inc. Proprietary and Confidential

109

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq 13

HL7 Field Name

Opt

Length

Data Type ST

Vision Series Data Mapping/ Comments Comments

Relevant Clinical Info.

300

<Patient Comments^Visit Comments^Exam Comments^Schedule Comments>

14

Specimen Rec'd Date/Time Specimen Source Source Code Additives Source Description Body Site

26

TS

15

300

CM

16

Ordering Provider physician ID family name given name middle initial or name

Ordering (referring) provider. Tilde (~) separates referring from any or all CC physicians. O 80 XCN <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> Rank 1 Physician Phone # & Fax # <Phone Number^Fax Number> Group Number for grouping procedures

17

Order Callback Phone No.

40

XTN

18

Placer Field 1

60

ST

Blank if no grouping, or Unique Group Number for Exam level or Unique Group Number for Visit level <Group Order Number> Procedure Category & Resource

19

Placer Field 2

60

ST

<Procedure Category Description^Resource Category Title>

20 21 22 23 24

Filler Field 1 Filler Field 2 Result Rpt/Status Change Date/Time Charge To Practice Diagnostic Serv Sect Id

O O C O O

60 60 26 40 10

ST ST TS CM ID Schedule Resource <Resource Category Title> Application Entity Title <Modality Name>

AMICAS, Inc. Proprietary and Confidential

110

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments F for Final A for Addendum P for Preliminary

25

Result Status

ID

Final is not appended to the addendum. If Report Deleted HL7 trigger point has been selected: A if Addendum C for Correction

26

Parent Result Quantity/Timing quantity interval duration start date/time end date/time priority condition text conjunction order sequencing priority condition text conjunction order sequencing

400

CM

Scheduled Date/Time O 200 TQ ^^^<yyyymmddhhmmss^^s> if urgent else <R>

27

Additional Physicians <Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix^~ Physician Identifier (configurable to Location PMIS Code or RIS Unique Identifier and/or NPI)^LastName^First^Middle Name^Suffix> <Parent Report Id>^<Child Report Id>

28

Result Copies To

150

XCN

29 30

Parent Number Transportation Mode

O O

200 20

CM ID

Reason for Visit 31 Reason For Study O 300 CE <Reason or Free form if Other Reason^Reason or Free form if Other Reason> Dictating Radiologist 32 Principal Result Interpreter O 200 CM <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix> Approving Radiologist 33 Assistant Result Interpreter O 200 CM <PMIS Code or Unique ID^Last Name^First Name^Middle^Suffix>

AMICAS, Inc. Proprietary and Confidential

111

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBR Seq 34

HL7 Field Name

Opt

Length

Data Type CM

Vision Series Data Mapping/ Comments Technologist

Technician

200

<PMIS Code or Unique ID^Last Name^First name^Middle^Suffix> Transcriptionist

35

Transcriptionist

200

CM

<PMIS Code or Unique ID^Last Name^First name^Middle^Suffix> Scheduled Date/Time <yyyymmddhhmmss>

36 37 38 39 40 41 42 43 44 45

Scheduled Date/Time Number of Sample Containers Transport Logistics of Collected Sample Collectors Comment Transport Arrangement Responsibility Transport Arranged Escort Required Planned Patient Transport Comment Procedure Code Procedure Code Modifier

O O O O O O O O O O

26 4 60 200 60 30 1 200 80 80

TS NM CE CE CE ID ID CE CE CE

4.8.7 OBX (Observation/Result Segment) - ORU^R01


The following table lists each Observation/Result segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
OBX Seq 1 2 3 4 5 6 7 8 HL7 Field Name Set ID - Observation Simple Formatted Text Observation Identifier Observation Sub-ID HTML Report Representation Units References Range Abnormal Flags Opt O C R C C O O O Length 4 2 80 20 65536 60 60 5 Data Type SI ID CE ST * CE ST ID Vision Series Data Mapping/ Comments Sequence number 'FT' Accession Number <Accession Number> '1' An HTML representation of the report in Vision Series RIS. The report will keep the same formatting as displayed in RIS.

AMICAS, Inc. Proprietary and Confidential

112

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

OBX Seq 9 10

HL7 Field Name Probability Nature of Abnormal Test

Opt O O

Length 5 2

Data Type NM ID

Vision Series Data Mapping/ Comments

P if Preliminary Report F if Approved/Final 11 Observe Result Status R 1 ID If Report Deleted HL7 trigger point has been selected: C for Correction D for Delete W for Wrong 12 13 14 15 16 17 Date Of Last Obs Normal Values User Defined Access Checks Date-Time of the Observation Producers ID Responsible Observer Observation Method O O O O O O 26 20 26 60 80 60 TS ST TS CE XCN CE Transcribed Date/Time <yyyymmddhhmm>

4.9 ORM^O01 HL7 Batch Charge Out Message Type


4.9.1 Definition
Vision Series RIS uses the order message event type ORM^O01 to send the Charge Out information to the billing system. The function of this message is to initiate the transmission of information about procedures qualifying for charges. The message is triggered to be sent once a charge out is done. The receiving billing system can pick up the message and continue with the charge out process. The following table lists each supported message segment and their description:
Message Segment MSH PID PV1 PV2 GT1 ACC DB1 IN1 Segment Description Message Header Patient Identification Patient Visit Patient Visit Guarantor Accident Disability Insurance

AMICAS, Inc. Proprietary and Confidential

113

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

Message Segment IN2 PR1

Segment Description Insurance Procedure

See the Glossary for definitions of each interface.

4.9.2 MSH (Message Header Segment) - ORM^O01


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/Time of Message Security Message Type Message Control ID Processing ID Version ID Sequence Number Continuation Pointer Accept Acknowledgment Type Application Acknowledgment Type Country Code ID Character Set Principal Language of Message Alternate Character Set Handling Scheme Opt R R O O O O O O R R R R O O O O O O O O Length 4 4 180 180 180 180 26 40 7 20 3 60 15 180 2 2 2 16 60 20 Data Type ST ST HD HD HD HD TS ST CM ST PT VID NM ST ID ID ID ID CE ID HL7 Version <Version Number - Currently "2.3"> Order Message Type "ORM^O01" Message Unique Identifier <System Generated Number> Date and Time of File Creation <yyyymmddhhmmss> "MSH" "^~\&" "Vision Series RIS" Corporation Name <Corporation Name> "Billing System" Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

114

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.9.3 PID (Patient Identification Definition Segment) - ORM^O01


The following table lists each Patient Identification Definition segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PID Seq 1 HL7 Field Name Set ID - PID Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PID Segment per Message "1" Patient Unique Identifier <Jacket> Patient Unique Identifier <Jacket> Patient Unique Identifier <Social Security > Patient Name <Last Name^First^Middle^Suffix>

Patient ID External

20

CX

Patient ID Internal

20

CX

Alternate Patient ID

20

CX

5 6 7 8 9 10

Patient Name Mother Maiden Name Date Of Birth Sex Patient Alias Race

R O O O O O

48 48 26 1 48 80

XPN XPN TS ST XPN IS

Patient DOB <yyyymmdd> Patient Gender <PMIS code or Gender Code> Patient Alias <Alias field> Patient Ethnicity <PMIS code or Ethnicity Code> Patient Address <Address 1^Address 2^City^State^Zip^ Country> County Code <County Field> Patient Home Phone, Fax, Email <(Area Code)Phone Number^(Fax Area Code) Fax Number^Email Address> Work Phone <(Area Code)Phone Number>

11

Patient Address

106

XAD

12

County Code

IS

13

Home Phone

40

XTN

14 15 16 17 18

Business Phone Patient Language Marital Status Religion Patient Account Number

O O O O O

40 60 80 80 20

XTN CE IS IS CX

Patient Marital Status <PMIS code for Martial Status Code>

Patient Unique Identifier <PMIS>

AMICAS, Inc. Proprietary and Confidential

115

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PID Seq 19 20 21 22 23 24 25 26 27 28 29 30

HL7 Field Name Patient SSN Drivers License Number Mother ID Ethnic Group Birth Place Multiple Birth Indicator Birth Order Citizenship Veterans Military Status Nationality Patient Death Date and Time Patient Death Indicator

Opt B O O O O O O O O O O O

Length 16 25 20 80 60 1 2 80 60 80 26 1

Data Type ST CM CX IS ST ID NM IS CE CE TS ID

Vision Series Data Mapping/ Comments Patient SS Number <SS Number format ###-##-####> Patient PMIS Number

Patient Date of Death <yyyymmdd>

4.9.4 PV1 (Patient Visit Segment) - ORM^O01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PV1 Seq 1 HL7 Field Name Set - PV1 Opt O Length 4 Data Type SI Vision Series Data Mapping/ Comments One PV1 Segment per Message "1" Service Type <PMIS Code for Service Type Code> Patient Location <Location PMIS or Unique Identification Number^Location Name>

Patient Class

IS

3 4 5 6

Assigned Patient Location Admission Type Preadmit Number Prior Patient Location

O O O O

80 2 20 80

PL IS CX PL

Attending (referring) Provider. A Tilde (~) separates referring from any/all cc physicians. 7 Attending Doctor O 60 XCN <Physician Location PMIS Code or Physician Location Unique Identifier^Last Name^First^Middle Name^Suffix^~PMIS^ Last Name^First Name^Middle Name^ Suffix>

AMICAS, Inc. Proprietary and Confidential

116

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq

HL7 Field Name

Opt

Length

Data Type

Vision Series Data Mapping/ Comments Rank 1 Physician <Physician Location PMIS Code or Physician Location Unique Identifier ^Last Name^First^Middle^Suffix ^^^^^^^^^^^^National Provider Identification> Additional Physicians <Physician Location PMIS Code or Physician Location Unique Identifier ^Last Name^First^Middle^Suffix~PMIS Code or Unique Identification Number^Last Name^First^Middle^Suffix~(additional physicians)>

Referring Doctor

60

XCN

Consulting Doctor

60

XCN

10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

Hospital Service Temporary Location Preadmit Test Indicator Re-admission Indicator Admit Source Ambulatory Status VIP Indicator Admitting Doctor Patient Type Visit Number Financial Class Charge Price Indicator Courtesy Code Credit Rating Contract Code Contract Effective Date Contract Amount Contract Period Interest Code Transfer to Bad Debt Code Transfer to Bad Debt Date Bad Debt Agency Code Bad Debt Transfer Amount

O O O O O O O O O O O O O O O O O O O O O O O

3 80 2 2 3 2 2 60 2 20 50 2 2 2 2 8 12 3 2 1 8 10 12

IS PL IS IS IS IS IS XCN IS CX CM IS IS IS IS DT NM NM IS IS DT IS NM Service Type <PMIS code for Service Type Code> Unique Visit Number <System Generated Number> <Room Number>

AMICAS, Inc. Proprietary and Confidential

117

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV1 Seq 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

HL7 Field Name Bad Debt Recovery Amount Delete Account Indicator Delete Account Date Discharge Disposition Discharged to Location Diet Type Servicing Facility Bed Status Account Status Pending Location Prior Temporary Location Admit Date/Time Discharge Date/Time Current Patient Balance Total Charges Total Adjustments Total Payments Alternate Visit ID Visit Indicator Other Healthcare Provider

Opt O O O O O O O B O O O O O O O O O O O O

Length 12 1 8 3 25 80 2 1 2 80 80 26 26 12 12 12 12 20 1 60

Data Type NM IS DT IS CM IS IS IS IS PL PL TS TS NM NM NM NM CX IS XCN

Vision Series Data Mapping/ Comments

Admit Date <yyyymmdd> Discharge Date <yyyymmdd>

<Order Number> (specific to a visit)

<Patient Weight>

4.9.5 PV2 (Patient Visit Segment) - ORM^O01


The following table lists each Patient Visit segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PV2 Seq 1 2 3 4 5 HL7 Field Name Prior Pending Location Accommodation Code Admit Reason Transfer Reason Patient Valuables Opt C O O O O Length 80 250 250 250 25 Data Type PL CE CE CE ST Comments (Patient, Schedule & Visit) <(comment type)^(comment free text)> Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

118

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV2 Seq 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28

HL7 Field Name Patient Valuables Location Visit User Code Expected Admit Date/Time Expected Discharge Date/Time Estimated Length of Inpatient Stay Actual Length of Inpatient Stay Visit Description Referral Source Code Previous Service Date Employment Illness Related Indicator Purge Status Code Purge Status Date Special Program Code Retention Indicator Expected Number of Insurance Plans Visit Publicity Code Visit Protection Indicator Clinic Organization Name Patient Status Code Visit Priority Code Previous Treatment Date Expected Discharge Disposition Signature on File Date

Opt O O O O O O O O O O O O O O O O O O O O O O O

Length 25 2 26 26 3 3 50 250 8 1 1 8 2 1 1 1 1 250 2 1 8 2 8

Data Type ST IS TS TS NM NM ST XCN DT ID IS DT

Vision Series Data Mapping/ Comments

Visit Reason <Visit Reason>

Onset Date Questionnaire Response Date <yyyymmdd>

Special Program Code IS <Special Program Code> ID NM IS ID XON IS IS ST IS DT Similar Onset Date Questionnaire Response Date <yyyymmdd> 30 31 Patient Charge Adjustment Code Recurring Service Code O O 250 2 CE IS Pregnancy Indicator <Y>

29

First Similar Illness Date

DT

AMICAS, Inc. Proprietary and Confidential

119

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

PV2 Seq 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

HL7 Field Name Billing Media Code Expected Surgery Date and Time Military Partnership Code Military Non-Availability Code Newborn Baby Indicator Baby Detained Indicator Mode of Arrival Code Recreational Drug Use Code Admission Level of Care Code Precaution Code Patient Condition Code Living Will Code Organ Donor Code Advance Directive Code Patient Status Effective Date Expected LOA Return Date/Time

Opt O O O O O O

Length 1 26 1 1 1 1 250 250 250 250 250 2 2 250 8 26

Data Type ID TS ID ID ID ID

Vision Series Data Mapping/ Comments

LMP Questionnaire Response

4.9.6 GT1 (Guarantor Segment) - ORM^O01


The following table lists each Guarantor segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
GT1 Seq 1 HL7 Field Name Set ID - GT1 Opt R Length 4 Data Type SI Vision Series Data Mapping/ Comments One GT1 Segment per Message "1" Guarantor PMIS <PMIS Code> Guarantor Name <Last Name^First^Middle^Suffix>

Guarantor Number

59

CX

3 4 5 6

Guarantor Name Guarantor Spouse Name Guarantor Address Guarantor Ph Num - Home

R O O O

48 48 106 40

XPN XPN XAD XTN

Guarantor Address <Address 1^^City^State^Zip^Country> Guarantor Home Phone <(Area Code)Phone Number^^>

AMICAS, Inc. Proprietary and Confidential

120

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

GT1 Seq 7 8 9 10 11 12 13 14 15 16 17

HL7 Field Name Guarantor Ph Num Business Guarantor Date/Time Of Birth Guarantor Administrative Sex Guarantor Type Guarantor Relationship Guarantor SSN Guarantor Date - Begin Guarantor Date - End Guarantor Priority Guarantor Employer Name Guarantor Employer Address Guarantor Employer Phone Number Guarantor Employee ID Number Guarantor Employment Status Guarantor Organization Name Guarantor Billing Hold Flag Guarantor Credit Rating Code Guarantor Death Date And Time Guarantor Death Flag Guarantor Charge Adjustment Code Guarantor Household Annual Income Guarantor Household Size Guarantor Employer ID Number Guarantor Marital Status Code

Opt O O O O O O O O O O O

Length 40 26 1 2 120 11 8 8 2 130 106

Data Type XTN TS ST IS CE ST DT DT NM XPN XAD

Vision Series Data Mapping/ Comments Guarantor Work Phone <(Area Code)Phone Number> Guarantor DOB <yyyymmdd> Guarantor Gender <PMIS code or Gender Code> Guarantor Qualifier <"1" if person> Guarantor Relationship to Patient <PMIS code or Relationship Code> Guarantor SS Number <SS Number format ###-##-####>

Guarantor Employer Name <Employer Name> Guarantor Employer Address <Address 1^^City^State^Zip> Employer Phone, Fax, Email <(Area Code)Phone Number^Fax Number^Email Address>

18

40

XTN

19 20 21 22 23 24 25 26 27 28 29 30

O O O O O O O O O O O O

20 2 130 1 80 26 1 80 10 3 20 80

CX IS XON ID CE TS ID CE CP NM CX CE Guarantor Employer ID <PMIS or Unique Identification Number>

AMICAS, Inc. Proprietary and Confidential

121

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

GT1 Seq 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55

HL7 Field Name Guarantor Hire Effective Date Employment Stop Date Living Dependency Ambulatory Status Citizenship Primary Language Living Arrangement Publicity Code Protection Indicator Student Indicator Religion Mothers Maiden Name Nationality Ethnic Group Contact Persons Name Contact Persons Telephone Number Contact Reason Contact Relationship Job Title Job Code/Class Guarantor Employers Organization Name Handicap Job Status Guarantor Financial Class Guarantor Race

Opt O O O O O O O O O O O O O O O O O O O O O O O O O

Length 8 8 2 2 80 60 2 80 1 2 80 48 80 80 48 40 80 2 20 20 130 2 2 50 80

Data Type DT DT IS IS CE CE IS CE ID IS CE XPN CE CE XPN XTN CE IS ST JCC XON IS IS FC IS

Vision Series Data Mapping/ Comments

Guarantor Ethnicity <PMIS Code or Ethnicity Code>

AMICAS, Inc. Proprietary and Confidential

122

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.9.7 ACC (Accident Segment) - ORM^O01


The following table lists each Accident segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
ACC Seq 1 HL7 Field Name Accident Date/Time Opt O Length 26 Data Type TS Vision Series Data Mapping/ Comments Accident Date <yyyymmdd> Accident Code <PMIS Code>

2 3 4 5 6 7 8 9 10

Accident Code Accident Location Auto Accident State Accident Job Related Indicator Accident Death Indicator Entered By Accident Description Brought In By Police Notified Indicator

O O O O O

60 25 60 1 12 250 25 80 1

CE ST CE ID ID

Accident State <State>

Accident Type <Accident Type>

4.9.8 DB1 (Disability Segment) - ORM^O01


The following table lists each Disability segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
DB1 Seq 1 2 3 4 HL7 Field Name Set ID - DB1 Disabled Person Code Disabled Person Identifier Disability Indicator Opt R O O O Length 4 2 32 1 Data Type SI IS CX ID Disability Start Date Questionnaire Response <yyyymmdd> Disability End Date Questionnaire Response <yyyymmdd> Disability Return to Work Date Disability Work Return Date Questionnaire Response <yyyymmdd> Vision Series Data Mapping/ Comments One Disability Segment per Message "1"

Disability Start Date

DT

Disability End Date

DT

DT

AMICAS, Inc. Proprietary and Confidential

123

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

DB1 Seq 8

HL7 Field Name Disability Unable to Work Date

Opt O

Length 8

Data Type DT

Vision Series Data Mapping/ Comments Last Worked Date Questionnaire Response <yyyymmdd>

4.9.9 IN1 (Insurance Segment) - ORM^O01


The following table lists each Insurance segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
IN1 Seq 1 HL7 Field Name Opt Length Data Type SI Vision Series Data Mapping/ Comments Number sequentially increased for each insurance segment provided <sequence identifier> Insurance Carrier Code <Insurance Carrier Code> Insurance Coverage Plan Code <Coverage Plan Code> Insurance Name <Insurance Carrier Name> Insurance Address <Address 1^Address 2^City^State^Zip> Insurance Contact Name <Contact Name> Insurance Phone Number <(Area Code)Phone Number> Group Number <Group Number> Group or Plan Name <Coverage Plan Name> Member Number <Member Number>

Set ID - IN1

2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

Insurance Plan ID Insurance Company ID Insurance Company Name Insurance Company Address Insurance Co Contact Person Insurance Co Phone Number Group Number Group Name Insureds Group Emp ID Insureds Group Emp Name Plan Effective Date Plan Expiration Date Authorization Information Plan Type Name Of Insured

R R O O O O O O O O O O O O O

60 59 130 106 48 40 12 130 12 130 8 8 55 3 48

CE CX XON XAD XPN XTN ST XON CX XON DT DT CM IS XPN

Effective Plan Start Date <yyyymmdd> Effective Plan End Date <yyyymmdd> Authorization, Date, Identifier <Authorization^^G1> Insurance Plan Type <Plan Type Name> Insured Name <Last Name^First^Middle^Suffix>

AMICAS, Inc. Proprietary and Confidential

124

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

IN1 Seq 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43

HL7 Field Name Insureds Relationship To Patient Insureds Date Of Birth Insureds Address Assignment Of Benefits Coordination Of Benefits Coord Of Ben. Priority Notice Of Admission Flag Notice Of Admission Date Report Of Eligibility Flag Report Of Eligibility Date Release Information Code Pre-Admit Cert (PAC) Verification Date/Time Verification By Type Of Agreement Code Billing Status Lifetime Reserve Days Delay Before L.R. Day Company Plan Code Policy Number Policy Deductible Policy Limit - Amount Policy Limit - Days Room Rate - Semi-Private Room Rate - Private Insureds Employment Status Insureds Administrative Sex

Opt O O O O O O O O O O O O O O O O O O O O O B O B B O O

Length 80 26 106 2 2 2 1 8 1 8 2 15 26 60 2 2 4 4 8 15 12 12 4 12 12 60 1

Data Type CE TS XAD IS IS ST ID DT ID DT IS ST TS XCN IS IS NM NM IS ST CP CP NM CP CP CE IS

Vision Series Data Mapping/ Comments Insured Relationship & Qualifier <PMIS Code for Relationship^ "1"=person> Insured DOB <yyyymmdd> Insured Address <Address 1^^City^State^Zip^Country>

Release Information <Y, N, or empty>

Policy Number <Policy Number>

Insured's Employment Status <PMIS Code or Employment Status Code> Insured's Gender <PMIS Code or Gender Code>

AMICAS, Inc. Proprietary and Confidential

125

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

IN1 Seq 44 45 46 47 48 49

HL7 Field Name Insureds Employers Address Verification Status Prior Insurance Plan ID Coverage Type Handicap Insureds ID Number

Opt O O O O O O

Length 106 2 8 3 2 12

Data Type XAD ST IS IS IS CX

Vision Series Data Mapping/ Comments Insured's Employer Address <Address 1^^City^State^Zip>

Insured's SS Number <SS Number format ###-##-####>

4.9.10 IN2 (Insurance Segment) - ORM^O01


The following table lists each Insurance segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
IN2 Seq 1 2 HL7 Field Name Insured's Employee ID Insured's Social Security Number Insured's Employer Name and ID Employer Information Data Mail Claim Party Medicare Health Ins Card Number Medicaid Case Name Medicaid Case Number Military Sponsor Name Military ID Number Dependent Of Military Recipient Military Organization Military Station Military Service Military Rank/Grade Military Status Military Retire Date Military Non-Avail Cert On File Opt O O Length 59 11 Data Type CX ST Insured's SS Number <SS Number format ###-##-####> Insured's Employer Name and ID <Employer Name^PMIS or Unique Identification Number> Vision Series Data Mapping/ Comments

3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

O O O O O O O O O O O O O O O O

130 1 1 15 48 15 48 20 80 25 25 14 2 3 8 1

XCN IS IS ST XPN ST XPN ST CE ST ST IS IS IS DT ID

AMICAS, Inc. Proprietary and Confidential

126

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

IN2 Seq 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

HL7 Field Name Baby Coverage Combine Baby Bill Blood Deductible Special Coverage Approval Name Special Coverage Approval Title Non-Covered Insurance Code Payor ID Payor Subscriber ID Eligibility Source Room Coverage Type/Amount Policy Type/Coverage Daily Deductible Living Dependency Ambulatory Status Citizenship Primary Language Living Arrangement Publicity Code Protection Indicator Student Indicator Religion Mother's Maiden Name Nationality Ethnic Group Marital Status Insured's Employment Start Date Employment Stop Date Job Title Job Code/Class

Opt O O O O O O O O O O O O O O O O O O O O O O O O O O O O O

Length 1 1 1 48 30 8 59 59 1 25 25 25 2 2 80 60 2 80 1 2 80 48 80 80 80 8 8 20 20

Data Type ID ID ST XPN ST IS CX CX IS CM CM CM IS IS CE CE IS CE ID IS CE XPN CE CE CE DT DT ST JCC

Vision Series Data Mapping/ Comments

Insured's Marital Status <PMIS Code or Marital Status Code>

AMICAS, Inc. Proprietary and Confidential

127

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

IN2 Seq 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72

HL7 Field Name Job Status Employer Contact Person Name Employer Contact Person Phone Number Employer Contact Reason Insured Contact Person Name Insured Contact Person's Phone Number Employer Contact Person Reason Relationship To The Patient Start Date Relationship To The Patient Stop Date Insurance Co. Contact Reason Insurance Co. Contact Phone Number Policy Scope Policy Source Patient Member Number Guarantor's Relationship To Insured Insured's Phone Number Home Insured's Employer Phone Number Military Handicapped Program Suspend Flag Copay Limit Flag Stoploss Limit Flag Insured Organization Name and ID Insured Employer Organization Name and ID Race HCFA Patient's Relationship to Insured

Opt O O O O O O O O O O O O O O O O O O O O O O O O O

Length 2 48 40 2 48 40 2 8 8 2 40 2 2 60 80 40 40 60 1 1 1 130 130 80 60

Data Type IS XPN XTN IS XPN XTN IS DT DT IS XTN IS IS CX CE XTN XTN CE ID ID ID XON XON CE CE

Vision Series Data Mapping/ Comments Insured's Employment Status <PMIS Code or Employment Status Code>

Insured Phone Number <(Area Code)Phone Number>

AMICAS, Inc. Proprietary and Confidential

128

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.9.11

PR1 (Procedure Segment) - ORM^O01


The following table lists each Procedure segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
PR1 Seq 1 HL7 Field Name Opt Length Data Type SI Vision Series Data Mapping/ Comments Number sequentially increased for each procedure segment provided <sequence identifier>

Set - PR1

R (B) R

Procedure Coding Method

IS Procedure Code, Unit Value and Accession Number <Procedure Code^Unit^Accession Number> Procedure Code Description and Resource Category <Procedure Code Description^Resource Category> Procedure Schedule Date and Time <yyyymmddhhmm>

Procedure Code

80

CE

Procedure Description

40

ST

5 6 7 8 9 10 11

Procedure Date/Time Procedure Functional Type Procedure Minutes Anesthesiologist Anesthesia Code Anesthesia Minutes Surgeon

R R O B O O B

26 2 4 120 2 4 120

TS IS NM XCN IS NM XCN

Technologist PMIS <PMIS Code> Dictating Radiologist <PMIS code or Unique Identification Number^Last Name^First^Middle^Suffix>

12 13 14 15

Procedure Practitioner Consent Code Procedure Priority Associated Diagnosis Code

B O O O

230 60 2 80

XCN CE NM CE

Diagnosis Codes <Diagnosis Code 1~Diagnosis Code 2~(all diagnoses)> Procedure Modifier Rank 1 <Procedure Modifier 1~Modifier 2~Modifier 3~Modifier 4>

16

Procedure Code Modifier

80

CE

AMICAS, Inc. Proprietary and Confidential

129

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

4.10 ACK Acknowledgment Message Type


4.10.1 Definition
The HL7 Acknowledgment Message Type, ACK will be sent by the filler to Vision Series RIS with a success or error message. Once a message is sent from Vision Series RIS (VSRIS) the filler should validate the message. If validation fails, a reject message should be constructed and returned to VSRIS. If validation does not fail, a success message should be returned to VSRIS. The following tables list each Message Type, Trigger Event Type and their descriptions:
Message Type MSH MSA Trigger Event Type A08, A34, R01 A08, A34, R01 Description Message Header Message Acknowledgment

See the Glossary for definitions of each interface.

4.10.2 MSH (Message Header Segment) - ACK


The following table lists each Message Header segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSH Seq 1 2 3 4 5 6 7 8 9 HL7 Field Name Field Separator Encoding Characters Sending Application Sending Facility Receiving Application Receiving Facility Date/time of Message Security Message Type Opt R R O O O O O O R Length 1 4 180 180 180 180 26 40 7 Data Type ST ST HD HD HD HD TS ST CM ACK System date/time 10 Message Control ID O 20 ST <yyyymmddhhmmss> This ID is echoed back to the placer in the MSA segment. 11 12 13 14 Processing ID Version ID Sequence Number Continuation Pointer R R O O 3 60 15 180 PT VID NM ST P 2.3 HL7 version number Current date/time <yyyymmddhhmmss> "|" "^~\&" Vision Series RIS <Corporation Name> PACS Vision Series Data Mapping/ Comments

AMICAS, Inc. Proprietary and Confidential

130

Vision Series RIS 5.0 HL7 Interface Guide

Outbound Messages

MSH Seq 15 16 17 18 19 20

HL7 Field Name Accept Acknowledgment Type Application Acknowledgment Type Country Code Character Set Principal Language of Message Alternate Character Set Handling Scheme

Opt O O O O O O

Length 2 2 2 16 60 20

Data Type ID ID ID ID CE ID "AL"

Vision Series Data Mapping/ Comments

4.10.3 MSA (Message Acknowledgment Seg.) - ACK


The following table lists each Message Acknowledgement segment and their Seq, HL7 Field Name, Opt, Length, Data Type, Rejection Rules, and Mapping/Comments:
MSA Seq HL7 Field Name Opt Length Data Type Vision Series Data Mapping/ Comments AA if Accepted (Original Mode) AE if Error (Original Mode) 1 Acknowledgment Code R 2 ID AR if Rejected (Original Mode) CA if Accepted (Enhanced Mode) CE if Error (Enhanced Mode) CR if Rejected (Enhanced Mode) 2 3 4 5 6 Message Control ID Text Message Expected Sequence Number Delayed Acknowledgment Type Error Condition R O O B O 20 80 15 1 100 ST ST NM ID CE The MSH_10 Message Control Number is echoed back to the placer Message Text

AMICAS, Inc. Proprietary and Confidential

131

Vision Series RIS 5.0 HL7 Interface Guide

Glossary

Glossary
Term ACC ACK Definition The accident segment contains patient information relative to an accident in which the patient has been involved. General Acknowledgment. The ACK message is used to respond to a message indicating receipt and status (either success or failure) by the receiving system. Admission, Discharge and Transfer messages contain information relating to patient demographics. Application Entity. The appointment information location resource segment contains information about location resources (meeting rooms, operating rooms, examination rooms, or other locations) that can be scheduled. Resources included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Resources not controlled by a schedule are not identified on a schedule request using this segment. Location resources are identified with this specific segment because of the specific encoding of locations used by the HL7 specification. The appointment information personnel resource segment contains information about the personnel types that can be scheduled. Personnel included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Personnel not controlled by a schedule are not identified on a schedule request using this segment. The kinds of personnel described on this segment include any healthcare provider in the institution controlled by a schedule (for example: technicians, physicians, nurses, surgeons, anesthesiologists, or CRNAs). The appointment information service segment contains information about various kinds of services that can be scheduled. Services included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Services not controlled by a schedule are not identified on a schedule request using this segment. American Standard Code for Information Interchange. Patient Account Balance Information message type. This message type sends data from some application (usually a Registration or an ADT system) to the patient accounting or financial system to establish an account for a patients billing/accounts receivable record. An interface engine. The disability segment contains information related to the disability of a person. This segment was created instead of adding disability attributes to each segment that contains a person (to which disability may apply).

ADT AE AIL

AIP

AIS

ASCII BAR

Broker DB1

AMICAS, Inc. Proprietary and Confidential

132

Vision Series RIS 5.0 HL7 Interface Guide

Glossary

Term EVN Filler

Definition Event Type segment. This segment is used to communicate necessary trigger event information to receiving applications. The application receiving and processing an HL7 message, i.e., entering the report in received in an ORU^R01into their application or creating a record or an order based on receipt of an ORM^O01. The guarantor segment contains information on the person or the organization with financial responsibility for payment of a patient account. Health Level Seven (HL7) is an application protocol for electronic data exchange in health care environments. The HL7 protocol is a collection of standard formats which specify the implementation of interfaces between different computer applications from vendors. This communication protocol allows healthcare institutions to exchange key sets of data amount different application systems. Flexibility is built into the protocol to allow compatibility for specialized data sets that have facilityspecific needs. The insurance segment contains insurance policy coverage information relating to the patient and visit. The insurance segment contains additional insurance policy coverage and benefit information necessary for proper billing and reimbursement. Information System. Lower Layer Protocol. Each message has a message type that defines its purpose. For example, the ADT Message Type is used to transmit portions of a patients demographic data from one system to another. A 3-character code contained within each message identifies its type. Master File Acknowledgment segment. This segment returns record-specific acknowledgement information. Master File Entry segment. This segment carries the recordlevel event code (such as Add, Update, etc.), the initial and requested dates for the event and the record-level key identifying the entry in the master file. Master File Identification segment. This segment identifies the master file being updated, as well as the initial and requested dates for file-level events such as Replace File. Master Files Notification message type. This message type provides a way of maintaining the synchronization of data across various applications at a given site. Patient Merge Information segment. This segment sends patient demographics to the receiving system to initiate the merging of one patients data into another patients data.

GT1

HL7

IN1 IN2

IS LLP Message Type

MFA MFE

MFI

MFN

MRG

AMICAS, Inc. Proprietary and Confidential

133

Vision Series RIS 5.0 HL7 Interface Guide

Glossary

Term MSA

Definition Message Acknowledgement segment. The filler will use this segment to send an acknowledgment of success or error to placer. If the message is processed successfully, the filler generates a functional response message with an MSA-1 Acknowledgment Code of AA. If an error occurs during processing, the filler will send an error response providing a MSA-1 Acknowledgement Code of AE and an error message in MSA-3 Text Message. If the filler rejects the message for any reason, it creates an ACK message with a MSA-1 Acknowledgement Code of AR.

MSH

Message Header segment. A message control segment that defines the intent, source, destination and some specifics of the syntax of a message. All HL7 messages start with a MSH segment. Notes and comments segment. Observation Request segment. In the reporting of clinical data, this segment serves as the report header. It is used to transmit information specific to an order for a diagnostic study or observation. When a set of observations is ordered, the order message contains an OBR message. When observations are reported, the report message includes one OBR segment. Some fields only apply to the ordering message and some only apply to the reporting message. Observation/result message. OBX is intended to cover all types of patient specific observation reports except pharmacy. This segment is used to transmit a single observation or part of an observation. It is the smallest inseparable unit of a report. It is used to carry information about observations in report messages and can also be part of an observation order. Multiple OBXs may be sent in an observation report. Common Order segment. This segment is required in the ORM message. The ORC is a common segment for all orders. It is used to transmit fields that are common to all orders. General Order Message. The function of this message is to initiate the transmission of information about an order. This includes placing new orders, cancellation of existing orders, discontinuation, holding, etc. General Order Acknowledgment. The function of this message is to respond to an ORM message. An ORR message is the application acknowledgment to an ORM message. Unsolicited Transmission of an Observation. For each patient order results may be transmitted depending upon the number of observations generated by the order.

NTE OBR

OBX

ORC

ORM

ORR

ORU

AMICAS, Inc. Proprietary and Confidential

134

Vision Series RIS 5.0 HL7 Interface Guide

Glossary

Term PID

Definition Patient Identification segment. This segment is used by all applications as the primary means of communicating patient identification information. It contains permanent patient identifying and demographic information. The application originating the HL7 message, i.e. if a patients report is signed, an ORU^R01 message is triggered to be sent to the defined filler(s). The procedures segment contains information relative to various types of procedures that can be performed on a patient. The PR1 segment can be used to send procedure information, for example: Abdominal Ultrasound, X-ray with contrast, etc. The PR1 segment is used to send the procedures for medical records encoding or for billing systems. Patient Visit segment. This segment is used to communicate information on an account or visit-specific basis. The PV2 segment is a continuation of visit-specific information contained on the PV1 segment. The resource group segment is used to identify relationships between resources identified for a scheduled event. This segment can be used, on a site specified basis, to identify groups of resources that are used together within a scheduled event, or to describe some other relationship between resources. To specify related groups of resources within a message, begin each group with an RGS segment, and then follow that RGS with one or more of the Appointment Information segments (AIG, AIL, AIS, or AIP). Radiology Information System. The schedule segment contains general information about the scheduled appointment. An HL7 segment is a logical grouping of data fields. Segments of a message may be required or optional. They may occur only once in a message or they may be allowed to repeat. Each segment is identified by a unique three character code known as the Segment ID. Schedule Information Unsolicited messages are used to send and receive schedule information regarding patient appointments. Transmission Control Protocol/Internet Protocol.

Placer

PR1

PV1 PV2 RGS

RIS SCH Segment

SIU

TCP/IP

AMICAS, Inc. Proprietary and Confidential

135

Vision Series RIS 5.0 HL7 Interface Guide

Glossary

Term Trigger Event

Definition The event that initiates an exchange of messages is called a trigger event. The HL7 Standard is written from the assumption that an event in the real world of healthcare creates the need for data to flow among systems. The real-world event is called the trigger event. For example, the trigger event a patient is scheduled may cause the need for data about that patient to be sent to a number of other systems. There is a one-to-many relationship between message types and trigger event codes. The same trigger event code may not be associated with more than one message type. Unique Identifier.

UID

AMICAS, Inc. Proprietary and Confidential

136

Vision Series RIS 5.0 HL7 Interface Guide

Appendix A: Data Types

Appendix A: Data Types


Data Type Category Alphanumeric ST TX FT Numerical CQ NM SI Identifier ID IS HD EI Coded values for HL7 tables Coded value for userdefined tables Hierarchic designator Entity identifier <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)> <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)> <point of care (IS)> ^ <room (IS)> ^ <bed (IS)> ^ <facility (HD)> ^ < location status (IS)> ^ <person location type (IS)> ^ <building (IS)> ^ <floor (IS)> ^ <location description (ST)> <processing ID (ID)> ^ <processing mode (ID)> Composite quantity with units Numeric Sequence ID <quantity (NM)> ^ <units (CE)> String Text data Formatting text 199 65536 65536 Data Type Name Length Notes/Format

PL PT Date/Time DT TS Code Values CE

Person location Processing type

Date Time stamp

YYYY[MM[DD]] YYYY[MM[DD[HHMM[SS[.S[S[S[S]]]]]]]][+/-ZZZZ] ^ <degree of precision>

Coded element

250

<identifier (ST)> ^ <text (ST)> ^ <name of coding system (IS)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (IS)> <ID (ST)> ^ <check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ < assigning authority (HD)> ^ <identifier type code (ID)> ^ < assigning facility (HD) ^ <effective date (DT)> ^ <expiration date (DT)>

CX

Extended composite ID with check digit

250

AMICAS, Inc. Proprietary and Confidential

137

Vision Series RIS 5.0 HL7 Interface Guide

Appendix A: Data Types

Data Type Category

Data Type Name

Length

Notes/Format <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type code (ID)> ^ <identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility (HD)>

XCN

Extended Composite ID Number and Name

250

Generic CM Composite No new CMs are allowed after HL7 Version 2.2. The CM data type is maintained strictly for backward compatibility and may not be used for the definition of new fields.

Demographics In Version 2.3 and later, replaces the AD data type. <street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code (ST)> ^ <country (ID)> ^ < address type (ID)> ^ <other geographic designation (ST)> ^ <county/parish code (IS)> ^ <census tract (IS)> In Version 2.3, replaces the PN data type. <family name (FN)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (IS)> ^ <name type code (ID) > <organization name (ST)> ^ <organization name type code (IS)> ^ <ID number (NM)> ^ <check digit (NM)> ^ <code identifying the check digit scheme employed (ID)> ^ <assigning authority (HD)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)> In Version 2.3 and later, replaces the TN data type. [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ <phone number (NM)> ^ <extension (NM)> ^ <any text (ST)>

XAD

Extended address

250

XPN

Extended person name

250

XON

Extended composite name and ID number for organizations

250

XTN

Extended telecommunications number

250

Time Series <quantity (CQ)> ^ <interval (*)> ^ <duration (*)> ^ <start date/time (TS)> ^ <end date/time (TS)> ^ <priority (ID)> ^ <condition (ST)> ^ <text (TX)> ^ <conjunction (ID)> ^ <order sequencing (*)>

TQ

Timing/quantity

AMICAS, Inc. Proprietary and Confidential

138