Outbound Interface Install Instructions

Overview

  1. Understanding the end point to configure the Refer To Systems (RTS).
  2. Understanding the trigger that will take place in Enterprise Health to send the data to the end point to configure the Auto Route.

Refer To Systems

Refer To Systems (RTS) is used to manage connection details for vendors/services that receive data from Enterprise Health. The
RTS Editor is found in the Control Panel. It requires a permission level to access it.

72d49a4da60ede7e9f94bdf983d46450

Each RTS entry contains:

  • System ID - This is a required unique identifier for the RTS
  • System Name - This is a human readable name for the entry. It is used when setting up Auto Routes and Performing Facilities on Lab Orders
  • System Address - This is the end point information. This can be a URL, Filename, SFTP, among others.
  • System Ability - This is a high level overview of what the connection is used for. HL7, Webchart to Webchart, among others
  • Active - This tells if the RTS is available for use. Inactive RTS cannot be sent to.
  • Options - This allows for Editing the RTS information, also to Deactivate, as well as Delete entirely. The Extended option is here as well to add special functionality when sending data over to this endpoint.

System Address

Here are the available connection options that the RTS editor supports

723100db4503d34d573ec01166f3921f

  1. Socket a. Format: ‘socket’|[IP address]|[port]|[SSL flag 1/0]
        Example: socket|192.168.2.23|5321|0
        ```
    
  2. File a. Format: ‘file’|[file directory and name relative to where the datasend binary lives]
        Example: file|../testfile.hl7
        ```
    
  3. Multi-File a. Format: ‘multi_file’|[file directory and beginning of filename to use]
        Example: multi_file|../testmultifile
        ```
    
  4. SCP a. Format: ‘scp’|[IP/hostname]|[port]|[subdir name]|[base filename]|[keyfile] i. Note username/password are on the RTS entry itself
        Example: scp|192.168.34.27||data/outbound|testfile.dat|
        ```
    
  5. SFTP a. Format: ‘sftp’|[IP/hostname]|[port]|[subdir name]|[base filename]|[keyfile] i. Note username/password are on the RTS entry itself
        Example: sftp|192.168.34.27||data/outbound|testfile.dat|
        ```
    
  6. HTTPS (default) a. Format: [URL]|[username CGI variable name]|[password CGI variable name]|[message CGI variable name] i. Note username/password are on the RTS entry itself
        Example: https://mywebchart.com/omg/webchart.cgi|login_user|login_passwd|message
        ```
    

System Ability

Here are the types of outbound messages that can be configured for each RTS endpoint. Selecting these determines how they are represented inside of Webchart and EH.

92e9971f0032eafe76fe1f520a8a4a8a

  1. Is WebChart? a. For sending messages between 2 Webchart systems
  2. Is HAP Server? a. Specifies that this can be used as a remote chart HAP System endpoint in the ChartTabs editor.
  3. Is HL7 Recipient? a. For sending HL7 data to a system
  4. Is Text Export? a. Specifies that this can be used as a Text Export endpoint in the Send dialog and Auto Routes editor.
  5. Is XDS Reg? a. For sending via XDS.
  6. Is PIX? a. Specifies that this is a PIX Manager and is suitable as an endpoint for performing ITI-9 PIX queries.
  7. Is HL7 Orders Outbound? a. For sending HL7 Orders to a system
  8. Is PDQ? a. Specifies that this a Patient Demographics Supplier and is suitable as an endpoint for performing ITI-21 PDQ queries.
  9. Is OnDemand? a. Specifies that any outgoing XDR submissions are to be registered as On-Demand documents rather than static documents.

Auto Routes

There are many available triggers

  • On Document Add/Update - creates MDM, VXU or ORU
  • On Patient Add/Update - creates ADT
  • On Appointments Add - creates SIU
  • On Procedures for Billing Add - creates DFT

8e32d4f5d4eff16fb06c8f84f057ad51

JOINs and WHERE clause

  • This allows for more filtering to work with specific sets of patients. Requires some understanding of the Webchart DB schema. Generally requires MIE EDI team to build. However, manually copying Auto Route JOINs and WHERE Clauses into new Auto Routes is also possible.
  • The Help Me feature allows non-power users to build their own commonly used Join/Where clauses.

59a0d8603cce1b3d57bd468474affaf5

There are many available send options

  • HL7 Send - this will send out HL7 messages

C33547588cf502a12090664e7feb0029

Testing and Verifying

Once records are added into Webchart and the triggers are satisfied, the HL7 message should send out according to the RTS. To validate that the data was sent outbound successfully, browse to the DataSend Queue in Control Panel -> Interfaces.

The Send Queue has reports that show the records

  • In Progress - messages currently being sent to the RTS End point
  • Pending - messages waiting to be sent to the RTS End point
  • Error - messages that were unable to send successfully
  • Completed/Acknowledged - messages that were sent successfully

3419ef2e1d3141f5c0dd86c3f1216ea1

Resending messages is possible for Completed messages using the Options Resend link

Cd194d4525be59d9453a9406d22038ef

Was this page helpful?

Let us know how we can improve this documentation.

Published: March 5, 2020