Artera Interface IDs
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 ContentsPatient ID Phone Numbers and Email Addresses Appointment IDProvider IDGeneral Resource IDLocation ID - AIL or RGSEvent Type ID
ADT and SIU HL7 Messages
Artera stores a single identifier for appointments, patients, providers, Locations, General Resources, phone numbers, and Event Types. In this article, we outline where Artera captures each of these IDs along with the importance of receiving a single, consistent ID.
Artera must be provided with a single, unique identifier for each patient. Most commonly, this is the patient’s MRN (unique patient identifier). Artera uses this ID for matching in order to update the associated information with that patient, such as the patient’s name, contact information or appointments.
If different IDs are provided for the same patient, duplicates will appear within your Artera environment. If IDs are shared between patients, information will be overwritten between patients based on the last interface message received. If using an HL7 interface, the patient ID must be provided in PID3.1.
Phone Numbers and Email Addresses
Artera can store up to three phone numbers and one email address per patient ID. Each phone number should have a unique ID tag to indicate which type of phone the number is for (i.e. Cell phone vs Home phone).
Artera has three fields to store phone numbers: Cell Phone, Home Phone, and Work Phone. These cannot be relabeled within the platform. The phone type tags should be consistent across messages for a given patient unless an update was made to the patient’s stored contact information in the EMR. For example, if we receive a cell and a home number on an ADT, the SIU messages for that patient should have the same numbers unless the patient's numbers were removed or changed. Only one phone number per interface message should have any given tag (i.e. Cell, H, etc.)
Artera uses the Appointment ID for appointment matching. Appointment IDs may be referred to as Scheduling or Encounter IDs in your EMR. This allows Artera to differentiate between SIU messages intending to update an existing appointment versus those for creating a new appointment. For example, if Artera receives an S13 to reschedule an appointment to a new time, Artera must ensure that the rescheduled message contains the same Appointment ID as the original SIU to update to the existing appointment, otherwise a duplicate appointment will be created. Appointment IDs are also used when other updates to an appointment occur such as cancellations, check-ins, and no shows. Artera expects the appointment ID in SCH2.1, unless otherwise discussed during your implementation.
Artera uses the ID sent in the AIP 3.1 field as the identifier for a Provider in the Artera platform. The Provider ID must be consistent across HL7 messages in order to prevent duplicate Providers from appearing in your Artera environment and to allow for appropriate filtering of automated messages based on Providers.
Provider IDs cannot be shared between providers either, otherwise the associated provider information and the appointments associated with that provider ID, will be overwritten in Artera based on the latest interface message.
General Resource ID
Artera uses the ID sent in the AIG 3.1 field as the identifier for a General Resource in the Artera platform. Examples of General Resources in EMRs include rooms, equipment, or General Providers such as a Flu Shot Nurse.
The General Resource ID must be consistent across HL7 messages in order to prevent duplicate General Resources from appearing in the platform and to allow for appropriate filtering of automated messages based on General Resources.
General Resource IDs cannot be shared between General Resources, otherwise the associated General Resource information and the appointments associated with that General Resource ID, will be overwritten in Artera based on the latest interface message.
Location ID - AIL or RGS
Artera must be provided with a single, unique identifier for each Location an appointment can be scheduled with. These may be referred to as Departments, Practices or Locations within your EMR.
Appointments will only appear within Artera if the patient is scheduled for an appointment with a Location ID that has been successfully mapped to an Artera Practice. Location IDs cannot be shared between Artera Practices. The location ID should be sent in AIL or RGS 3.1.
Event Type ID - AIS/SCH
Artera must be provided with a single, unique identifier for each Event Type that can be scheduled. These are often referred to as Appointment Types in EMRs. If Event Type IDs are shared, all associated appointments in Artera will have their Event Type updated based on the latest interface message and this will impact the ability for your staff to filter messages based on the Event Type.
Event Type IDs can be sent in SCH6.1, SCH7.1, SCH8.1, or AIS3.1.