Artera HL7 Integration Specification - Inbound ADT & SIU
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 ContentsID Matching Incoming Integration (to Artera) ADT - Demographic MessagesADT SegmentsSample ADT (to Artera)Patient Merge MessagesSample Merge MessageSIU - Appointment MessagesSIU SegmentsSample SIU (to Artera)Optional Message Segments
Artera must be provided with a single, unique identifier for each patient, appointment, Event Type, Resource, and Location for all ADT and/or SIU messages associated with a given patient, appointment, Event Type, Resource or Location.
Artera uses these IDs for matching in order to update the associated information with that ID, such as a patient’s name. If different IDs are provided for the same Resource value (i.e. a provider), duplicate Resources will appear in Artera. If IDs are shared between any two values, information will be overwritten with the latest received.
Incoming Integration (to Artera)
ADT - Demographic Messages
Artera is typically configured to use the following ADT messages. Unless otherwise specified by an Artera Integration Engineer, any other message types will be filtered and ignored.
NOTE: Segments and Fields not discussed in the specifications will be ignored, if provided.
Sample ADT (to Artera)
PID|1||410000060||ZTEST^ARTERA3^^^^^L~SMITH^LINDA^^^^^N||19700520||||342 ARTERA AVE^^POWELL^OH^43065^US^L||9998887777^^H^^^^^^^^^^^^^^^1~^NETfirstname.lastname@example.org||ENG^ENGLISH^^22|||100013314||||||||||||N
Patient Merge Messages
Merges in Artera label the duplicate patient by adding DUPLICATE to the front of the patient’s first and last name. The duplicate patient record is modified to label the patient as Do Not Contact. A merge does not move any appointments associated with the duplicate patient record to the persisting patient record. Artera has to receive new SIU messages to move an appointment from one patient record to the other. If there is no MRG segment, the message will not process.
Sample Merge Message
PID|1||430001148||ARTERATEST^ARCH^^^^^L~ZTEST^ARCHIE^^^^^N||19900101|||O|123 TESTING ST.^^COLUMBUS^OH^43201^US^L^^FRANKLIN|FRANKLIN|6666666666^^H^^^^^^^^^^^^^^^1~5555555555^^C~^NETemail@example.com|2222222222^^W|ENG^ENGLISH^^22|||||||O||||||||N
SIU - Appointment Messages
Artera’s core system will only accept SIU messages for appointments whose Location(s) are properly mapped to an Artera Practice. Any other messages received will be filtered.
Artera is typically configured to consume the following SIU messages, other messages might be filtered and ignored unless otherwise specified during the integration process.
PID - Should be identical to the PID segment of ADT message
NOTE: If Artera is sent multiple AIS, AIG, AIP, AIL and RGS segments, only the first segment is consumed. Appointment Event may be referred to as Appointment Type or Visit Type in your EMR.
Sample SIU (to Artera)
SCH||104793600||||^^^^|NATHC^NEW ATHLETICS COUNSELING VISIT|SCH^|60|MIN|^^60^20221215120000^20221215130000|SLUB01^SLUBOWSKI^ALICIA|||||||||||||SCH||
PID|||430000244||SLUBTEST^ATHLETE^^^^^L~SLUBTEST^ATH^^^^^N|^^|20010818|M|^^|W|123 ST. JOHN^^HILLIARD^OH^43026^^^^FRANKLIN|FRANKLIN|7777777777^^C^^^^^^^^^^^^^^^1~^NETfirstname.lastname@example.org~||ENG^UNDEFINED^^22|S|||||^|N||||||||N
RGS|1|A|300102469^SPORTS MED PSYCHOLOGY ST JOHN ARENA^^300102469
AIS|1|A|NATHC^NEW ATHLETICS COUNSELING VISIT|20221215120000|||60|MIN||SCH
Optional Message Segments - Required for Specific Artera Products
Additional Artera features may require additional HL7 fields. The following table outlines the various Artera features that require values sent via HL7. If a given feature has mapped values called out, we require the customer to send us their external values mapped to our Artera values.
Mapped Values & Message Types for each Product Feature
How to send these Values
Option 1: OBX Segments
OBX segments can be used to send these feature values. If using OBX, the OBX-3.2 field must be populated with a pre-determined ID that the Artera Integration Engineer is notified of. The OBX-5.1 field will be populated with the actual value.
Option 2: Custom Z-Segments
If using a Z-segment to send any of these additional values, you must work with your Artera Integration Engineer to configure these segments appropriately. Please see Artera Z-Segments for more information.