Artera HL7 Integration Specification - Inbound ADT & SIU

+ More

ID Matching Incoming Integration (to Artera) ADT - Demographic Messages ADT Segments Sample ADT (to Artera)Patient Merge Messages Sample Merge Message SIU - Appointment Messages SIU Segments Sample SIU (to Artera)Optional Message Segments

ID Matching

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.

Accepted ADT Message Types
Message Type	How it is used in Artera
ADT^A01	Add/Update a Patient Record
ADT^A02	Add/Update a Patient Record
ADT^A03	Add/Update a Patient Record
ADT^A04	Add/Update a Patient Record
ADT^A05	Add/Update a Patient Record
ADT^A08	Add/Update a Patient Record
ADT^A14	Add/Update a Patient Record
ADT^A28	Add/Update a Patient Record
ADT^A31	Add/Update a Patient Record
ADT^A18	Patient Merge
ADT^A34	Patient Merge
ADT^A35	Patient Merge
ADT^A40	Patient Merge
ADT^A45	Patient Merge

Field Requirements
Name	Code	Comments
Required	R	This field must be present within a segment and contain a valid value.
Optional	O	This field is not required but will be consumed if present.
Conditional	C	This field may or may not be required depending on conditions in the notes column

NOTE: Segments and Fields not discussed in the specifications will be ignored, if provided.

ADT Segments

MSH
Field	Name	Req’d?	Notes	Repeat?
4	Sending Facility	R	Can be name, abbreviation, ID or acronym	N
7	HL7 Message Datetime	R	Format: YYYYMMDDhhmmss, timezone must be the same as the SIU feed or data may be rejected	N
9.1	HL7 Message Type	R	Must be ADT	N
9.2	HL7 Message Type	R	Must be one of the above accepted message types	N
11	Processing ID	R	Indicates if messages are coming from a Test (T) or Prod (P) environment	N

PID
Field	Name	Req’d?	Notes	Repeat?
3.1	Patient ID	R	Must be a value that uniquely identifies a patient across an organization. If 3.1 is repeated, either 3.4 or 3.5 must be populated.	Y
3.4	ID Assigning Auth	C	If 3.1 is repeated, 3.4 must be an agreed upon assigning authority.	Y
3.5	ID Type	C	If 3.1 is repeated, 3.5 must be an agreed upon type	Y
5.1	Patient Last Name	R	If repeating values are sent, only the first value will be processed unless a Name Type Code is populated and of an agreed upon value.	Y
5.2	Patient First Name	R	If repeating values are sent, only the first value will be processed unless a Name Type Code is populated and of an agreed upon value.	Y
5.3	Patient Middle Name	O		Y
5.7	Name Type Code	C	Required if implementing preferred name and repeated segments are sent.	Y
7.1	Date of Birth	R	Expected format: yyyyMMdd	N
8.1	Patient Sex	O	Artera can only store values of Male, Female or Unknown at this time	N
11.1	Address Line 1	O	If repeating values are sent, only the first value will be processed	N
11.2	Address Line 2	O	If repeating values are sent, only the first value will be processed	N
11.3	City	O	If repeating values are sent, only the first value will be processed	N
11.4	State	O	If repeating values are sent, only the first value will be processed	N
11.5	Zip	O	If repeating values are sent, Artera Integration only the first value will be processed	N
13.1	Phone Value	R	Must be a 10-digit phone number. If repeating values are sent, only the first phone numbers with each of the designated identifiers (13.3) will be consumed	Y
13.2	Email Identifier	O	Unless otherwise agreed upon, identifier must be ‘NET’	Y
13.3	Phone Identifier	R	Unless otherwise agreed upon, identifier must be ‘H’ for Home, ‘C’ for Cell	Y
13.4	Email Address	O	If repeating values are sent, only the first email address with the designated email identifier (13.2) will be consumed	Y
13.18	Preferred Phone Identifier	O	Indicates if a given repetition's 13.1 value is the preferred phone. Preferred number must be one of the stored numbers (cell, home or work phone). Unless otherwise agreed upon, identifier must be ‘1’	N
14.1	Work Phone	O	Must be a 10-digit phone number. If repeating values are sent, only the first phone number with the designated identifier (14.3) will be consumed	N
14.3	Work Phone Identifier	O	Unless otherwise agreed upon, identifier must be ‘W’ for Work	N
14.18	Preferred Phone Identifier	O	Indicates if the 14.1 value is the preferred phone. Preferred number must be one of the stored numbers (cell, home or work phone). Unless otherwise agreed upon, identifier must be ‘1’	N
15.1	Primary Language	R	If not passed, the patient's preferred language will default to English. Required if using preferred language automations	N
19.1	Social Security Number	C	If sent, Artera only requires the last 4 digits. Required if using SSN for patient access to secure messages.	N
30	Deceased Indicator	O	Used to nullify all contact info and prevent future Artera message from being sent to the patient	N

Sample ADT (to Artera)

MSH|^~\&|EPIC||ARTERA|ARTERA|20221214094145|MYCHARTG|ADT^A04|42877|T|2.3|||||||||POC

PID|1||410000060||ZTEST^ARTERA3^^^^^L~SMITH^LINDA^^^^^N||19700520||||342 ARTERA AVE^^POWELL^OH^43065^US^L||9998887777^^H^^^^^^^^^^^^^^^1~^NET^^robert.mychart@test.com||ENG^ENGLISH^^22|||100013314||||||||||||N

Patient Merge Messages

