HL7 REF Specifications
If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.
- Get Started
- Patient Channel
- Patient Facesheet
- Collaborative Inbox
- Lines & Resources Requests
- Lines, Events, Resources
- Platform Settings and Configuration
- Users and Groups
- SMS Basics
- Troubleshooting and FAQ
- Conversation Builder
- Release Notes
- Technical Specifications
Table of ContentsIntroduction VPN and Communication Protocol Patient MatchingIncoming Integration (to Artera)Outgoing Integration (from Artera)
This document defines the specifications for full integration with the Artera application using HL7 interface standards. Please note that Artera supports a wide range of integration methodologies depending on your Practice Management (PM) and Electronic Medical Record (EMR) system. For more information on HL7, please refer to the Health Level Seven website: http://www.hl7.org
Phase I: Patient Referral Data to Artera
Establish VPN Tunnel
Connect Interface Engines
Live Data Feeds to Artera from Customer
One-Way Referrals (HL7-REF)
Phase II: Data Writeback to External System (Optional and PM/EMR System Dependent)
Live data feeds from Artera to customer
- One-Way Referral Scheduling Status updates Confirmation Status - available via flat file, API, or custom webservice
VPN & Communication Protocol
Artera will provide all prospective clients with the Artera VPN Template. Please fill this out as soon as possible. A completed form is required before moving forward with any significant integration discussions.
Due to the variability of patient spellings and risk of mistyping, Artera performs patient mapping based on the external application’s patient identifier sent over the interface. Artera will not update patient demographic data from this interface feed.
Incoming Integration (to Artera)
REF - Referral Messages
REF messages keep Artera synchronized when important referral information is changed in your system.
Artera is typically configured to use the following REF messages. Unless otherwise specified by an Artera Integration Engineer, any other message transactions might be filtered and ignored.
REF^I12 - Add a Referral Record
REF^I13 - Update a Referral Record (Note: this can also add a Referral Record if received instead of an I12)
REF^I14 - Cancel a Referral Record
REF Field Breakdown
Sample REF (to Artera)
AUT|1143563^BCBS OUT OF STATE|100000|BCBS|20200515|20210515|||||20200522113426
PRD|RP|TEST^PROVIDER|1025 Chapala^STE 400^SANTA BARBARA^CA^93101|884747333^^^WBM1|(888)888-8888||844993332^NPI^NPI
PRD|RT|TEST2^PROVIDER|1025 Chapala^STE 400^SANTA BARBARA^CA^93101|884747333^^^WBM1|(888)888-8887||844993338^NPI^NPI
IN1|1|88443333^BCBS OUT OF STATE|2288333|BCBS||||300164|MARMON PPO PLAN - ACTIVE|||20190101||||TEST^PATIENT|Se|||||1|||YE|20190523|||||||||14541576|MNX8288777||||||Full|F|^^^^^US|||BOTH
DG1|1|I1|R07.9^Chest pain, unspecified^I10
PR1|1|C4|REF12^AMB REFERRAL TO CARDIOLOGY^C4
Outgoing Integration (from Artera)
Patient Referral Acceptance Status updates
There is no standards-based mechanism for communicating a patient’s response to whether or not they would like to schedule their Referral. This information, however, can be critical to track within your EMR. To that end, Artera can provide the following data fields in a flat file or those data elements can be used to call an API or custom webservice.