Read HL7_Configuration_UG.book text version

Allscripts Homecare

HL7 Configuration User`s Guide

Copyright © 2011 Allscripts Healthcare Solutions, Inc.

www.allscripts.com

Copyright © 2011 Allscripts Healthcare Solutions, Inc.

This document is the confidential property of Allscripts Healthcare Solutions, Inc. It is furnished under an agreement with Allscripts Healthcare Solutions, Inc. and may only be used in accordance with the terms of that agreement. The use of this document is restricted to customers of Allscripts Healthcare Solutions, Inc. and their employees. The user of this document agrees to protect the Allscripts Healthcare Solutions, Inc. proprietary rights as expressed herein. The user further agrees not to permit access to this document by any person for any purpose other than as an aid in the use of the associated system. In no case will this document be examined for the purpose of copying any portion of the system described herein or to design another system to accomplish similar results. This document or portions of it may not be copied without written permission from Allscripts Healthcare Solutions, Inc. The information in this document is subject to change without notice. The names and associated patient data used in this documentation are fictional and do not represent any real person living or otherwise. Any similarities to actual people are coincidental. CPT copyright 2009 American Medical Association. All rights reserved. Fee schedules, relative value units, conversion factors and/or related components are not assigned by the AMA, are not part of CPT, and the AMA is not recommending their use. The AMA does not directly or indirectly practice medicine or dispense medical services. The AMA assumes no liability for data contained or not contained herein. CPT is a registered trademark of the American Medical Association. International Statistical Classification of Diseases and Related Health Problems (ICD) is copyright 2009 World Health Organization (WHO). Microsoft® Excel and Microsoft® Word are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Table of Contents

HL7 Interface ............................................................................................................. 5

HL7 General Overview ................................................................................................. 5 Allscripts Homecare HL7 Interface ............................................................................... 5 HL7 Interface HighLevel Flow ...................................................................................... 6 Available Interfaces Short Overview ............................................................................. 6 Telemedicine Interface .......................................................................................... 7 Pharmacy Interface ................................................................................................ 7 ADT Interface ........................................................................................................ 7 Supported HL7 Messages Types ................................................................................... 8 ADT Message Example ................................................................................................. 8 HL7 Interface System Requirements ............................................................................ 9 HL7 Interface Configuration Overview ........................................................................ 10 General Checklist for HL7 Interface Usage .................................................................. 11 HL7 Privileges Settings ............................................................................................... 12 Setting Up HL7 Administration Privileges .................................................................... 12 Setting Up HL7 Interfaces Privileges ........................................................................... 13 Setting Up HL7 Patient Privileges .............................................................................. 13 Setting Up HL7 Patient Account # Privilege ................................................................. 14 Setting Up HL7 Reports Privileges .............................................................................. 15 Adding a "Loopback" Destination ............................................................................... 24

Interface Specific Configurations ..................................................................... 25

ADT Configuration Specifics ....................................................................................... 25 Setting Up Patient Status Codes ........................................................................... 25 Setting Up Z Segments ......................................................................................... 26 Telehealth Configuration Specifics ............................................................................. 27 Setting Up Vendor ............................................................................................... 27 Setting Up Disciplines .......................................................................................... 28 Setting Up Clinical Monitoring Data ...................................................................... 29 Pharmacy Configuration Specifics .............................................................................. 30 Allscripts Homecare HL7 Interface PV118 Location Logic ...................................... 30

HL7 Configuration User's Guide

3

Table of Contents

Pharmacy Logic and Location ................................................................................31 Pharmacy Categories and Values ..........................................................................32

Interfacing with Allscripts Referral Manager ...............................................33

Integration between Allscripts Referral Manager and Allscripts Homecare ..................33 Keeping Allscripts Referral Manager and Allscripts Homecare Synchronized ................34 Process HL7 ADT Messages from Referral Manager ...............................................34 Maintain Single Signon ........................................................................................34 Activate the Automatic Sending of the Start of Care Date ......................................35 How to Enable an Operator to View Referrals in Allscripts Referral Manager ...............35 Managing Privileges Related to Viewing Referrals .................................................36 Storing Referral Manager Credentials ...................................................................36 How Do I Change the Referral Manager Credentials Stored in an Operator's Password Vault? ........................................................................................................................37 Setting the Referral Manager URL ...............................................................................38 How Do I Automatically Send the Start of Care Date to Allscripts Care Manager? .........39 How Can One Patient Have Multiple Referrals from Allscripts Referral Manager? ........40

Operators Supplement for Allscripts Referral Manager Interface ......41

Who May Benefit from Referral Manager Interface? ...................................................41 How do I View a Referral from Allscripts Referral Manager? ........................................41 How do I Enable Single Signon with Allscripts Referral Manager? ...............................43 Why Can I Not See the "View Referral" Link? ..............................................................44

HL7 Message Definition Parameters ..............................................................46

HL7 Message Definitions ............................................................................................46 Outbound HL7 Message Event Triggers .......................................................................57 Vendor Configurations ...............................................................................................65 Allscripts Referral Manager (formerly ECIN) Configuration Specifics .......................65 Philips Configuration Specifics ....................................................................................72 AMC Configuration Specifics .......................................................................................74 HomMed Configuration Specifics ................................................................................75 Hospice Pharmacia Configuration Specifics .................................................................76 Require May Administer .......................................................................................76 Default Physician ID to MD#1 ...............................................................................76

4 HL7 Configuration User's Guide

HL7 Interface

HL7 Interface

HL7 General Overview

Health Level Seven (HL7) refers to the highest level of the International Standards Organization's (ISO) communications model for Open Systems Interconnection (OSI) the application level. The application level addresses the data definition to be exchanged, the interchange timing, and the communication of certain errors to the application. The seventh level supports such functions as security checks, participant identification, availability checks, exchange mechanism negotiations, and, most importantly, data exchange structuring. The goal of HL7 compliance is to facilitate communication, provide standards for the exchange of data among healthcare applications, and reduce custom interface programming. The HL7 Standard was developed by a community of healthcare subject matter experts and information scientists collaborating to create standards for the exchange, management, and integration of electronic healthcare information.

Allscripts Homecare HL7 Interface

The Allscripts Homecare HL7 Interface is a standard messaging format for transferring information from system to system. The HL7 message processing can process both inbound and outbound messages. With the Allscripts Homecare HL7 Interface, the bidirectional electronic data interchange of patient data including information such as demographics, insurance, physician, diagnosis, medication, and vital signs can be processed. Patient information is carried within ADT, BAR, DFT, OMP, ORU, and ACK messages which adhere to the HL7 2.4 Standard. The Allscripts Homecare HL7 Interface is a powerful tool to aid in the real time electronic interchange of data; it is dependable and easily configured.

Note Note

For information on HL7 new installation or upgrade, refer to the Homecare New Installation or Upgrade Allscripts Homecare guides.

HL7 Configuration User's Guide

5

HL7 Interface

HL7 Interface HighLevel Flow

The diagram shows how the Allscripts Homecare HL7 Web Service performs the processing of HL7 messages.

Available Interfaces Short Overview

Allscripts Homecare application supports the following interfaces: > > > ADT Interface ­ Allows sending and receiving of patient demographic information. Telemedicine Interface ­ Allows receiving ORU R01 message with discrete data and notes. Pharmacy Interface ­ Allows receiving OMP O09 message with medications for patients who are registered with a qualified vendor for this service.

6

HL7 Configuration User's Guide

HL7 Interface Note Note

The telemedicine and pharmacy interfaces are incorporated with the ADT outbound interface.

Telemedicine Interface

Allscripts Homecare offers a solution to our clients for integration of clinical monitoring data from TeleHealth vendors. The solution uses HL7 messaging to send patient data to the TeleHealth vendor (via ADT messages) and receive clinical data from the TeleHealth vendor (via ORU messages). The goal of the TeleHealth vendor integration is to display the data captured by TeleHealth device in a comprehensive display for the clinician. This display is provided within the Allscripts Homecare Clinical Monitoring windows. The R01 inbound message is used for discrete data (vitals, measurements, and so on), as well as clinical notes.

Pharmacy Interface

The Allscripts Pharmacy interface enables ADTs outbound to be passed from Allscripts to the pharmacy system. The pharmacy vendor functionality enables the processing of the HL7 OMP O09 medication transaction, inbound from the pharmacy application to the Allscripts application. The Allscripts user benefits from this interface because the need to manually enter medication information into Allscripts will be eliminated for patients new to the system at the point that the interface goes live. The pharmacy vendor will handle all medication management issues, including drug and allergy interactions, changes to the meds, and so on. In addition, complex, compounded medications unique to the needs of terminal hospice patients, which our application is not designed to be able to assemble, can be sent through the interface.

ADT Interface

The Allscripts Homecare interface uses the ADT message types to communicate core patient demographic information. The ADT messages within the HL7 standard are typically initiated to inform ancillary systems that a patient was admitted, discharged, transferred, merged, that other demographic data about the patient were changed (name, insurance, next of kin, and so on), or that some visit information was changed (patient location, attending doctor, and so on).

HL7 Configuration User's Guide

7

HL7 Interface

The Allscripts Homecare system includes the HL7 Inbound and Outbound functionalities with which you can send and receive the ADT messages.

Supported HL7 Messages Types

The following are the HL7 message types supported by Allscripts Homecare: > > > > > > > > > > > > ADT A01 ­ Admit a Patient. ADT A02 ­ Transfer a Patient. ADT A03 ­ Discharge a Patient. ADT A04 ­ Register a Patient. ADT A08 ­ Update Person Information. ADT A28 ­ Add Person Information. ADT A31 ­ Update Person Information. BAR P01 ­ Add/Update Patient Account. OMP O09 ­ Pharmacy/Treatment Order Message. ACK (Acknowledgement) ­ Sent upon receipt of all inbound messages and required for all outbound messages. ORU R01 ­ Unsolicited Observation (Custom Outbound Only). ORU R01 ­ Unsolicited Observation (Telemedicine Inbound Only).

ADT Message Example

This specific example is an ADT A01 message, which is an admission message. MSH|^~\&|MHC HL7 Server|chwhl7|visit|admission|20050124142253921||ADT^A01|131 |P|2.4 EVN|A01|20050124142253921 PID|||||KEVIN^Jones||19220303000000000|M|||19 Main Street^^Raleigh^NC^27615||919-555-3939|||M||^^^^^Misys Home Health |116-26-2626 PV1||U||||||A47811|||||||||A47811||||||||||||||||||||||||||| 20041107000000000 DG1|0||401.9^HYPERTENSION NOS||20010101000000000|F IN1|0|116-26-2626^^^MP|||||||||||||M

8 HL7 Configuration User's Guide

HL7 Interface

The A01 message is broken into segments by the pipe symbol which is the field separator. A segment is a logical grouping of data fields. The following segments are listed in the above example: > > > > > > MSH Message Header EVN Event Type PID Patient Identifier PV1 Patient Visit DG1 Diagnosis IN1 Insurance

HL7 Interface System Requirements

You need to have the following additional components installed for the proper functioning of the application: 1. Windows 2003 Server. A separate server is required from the application server. The interface can share the same server as Alert Manager or Physician Portal. 2. .NET Framework v.2.0. 3. IIS 5.1 or greater. 4. Allscripts Homecare HL7 Service installed. 5. HL7 HTTP Web Service (if you will be using HTTP(S) protocol). 6. SSL (if you will be using HTTP(S) protocol for incoming messages).

Note Note

Contact your IT department if you are uncertain about your ability to meet these requirements.

HL7 Configuration User's Guide

9

HL7 Interface

HL7 Interface Configuration Overview

HL7 activities that are available in the application depend on the agency's HL7 licensing and the privileges granted to each individual user. Privileges and initial interface setup are available in Administration>Configuration, and include: > > > > Message processing. Reports. Patient records. General HL7 interface settings.

Architecture of the HL7 system consists of three main parts:

The HL7 Service

The HL7 Service is a plugin that runs under the Allscripts Service Manager application. The main goals of the HL7 Service are the following: > > > > Listen to the TCP/IP port. Receive HL7 message. Transmit the received HL7 message to the HL7 WebService for further processing. The HL7 WebService

The HL7 WebService is a .Net WebService that performs: > Inbound activities: · · · > · · · Parse HL7 message and store data into internal relational structure (Message Parser). Validate HL7 data (Business Layer). Store HL7 data in the Allscripts database (Data Access Layer). Read data from Allscripts database and store in the internal relational structure (Data Access Layer). Complete HL7 message with data from internal relational structure (Message Parser). Send HL7 message.

Outbound activities:

The Allscripts Application Server

The Allscripts Application Server performs the following activities: > >

10

Run separate thread that listens (periodically scans Allscripts database) for new HL7 outbound messages. Run outbound process on the HL7 WebService when new outbound messages are present.

HL7 Configuration User's Guide

HL7 Interface

General Checklist for HL7 Interface Usage

Before using the HL7 functionality (sending and receiving messages), it may be necessary to communicate with the third party vendor's technical representative or your own technical representatives to define the communication setup. This primarily occurs with ADT only interfaces because of the various potential third party systems involved. Since different vendors can use different communications protocols, applications, and other items, it is obligatory to agree on the settings to make sure that the system exchanges the necessary data correctly. In the case of Telephony and Telemedicine Interfaces, Allscripts has already worked with the third party vendors to address these considerations. However, due to the changing nature of all the applications involved, technical review is prudent. Use the following checklist to ensure that all requirements are met: 1. Supported communication protocols: Allscripts Homecare supports TCP/IP and HTTP(S) protocols. If the third party vendor uses another communication protocol, you will not be able to establish a connection for receiving or sending messages. · If the vendor is using TCP/IP, you will need to exchange the following information for configuration: 1. IP address of the vendor. 2. Allscripts server IP address. 3. The Port that the vendor's server is listening on. 4. The Port that the Allscripts server is listening on (default is port 8000). · If the vendor is using HTTP(S), you will need to exchange the following information for configuration: 1. URL of the vendor's server and page that will receive messages. The URL can contain the http:\\ or https:\\ prefix. 2. Allscripts Homecare HTTP Inbound Web Service URL that will receive messages. The URL can contain the http:\\ or https:\\ prefix. 2. HTTPS is recommended if the Allscripts server and third party vendor server are not in the same domain or behind the same firewall.

HL7 Configuration User's Guide

11

HL7 Interface

HL7 Privileges Settings

Administration>Configuration>HL7 HL7 configuration windows are visible only for users who have purchased HL7 licensing from Allscripts Homecare. Licensing is activated after interface installation. HL7 activities that are available for operators in the Allscripts Homecare application depend on your HL7 licensing and the options selected on the Privileges tab of the Operators window (Administration>Configuration>Operators). The HL7 options for which readonly or full access is granted appears in the menu.

Setting Up HL7 Administration Privileges

1. In the Operators window (Administration>Configuration>Operators), select an operator and click the Privileges tab. Note All privilege selections are done by Business Unit. 2. In the Category pane, click the plus sign (+) next to the corresponding category or doubleclick the heading to expand the navigation tree according to the following path: Administration>Configuration>HL7. The list of HL7 components appears on the right pane of the window.

3. For each of the HL7 components, define whether the selected operator is to have full access, readonly access, or no access within the application.

12 HL7 Configuration User's Guide

HL7 Interface

4. Click

or select Save All from the File menu to save all the settings.

Setting Up HL7 Interfaces Privileges

1. In the Operators window (Administration>Configuration>Operators), select an operator and click the Privileges tab. Note All privilege selections are done by Business Unit. 2. On the Category pane, click the plus sign (+) next to the corresponding category or doubleclick the heading to expand the navigation tree according to the following path: Interfaces>HL7. The list of HL7 interfaces appears on the right pane of the window.

3. Selected full or readonly access to the HL7 interfaces to make them available in the Administration and Interface components of the application respectively. The interfaces with no access will remain hidden in the application but can be enabled at any time. 4. Click or select Save All from the File menu to save all the settings.

Setting Up HL7 Patient Privileges

1. In the Operators window (Administration>Configuration>Operators), select an operator and click the Privileges tab. Note All privilege selections are done by Business Unit.

HL7 Configuration User's Guide

13

HL7 Interface

2. In the Category pane, click the plus sign (+) next to the corresponding category or doubleclick the heading to expand the navigation tree according to the following path: Patient>HL7. The list of HL7 interfaces available through Patient component appears on the right pane of the window.

3. For each of the HL7 interfaces, define whether the selected operator is to have full access, read only access, or no access to the application. 4. Click or select Save All from the File menu to save all the settings.

Setting Up HL7 Patient Account # Privilege

1. In the Operators window (Administration>Configuration>Operators), select an operator and click the Privileges tab. Note All privilege selections are done by Business Unit.

14

HL7 Configuration User's Guide

HL7 Interface

2. In the Category pane, click the plus sign (+) next to the corresponding category or doubleclick the heading to expand the navigation tree according to the following path: Patient>General>Basic. The list of available privileges appears in the right pane of the window.

3. Define whether you want the selected operator to have access to view and edit the Account #. This option will appear under Master ID in the Allscripts Homecare application. It is used to view and edit the value passed via applicable messages in the PID_18 (PID\PatientAccountNumber\IDNumber) segment. If this segment\field combination is not used, this step may be omitted. 4. Click or select Save All from the File menu to save all the settings.

Setting Up HL7 Reports Privileges

1. In the Operators window (Administration>Configuration>Operators), select an operator and click the Privileges tab. Note All privilege selections are done by Business Unit.

HL7 Configuration User's Guide

15

HL7 Interface

2. In the Category pane, click the plus sign (+) next to the corresponding category or doubleclick the heading to expand the navigation tree according to the following path: Reports>HL7. The list of available HL7 reports appears in the right pane of the window.

3. For each of the HL7 reports define whether the selected operator should have full access, read only access, or no access to the application. 4. Click or select Save All from the File menu to save all the settings.

HL7 General Settings

Before working with the HL7 functionality, it is necessary to customize the system settings according to your agency's policies and procedures. To successfully setup the HL7 component, the HL7 Inbound and Outbound functionality Licensing, and Vendor Licensing setup must be performed by the member of the Allscripts Support Team.

16

HL7 Configuration User's Guide

HL7 Interface

To configure the general HL7 settings, perform the following steps: 1. Open the Administration component. 2. Select Configuration>HL7>General. The HL7 General Settings window appears where you can set up HL7 patient identifier options, inbound messaging options, message logging options, and other options you need.

3. In the General section of the Inbound Processing tab, select the Reject duplicated messages check box to prevent receipt of duplicated messages. 4. In the Patient's Identifiers section, select patient first and second identifiers to be used for HL7 from the corresponding dropdown lists. Note By default, the first HL7 identifier is the Master ID (if both identifier fields are left blank). Patient's Identifiers are values passed within the HL7 message used to match the message with the existing patient in the system. First Identifier ­ Primary identifier which is the first value used for matching. Second Identifier ­ If a positive match is not found via the First Identifier, then the second is incorporated.

HL7 Configuration User's Guide

17

HL7 Interface

5. The Allow insert Patient Code check box works in conjunction with the Generate New Patient Code option in the following manner:

Generate New Patient Codes True

Allow Insert Patient Code True

Patient code inserting functionality Try to insert patient code value from the message. If patient code already exists in database, then generate an error message. Patient code value from the message is ignored. New patient code value is generated automatically and warning message is generated: "Patient Code value in this message will not be used because Allow Insert Patient Code has not been enabled in the application." Try to insert the patient code value from the HL7 message. If the patient code value already exists in the database, then error message is generated and HL7 message processing is stopped. Patient code value from the message is ignored. Generate an error message: "Cannot complete message because Allow Insert Patient Code has not been enabled in the application."

True

False

False

True

False

False

6. Select the Allow updated Master ID check box to populate the Master ID value from the HL7 message (PID_3.1) in the database. If selected and one of the patient identifiers is set to Master ID, then the Master ID value (PID_3.1) will be not populated. If not selected, the Master ID value from PID_3.1 will not be populated.

18

HL7 Configuration User's Guide

HL7 Interface

7. In the Auto complete inbound messages section, you can select check boxes that regulate completion of inbound messages according to different criteria: Auto Complete Inbound Messages: Auto complete HL7 messages with no error allows inbound HL7 messages with no errors or warnings to automatically be completed and flow into the application in a prospective admit status. With warnings as above, but allows messages with warnings to be completed automatically. Auto readmit patient (for A01, A04, A28, P01 only) if checked, the inbound referenced message types can be used for auto readmission. Auto resume patient in transfer status (for A01, A04, A28, P01 only) if checked, the inbound referenced message types may be used for automatic resumption if the patient has a status code of transfer type attached. Ignore insurance information that cannot be auto completed if checked, logic will ignore erroneous insurance information and allow the message to complete into the application without the insurance data. 8. In the Medication Processing section, select the following check boxes: Use GPI Code for identification of a medication if selected, allows medication matching via the GPI Code. Allow empty dose, units, frequency and route for MediSpan medications if selected, logic ignores blank dose, route, units and frequency values. Allow processing of Covered indicator for medications If selected, allows processing of Covered indicator (RXO24.4) for medication from inbound OMP O09 message. This option marks the medication as covered within Patient>Clinical>Medications. If not, selected and the Covered indicator is included in the inbound message a warning message will appear during message processing. 9. In the Insurance Processing section, select the Allow Expanded Processing for A05 and A08 check box that allows A05 and A08 messages to insert new data (pay control, negotiated rates, and insurance companies) along with the standard data into the Allscripts Homecare database. 10. In the Business Unit settings section, select the Business Unit that will default for all inbound HL7 message which do not contain a value for Business Unit in PID_18.6.1. 11. In the Diagnosis processing section, select the Auto insert new diagnosis check box if you want to automatically insert new diagnosis into the HL7 message when the diagnosis is updated. 12. Save your changes and go to the Logging tab. On this tab, you can select whether or not to store HL7 Logs, which logs to save (for example, System Errors or System Events), and the time period for storing these logs on your computer. You can select the following check boxes: · Store HL7 logs ­ stores all HL7 messages inbound and outbound in the database for advance troubleshooting.

HL7 Configuration User's Guide

19

HL7 Interface

· · · · ·

Clear HL7 logs after XX week(s) ­ Clears the stored log files after the specified number of weeks. Log System Errors ­ Logs any HL7 related system errors. Log System Events ­ Logs any HL7 related system events. Path to the log files ­ The path on the system hard drive where the logs are stored. Delete log files after ­ Purges the stored log files after the specified number of weeks.

Caution It is strongly recommended to save message logging information to keep track of what occurred during the message processing. Saved logs can be used further by the Allscripts Homecare Support Team for troubleshooting.

13. Click

to save your changes and go to the R01 Message tab.

On this tab, you can activate or inactivate the whole R01 Messaging process.

14. Select the Process R01 Messages check box to enable the system to process R01 messages. If one of the destinations is marked as an R01 Subscriber, the Outbound Processing functionality checks for data to populate the R01 message automatically and then sends an R01 message to the corresponding destination. ORU R01 messages can be sent using the outbound functionality. It does not appear for selection in the Outbound HL7 Message Processing window.

20 HL7 Configuration User's Guide

HL7 Interface

15. To set the time period of the searching for new R01 message by the system, enter a value in the Start to process R01 messages each XX hours field. Note If the value in this field is 0, the system starts the searching process continually (each 10 seconds). 16. To resend failed messages automatically, set the number of days which you want in the Resend failed messages after XX days field. Note If the value in this field is 0, the system will not resend failed messages.

Setting Up Destinations

This section provides a general description of configuring HL7 destinations. Destinations create the outbound mapping between the source system and the destination system using TCP/IP or HTTP(S).

Note Note

See the descriptions for specific vendors in the HL7 Message Definition Parameters.

HL7 Configuration User's Guide

21

HL7 Interface

To set up HL7 destinations, perform the following steps: 1. Open the Administration component. 2. From the menu bar, select Configuration>HL7>HL7 Destinations. The Destinations window appears where the destination parameters of the system receiving ADT messages from the Allscripts ADT outbound interface can be defined.

3. Click

to add a row to the grid.

4. In the Name field, enter the name of the vendor or Third Party used as a reference for the destination. 5. Select HTTP or TCP communication type from the dropdown list. If TCP\IP is chosen, the TCP tabsheet will be enabled at the bottom of the window allowing for the insertion of the IP Address and Port value. If HTTP(S) is chosen, the HTTP(S) tabsheet will be enabled at the bottom of the window allowing for the insertion of HTTP specific information such as: URL, Request Method, Request Variable Name (for Get Request Method), Content Type and Encoding values. 6. In the Max Retires field, enter the maximum number of attempts to send an outbound message to the third party vendor interface before failing. 7. In the Interval field, enter the time in minutes between attempts to send a message to the third party vendor interface. 8. Select the R01 Subscriber check box identify destination as eligible to receive outbound ORU R01 messages. 9. If you want to make a particular destination the default, select the Default check box next to that destination.

22

HL7 Configuration User's Guide

HL7 Interface

10. The HL7 Destinations contains two tabs: HTTP(S) Tab ­ Allows sending of outbound messages to HL7 destinations that support communication via HTTP/HTTPS. The system generates the HTTP request with the flatwire outbound HL7 message and receives flatwire ACK message in the HTTP response from the server. TCP Tab ­ Defines connection settings for sending outbound messages to HL7 destinations via TCP. Enter the IP address and the Port number of the HL7 outbound messages destination. 11. In the HTTP(S) tab, enter the URL address of the server or page that will receive the HL7 outbound messages. The URL can contain "http:\\" or "https:\\" prefix. 12. Select the request method for the destination from the Request Method dropdown list. There are two different request method types possible. The HTTP/HTTPS HL7 outbound functionality allows you to specify the following two methods: GET and POST. The POST method is selected by default. 13. Select the content type for the destination. Content type values contain the media type of the request and are configured manually by a user. The most commonly used value is "application/x wwwformurlencoded" which is set by default. 14. From the Encoding dropdown list, select the character encoding (any supported by .NET 2.0) in which the receiving system expects to receive the HL7 messages. The UTF8 encoding type is selected by default. 15. In the TCP tab, enter the IP address for the destination. 16. Enter the port number for the destination. 17. Go to the Options tab. This tab contains the following controls: The Send Insured from Guarantor & Insured screen check box ­ If selected, the HL7 outbound message will be populated with the Insured data from the Insured tab of the Patient>Guarantor & Insured window. If not selected, Insured's data for outbound message will be taken based on data in Patient>Payers only. If type of relationship of the Insured (provided by Payers window) is set to 01 (The patient is the insured person), then patient's first, last name, address etc. data from Patient>Basic will be used by outbound functionality as Insured's data. If type of relationship of the Insured is set to a type that differs from 01 (The patient is not the insured person), then Insured's data will be get from appropriate resource using the same approach as in case of PV1 population: If the Resource defined on the Payers window is Male, Female, Couple, or Unknown, then the first name, last name etc. data from Resource>Basic and default resource's address from Resource>Address of this resource will be populated in the appropriate Insured's fields of HL7 outbound message. If the Resource defined in the Payers window is Organization, then the Organization Name value will be populated as an Insured's last name into the HL7 outbound message. First name, date of

HL7 Configuration User's Guide

23

HL7 Interface

birth, SSN etc. values will be empty since organization resources do not have them specified. The address data will be populated in the same way as other resource types. The Resource Identifier Type field ­ Click the dropdown arrow and select the type of resource identifier to be sent in the HL7 message.

18. Complete all the fields as appropriate and click

to save your changes.

Adding a "Loopback" Destination

The Loopback destination is used to test basic sending and receiving functionality. 1. Enter a new row and name it Loopback TCP or similar. 2. Set the TCP communication type. 3. Set the IP address of where the HL7 server will reside. 4. Set the port to the value used in the initial configuration of the interface (default is 8000). 5. Click to save your changes.

24

HL7 Configuration User's Guide

Interface Specific Configurations

Interface Specific Configurations

ADT Configuration Specifics Setting Up Patient Status Codes

Patient Status Codes must be set up to process inbound HL7 messages. An error will occur in the inbound processing activity during the processing of a message if a Patient Status Code is not assigned for the particular type. To set up Patient Status Codes, perform the following steps: 1. Open the Administration component. 2. From the menu bar, select Administration>General>Patient Status Codes. The Patient Status Codes window appears.

3. Select the HL7 Use Only check box if you want that patient status code to serve for HL7 Interface use. The HL7 Use Only check box is available for prospective status codes of type A (admission), active codes of type F (discharge), and T (transfer). It is not available for D (death) or

HL7 Configuration User's Guide

25

Interface Specific Configurations

R (readmission) type status codes. A potential total of three HL7 status codes can be created (See table below). If you attempt to save a status code as HL7 use when there is already a code of that type specified for HL7, the application displays the error message saying that the patient status code with the same type has already been assigned. Active/Prospective Prospective Active Active Status Code Type A F T Code (recommended) HL1 HL2 HL3 Description (recommended) HL7 Patient Referral HL7 Patient Discharge HL7 Patient Transfer

Setting Up Z Segments

Z Segments are used when standard segments of an HL7 message do not exist for the particular data that a client wants to pass in a message. Z Segments are not applicable to most users and setup should be done in consultation with the Allscripts Homecare Client Support Services. To set up Z Segments, perform the following steps: 1. Open the Administration component. 2. From the menu bar, select Administration>Configuration>HL7>Z Segments. The Z Segments window appears.

Using the ZSegments window, you can define custom message information.

26 HL7 Configuration User's Guide

Interface Specific Configurations

Telehealth Configuration Specifics Setting Up Vendor

1. Open the Administration component. 2. From the menu bar, select Configuration>HL7>Vendors. The HL7 Vendors window appears.

3. Enter the vendor name in the Vendor field and then select the corresponding vendor type. 4. If you want patient Clinical Notes data to be automatically updated when receiving a message, select the R01 Note Updates check box after selecting the appropriate vendor. Enabling the R01 Updates option allows the system to process notes associated with the observations from the R01 information. This information will be stored in the patient record as a Clinical Note. 5. Click to save your changes.

HL7 Configuration User's Guide

27

Interface Specific Configurations

Setting Up Disciplines

During insertion and update of patient clinical notes from an ORU_R01 message, a discipline code is required. The discipline code is not sent in the ORU_R01 message. You can define the discipline code that will be used by HL7 as the default code. To set up disciplines, perform the following steps: 1. Open the Administration component. 2. From the menu bar, select Clinical>Disciplines. The Disciplines window appears.

3. Choose the discipline code to be used for HL7 as the default code by selecting the HL7 Discipline check box for the needed discipline. It is recommended to create the following discipline: Code ­ HL7, Description ­ HL7 Note, and then assign it to HL7. Note You are limited to selecting only one discipline code as the HL7 default. 4. When you selected the HL7 Discipline check box for a default code, the HL7 check box is automatically selected opposite the discipline in the HL7 column of the grid. 5. Save your changes.

28

HL7 Configuration User's Guide

Interface Specific Configurations

Setting Up Clinical Monitoring Data

The Clinical Monitoring Data window allows the user to map the HL7 Clinical Monitoring Data Point to the Allscripts Clinical Monitoring Data Point. Configuration of this window is specific for each vendor installation, reference the appendix for additional configuration settings. To set up Clinical Monitoring Data, perform the following steps: 1. Open the Administration component. 2. From the menu bar, select Configuration>HL7>Clinical Monitoring Data. The HL7 Clinical Monitoring Data window appears. This window must be set up based on the readings transmitted from the HL7 vendor used. The HL7 Clinical Monitoring Data Point field contains the reading values in the R01 message sent by the HL7 vendor. The Allscripts Clinical Monitoring Data Point dropdown list displays the reading values in Allscripts Homecare that represent the data coming from the R01 message.

3. Enter the HL7 Clinical Monitoring Data Point of the vendor and then select corresponding Data Point for Allscripts Homecare from the dropdown list. 4. Click to save your changes.

To set up Units of Measure Data, perform the following steps: 1. Open the Administration component. 2. From the menu bar, select Configuration>HL7>HL7 Units of Measure Data. The HL7 Units of Measure Data window appears. This window must be set up based on the readings transmitted from the HL7 vendor used. The HL7 Units of Measure Data field maps the reading values in the R01 message sent by the HL7 vendor. 3. Enter the HL7 Units of Measure Data of the vendor and then select the corresponding Data Points for Allscripts Homecare from the dropdown list 4. Save your changes.

HL7 Configuration User's Guide 29

Interface Specific Configurations

Pharmacy Configuration Specifics Allscripts Homecare HL7 Interface PV118 Location Logic

A location value of Home, Hospice or Facility is completed for PV118 in the outbound HL7 messages. This value is based upon userconfigured values in the Administration module for a resource type. To identify a patient's location in PV1\PatientType (PV118) of the outbound HL7 messages, logic derives a value based upon the Resource Type Category and SubCategory (see Fig. 3) of the patient's Associated Facility ID (see Fig. 1). Note It is necessary that the To ID Required check box (see Fig. 2) is selected in the Patient Status Codes window of the Administration component for all relevant codes for this logic to be operational.

Figure 1 Admissions & Status Window

30

HL7 Configuration User's Guide

Interface Specific Configurations

Figure 2 Patient Status Codes Window

Figure 3 Resource Types Window

Pharmacy Logic and Location

· Patient · · · · · · Admissions & Status Associated Facility ID Use the Associated Facility ID (Resource ID). Identify the Resource Type Code in Resource>Roles.

Resource

Administration

31

HL7 Configuration User's Guide

Interface Specific Configurations

·

Resource Types · · Find the Resource Type Code. Identify the Category and SubCategory.

Pharmacy Categories and Values

Category S N

Description Staff Neither

PV118 Location Value Home Home

Note The SubCategory value is irrelevant for the above Categories.

Category C

Description Contractor

Note A Category value of C is required for the following to complete. PV118 Location Hospice Facility Facility Blank

SubCategory X C F Any other value

Description SNF/Nursing Home CLHF RCFE/ARF N/A

Note If there is no Associated Facility ID for the Patient Status Code, then PV118 will be completed with the Home value.

32

HL7 Configuration User's Guide

Interfacing with Allscripts Referral Manager

Interfacing with Allscripts Referral Manager

Integration between Allscripts Referral Manager and Allscripts Homecare

By interfacing with Allscripts Referral Manager, Allscripts Homecare can make the job of handling referrals easier, faster and less errorprone. The interaction between Allscripts Referral Manager and Allscripts homecare application proceeds according to the following process flow: 1. A facility's discharge planner uses Allscripts Referral Manager to send a patient referral to Allscripts Homecare via an HL7 message. 2. After an intake specialist approves the HL7 message, Allscripts Homecare creates a new prospective patient based on the patient referral. 3. Clinicians viewing the patient's record in Allscripts Homecare can follow a link to directly in Allscripts Referral Manager the patient's referral information 4. Once the agency admits a patient, Allscripts Homecare automatically sends the Start of Care date to Allscripts Care Manager. The integration between Allscripts Referral Manager and Allscripts Homecare application provides an agency with the following advantages: > Receive referrals faster Intake specialists can view patient information directly in Allscripts Homecare as soon as the discharge planner sends out the referral. This eliminates the need to wait for a fax or go out to a list on a web site. Eliminate needless data entry The Referral Manager Interface creates patients automatically in Allscripts Homecare. This eliminates the need to keyin patient information, a process that is time consuming and errorprone. Launch directly to patient referrals Clinicians can go from the patient's record in Allscripts Homecare to the full patient referral in Allscripts Referral Manager with a single click. This eliminates the need to log into Allscripts Referral Manager and search around for the correct patient. Keep other facilities informed automatically Allscripts Homecare automatically notifies Allscripts Care Manager when an agency admits a patient. This eliminates the need for the agency to remember to contact the referring facility.

>

>

>

HL7 Configuration User's Guide

33

Interfacing with Allscripts Referral Manager

Keeping Allscripts Referral Manager and Allscripts Homecare Synchronized Process HL7 ADT Messages from Referral Manager

Turning Referral Manager referrals into patients requires a properly installed and configured Referral Manager Interface. Consider the following: · · Is the HL7 engine installed and configured properly? For more details, see HL7 Interface Configuration Overview and General Checklist for HL7 Interface Usage. Have you set up the correct patient status codes? For more details, see Setting Up Patient Status Codes.

Having the referrals flowing into Homecare is not enough. Your agency's intake specialists must be given the tools and the knowledge to manage the incoming messages. Some things to consider: · · · · Have you granted privileges to your intake specialists to handle incoming messages. (See HL7 Privileges Settings). Do your intake specialists understand the process for handling inbound HL7 messages? (See Inbound Message Processing in the HL7 User's Guide). Do your intake specialists understand how to handle HL7 messages with errors? (See Error Processing in the HL7 User's Guide). Are your intake specialists aware of the Patients in the HL7 Status Report? (See Patients in the HL7 Status Report in the HL7 User's Guide).

Maintain Single Signon

To enjoy the full benefits of the single signon between Allscripts Homecare and Allscripts Referral Manager, it is important to maintain the proper credentials. It is important to remember that the Referral Manager credentials are created and maintained in the Referral Manager system, not in Homecare. As of 5.1, Allscripts Homecare does not have any facility to alter Allscripts Referral Manager credentials. This means an operator's Referral Manager credentials must be changed in Referral Manager first and then updated in the Allscripts Homecare Password Vault. Regardless of whether the login and password on the Password Vault's Referral Manager tab is valid, clicking View Referral will always behave the same way. Allscripts Referral Manager will always attempt to authenticate against the credentials that are passed from Allscripts Homecare. In the event those credentials are invalid, Allscripts Referral Manager displays the standard login window.

34 HL7 Configuration User's Guide

Interfacing with Allscripts Referral Manager

This means that whenever an operator's Referral Manager credentials are changed, either the administrator or operator must change those credentials in the Allscripts Homecare Password Vault. For more details, see How to Enable an Operator to View Referrals in Allscripts Referral Manager.

Activate the Automatic Sending of the Start of Care Date

As of 5.1, the Referral Manager Interface includes the ability to send a patient's Start of Care date automatically to Allscripts Care Manager when a patient referred from Allscripts Referral Manager is admitted into your agency. To enable this, the following elements need to be installed and configured properly: · · · The Allscripts Homecare Automated Communication Engine (ACE). The Allscripts Homecare Link The Care Manager Interface

ACE provides a way of creating a rule to send an interface message from the Homecare Link to Care Manager when a patient is admitted. See the How Do I Automatically Send the Start of Care Date to Allscripts Care Manager? topic for details on how to create this rule. Once everything is configured correctly, enabling automation of sending the Start of Care date is as easy as activating the appropriate ACE rule. See Configure Rule Window in the ACE User's Guide for more details on how to activate ACE rules.

How to Enable an Operator to View Referrals in Allscripts Referral Manager

When the Allscripts Referral Manager interface is first installed, by default no operator is able to launch from the patient and admission window to view referrals in Allscripts Referral Manager. Two tasks must be performed before an operator can take advantage of the single signon feature with Referral Manager: · · The operator must have permission to view referrals. The operator must have referral manager credentials stored in the Allscripts Homecare Password Vault.

HL7 Configuration User's Guide

35

Interfacing with Allscripts Referral Manager

Managing Privileges Related to Viewing Referrals

The two policies that relate to an operator's viewing referrals are located in the privileges category: Policy Name View Allscripts Referral Allow Allows operators to see on a patient's Admission & Status window a link to view the referral, when it is available. Operators can also click on the link to go directly to the referral in Allscripts Referral Manager. Allows operators to have access to the Allscripts Referral Manager tab in the Homecare Password Vault. Operators can manage their own Referral Manager credentials. Deny When a referral is available operators do not see on the patient's Admission & Status window the View Referral link.

Manage login credentials for Allscripts Referral Manage

Operators do not see the Allscripts Referral Manager tab in the Homecare Password Vault. Note: Any operators that have permission to view a referral but not to manage their Referral Manager credentials will still be able to launch out to Referral Manager website. An administrator will need to store their Referral Manager credentials to enable single signon.

For more information on how to manage privileges for operators and roles, see the Operators section in the Administration User's Guide.

Storing Referral Manager Credentials

To take advantage of single signon with Allscripts Referral Manager, operators must have their Referral Manager credentials stored in the Allscripts Password Vault. If those credentials are not present operators will be prompted to log into Referral Manager each time they launch out to the website. Administrators have two options for handling an operator's Referral Manager credentials:

36

HL7 Configuration User's Guide

Interfacing with Allscripts Referral Manager

·

Enter the operator's credentials: If administrators know an operator's Referral Manager credentials, they can enter those credentials in that operator's Password Vault under the Allscripts Referral Manager tab. For more information on accessing an operator's Password Vault, see the How Do I Change the Referral Manager Credentials Stored in an Operator's Password Vault? topic. Let operators enter their own credentials: If administrators want operators to manage their own Referral Manager credentials, they can simply leave an operator's Referral Manager credentials blank in that operator's Password Vault. If the operator has been granted permission to manager his or her own Referral Manager credentials, the operator will be prompted to store his or her Referral Manager credentials during the first attempt to launch out to Referral Manager.

·

Operators who have been granted the privilege to manage their own Referral Manager credentials can always add them or change them in their Password Vault, which is accessed by pressing the Settings ( ) button from any open module (except for the Reports). For more details, see Operators section in the Administration User's Guide.

How Do I Change the Referral Manager Credentials Stored in an Operator's Password Vault?

At times an administrator may need to change the Referral Manager Credentials stored in an operator's Password Vault. This could be to enter the operator's credentials for the first time, or to change existing credentials to match what is expected by Referral Manager. 1. Navigate to Administration>Configuration>Operators.

2. Select the operator.

HL7 Configuration User's Guide

37

Interfacing with Allscripts Referral Manager

3. On the Basic tab, click the Password Vault button. The operator's Password Vault opens. 4. Click the Allscripts Referral Manager tab.

5. Make whatever changes you need to make to the Referral Manager credentials. 6. Click OK. 7. Click to save your changes.

Setting the Referral Manager URL

Depending on whether you are running the Allscripts Homecare server as a service or as a GUI, you can change the Referral Manager URL in two different ways. If you are running the Allscripts Homecare server as a service 1. On the server machine, access X:\\Program Files\Misys Homecare\Server. X ­ is the drive where you have your server installed. 2. Open the MHCServer.ini file. 3. Locate the ReferralManagerJumpPointsURL= line and enter the appropriate URL. If this record does not exist in the file, add it. 4. Save the MHCServer.ini file. 5. Restart the service.

38

HL7 Configuration User's Guide

Interfacing with Allscripts Referral Manager

If you are running the Allscripts Homecare server as a GUI 1. On the server machine, open the Allscripts Homecare Server GUI. 2. Click the Tools button. ( )

3. In the Settings dialog, click the Referral Manager tab. 4. In the Referral Manager URL field, enter the appropriate URL. 5. Restart the server.

How Do I Automatically Send the Start of Care Date to Allscripts Care Manager?

To ensure continuity of care, referring facilities are often interested in knowing when their patient has begun care with another facility. Often the process for determining this continuity of care is handled via phone calls and other time consuming methods. By combining the power of the Homecare Automated Communication Engine (ACE) and the Homecare Link and interfacing with Allscripts Care Manager, agencies can now fully automate this notification process. This section describes the necessary ingredients of a successful Start of Care automation rule. For specific steps on how to create and manage a new ACE rule, please see Creating a New Rule for Status Category in the ACE User's Guide. The ACE rule should be configured to have the following: > > > The rule triggers when the Patient Status parameter changes from Any to Any of the Business Unit's Admission patient status codes (i.e. status codes that are an A or an X). A reaction of Send Interface Message that sends a message of type StartOfCareDate to Care Manager. The rule should be active.

Note that the Homecare Link automatically disregards any patient that was not first created from a Referral Manager referral. Furthermore, these ACE rules automatically disregard any patients that are not assigned to the Care Manager association. For more details, see the Homecare Link Administrator's Guide. To make sure the right patients are properly assigned to the Care Manager association, an agency has two choices: > Assign the Care Manager association to all patients by default. This has the advantage that no legitimate Referral Manager patients will be ignored by the ACE rule. This has the disadvantage that ACE will attempt to send the Start of Care date for every single patient even though any patient that was not created from a Referral Manager referral will be ignored by the Homecare Link.

HL7 Configuration User's Guide

39

Interfacing with Allscripts Referral Manager

>

Have someone assign all legitimate patients to the Care Manager association manually. This has the advantage that ACE will attempt to send the Start of Care date only for the patients it should. However, as with any manual process, being dependent on an operator such as an intake specialist or a clinician means there is always a risk that legitimate ACE will ignore legitimate Referral Manager patients.

How Can One Patient Have Multiple Referrals from Allscripts Referral Manager?

It is not uncommon for Allscripts Homecare to receive different referrals for the same patient. This happens when facilities on two distinct occasions use Allscripts Referral Manager to send referrals to your agency. Allscripts Homecare handles this situation by associating the unique referral with a specific admission episode. This means that clinicians clicking on a link for a specific admission will go directly to the specific referral that created that admission episode.

An example:

On June 1st, Memorial Hospital discharges John Smith and refers him to your home care agency. Your agency admits him the following day. Once John recovers, your agency discharges him. Two months later, John Smith requires additional care and spends several days at County Hospital. When County Hospital discharges him, it refers him to your agency. Allscripts Homecare receives this new referral and creates a second admission period for John Smith, associating the new admission with this second referral.

40

HL7 Configuration User's Guide

Operators Supplement for Allscripts Referral Manager Interface

Operators Supplement for Allscripts Referral Manager Interface

Who May Benefit from Referral Manager Interface?

There are several within your agency who may desire to launch directly from Allscripts Homecare into a patient referral in Allscripts Referral Manager. For instance, intake specialists who are already used to logging into Allscripts Referral Manager from their web browser will find the single signon capabilities save them several clicks. Also clinicians preparing for an initial patient visit will be interested in the referring facility's clinical data about the referred patient. The following sections are written specifically with these types of operators in mind.

How do I View a Referral from Allscripts Referral Manager?

When a patient is created from an Allscripts Referral Manager referral, Allscripts Homecare makes it easy for clinicians and other operators to view the complete referral that was originally used to create that patient. To view a patient referral in Allscripts Referral Manager: 1. In the Patient component, select a patient that was created from an Allscripts Referral Manager referral. 2. Open the Admission & Status window (Patient>General>Admission & Status). A View Referral link will be present if the selected patient was originally created from an Allscripts Referral Manager referral and the operator has permission to view referrals. If you expect to see a link and it does not appear, please consult the Why Can I Not See the "View Referral" Link? topic.

HL7 Configuration User's Guide

41

Operators Supplement for Allscripts Referral Manager Interface

3. Click the View Referral link. Depending on how your Allscripts Referral Manager credentials have been configured, one of three events will occur: · · Successfully launch out to the patient's referral in Allscripts Referral Manager. This occurs when the credentials stored in the Allscripts Homecare Password Vault are correct. Launch out to the Allscripts Referral Manager login page. This primarily occurs when the credentials stored in the Allscripts Homecare Password Vault are invalid. It can also occur when no credentials are present and you have opted to no longer be prompted to store your credentials in the Password Vault. Prompt to store your Allscripts Referral Manager credentials. This occurs when there are no Allscripts Referral Manager credentials stored in the Allscripts Homecare Password Vault. A dialog will prompts you to store those credentials.

·

To continue to Allscripts Referral Manager without storing your credentials in the Allscripts Homecare Password Vault, click No. You will be taken to the Allscripts Referral Manager login page. To store your Allscripts Referral Manager credentials, click Yes. The Password Vault dialog opens with the Allscripts Referral Manager tab active.

You must enter your User Name and Password exactly as it is expected in Allscripts Referral Manager in order to successfully view the patient's referral without first logging in. Once you are finished entering your correct credentials, click OK to continue on to Allscripts Referral Manager.

42

HL7 Configuration User's Guide

Operators Supplement for Allscripts Referral Manager Interface

How do I Enable Single Signon with Allscripts Referral Manager?

In order to enjoy the benefits of single signon with Allscripts Referral Manager, your correct Referral Manager credentials must be stored in the Allscripts Homecare Password Vault. To view your Allscripts Referral Manager credentials in the Homecare Password Vault: 1. From any open component (except for the Reports), click the Settings ( the toolbar. The Preferences dialog appears. ) button on

2. Click the Password Vault button. You will be prompted to unlock your Password Vault.

3. Enter your current Homecare password and click Unlock. The Password Vault window appears.

HL7 Configuration User's Guide

43

Operators Supplement for Allscripts Referral Manager Interface

4. Click the Allscripts Referral Manager tab. You will see the necessary information required for single signon to Allscripts Referral Manager. Note If you do not see the Allscripts Referral Manager tab, you have not been granted the privilege to manager your Referral Manager credentials. Contact your administrator for more information.

5. Provide the credential information you use to log on to the Referral Manager website. 6. Click OK to save changes. Remember, storing your Referral Manager credentials in the Homecare Password Vault does not affect your actual Referral Manager credentials. Any changes to the actual credentials must be handled through the Referral Management system.

Why Can I Not See the "View Referral" Link?

If the View Referral link for a specific patient does not appear, consider the following: > Potential Issue #1: The Interface with the Allscripts Referral Manager is not installed or is not licensed. Solution: Ensure the Interface is properly installed and licensed. > > Potential Issue #2: The correct version of Allscripts Homecare is not present. Solution: Ensure Allscripts Homecare is version 5.1. or higher. Potential Issue #3: You do not have the correct permissions to view referrals. Solution: Contact your Allscripts Homecare administrator to determine if you have been granted permission to view referrals.

44

HL7 Configuration User's Guide

Operators Supplement for Allscripts Referral Manager Interface

>

Potential Issue #4: The patient was not originally created from an Allscripts Referral Manager referral. Solution: If you are certain the patient was created from an Allscripts Referral Manager, look at other admission periods to see if perhaps the link is displaying on that tab.

HL7 Configuration User's Guide

45

HL7 Message Definition Parameters

HL7 Message Definition Parameters

HL7 Message Definitions

Supported ADT Messages: ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field MSH1 MSH2 MSH3.1 Segment/FieldName MSH/FieldSeparator MSH/EncodingCharacters MSH/SendingApplication/ NamespaceID MSH/SendingFacility/NamespaceID Data Point\Comments | ^~\& Sending application name. User defined during installation (for outbound). Sending facility name. User defined during installation (for outbound). Destination Name. Destination Name. Date/Time Message created. Static, based upon message type. Static, based upon message type. Unique message identifier. "P" = Production. 2.4 = HL7 Version used to create message.

MSH4.1

MSH5.1 MSH6.1 MSH7.1 MSH9.1 MSH9.2 MSH10 MSH11.1 MSH12.1

MSH/Receiving Application/ NamespaceID MSH/Receiving Facility/ NamespaceID MSH/DateTimeOfMessage MSH/MessageType/MessageType MSH/MessageType/TriggerEvent MSH/MessageControlID MSH/Processing ID/ProcessingID MSH/VersionID/VersionID

EVN1 EVN2.1

EVN/EventTypeCode EVN/RecordedDateTime

Static, based upon message type. Date/Time Message created.

PID3.1 PID4.1

46

PID/PatientIdentifierList/IDNumber PID/AlternatePatientID/IDNumber

Master ID. Patient Code.

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field PID5.1.1 PID5.2 PID5.3 PID7.1 PID8 PID11.1.1 PID11.1.2 PID11.3 PID11.4 PID11.5 PID13.1 PID16.1 PID18.1 PID18.2 PID18.4.1 Segment/FieldName PID/PatientName/FamilyName/ Surname PID/PatientName/GivenName PID/PatientName/ MiddleInitialOrName PID/DateTimeOfBirth PID/Sex PID/PatientAddress/StreetAddress/ StreetOrMailingAddress PID/PatientAddress/StreetAddress/ StreetName PID/PatientAddress/City PID/PatientAddress/StateOrProvince PID/PatientAddress/ZipOrPostalCode PID/HomePhoneNumber/ PhoneNumberString PID/MaritalStatus/Identifier PID/PatientAccountNumber/ IDNumber PID/PatientAccountNumber/ CheckDigit PID/PatientAccountNumber/ AssigningAuthority/NamespaceID PID/PatientAccountNumber/ AssigningFacility/NamespaceID PID/SSNNumber Data Point\Comments Patient Last Name. Patient First Name. Patient Middle Name. Date of Birth. Gender (U, F, or M). Patient Address 1. Patient Address 2. Patient City. Patient State. Patient Zip. Patient Phone. Patient Marital Status (M, S, D, X, W, or U). Patient Account Number. Unique integer based upon current episode. Outbound only. VarChar (36) available for MRN, etc. Not visible from the application. Bidirectional. Business Unit Name. Patient SSN.

PID18.6.1 PID19

DG11 DG13.1

DG1/SetID DG1/DiagnosisCode/Identifier

Auto incrementing index. ICD9 (NonSurgical Diagnosis) Code.

47

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field DG13.2 DG15.1 Segment/FieldName DG1/DiagnosisCode/Text DG1/DiagnosisDateTime Data Point\Comments Non Surgical Diagnosis Description. Non Surgical Diagnosis Start Date.

PR11 PR13.1 PR13.2 PR15.1

PR1/SetID PR1/ProcedureCode/Identifier PR1/ProcedureCode/Text PR1/ProcedureDateTime

Auto incrementing index. ICD9 (Surgical Diagnosis) Code. Surgical Diagnosis Description. Surgical Diagnosis Start Date.

PV12 PV17.1

PV1/PatientClass PV1/AttendingDoctor/IDNumber

Patient Class. Attending Doctor ID. First non empty value from Other Physician, UPIN, or State License. Outbound only. Attending Doctor Last Name. Attending Doctor Last Name. Referring Doctor ID. First non empty value from Other Physician, UPIN, or State License. Outbound only. Referring Doctor Last Name. Referring Doctor First Name. Consulting Doctor ID. First non empty value from Other Physician, UPIN, or State License. Outbound only. Consulting Doctor Last Name. Consulting Doctor First Name.

PV17.2.1 PV17.3 PV18.1

PV1/AttendingDoctor/FamilyName/ Surname PV1/AttendingDoctor/GivenName PV1/ReferringDoctor/IDNumber

PV18.2.1 PV18.3 PV19.1

PV1/ReferringDoctor/FamilyName/ Surname PV1/ReferringDoctor/GivenName PV1/ConsultingDoctor/IDNumber

PV19.2.1 PV19.3

PV1/ConsultingDoctor/FamilyName/ Surname PV1/ConsultingDoctor/GivenName

48

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field PV117.1 Segment/FieldName PV1/AdmittingDoctor/IDNumber Data Point\Comments Admitting Doctor ID. First non empty value from Other Physician, UPIN, or State License. Outbound only. Admitting Doctor Last Name. Admitting Doctor First Name. Outbound Only ('Home', 'Hospice', or 'Facility'). Status Code (current). Status Date.

PV117.2.1 PV117.3 PV118 PV136 PV144.1

PV1/AdmittingDoctor/FamilyName/ Surname PV1/AdmittingDoctor/GivenName PV1/PatientType PV1/DischargeDisposition PV1/AdmitDateTime

PV150.1 PV223.1

PV1/PatientVisit/AlternateVisitID/ IDNumber PV2/ClinicOrganizationName/ OrganizationName

Admission ID. Pharmacia ID.

IN119.1.1 IN119.3 IN119.4 IN119.5 NK11 NK12.1.1 NK12.2 NK12.3

IN1/InsuredsAddress/Street/ Address/StreetOrMailingAddress IN1/InsuredsAddress/City IN1/InsuredAddress/State IN1/InsuredsAddress/ ZipOrPostalCode NK1/SetID NK1/NextOfKinName/FamilyName/ Surname NK1/NextOfKinName/GivenName NK1/NextOfKinName/ MiddleInitialOrName

Insured Street Address. Insured City. Insured State. Insured Zip. Auto incrementing index. Resource Last Name. Resource First Name. Resource Middle Name.

HL7 Configuration User's Guide

49

HL7 Message Definition Parameters

ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field NK13.2 Segment/FieldName NK1/Relationship/Text Data Point\Comments Resource Type (AU, CH, CL, CO, FR, GC, GP, NN, OT, PA, PL, PR, SB, SL, SP, SC, or ST). Resource Address 1. Resource Address 2. Resource City. Resource State. Resource>Address & Phones>Zip. Resource Phone. Resource Work Phone. Resource Status Date. Resource Gender. Resource Date of Birth.

NK14.1.1 NK14.1.2 NK14.3 NK14.4 NK14.5 NK15.1 NK16.1 NK18 NK115 NK116

NK1/Address/StreetAddress/ StreetOrMailingAddress NK1/Address/StreetAddress/ StreetName NK1/Address/City NK1/Address/StateOrProvince NK1/Address/ZipOrPostalCode NK1/PhoneNumber/ PhoneNumberString NK1/BusinessPhoneNumber/ PhoneNumberString NK1/StartDate NK1/Sex NK1/DateTimeOfBirth

IN11 IN12.1 IN12.2 IN12.4 IN13.1 IN14.1 IN15.1.1

IN1/SetID IN1/InsurancePlanID/Identifier IN1/InsurancePlanID/Text IN1/InsurancePlanID/ AlternateIdentifier IN1/InsuranceCompanyID/IDNumber IN1/InsuranceCompanyName/ Organization name IN1/InsuranceCompanyAddress/ Street address/ StreetOrMailingAddress IN1/InsuranceCompanyAddress/City

Auto incrementing index. Insurance Code Secondary No./Locator Code. Coverage Description. Insurance Code. Insurance Company Code. Insurance Description (Name). Insurance Company Address.

IN15.3

50

Insurance Company City.

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field IN15.4 IN15.5 IN16.1.1 IN17.1 IN115 IN116.1.1.1 IN116.1.2 IN116.1.3 IN117.2 IN118.1 IN136 Segment/FieldName IN1/InsuranceCompanyAddress/ State or province IN1/InsuranceCompanyAddress/Zip or postal code IN1/InsuranceCoContactPerson/ FamilyName/SurName IN1/InsuranceCoPhoneNumber/ PhoneNumberString IN1/PlanType IN1/NameOfInsured/FamilyName/ Surname IN1/NameOfInsured/GivenName IN1/NameOfInsured/ MiddleInitialOrName IN1/InsuredsRelationshipToPatient IN1/InsuredsDateOfBirth IN1/PolicyNumber Data Point\Comments Insurance Company State. Administration>Insurance Companies>Company>Zip. Insurance Company Contact: Name. Insurance Company Contact: Phone. Insurance Code Type. Insured Name Last. Insured Name First. Insured Middle Name. Insured Relationship to Patient. Insured Date of Birth. Insurance ID.

IN22

IN2/InsuredsSocialSecurityNumber

Insured SSN.

GT11 GT13.1.1 GT13.2 GT13.3 GT15.1.1 GT15.1.2 GT15.3 GT15.4 GT15.5

GT1/SetID GT1/FamilyName GT1/GivenName GT1/MiddleName GT1/Address1 GT1/Address2 GT1/City GT1/State GT1/ZipCode

Auto incrementing index. Guarantor Last Name. Guarantor First Name. Guarantor Middle Name. Guarantor Address (line 1). Guarantor Address (line 2). Guarantor City. Guarantor State. Guarantor Zip.

51

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ADT A01, ADT A04, ADT A08, ADT A28, and ADT A31 Segment Field GT1.6.1 GT17.1 GT111.1 GT116.1.1 GT117.1.1 Segment/FieldName GT1/HomePhone GT1/WorkPhone GT1/Relationship GT1/GuarantorEmployerName/ FamilyName/Surname GT1/GuarantorEmployerAddress/ Street Address/ StreetOrMailingAddress GT1/GuarantorEmployerAddress/ Street Address/Steet Name GT1/GuarantorEmployerAddress/ City GT1/GuarantorEmployerAddress/ State GT1/GuarantorEmployerAddress/ ZipCode GT1/ GuarantorEmployerPhoneNumber/ PhoneNumberString Data Point\Comments Guarantor Home Phone. Guarantor Work Phone. Guarantor Relationship. Guarantor Employer. Guarantor's Employer Address (line 1). Guarantor's Employer Address (line 2). Guarantor's Employer City. Guarantor's Employer State. Guarantor's Employer Zip. Guarantor's Employer Phone.

GT117.1.2 GT117.3 GT117.4 GT117.5 GT118.1

Note Note

Not all segment\field combinations are required or will be populated. ADT A02 (Transfer) Segment Field MSH1 MSH2 MSH3.1 Segment/FieldName MSH/FieldSeparator MSH/EncodingCharacters MSH/SendingApplication/ NamespaceID MSH/SendingFacility/NamespaceID Data Point\Comments | ^~\& Sending application name. User defined during installation (for outbound). Sending facility name. User defined during installation (for outbound).

HL7 Configuration User's Guide

MSH4.1

52

HL7 Message Definition Parameters

ADT A02 (Transfer) Segment Field MSH5.1 MSH6.1 MSH7.1 MSH9.1 MSH9.2 MSH10 MSH11.1 MSH12.1 Segment/FieldName MSH/Receiving Application/ NamespaceID MSH/Receiving Facility/ NamespaceID MSH/DateTimeOfMessage MSH/MessageType/MessageType MSH/MessageType/TriggerEvent MSH/MessageControlID MSH/Processing ID/ProcessingID MSH/VersionID/VersionID Data Point\Comments Destination Name. Destination Name. Date/Time Message created. Static, based upon message type. Static, based upon message type. Unique message identifier. "P" = Production. 2.4 = HL7 Version used to create message.

EVN1 EVN2.1

EVN/EventTypeCode EVN/RecordedDateTime

Static, based upon message type. Date/Time Message created.

PID3.1 PID5.1.1 PID5.2 PID5.3

PID/PatientIdentifierList/IDNumber PID/PatientName/FamilyName/ Surname PID/PatientName/GivenName PID/PatientName/ MiddleInitialOrName

Master ID. Patient Last Name. Patient First Name. Patient Middle Name.

PV145

PV1/DischargeDateTime/Time

Discharge Date.

ADT A03 (Discharge) Segment Field MSH1 MSH2 Segment/FieldName MSH/FieldSeparator MSH/EncodingCharacters Data Point\Comments | ^~\&

HL7 Configuration User's Guide

53

HL7 Message Definition Parameters

ADT A03 (Discharge) Segment Field MSH3.1 MSH4.1 MSH5.1 MSH6.1 MSH7.1 MSH9.1 MSH9.2 MSH10 MSH11.1 MSH12.1 Segment/FieldName MSH/SendingApplication/ NamespaceID MSH/SendingFacility/ NamespaceID MSH/Receiving Application/ NamespaceID MSH/Receiving Facility/ NamespaceID MSH/DateTimeOfMessage MSH/MessageType/ MessageType MSH/MessageType/ TriggerEvent MSH/MessageControlID MSH/Processing ID/ ProcessingID MSH/VersionID/VersionID Data Point\Comments Sending application name. User defined during installation (for outbound). Sending facility name. User defined during installation (for outbound). Destination Name. Destination Name. Date/Time Message created. Static, based upon message type. Static, based upon message type. Unique message identifier. "P" = Production. 2.4 = HL7 Version used to create message.

EVN1 EVN2.1

EVN/EventTypeCode EVN/RecordedDateTime

Static, based upon message type. Date/Time Message created.

PID3.1 PID5.1.1 PID5.2 PID5.3 PID29.1

PID/PatientIdentifierList/ IDNumber PID/PatientName/FamilyName/ Surname PID/PatientName/GivenName PID/PatientName/ MiddleInitialOrName PID/ PatientDeathDateAndTime/ Time

Master ID. Patient Last Name. Patient First Name. Patient Middle Name. Death Date and Time.

54

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ADT A03 (Discharge) Segment Field PID30 Segment/FieldName PID/PatientDeathIndicator Data Point\Comments In case of death, the value is 'Y'.

PV145

PV1/DischargeDateTime/Time

Discharge Date.

ACK (Outbound from Allscripts Homecare) Segment Field MSH1 MSH2 MSH3.1 MSH4.1 MSH5.1 MSH6.1 MSH7.1 MSH9.1 MSH9.2 MSH10 MSH11.1 MSH12.1 Segment/FieldName MSH/FieldSeparator MSH/EncodingCharacters MSH/SendingApplication/ NamespaceID MSH/SendingFacility/ NamespaceID MSH/Receiving Application/ NamespaceID MSH/Receiving Facility/ NamespaceID MSH/DateTimeOfMessage MSH/MessageType/ MessageType MSH/MessageType/ TriggerEvent MSH/MessageControlID MSH/Processing ID/ ProcessingID MSH/VersionID/VersionID Data Point\Comments | ^~\& User defined during installation. Remains static thereafter. User defined during installation. Remains static thereafter. Destination Name. Destination Name. Date/Time Message created. Static, based upon message type. Static, based upon message type. Unique message identifier based upon DateTime. "P" = Production. 2.4 = HL7 Version used to create message.

MSA1

MSA/AcknowledgmentCode

Original Acknowledgment Processing. Enhanced Acknowledgment Processing.

HL7 Configuration User's Guide

55

HL7 Message Definition Parameters

ACK (Outbound from Allscripts Homecare) Segment Field MSA2 Segment/FieldName MSA/MessageControlID Data Point\Comments Value of the MSA_2 (MessageControlId) in the ACK message should be equal to MSH_10 (MessageControlId) in the original message.

ERR1.4.2

ERR/ErrorCodeAndLocation/ CodeIdentifyingError/Text

Note Note An ACK message is returned for all incoming messages.

ACK (Inbound to Allscripts Homecare) Segment Field MSH1 MSH2 MSH3.1 MSH4.1 MSH5.1 MSH6.1 MSH7.1 MSH9.1 MSH9.2 MSH10 MSH11.1 Segment/FieldName MSH/FieldSeparator MSH/EncodingCharacters MSH/SendingApplication/ NamespaceID MSH/SendingFacility/ NamespaceID MSH/Receiving Application/ NamespaceID MSH/Receiving Facility/ NamespaceID MSH/DateTimeOfMessage MSH/MessageType/ MessageType MSH/MessageType/ TriggerEvent MSH/MessageControlID MSH/Processing ID/ ProcessingID Data Point\Comments | ^~\& Application Name. Facility Name. Value in MSH3.1 from message sent via Allscripts Homecare. Value in MSH4.1 from message sent via Allscripts Homecare. Date/Time Message created. Static (ACK). Trigger Event based upon message type. Unique message identifier based upon DateTime. Usually "P" for Production.

56

HL7 Configuration User's Guide

HL7 Message Definition Parameters

ACK (Inbound to Allscripts Homecare) Segment Field MSH12.1 Segment/FieldName MSH/VersionID/VersionID Data Point\Comments HL7 Version used to create message.

MSA1 MSA2

MSA/AcknowledgmentCode MSA/MessageControlID

'AA', 'AE', or 'AR'. Value of the MSA_2 (MessageControlId) in the ACK message should be equal to MSH_10 (MessageControlId) in the original message.

Outbound HL7 Message Event Triggers

Message Type ADT Trigger Event A01 Allscripts Events to Cause Creation 1. Patient Status is admitted. That means that the patient status code has the Status Code Type set to A (Initial admission); A_PATIENT_STATUS.TYPE='A'. 2. Patient is active. That means that patient status code has the Active/Prospective indicator set to "Active"; A_PATIENT_STATUS.PATIENT_TYPE = 'A'. 3. Patient status date (PT_STATUS.STATUS_DATE) is between the START DATE and END DATE selected on the HL7 Outbound window. 4. The patient is from the Business Unit of the user that initiates the outbound processing (PT_STATUS.DATASET_ID).

HL7 Configuration User's Guide

57

HL7 Message Definition Parameters

Message Type ADT

Trigger Event A02

Allscripts Events to Cause Creation 1. Patient Status is temporary moved to hospital/respite. That means that the patient status code has the Status Code Type set to T (temporary moved to hospital/respite); A_PATIENT_STATUS.TYPE='T'. 2. Patient is active. That means that patient status code has the Active/Prospective indicator set to "Active"; A_PATIENT_STATUS.PATIENT_TYPE = 'A'. 3. Patient status date (PT_STATUS.STATUS_DATE) is between the START DATE and END DATE selected on the HL7 Outbound window. 4. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_STATUS.DATASET_ID).

ADT

A03

1. Patient Status is final discharge or death. That means that the patient status code has the Status Code Type set to F (final discharge) or D (death); A_PATIENT_STATUS.TYPE='F' OR A_PATIENT_STATUS.TYPE='D'. 2. Patient is active. That means that patient status code has the Active/Prospective indicator set to "Active"; A_PATIENT_STATUS.PATIENT_TYPE = 'A'. 3. Patient status date (PT_STATUS.STATUS_DATE) is between the START DATE and END DATE selected on the HL7 Outbound window. 4. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_STATUS.DATASET_ID).

58

HL7 Configuration User's Guide

HL7 Message Definition Parameters

Message Type ADT

Trigger Event A04

Allscripts Events to Cause Creation 1. Patient Status is admitted. That means that the patient status code has the Status Code Type set to A (Initial admission); A_PATIENT_STATUS.TYPE='A'. 2. Patient is active. That means that patient status code has the Active/Prospective indicator set to "Active"; A_PATIENT_STATUS.PATIENT_TYPE = 'A'. 3. Patient Address is Active. That means that indicator Active in Patient>Basic window in selected; PT_ADDRESS.IS_ACTIVE = 'Y'. 4. Patient status date (PT_STATUS.STATUS_DATE) is between the START DATE and END DATE selected on the HL7 Outbound window. 5. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_STATUS.DATASET_ID).

ADT

A05

1. Patient Status is admitted. That means that the patient status code has the Status Code Type set to A (Initial admission); A_PATIENT_STATUS.TYPE='A'. 2. Patient is active. That means that patient status code has the Active/Prospective indicator set to Active; A_PATIENT_STATUS.PATIENT_TYPE = 'A'. 3. Patient Address is Active. That means that indicator Active in Patient>Basic window in selected; PT_ADDRESS.IS_ACTIVE = 'Y'. 4. Patient status date (PT_STATUS.STATUS_DATE) is between the START DATE and END DATE selected on the HL7 Outbound window. 5. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_STATUS.DATASET_ID).

HL7 Configuration User's Guide

59

HL7 Message Definition Parameters

Message Type ADT

Trigger Event A08

Allscripts Events to Cause Creation 1. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_BASIC.DATASET_ID). 2. Patient is admitted. (The record for the patient exists in PT_ADMISSION). 3. Patient general information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_BASIC.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 4. Patient address information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_ADDRESS.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 5. Patient diagnosis information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PTC_DIAGNOSIS.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 6. Patient surgical diagnosis information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PTC_DIAGNOSIS_SURGICAL.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 7. Patient admission information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_ADMISSION.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 8. Patient HL7 Additional Data information was changed in the period from START DATE till END DATE selected on the Patient>HL7>HL7 Patient Additional Data window. (PT_HL7_ADDITIONAL_DATA.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 9. Date range checking for 'A01', 'A28', 'A04', 'A08', 'A31' messages; E.MESSAGE_DATE IS NULL OR (PU.MOD_DATE > E.MESSAGE_DATE and (PU.MOD_DATE E.MESSAGE_DATE) >= dateadd(second,1, 0)).

60

HL7 Configuration User's Guide

HL7 Message Definition Parameters

Message Type ADT

Trigger Event A28

Allscripts Events to Cause Creation 1. Patient Status is admitted. That means that the patient status code has the Status Code Type set to A (Initial admission); A_PATIENT_STATUS.TYPE='A'. 2. Patient is prospective. That means that patient status code has the Active/Prospective indicator set to "ProspectiveSchedule A_PATIENT_STATUS.PATIENT_TYPE = 'P'. 3. Patient Address is Active. That means that indicator Active in Patient>Basic window in selected; PT_ADDRESS.IS_ACTIVE = 'Y'. 4. Patient status date (PT_STATUS.STATUS_DATE) is between the START DATE and END DATE selected on the HL7 Outbound window. 5. The patient is from the Business Unit of the user that initiates the outbound processing (PT_STATUS.DATASET_ID).

HL7 Configuration User's Guide

61

HL7 Message Definition Parameters

Message Type ADT

Trigger Event A31

Allscripts Events to Cause Creation 1. The patient is from the Business Unit of the user that initiates the outbound processing (PT_BASIC.DATASET_ID). 2. Patient is admitted. (The record for the patient exists in PT_ADMISSION). 3. Patient general information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_BASIC.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 4. Patient address information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_ADDRESS.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 5. Patient diagnosis information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PTC_DIAGNOSIS.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 6. Patient surgical diagnosis information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PTC_DIAGNOSIS_SURGICAL.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 7. Patient admission information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_ADMISSION.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 8. Patient HL7 Additional Data information was changed in the period from START DATE till END DATE selected on the Patient>HL7>HL7 Patient Additional Data window. (PT_HL7_ADDITIONAL_DATA.MOD_DATE BETWEEN @START_DATE AND @END_DATE). 9. Date range checking for 'A01', 'A28', 'A04', 'A08', 'A31' messages; E.MESSAGE_DATE IS NULL OR (PU.MOD_DATE > E.MESSAGE_DATE and (PU.MOD_DATE E.MESSAGE_DATE) >= dateadd(second,1, 0)).

62

HL7 Configuration User's Guide

HL7 Message Definition Parameters

Message Type ADT

Trigger Event P01

Allscripts Events to Cause Creation 1. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_BASIC.DATASET_ID). 2. Patient general information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_BASIC.MOD_DATE BETWEEN @START_DATE AND @END_DATE).

BAR

P01

1. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_BASIC.DATASET_ID). 2. Patient general information was changed in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_BASIC.MOD_DATE BETWEEN @START_DATE AND @END_DATE).

DFT

P03

1. The service is from the Business Unit of the user that initiates the outbound processing. (PT_SERVICE.DATASET_ID). 2. Service providing date is in the period from START DATE till END DATE selected on the HL7 Outbound window. (PT_SERVICE.DATE_PROVIDED BETWEEN @START_DATE AND @END_DATE). 3. The status of Service is V. (PT_SERVICE.STATUS = 'V').

OMP

O09

1. The patient is from the Business Unit of the user that initiates the outbound processing. (PT_BASIC.DATASET_ID). 2. There are NO not sent O09 messages in HL7 outbox. (SYS_HL7_OUTBOUND.MESSAGE_TYPE = 'O09' AND STATUS <> 'F'; SYS_HL7_OUTBOUND.MESSAGE_DATE IS NULL OR PTC_MEDICATION.MOD_DATE > SYS_HL7_OUTBOUND.MESSAGE_DATE). 3. The medication start date is in the period from START DATE till END DATE selected on the HL7 Outbound window. (PTC_MEDICATION.MED_START_DATE BETWEEN @START_DATE AND @END_DATE).

HL7 Configuration User's Guide

63

HL7 Message Definition Parameters

Message Type ORU

Trigger Event R01

Allscripts Events to Cause Creation 1. Process R01 messages check box has to be selected on the Administration>Configuration>HL7 General Settings window. 2. At least one of the destinations must be subscriber to R01 messages. That means that R01 Subscriber check box has to be selected in Administration>Configuration>HL7 Destination window. ('FROM SYS_HL7_DESTINATION WHERE IS_R01_SUBSCRIBER = 'Y'). 3. The patient must have the verified Service. That means that Verified" check box has to be selected in Schedule screen. (WHERE PT_SERVICE.STATUS = 'V'). 4. If the service from STAFF category that type of service has to be as "Visit (billable)" or "Bereavement" or "Visit (non billable)", and if from Contract category ­ "Private Duty Nursing"or "Home Health Aide" or "Time Entry Required"; ((PT_SERVICE.CATEGORY = 'S' AND A_STAFF_SERVICE_TYPE.TYPE IN ('V', 'B', 'X')) OR (PT_SERVICE.CATEGORY = 'C' AND A_COTRACT_SERVICE_TYPE.TYPE IN ('N', 'H', 'T'))). 5. The service has not been unmade. That means that "Unmade Reason" field has to be empty on Schedule screen. (PT_SERVICE.UNMADE_REASON IS NULL). 6. The service has to be modified between start date and current date. (PS.MOD_DATE BETWEEN:START_DATE AND GETDATE()). 7. There are no R01 messages in Outbound that are not send or Service Modified date is not between start and current date of R01 message sending. (WHERE SYS_HL7_OUTBOUND.MESSAGE_TYPE = 'R01' AND ((SYS_HL7_OUTBOUND.STATUS IN ('R', 'P', 'E')) OR (SYS_HL7_OUTBOUND.END_PROCESSING_DATE_TIME > PT_SERVICE.MOD_DATE AND SYS_HL7_OUTBOUND.STATUS IN ('C', 'F')))).

64

HL7 Configuration User's Guide

HL7 Message Definition Parameters

Vendor Configurations Allscripts Referral Manager (formerly ECIN) Configuration Specifics

Overview

Allscripts Referral Manager (formerly ECIN) is the ADT HL7 Interface with Extended Care Information Network vendor. The HL7 Interface with Extended Care Information Network allows referral patient information to flow electronically to Allscripts Homecare minimizing data entry errors, effort and maximizing efficiency. This flow of data utilizes the HL7 Standard over a TCP\IP protocol.

HL7 Data Map

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Field Label in Allscripts Referral Manager Allscripts Field

MS H MS H MS H

1 2 3.1

Field Separator Encoding Characters Sending Application Database name (e.g. "TRAINING", "PROD"). Allscripts Referral Manager (formerly ECIN).

N/A N/A N/A

MS H

4.1

Sending Facility

N/A

MS H MS H

5.1 6.1

Receiving Application Receiving Facility Organization name (e.g. "HOSPITAL").

N/A N/A

HL7 Configuration User's Guide

65

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Field Label in Allscripts Referral Manager Allscripts Field

MS H

7.1

Date/Time of Message

Time the message is sent (to the ms) in the local time of the receiving facility. Format: YYYYMMDDHH MMSS.SSS +/ ZZZZ where the timezone (+/ ZZZZ) is represented as +/HHMM offset from UCT (formerly known as GMT). Always "A01".

N/A

MS H MS H MS H

9/1 10 11.1

Message Type Message Control ID Processing ID

N/A N/A

First letter of the sending application e.g. "T", "P".

N/A

MS H

12.1

Version ID

N/A

EVN

1

EVNEvent Type Code

Always "A01".

N/A

66

HL7 Configuration User's Guide

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Field Label in Allscripts Referral Manager Allscripts Field

EVN

2

Date/ Time of Event

Same as MSH.7 but without timezone offset.

N/A

PID PID

3.1 5.1.1

Patient ID (Internal ID) Patient Family Name Patient Given Name Patient Middle Name Date of Birth Format: YYYYMMDD in local time of the receiving facility (see MSH.7 for timezone offset from UCT).

Patient Details Patient Details Patient Details Patient Details Patient Details

MRN Patient Last Name Patient First Name Patient Middle Name Patient DOB

Patient>Basic> Master ID Patient>Basic>Last

PID

5.1.2

Patient>Basic>First

PID

5.1.3

Patient>Basic> Middle Patient>Basic> DOB

PID

7

PID PID

8 11.1. 1 11.1. 2

Sex Patient Street

Patient Details Patient Details Patient Details

Patient Gender Patient Home Address 1 Patient Home Address 2

Patient>Basic>Sex Patient>Basic> Address Patient>Basic> Address

PID

Patient Street2

HL7 Configuration User's Guide

67

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Patient Details Patient Details (9digits or 5 digits). Format: [(999)]999 9999[X99999] Patient Details Patient Details Patient Details Patient Details Blank Format: xxxxxxxxx Patient Details Patient Details Patient SSN Field Label in Allscripts Referral Manager Patient Home City Patient Home State Patient Home Zip Patient Home Phone Patient Marital Status Patient Account Number Allscripts Field

PID

11.1. 3 11.1. 4 11.1. 5 13

Patient City

Patient>Basic>City

PID

Patient State

Patient>Basic> State Patient>Basic>Zip Patient>Basic> Phone Patient>Basic>M/S

PID PID

Patient Zip Phone Number Home Marital Status

PID

16.1

PID

18.1

Patient Account Number Referral Type SSN Number Patient

Patient>Basic> Account# Business Unit Name Patient>Basic>SSN

PID PID

18.6. 1 19

NK1

2.1.1

Next of Kin Family Name

Contact s

Patient Contact Last Name Patient Contact First Name

Patient>General> Family & Friends> Last Name Resource>Basic> Last Name Patient>General> Family & Friends> First Name Resource Basic>First Name

NK1

2.1.2

Next of Kin Given Name

Contact s

68

HL7 Configuration User's Guide

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Contact s Field Label in Allscripts Referral Manager Patient Contact Middle Name Patient Contact Relations hip Patient Contact Address 1 Patient Contact Address 2 Patient Contact City Patient Contact State Patient Contact Zipcode Patient Contact Home Phone Patient Contact Work Phone Allscripts Field

NK1

2.1.3

Next of Kin Middle Name

Patient>General> Family & Friends> Middle Name Resource>Basic> Middle Name Patient>General> Family & Friends> Rel Resource>General> Address & Phone>Address Resource>General> Address & Phone>Address Resource>General> Address & Phone>City Resource>General> Address & Phone>State Resource>General> Address & Phone>Zip Resource>General> Address & Phone>Phones Resource>General> Address & Phone>Phones

NK1

3.2

Relationship

Contact s

NK1

4.1.1

Next of Kin Address Next of Kin Address2 Next of Kin City Next of Kin State Next of Kin Zipcode Next of Kin Home Phone Format: [(999)]999 9999[X99999] Format: [(999)]999 9999[X99999]

Contact s Contact s Contact s Contact s Contact s Contact s

NK1

4.1.2

NK1

4.3

NK1

4.4

NK1

4.5

NK1

5.1

NK1

6.1

Next of Kin Work Phone

Contact s

HL7 Configuration User's Guide

69

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Admissi on Details Field Label in Allscripts Referral Manager Allscripts Field

PV1

44

Projected Discharge Date

Projected Patient>General> Discharge Admissions & Date Status>Status Date

GT1

3.1.1

Guarantor Family Name

Financia l

Guaranto r Last Name Guaranto r First Name Guaranto r Middle Name Guaranto r Address 1

Patient>General> Guarantors & Insured>Guarantor Information>Last Patient>General> Guarantors & Insured>Guarantor Information>First Patient>General> Guarantors & Insured>Guarantor Information>Middle Patient>General> Guarantors & Insured>Guarantor Information> Address (line 1) Patient>General> Guarantors & Insured>Guarantor Information> Address (line 2) Patient>General> Guarantors & Insured>Guarantor Information>City Patient>General> Guarantors & Insured>Guarantor Information>State

GT1

3.1.2

Guarantor Given Name

Financia l

GT1

3.1.3

Guarantor Middle Name

Financia l

GT1

5.1.1

Guarantor Address

Financia l

GT1

5.1.2

Guarantor Address2

Financia l

Guaranto r Address 2

GT1

5.3

Guarantor City

Financia l

Guaranto r City

GT1

5.4

Guarantor State

Financia l

Guaranto r State

70

HL7 Configuration User's Guide

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Financia l Field Label in Allscripts Referral Manager Guaranto r Zipcode Allscripts Field

GT1

5.5

Guarantor Zipcode

(9digits or 5 digits)

Patient>General> Guarantors & Insured>Guarantor Information>Zip Patient>General> Guarantors & Insured>Guarantor Information>Home Phone Patient>General> Guarantors & Insured>Guarantor Information>Work Phone Patient>General> Guarantors & Insured>Guarantor Information> Relationship Patient>General> Guarantors & Insured>Employer Information> Employer Patient>General> Guarantors & Insured>Employer Information> Address (line 1) Patient>General> Guarantors & Insured>Employer Information> Address (line 2)

GT1

6.1

Guarantor Home Phone

Format: [(999)]999 9999[X99999]

Financia l

Guaranto r Home Phone

GT1

7.1

Guarantor Work Phone

Format: [(999)]999 9999[X99999]

Financia l

Guaranto r Work Phone

GT1

11.1

Guarantor Relationship

Financia l

Guaranto r Relations hip Guananto r Employer

GT1

16.1. 1

Guanantor Employer

Financia l

GT1

17.1. 1

Guarantor Employer Address

Financia l

Guaranto r Employer Address Guaranto r Employer Address2

GT1

17.1. 2

Guarantor Employer Address2

Financia l

HL7 Configuration User's Guide

71

HL7 Message Definition Parameters

HL7 Seg men t Field Inbound Num Field Name ber Format (HL7) / Notes Page in Allscript s Referral Manage r Financia l Field Label in Allscripts Referral Manager Guaranto r Employer City Guaranto r Employer State Guaranto r Employer Zipcode Guaranto r Employer Phone Allscripts Field

GT1

17.3

Guarantor Employer City

Patient>General> Guarantors & Insured>Employer Information>City Patient>General> Guarantors & Insured>Employer Information>State Patient>General> Guarantors & Insured>Employer Information>Phone Patient>General> Guarantors & Insured>Employer Information>Phone

GT1

17.4

Guarantor Employer State Guarantor Employer Zipcode Guarantor Employer Phone (9digits or 5 digits)

Financia l

GT1

17.5

Financia l

GT1

18

Financia l

Philips Configuration Specifics

The following represents vendor specific configuration for HL7 Clinical Monitoring Data.

HL7 Clinical Monitoring Data for Philips Vendor

72

HL7 Configuration User's Guide

HL7 Message Definition Parameters Note Note

See Telehealth Configuration Specifics for detailed instructions on entering data. The following represents vendor specific configuration for HL7 Units of Measure Data.

HL7 Units of Measure for Philips Vendor The following represents the vendor specific configuration for the HL7 Destinations.

The name and URL fields should be set up as follows: Have the Philips Healthcare PTSS as the destination name. Have the https://cctranport.chs.philips.com:{port} as the entry in the URL field.

HL7 Configuration User's Guide

73

HL7 Message Definition Parameters Note Note

{port} is the unique port value assigned by Philips to the client usually in the form of 9xxx. Firewall Considerations Traffic coming from Philips uses the appliance IP address, not the cluster.

Note Note

There is a primary and backup IPs and they can be used during DMZ configuration. · Primary IP: 12.40.54.182 · Backup IP: 12.40.54.183 The following represents the vendor specific configuration for the HL7 Vendors.

AMC Configuration Specifics

The following represents vendor specific configuration for HL7 Clinical Monitoring Data.

HL7 Clinical Monitoring Data for AMC Vendor

Note Note See Telehealth Configuration Specifics for detailed instructions on entering data.

74

HL7 Configuration User's Guide

HL7 Message Definition Parameters

The following represents vendor specific configuration for HL7 Units of Measure Data.

HL7 Units of Measure for AMC Vendor

HomMed Configuration Specifics

The following represents vendor specific configuration for HL7 Clinical Monitoring Data.

HL7 Clinical Monitoring Data for HomMed Vendor

Note Note

See Telehealth Configuration Specifics for detailed instructions on entering data.

HL7 Configuration User's Guide

75

HL7 Message Definition Parameters

The following represents vendor specific configuration for HL7 Units of Measure Data.

HL7 Units of Measure for HomMed Vendor

Hospice Pharmacia Configuration Specifics

There are the following Business Units settings for the Hospice Pharmacia configuration: > > Require May Administer Default Physician ID to MD#1

Require May Administer

Administration>Configuration>Business Units>Settings>Medications The Require May Administer setting controls if the May Administer field is required for the patient medication. If this check box is selected, the May Administer edit becomes required for any new entry of medications (including those coming in via the HL7 interface) and for the prior records (if they are edited and the edit is enabled to a user).

Default Physician ID to MD#1

Administration>Configuration>Business Units>Settings>Clinical Miscellaneous This is relevant to the Inbound Medication interface because the physician who orders a medication (indicated in the HL7 message) may not exist in the Allscripts Homecare database. Due to this an error message will occur within Inbound Processing.

76

HL7 Configuration User's Guide

HL7 Message Definition Parameters

Agencies that require the clinician to select the ordering physician each time for Clinical Notes, Medications, Projected Visits, and Problems should clear the Default Start Physician entry to MD#1 check box. As a result, when adding or modifying a record in the corresponding windows, the user has to select the Physician ID manually instead of automatic completing with MD#1 ID value.

HL7 Configuration User's Guide

77

Information

HL7_Configuration_UG.book

77 pages

Find more like this

Report File (DMCA)

Our content is added by our users. We aim to remove reported files within 1 working day. Please use this link to notify us:

Report this file as copyright or inappropriate

825971


You might also be interested in

BETA
HL7_Configuration_UG.book