MRG
Field	Name	Req’d?	Notes	Repeat?
1.1	Prior Patient ID	R	ID should match what we would expect in PID 3.1 for a previous message with the prior ID.	N

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

MSH|^~\&|EPIC||ARTERA|ARTERA|20221117132435|MYCHARTG|ADT^A18|526494826|T|2.3|||||||||TST

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~^NET^^arch.arteratest@test.com|2222222222^^W|ENG^ENGLISH^^22|||||||O||||||||N

MRG|430001141|||430001141

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.

Accepted SIU Message Types
Message Type	How it is used in Artera
SIU^S12	Notification of New Appointment
SIU^S13	Notification of Appointment Modification
SIU^S14	Notification of Appointment Modification
SIU^S15	Notification of Appointment Cancellation
SIU^S26	Notification of an Appointment No Show

SIU Segments

MSH
Field	Name	Req’d?	Notes	Repeat?
4	Sending Facility	R	Can be name, abbreviation, ID or acronym	N
7	HL7 Message Datetime	R	Format: YYYYMMDDhhmmss, timezone must be the same as the ADT feed or data may be rejected	N
9.1	HL7 Message Type	R	Must be SIU	N
9.2	HL7 Message Type	R	Must be one of the above accepted message types	N
11	Processing ID	R	Indicates if messages are coming from a Test (T) or Prod (P) environment	N

PID - Should be identical to the PID segment of ADT message

SCH
Field	Name	Req’d?	Notes	Repeat?
2.1	Appointment ID	R	Used to uniquely identify an appointment. Must be unique and consistent across an appointment’s lifecycle.	N
6.1	Event Reason ID	C	Either the SCH-6, SCH-7, SCH-8, or AIS-3 segment needs to be populated with the Appointment Event ID.	N
6.2	Event Reason Name	C	If SCH-6.1 is being used for Event ID, SCH-6.2 must be populated with Event Name. This is what will be displayed in Artera for that Event Resource and what will be sent to the patient.	N
7.1	Appointment Reason ID	C	Either the SCH-6, SCH-7, SCH-8, or AIS-3 segment needs to be populated with the Appointment Event ID	N
7.2	Appointment Reason Name	C	If SCH-7.1 is being used for Event ID, SCH-7.2 must be populated with Event Name. This is what will be displayed in Artera for that Event Resource and what will be sent to the patient.	N
8.1	Appointment Type ID	C	Either the SCH-6, SCH-7, SCH-8, or AIS-3 segment needs to be populated with the Appointment Event ID	N
8.2	Appointment Type Name	C	If SCH-8.1 is being used for Event ID, SCH-8.2 must be populated with Event Name. This is what will be displayed in Artera for that Event Resource and what will be sent to the patient.	N
9.1	Appointment Duration	R	Used to denote the length of the appointment in minutes	N
11.4	Appointment Date/Time	R	yyyyMMddHHmm	N
25.1	Appointment Status	R	Statuses must be mapped to Artera values	N

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.

AIS
Field	Name	Req’d?	Notes	Repeat?
3.1	Event ID	R	Either the SCH-6, SCH-7, SCH-8, or AIS-3 segment needs to be populated with the Appointment Event ID	N
3.2	Event Type	R	If the AIS-3.1 is populated, the AIS-3.2 must be populated with the Event Name. This is what will be displayed in Artera for that Event Resource and what will be sent to patient.	N

AIP
Field	Name	Req’d?	Notes	Repeat?
3.1	Provider ID	C	Required if no AIG	N
3.2	Provider Last Name	C	Required if no AIG	N
3.3	Provider First Name	C	Required if no AIG	N
4.2	Provider Degree	O		N

AIG
Field	Name	Req’d?	Notes	Repeat?
3.1	General Resource ID	C	Required if no AIP, if both AIP and AIG segments are present on a message this is used as the general resource ID	N
3.2	General Resource Last Name	C	Required if no AIP, if both AIP and AIG segments are present this is not consumed	N
3.3	General Resource First Name	C	Required if no AIP, if both AIP and AIG segments are present on a message this is used as the general resource name	N
4.2	General Resource Degree	O	If both AIP and AIG segments are present this is not consumed	N

RGS or AIL
Field	Name	Req’d?	Notes	Repeat?
3.1	Appointment Location ID	R	Must match ID provided in the location mapping	N
3.2	Appointment Location Name	O	Used solely for troubleshooting	N

Sample SIU (to Artera)

MSH|^~\&|EPIC|CADENCE||APPT_NEW|20221214113115|SLUB01|SIU^S12|112||2.3|||||||||||

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~^NET^^artera@testing.com~||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

AIP|1|A|9500000^WILLIAMS^CANDICE

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

Product Feature	Message Type	Mapped Values
Visit Method/Mode	SIU	In_Person Telehealth Video
Preferred Contact Method - Patient	ADT	DNC (Do Not Contact) Voice SMS Email
Preferred Contact Method - Appointment	SIU	DNC (Do Not Contact) Voice SMS Email
Arrival Time	SIU	n/a (should be in yyyymmddhhmmss format)
Portal Enrollment Status	SIU & ADT	Enrolled Unenrolled Inactive
Portal Enrollment Token	SIU & ADT	n/a
Portal ID (or WPR ID for Epic)	SIU & ADT	n/a
Appointment Confirmation Status	SIU	Confirmed Unconfirmed

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.

OBX
Field	Name	Req’d?	Notes	Repeat?
3.2	ID	R	ID used to specify the value sent in 5.1. See table below of accepted IDs	N
5.1	Value	R		N

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.

integration hl7 incoming data

Contact Us