Schedule a demo
Healthcare/HL7 v2/ARQ
Segment

Appointment request

Serves as the core segment in scheduling request (SRM) messages sent by the placer application to the filler or scheduling system. It carries the placer appointment identifier, requested start date and time range, priority, duration, and ordering provider. It is the scheduling request counterpart to the SCH segment (which is the filler's response and notification), and the filler responds via SRR with an S CH segment reflecting the booked appointment.

26fields
3required
v2.9HL7 version
arq.py
from zato.hl7v2.v2_9 import ARQ
from zato.hl7v2.v2_9 import XCN, CWE, DTM

arq = ARQ()
arq.arq_placer_appointment_id = 'REQ202601150900'
arq.arq_filler_appointment_id = 'APT202601150900'
arq.arq_event_reason = CWE(
    identifier='ROUTINE',
    text='Routine',
    name_of_coding_system='HL70276'
)
arq.arq_requested_start_date_time = DTM('20260115090000')
arq.arq_priority = 'R'
Python examples

Build ARQ segments in Python

How to construct and work with real-world ARQ segments.

1

Wellness check-up request

Routine preventive care appointment request

from zato.hl7v2.v2_9 import ARQ
from zato.hl7v2.v2_9 import XCN, CWE, DTM

arq = ARQ()
arq.arq_placer_appointment_id = 'REQ202401150900'
arq.arq_filler_appointment_id = 'APT202401150900'
arq.arq_event_reason = CWE(
    identifier='ROUTINE',
    text='Routine',
    name_of_coding_system='HL70276'
)
arq.arq_requested_start_date_time = DTM('20240115090000')
arq.arq_requested_end_date_time = DTM('20240115100000')
arq.arq_priority = 'R'
arq.arq_placer_contact_person = XCN(
    person_identifier_type='MRN',
    id_number='12345',
    family_name='Smith',
    given_name='John'
)
arq.arq_filler_contact_person = XCN(
    person_identifier_type='NPI',
    id_number='1234567890',
    family_name='Johnson',
    given_name='Sarah'
)
2

Nutrition consultation request

Dietary counseling appointment request

from zato.hl7v2.v2_9 import ARQ
from zato.hl7v2.v2_9 import XCN, CWE, DTM

arq = ARQ()
arq.arq_placer_appointment_id = 'REQ20240116140000'
arq.arq_filler_appointment_id = 'APT20240116140000'
arq.arq_event_reason = CWE(
    identifier='NUTRITION',
    text='Nutrition Counseling',
    name_of_coding_system='HL70276'
)
arq.arq_requested_start_date_time = DTM('20240116140000')
arq.arq_requested_end_date_time = DTM('20240116150000')
arq.arq_priority = 'R'
arq.arq_placer_contact_person = XCN(
    person_identifier_type='MRN',
    id_number='67890',
    family_name='Johnson',
    given_name='Maria'
)
arq.arq_filler_contact_person = XCN(
    person_identifier_type='NPI',
    id_number='5551112222',
    family_name='Chen',
    given_name='Lisa'
)
3

Group fitness class request

Wellness program group activity request

from zato.hl7v2.v2_9 import ARQ
from zato.hl7v2.v2_9 import XCN, CWE, DTM

arq = ARQ()
arq.arq_placer_appointment_id = 'REQ20240117180000'
arq.arq_filler_appointment_id = 'APT20240117180000'
arq.arq_event_reason = CWE(
    identifier='GROUP',
    text='Group Class',
    name_of_coding_system='HL70276'
)
arq.arq_requested_start_date_time = DTM('20240117180000')
arq.arq_requested_end_date_time = DTM('20240117190000')
arq.arq_priority = 'R'
arq.arq_placer_contact_person = XCN(
    person_identifier_type='MRN',
    id_number='54321',
    family_name='Brown',
    given_name='Robert'
)
arq.arq_filler_contact_person = XCN(
    person_identifier_type='NPI',
    id_number='9876543210',
    family_name='Miller',
    given_name='Michael'
)
Tutorials

Learn by building

Step-by-step guides for working with HL7 v2 in Zato.

MLLP
Receive and parse HL7 v2 messages
Set up an MLLP channel, parse incoming messages, and respond with acknowledgments.
Start tutorial Build
Build and send HL7 v2 messages
Construct HL7 v2 messages from scratch using typed segment classes and send them over MLLP.
Start tutorial
Related segments

Commonly used with ARQ

SCH Scheduling activity information AIS Appointment information AIG Appointment information APR Appointment reason PV1 Patient visit
FAQ

Frequently asked questions

ARQ contains appointment request information including requested appointment details, scheduling preferences, patient information, and resource requirements. It's used to request wellness appointments and preventive care visits.

Use HL70276 table values for appointment reasons like ROUTINE, NUTRITION, or GROUP:

arq.arq_event_reason = CWE(
    identifier='ROUTINE',
    text='Routine',
    name_of_coding_system='HL70276'
)

The placer appointment ID is assigned by the requesting system, while the filler appointment ID is assigned by the scheduling system. Both IDs help track appointments across different wellness center systems.

Use DTM datatype with YYYYMMDDHHMMSS format for requested date-time values:

arq.arq_requested_start_date_time = DTM('20240115090000')
arq.arq_requested_end_date_time = DTM('20240115100000')

Use R for routine, S for stat/urgent, or A for ASAP. These priority values help scheduling systems prioritize wellness center appointment requests.

Zato connects to any system that speaks HL7v2 over MLLP or FHIR over REST. This includes Epic, Cerner, Meditech, Allscripts, and other EHR platforms.

Yes, Zato has built-in MLLP support for sending and receiving HL7v2 messages. MLLP channels handle the framing protocol automatically.

Zato supports HL7 v2.9, which is backward compatible with earlier versions including v2.3, v2.5, and v2.7. Standard segments and datatypes are available as typed Python classes.

Yes. Zato handles both HL7v2 and FHIR natively, so you can parse v2 messages and build FHIR resources with IG-specific extensions in the same service. Typed Python classes are available for both protocols, including extensions from US Core, UK Core, Da Vinci, and other Implementation Guides.

Reference

ARQ field reference

Complete list of fields in the ARQ segment, HL7 v2.9.

#Python nameDatatypeUsageRepeatableTable
1▶placer_appointment_idEIRequiredNo-
2▶filler_appointment_idEIOptionalNo-
3occurrence_numberNMOptionalNo-
4▶placer_order_group_numberEIOptionalNo-
5▶schedule_idCWEOptionalNo-
6▶request_event_reasonCWEOptionalNo-
7▶appointment_reasonCWEOptionalNoHL70276
8▶appointment_typeCWEOptionalNoHL70277
9appointment_durationNMOptionalNo-
10▶appointment_duration_unitsCNEOptionalNo-
11▶requested_start_date_time_rangeDROptionalYes-
12priority_arqSTOptionalNo-
13▶repeating_intervalRIOptionalNo-
14repeating_interval_durationSTOptionalNo-
15▶placer_contact_personXCNRequiredYes-
16▶placer_contact_phone_numberXTNOptionalYes-
17▶placer_contact_addressXADOptionalYes-
18▶placer_contact_locationPLOptionalNo-
19▶entered_by_personXCNRequiredYes-
20▶entered_by_phone_numberXTNOptionalYes-
21▶entered_by_locationPLOptionalNo-
22▶parent_placer_appointment_idEIOptionalNo-
23▶parent_filler_appointment_idEIOptionalNo-
24▶placer_order_numberEIOptionalYes-
25▶filler_order_numberEIOptionalYes-
26▶alternate_placer_order_group_numberEIPOptionalNo-

Ready to build integrations?

Get started with Zato and connect your systems in minutes.

Get started ▶Read the docs
Open source In Python