HL7 Appointment Status Writeback Specifications

+ More

Outgoing Integration (from Artera) Sample SIU (from Artera) Filler Status Codes

Outgoing Integration (from Artera)

SIU - Appointment Notification Message

Artera can send real-time SIU messages when confirmation, reschedule, or cancellation requests are made. This request is sent using the original patient and appointment information

Artera typically is configured to send SIU messages as follows:

SIU Fields
Field	Sent?	Notes	HL7 Field
Patient ID	Always	Used to uniquely identify patient	PID.2 & PID.3
First Name	Always		PID.5.2
Last Name	Always		PID.5.1
Gender	Always		PID.8
Date of Birth	Always		PID.7
SSN	Optional	If Artera has SSN stored	PID.19
Appointment ID	Always		SCH.1.1
Event Reason Code	Always		SCH.7.1 & AIS-3.1
Event Reason	Always		SCH.7.2 & AIS.3.2
Appointment Duration	Always		SCH.9.1
Appointment Date	Always		SCH.11.4
Filler Status Code	Always	Filler Status Code table below	SCH.25.1
Appointment Location	Always		RGS.3.1 & AIL.3.1
Appointment Location Name	Always		RGS.3.2 & AIL.3.2
General Resource ID	Conditional	If there is a general resource associated with the appointment. If a Provider was sent to Artera using an AIG segment and ingested as a Provider in Artera, it will be sent back in an AIP segment. If this needs to be sent back in an AIG please discuss with your Artera integration resource.	AIG.3.1
General Resource Name	Conditional	If there is a general resource associated with the appointment	AIG.3.2
Provider ID	Conditional	If there is a provider associated with the appointment	AIP.3.1
Provider First Name	Conditional	If there is a provider associated with the appointment	AIP.3.3
Provider Last Name	Conditional	If there is a provider associated with the appointment	AIP.3.2

Sample SIU (from Artera)

MSH|^~\&|Artera||||20220830095454||SIU^S15|5759c70c|T|2.3

SCH|5555|5555|||||1004^OFFICE VISIT||15|min|^^^20220823143000^20220823144500||||||||||||||2P

PID|1|6666|6666||ZZTEST^ARTERA^||19680224|M|||^^^^||^^^~||||||4188

PV1|1||987654^HEALTH CENTER||||||||||||||||

RGS|1||987654^HEALTH CENTER

AIS|1||1004^OFFICE VISIT

AIG|1||^

AIL|1||987654^HEALTH CENTER

AIP|1||1054^CHAMPION^PHYSICIAN|P^Attending

Filler Status Codes

Artera Code (SCH.25.1)	Description
1S	Staff Confirmed Appointment
1P	Patient Confirmed Appointment
2P	Patient Appointment Cancel Request
3P	Patient Appointment Reschedule Request

writeback hl7 hl7 writebacks appointment writebacks filler status siu

Contact Us