Outgoing Appointment
Scheduling Interface
Technical Specification
 
 
Version: May 2021
 
 
Last Updated: April 29, 2021
 
 
For additional interface technical specifications, or the most current version of this document, visit https://open.epic.com.
Do not distribute this document.
 
To access the table of contents, use the bookmarks feature within your PDF reader.
 
Message Specifications
The interface sends scheduling information from Cadence to external systems .
 

Note:
This document can be shared with third parties to assist with interface implementation.
The interface is a subset of the full standard as defined in the published normative HL7 documentation coinciding with
the released software version.  It may not support the entire HL7 specification, depending on functional needs.

SIU^S12 or SRM^S01 New Appointment Booking

This message is generated by Cadence to inform an external system that a new appointment has been booked.
Scheduling a new appointment triggers this message.
SIU^S13 or SRM^S02 Reschedule Appointment
This event occurs when a Cadence user selects to reschedule an appointment that has just been canceled.
SIU^S14 or SRM^S03 Appointment Modification
This message is generated by modifications to appointment status and appointment notes.
SIU^S15 or SRM^04 Appointment Cancellation
This message is generated when an appointment is canceled.
SIU^S26 Notification That Patient Did Not Show for Scheduled Appointment
This message is generated when a patient does not check in (typically detected by End of Day processing in Cadence)
or leaves without being seen.
Message Format for SIU Event Types S12, S13, S14, S15, and S26
General Schedule Request
SIU Chapter
Message

MSH Message Header 2

SCH Schedule Activity Information 10

[{NTE}] Notes and Comments 2

PID Patient Identification 3

[{NTE}] Notes and Comments 2

Additional Patient Identification

[ZPD]  
Info
 General Schedule Request
SIU Chapter
Message

[{LAN}] Language Detail 15

[PD1] Patient Additional Demographics 3

[{ROL}] Role Information 5

PV1 Patient Visit Information 3

[PV2] Patient Visit - Additional Info 3

[{OBX}] Observation/Result 7

[{DG1}] Diagnosis Info 6

{    

RGS Resource Group Segment 10

[{    

AIS Appointment Info - Service 10

[{NTE}] Notes and Comments 2

}]    

[{    

Appointment Info - General

AIG 10
Resource

[{NTE}] Notes and Comments 2

 General Schedule Request
SIU Chapter
Message

}]    

[{    

AIP Appointment Info - Personnel 10

[{NTE}] Notes and Comments 2

}]    

}    

[{    

ZOR Additional Order Info  

[{NTE}] Notes and Comments 2

}]    

Additional Appointment
[ZCH] N/A
Information

ACK General Acknowledgement Chapter

MSH Message Header 2

MSA Message Acknowledgement 2

[ERR] Error Information 2

 
Message Format for SRM Event Types S01, S02, S03, and S04
 SRM General Schedule Request Message Chapter

MSH Message Header 2

ARQ Schedule Activity Information 10

[{NTE}] Notes and Comments 2

PID Patient Identification 3

[{ROL}] Role Information  

PV1 Patient Visit Information 3

[PV2] Patient Visit - Additional Info 3

[{OBX}] Observation/Result 7

{RGS Resource Group Segment  

{AIS Appointment Info - Service 10

[{NTE}] Notes and Comments 2

[{AIG Appointment Info - General Resource 10

[{NTE}] Notes and Comments 2

}]    

[{AIP Appointment Info - Personnel 10

[{NTE}] Notes and Comments 2

}]}    

 
 ACK General Acknowledgement Chapter

MSH Message Header 2

MSA Message Acknowledgement 2

[ERR] Error Information 2

Example Messages
S12 - New Appointment
Format Example
MSH|^~\&|SCHED|SENDING FAC|RECEIVING APP|RECEIVINGFAC|2010052711090000||SIU^S12|1055|P|
2.3||
SCH|1|36996|||||||30|MIN|^^^201005271115|589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY
BLVD^ALTERNATE ADDR^MADISON^^53719^|||||||||||1^SCH
NTE|1||CSCOPE
PID|||Z556301||JOHNSON^JOHN^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||
271-9000||||||333-44-4433|||||||||||N
PV1||O|IM||||||||||||||||36996|||||||||||||||||
OBX|1|TX|PPC^PPC||PATIENT LEVEL COMMENTS
RGS|1||1^INTERNAL MEDICINE
AIS|1||001^GI EXAM
NTE|1||Notes 1
NTE|2||Notes 2
AIG|1||399^COLONOSCOPY ROOM^^^^^|2^RESOURCE||||201005271130|30|MIN|30|MIN
NTE|1||leave 10 minutes between patients for cleaning
AIP|1||400^BEST^TINA^^^^|1^MD||201005271115|0|MIN|15|MIN
NTE|1||Tina is scheduled on alternate weeks only

S13 - Appointment Rescheduling

Format Example
MSH|^~\&|SCHED|SENDING FAC|RECEIVING APP|RECEIVING FAC|2010052711420000||SIU^S13|1056|P|
2.3||
SCH|1|36996|||||||30|MIN|^^^201005271300|589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY
BLVD^ALTERNATE ADDR^MADISON^^53719^|||||||||||9^RESCH
NTE|1||CSCOPE
PID|||Z556301||JOHNSON^JOHN^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||
271-9000||||||333-44-4433|||||||||||N
PV1||O|IM|||||||||||||||||||||||||||||||||
OBX|1|TX|PPC^PPC||PATIENT LEVEL COMMENTS
RGS|1||1^INTERNAL MEDICINE
AIS|1||001^OFFICE VISIT
NTE|1||Notes 1
NTE|2||Notes 2
AIG|1||399^COLONOSCOPY ROOM^^^^|2^RESOURCE||||201005271315|30|MIN|30|MIN
NTE|1||Leave 10 minutes between patients for cleaning
AIP|1||400^BEST^TINA^^^^|1^MD||201005271300|0|MIN|15|MIN
NTE|1||Tina is scheduled on alternate weeks only
S14 - Appointment Modification
Format Example
MSH|^~\&|SCHED|SENDING FAC|RECEIVING APP|RECEIVINGFAC|2010052711090000||SIU^S14|1055|P|
2.3||
SCH|1|36996|||||||30|MIN|^^^201005271115|589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY
BLVD^ALTERNATE ADDR^MADISON^^53719^|||||||||||2-ARRIVED|123456
NTE|1||CSCOPE
PID|||Z556301||JOHNSON^JOHN^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||
271-9000||||||333-44-4433|||||||||||N
PV1||O|IM||||||||||||||||36996|||||||||||||||||
OBX|1|TX|PPC^PPC||PATIENT LEVEL COMMENTS
RGS|1||1^INTERNAL MEDICINE
AIS|1||001^GI EXAM
NTE|1||Notes 1
NTE|2||Notes 2
AIG|1||399^COLONOSCOPY ROOM^^^^^|2^RESOURCE||||201005271130|30|MIN|30|MIN
NTE|1||leave 10 minutes between patients for cleaning
AIP|1||400^BEST^TINA^^^^|1^MD||201005271115|0|MIN|15|MIN
NTE|1||Tina is scheduled on alternate weeks only

S15 - Appointment Cancellation

Format Example
MSH|^~\&|SCHED|SENDING FAC|RECEIVING APP|RECEIVING FAC|2010052711560000||SIU^S15|1060|P|
2.3||
SCH|1|37006|||||||30|MIN|^^^201005271400|589^LEE^STEVEN^ ^^^|(608)271-9000|5301 TOKAY
BLVD^ALTERNATE ADDR^MADISON^^53719^|||||||||||3^CAN
NTE|1||This is a Display Note
PID|||Z556301||JOHNSON^JOHN^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||
271-9000||||||333-44-4433|||||||||||N
PV1||O|WCARD||||||||||||||||37006|||||||||||||||||
RGS|1||1^WEST CARDIOLOGY
AIS|1||001^OFFICE VISIT
AIG|1||399^STRESS^ECHOROOM^^^^|2^RESOURCE||||201005271415|15|MIN|15|MIN
AIP|1||400^GREEN^TIM^^^^|1^MD||201005271400|0|MIN|15|MIN

S26 - Notification that Patient Did Not Show for Scheduled Appointment
Format Example
MSH|^~\&|SCHED|SENDING FAC|RECEIVING APP|RECEIVING FAC|2010061109560000||SIU^S26|1462|P|
2.3||
SCH|1|44444|||||||30|MIN|^^^201006111000|589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY
BLVD^ALTERNATE ADDR^MADISON^^53719^|||||||||||4^NO SHOW
NTE|1||strep – pt stated
PID|||Z556301||JOHNSON^JOHN^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||
271-9000||||||333-44-4433|||||||||||N
PV1||O|IM||||||||||||||||44444|||||||||||||||||
RGS|1||1^INTERNAL MEDICINE
AIS|1||001^OFFICE VISIT
AIP|1||400^WEST^TOM^RN^^^|1^MD||201006111010|0|MIN|15|MIN
NTE|1||Have a great day.
  (suggestion) 
 Supported Segments and Fields

Fields in gray are not supported by this interface.

Message Types: OUT - SCHEDULING (SIU)

MSH - Message Header
Element Name Type Usage Notes
2 - Encoding ST Required Value is: ^~\&
Characters
3 - Sending HD Optional Format: Free text, configurable
Application
4 - Sending Facility — — Format: Free text, configurable
5 - Receiving HD Optional Format: Free text, configurable
Application
6 - Receiving Facility HD Optional Format: Free text, configurable
7 - Date/Time of DTM Required Sending UTC offset is configurable.
Message
Example: 20140203133854-0500
8 - Security ST Optional This field contains the user that triggered the interface message.
9 - Message Type MSG Required Format: <Message type>^<Trigger event>
Example: SIU^S12
Sending <message structure> is configurable.
Format: <Message type>^<Trigger event>^<message structure>
Example: ADT^A08^ADT_A08 or ADT^A08

10 - Message Control ST Required The value sent in this field is returned in the acknowledgment message
ID (MSA).
11 - Processing ID PT Required This field can contain the following values:
• D-Debugging
• P-Production
• T-Training
12 - Version ID VID Required HL7 version number.
Example: 2.5.1
13 - Sequence NM Optional Optional field used in the sequence number protocol
Number Format: Numeric
14 - Not Supported — — —
15 - Accept ID Optional This field indicates whether request enhanced acknowledgments are
Acknowledgment requested. If null, original acknowledgments are requested.
Type
Potential values include:
• AL-Always send acknowledgment
• NE-Never send acknowledgment
 Element Name Type Usage Notes
• ER-Only send acknowledgments on errors
• SU-Only send acknowledgments on success
16 - Application ID Optional This field indicates whether request enhanced application
Acknowledgment acknowledgments are requested. If null, original application
Type acknowledgments are requested.
Values:
• AL-Always send acknowledgment
• NE-Never send acknowledgment
• ER-Only send acknowledgments on errors
• SU-Only send acknowledgments on success
17 - Country Code ID Optional This field contains the country code.
18 - Character Set ID Optional Configurable. Supports options for Unicode UTF-8, ASCII, or ISO 8859-1.
Default is no translation.
19 - Not Supported — — —
20 - Not Supported — — —
21 - Message Profile ID Optional —
Identifier
22 - Sending XON Optional Free text
Responsible
Organization
23 - Receiving XON Optional Free text
Responsible
Organization

SCH - Schedule Activity Information (SIU Only)

Element Name Type Usage Notes
1 - Placer EI Optional Contains unique appointment number assigned by the placer for each
Appointment ID appointment.
2 - Filler — Optional Visit number assigned by Epic for each new appointment. For rescheduled
Appointment ID appointments, the visit number of the original appointment can be sent
Format: ID
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Event Reason CWE Required —
7 - Appointment CWE Optional Format: ID^Text^^<Alternate ID>
Reason ID^Text^<ID Type>^<Alternate ID>

8 - Not Supported — — —
9 - Appointment NM Optional Appointment length
Duration
 Element Name Type Usage Notes
10 - Appointment CNE Optional Appointment length units
Duration Units
Format: "S" or "MIN"
11 - Appointment TQ Required This field contains the appointment start date/time, end date/time, and
Timing Quantity duration.
Format: ^^<duration>^CCYYMMDDHHMM^CCYYMMDDHHMM

12 - Entered By XCN Required Data entry person

Person
Format: <ID>^<Name>^^^^^^^<Assigning Authority>^^^^<ID Type>

13 - Placer Contact XTN Optional Format: (xxx)xxx-xxxx or xxx-xxxx

Phone Number
14 - Placer Contact XAD Optional • Address
Address
• City
• State
• ZIP Code
15 - Not Supported — — —
16 - Entered By XCN Required Data entry person
Person
Format: <ID>^<Name>^^^^^^^<Assigning Authority>^^^^<ID Type>

17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Entered By XCN Required Data entry person
Person
Format: <ID>^<Name>^^^^^^^<Assigning Authority>^^^^<ID Type>

21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Filler Status Code CWE Optional Appointment status. Mapped using a translation table.
Format: <ID>^<Text>

26 - Placer Order — Optional Orders scheduled to the current appointment. May repeat if multiple
Number orders are linked to the appointment.
Format: <Order A ID#1>~<Order B ID#1>...

27 - Filler Order — Optional Orders scheduled to the current appointment. May repeat if multiple
Number orders are linked to the appointment.
Format: <Order A ID#2>~<Order B ID#2>...

NTE - Notes and Comments Following SCH/ARQ

Segment-Level Summary

Element Name Type Usage Notes

 Element Name Type Usage Notes
1 - Set ID – Notes SI Optional This field is incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Appointment display notes
4 - Comment Type CWE Optional Appointment Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

PID - Patient Identification

Element Name Type Usage Notes
1 - Set ID SI Optional —
2 - Patient ID CX Optional This field is for backward compatibility only.
3 - Patient Identifier CX Required Which of the patient's Identifiers are sent is configurable
List <ID>^^^<SA>^<assigning authority>~<ID2>^^^<SA2>^<Assigning
Authority>
Outgoing interfaces support sending the specific patient identifiers
specified in Chapter 3 of the Netherlands HL7 specification, HL7 Versie 2.4
NL; the Burgerservicenummer, Passport Identification, and Driver's License
Number, in the following format:
Burgerservicenummer: 066123456^^^NLMINBIZA^NNNLD^^20090101
Reisdocument (paspoort/identiteitskaart):
AA1234567^^^NLMINBIZA^PPN^^20090101
Rijbewijs: 1234567890^^^NLRDW^DL^^20090101

4 - Alternate Patient CX Optional This field is for backward compatibility only.

ID
5 - Patient Name XPN Required —
6 - Mother's Maiden XPN Optional —
Name
7 - Date/Time of Birth DTM Optional Date of birth is always sent in this field. Time of birth is sent when
available.
8 - Sex IS Optional This field is mapped using a translation table.
9 - Patient Alias XPN Optional This field respects escape characters. Aliases may repeat.
10 - Race CWE Optional This field is mapped using a translation table.
11 - Patient Address XAD Optional Permanent Address
• Street
• Dwelling number
• City
• State
• ZIP/Postal code
Element Name Type Usage Notes
• Country
• County
Confidential Address
• Street
• City
• State
• ZIP/Postal code
• Country
• Start Date
• End Date
Temporary Address
• Street
• City
• State
• ZIP/Postal code
• Country
• Start Date
• End Date
This field can repeat and can respect escape characters. County and
country can be mapped using a translation table
The interface sends permanent, confidential, and/or temporary addresses.
The seventh component (type) is mapped by a translation table
Format (dwelling number part of street address line 1):
<Street 1>^<Street 2>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^^^^<Start
Date>^<End Date>
Format (dwelling number entered discretely in EPT 82):
&<Street 1>&<Dwelling Number>^<Street
2>^<City>^<State>^<ZIP code>^<Country>^<Address
Type>^^<County>^^^^<Start Date>^<End Date>

12 - County Code IS Optional This field is mapped using a translation table.

13 - Phone Number – XTN Optional • Phone
Home
• E-mail address
• Confidential Home Phone
• Temporary Home Phone
Element Name Type Usage Notes
Format: [nnn](nnn)nnn-nnnn^<Telecommunication use
code>^<Telecommunication equipment type>^<E-mail
address>^<Country code>^<Area/city code>^<Local
number>^<Extension>^<Any text>^<Extension prefix>^<Speed
dial code>^<Unformatted telephone number>^^^^^^<Phone
number priority>
Note: For backward compatibility, only the first component is sent by
default. If configured to do so, the different parts of the phone number
are also sent in the appropriate components of the XTN data type, and
the e-mail address is sent in a repetition of the field.
This field repeats.
The interface sends permanent, confidential, and/or temporary home
telephone numbers. Multiple equipment types can be specified. The
second and third components are mapped by a translation table.
14 - Phone Number – XTN Optional • Work Phone
Work
• Confidential Work Phone
Format: [nnn](nnn)nnn-nnnn^<Telecommunication use
code>^<Telecommunication equipment type>^<E-mail
address>^<Country code>^<Area/city code>^<Local
number>^<Extension>^<Any text>^<Extension prefix>^<Speed
dial code>^<Unformatted telephone number>^^^^^^<Phone
number priority>
Note: For backward compatibility, only the first component is sent by
default. If configured to do so, the different parts of the phone number
are also sent in the appropriate components of the XTN data type.
This field repeats.
The interface sends permanent, and/or confidential work telephone
number (note, there is no temporary work telephone number). Multiple
equipment types can be specified. The second and third components are
mapped by a translation table.
15 - Primary CWE Optional This field is mapped using a translation table.
Language
Either written language or spoken language can be sent in this field. This
is determined by the customer's Epic configuration settings.
16 - Marital Status CWE Optional This field is mapped using a translation table.
17 - Religion CWE Optional This field is mapped using a translation table.
18 - Patient Account CX Optional <String>
Number or
<ID>^^^^<coding system>

19 - National ST Optional nnn-nn-nnnn or nnnnnnnnn; configurable

Identifier – Patient
20 - Driver's License DLN Optional This field respects escape characters.
Number – Patient <Driver's license number>^<Driver's license state>
 Element Name Type Usage Notes
 
Example: G6515665260505^WI

21 - Mother's CX Optional Mother's name

Identifier
or
This field can repeat with any of the following values:
• Mother's ID
• Mother's visit ID
• Mother's account ID
22 - Ethnic Group CWE Optional This field is mapped according to a translation table
23 - Birth Place XAD Optional Birth city
Birth state
Standard HL7 address format or string
24 - Multiple Birth ID Optional This field contains Y, N, or null depending on whether the patient was
Indicator identified as part of a multiple birth event (Y), was identified as a single
birth event (N), or the information was not captured (null).
25 - Birth Order NM Optional Format: Numeric
26 - Citizenship CWE Optional This field is mapped using a translation table.
27 - Veterans Military CWE Optional This field is mapped using a translation table.
Status
28 - Country of CWE Optional This field is mapped using a translation table.
Origin
29 - Patient Death DTM Optional Format: Standard HL7 timestamp
Date and Time
• Death date
• Death time
30 - Patient Death ID Optional Values:
Indicator
• Y – The patient is deceased
• N or blank – The patient is not deceased
31 - Identity ID Optional —
Unknown Indicator
32 - Identity IS Optional —
Reliability Code

LAN - Language Detail

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID - Language SI Required Numeric value that is incremented for each LAN segment being sent
Format: Numeric
 Element Name Type Usage Notes
2 - Language Code CWE Required This field contains the language about which the patient has some
knowledge.
3 - Language Ability CWE Optional This field contains the ability the patient possesses with respect to the
Code language.
4 - Language CWE Optional A flag indicating if an interpreter is needed for this language.
Proficiency Code

NTE - Notes Following PID

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Patient FYIs and comments.
Format: Free text
4 - Comment Type CWE Optional Patient FYI type.
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

PD1 - Patient Additional Demographics

Element Name Type Usage Notes
1 - Not Supported — — —
2 - Not Supported — — —
3 - Primary Facility XON Optional The item sent here is defined by the customer's Epic configuration
settings.
Format: <Facility name>^^<Facility ID>
4 - Primary Care XCN Optional <Provider ID>^<Last name>^<First name>^<Middle initial>
Provider or
<Provider ID>^<Last name>^<First name>^<Middle
initial>^^^^^<Assigning authority>^^^^<Identifier type
code>

5 - Not Supported — — —
6 - Handicap IS Optional Can have multiple repetitions:
<Handicap1>~<Handicap2>

7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Publicity Code CWE Optional —
 Element Name Type Usage Notes
12 - Protection ID Optional This field indicates patient consent based on document of a certain type
Indicator and status.
13 - Protection DT Optional —
Indicator Effective
Date
14 - Place of Worship XON Optional <Place of Worship name>^^<Place of Worship ID>
15 - Advance — — <Code Status Identifier>^<Code Status Title>^<Coding System ID>
Directive Code Status
16 - Immunization CWE Optional —
Registry Status
17 - Immunization DT Optional —
Registry Status
Effective Date
18 - Publicity Code DT Optional —
Effective Date

ROL - Role Information

Segment-Level Summary

Element Name Type Usage Notes

1 - Role Instance ID EI Optional —
2 - Action Code ID Required Specifies the Action Code for the provider.
3 - Role-ROL CWE Required Describes the subject's functional involvement in the activity being
transmitted. The interface currently sends "PP" for Primary Care Provider.
Format: Code
4 - Role Person XCN Required Identifies the person assuming the role.
Format: <Provider ID>^<Last name>^<First name>^<Middle name>
Or preferred:
<Provider ID>^<Last name>^<First name>^<Middle
initial>^^^^^<Assigning authority>^^^^<Identifier type
code>

5 - Role Begin Date DTM Optional Identifies the date and time at which the role takes effect.
6 - Role End Date DTM Optional Identifies the date and time at which the role takes expires.
7 - Not Supported — — —
8 - Role Action CWE Optional Identifies the reason why the person is assuming or changing the role.
Reason
Format: <Code>^<Text>
9 - Provider Type CWE Optional This field is mapped using the associated translation table.
10 - Organization CWE Optional This field is mapped using the associated translation table.
Unit Type
11 - Office/Home XAD Optional Identifies the office address of the person in this ROL segment.
Address/Birthplace
• Street
 Element Name Type Usage Notes
• Dwelling number
• City
• State
• ZIP/Postal code
• Country
• County
Format (dwelling number part of street address line 1):
<Street 1>^<Street 2>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^^^^<Start
Date>^<End Date>
Format (dwelling number entered discretely in I SER 1276):
&<Street 1>&<Dwelling Number>^<Street
2>^<City>^<State>^<ZIP code>^<Country>^<Address
Type>^^<County>^^^^<Start Date>^<End Date>

12 - Provider Phone XTN Optional Sends the provider's office phone and fax number.
Number

PV1 - Patient Visit

Segment-Level Summary

Element Name Type Usage Notes

1 - Not Supported — — —
2 - Patient Class IS Required —
3 - Assigned Patient PL Optional <Point of
Location care>^<Room>^<Bed>^<Facility>^^^<Building>^<Floor>^

4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Attending Doctor XCN Optional Attending doctor
8 - Referring Doctor XCN Optional —
9 - Consulting Doctor XCN Optional Format: (preferred)
<Provider ID>^<Last name>^<First name>^<Middle
initial>^^^^^<Assigning authority>^^^^<Identifier type
code>

10 - Hospital Service IS Optional Format: <code>

11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
16 - Not Supported — — —
 Element Name Type Usage Notes
17 - Admitting XCN Optional —
Doctor
18 - Patient Type IS Optional —
19 - Visit Number CX Optional Generally set to the same number as SCH-2.
20 - Financial Class FC Optional Retained for backwards compatibility
21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Not Supported — — —
26 - Not Supported — — —
27 - Not Supported — — —
28 - Not Supported — — —
29 - Not Supported — — —
30 - Not Supported — — —
31 - Not Supported — — —
32 - Not Supported — — —
33 - Not Supported — — —
34 - Not Supported — — —
35 - Not Supported — — —
36 - Discharge IS Optional —
Disposition
37 - Not Supported — — —
38 - Not Supported — — —
39 - Not Supported — — —
40 - Not Supported — — —
41 - Not Supported — — —
42 - Not Supported — — —
43 - Not Supported — — —
44 - Admit Date/Time DTM Optional The date and time an appointment check-in occurred in Epic.
Format: YYYYMMDDhhmmss
45 - Discharge Date/ DTM Optional The date and time an appointment was checked out in Epic.
Time
Format: YYYYMMDDhhmmss
46 - Not Supported — — —
47 - Not Supported — — —
48 - Not Supported — — —
49 - Not Supported — — —
50 - Alternate Visit ID CX Optional —

PV2 - Patient Visit – Additional Information

Segment-Level Summary

Element Name Type Usage Notes

 Element Name Type Usage Notes
1 - Not Supported — — —
2 - Not Supported — — —
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Visit User Code IS Optional —
8 - Expected Admit DTM Optional Target date. The value sent in this field will represent the date on which
Date/Time the provider would expect to see the patient for a follow-up visit.
9 - Not Supported — — —
10 - Not Supported — — —
11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
16 - Not Supported — — —
17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Not Supported — — —
21 - Not Supported — — —
22 - Not Supported — — —
23 - Clinic Source XON Optional This field is mapped with identity and can send either the admission
Location source location (EPT 10309) or the referring hospital (EPT 7771).
Format:
<EAF ID>^<Name>^<Name Type>^^^<HL7 Assigning
Authority>^<HL7 ID Type>~<EAF ID>^<Name>^<Name Type>^^^<HL7
Assigning Authority>^<HL7 ID Type>

ZPV - Patient Visit - Additional Visit Information

Segment-Level Summary

Element Name Type Usage Notes

1 - Not Supported — — —
2 - Not Supported — — —
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Not Supported — — —
 Element Name Type Usage Notes
11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
16 - Not Supported — — —
17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Not Supported — — —
21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Not Supported — — —
26 - Not Supported — — —
27 - Not Supported — — —
28 - Not Supported — — —
29 - Not Supported — — —
30 - Not Supported — — —
31 - Not Supported — — —
32 - Not Supported — — —
33 - Parent Pathway ID — The overall administrative pathway for an encounter.
Format: <ID>

34 - Parent Pathway DT — Start date of the administrative pathway in ZPV-33.

Start Date
Format: YYYYMMDD

35 - Parent Pathway DT — End date of the administrative pathway in ZPV-33.

End Date
Format: YYYYMMDD

OBX - Observation Notes

Segment-Level Summary
Sends a generic observation to a third-party system.

Element Name Type Usage Notes

1 - Set ID SI Optional The value sent in this field is a numeric value that is incremented for each
OBX segment.
2 - Value Type ID Required Supported Types are:
• TX – Text
• NM – Numeric
• DT – Date
• TM – Time
Element Name Type Usage Notes
• DTM – Date and time
3 - Observation CWE Required —
Identifier
4 - Observation Sub- ST Optional Incremented for each questionnaire or patient item sent.
ID
5 - Observation Value ST Required All HL7 separators will be translated to their corresponding escape
sequences.
Format: Free text
6 - Units CWE Optional —
7 - Not Supported — — —
8 - Abnormal Flags CWE Optional —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Observation ID Optional —
Result Status
12 - Not Supported — — —
13 - Not Supported — — —
14 - Date/Time of the DTM Optional Format: CCYYMMDDhhmmss
Observation
15 - Producer's ID CWE Optional —
16 - Not Supported — — —
17 - Observation CWE Optional —
Method
18 - Not Supported — — —
19 - Date/Time of the DTM Optional Format: CCYYMMDDhhmmss
Analysis
20 - Not Supported — — —
21 - Observation EI Optional —
Instance Identifier
22 - Not Supported — — —
23 - Performing XON Optional —
Organization Name
24 - Performing XAD Optional —
Organization Address
25 - Performing XCN Optional —
Organization Medical
Director
26 - Not Supported — — —
27 - Not Supported — — —
28 - Not Supported — — —
29 - Not Supported — — —
30 - Not Supported — — —
31 - Not Supported — — —
 Element Name Type Usage Notes
32 - Observation — — —
Value Absent Reason
(standard)

DG1 - Diagnosis
Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required Sequentially assigned for each DG1 segment.
Format: Numeric
2 - Diagnosis Coding ID Required Value: <Code set> or <Null>, depending on configuration
Method
3 - Diagnosis Code CWE Optional Format: (depending on configuration)
• <ID>^<Description>^<ID type>
• <Diagnosis code>^<Description>^<Code set>
• ^<Description>
• <HRV Code>^<Description>^HRV

4 - Diagnosis ST Optional Description, if DG1-3.2 is blank.

Description
Format: String
5 - Diagnosis Date/ DTM Optional The date and time a patient's diagnosis was determined. If only the date is
Time available, it is sent.
Format for date and time: yyyyMMddHHmmss
Format for date only: yyyyMMdd

6 - Diagnosis Type CWE Required Supported formats:

• <Diagnosis Qualifier>
• <Diagnosis Qualifier>^<Diagnosis Type>
• <Diagnosis Type>

7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
16 - Not Supported — — —
17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
 Element Name Type Usage Notes
20 - Not Supported — — —
21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Not Supported — — —
26 - Present On CWE Optional Format: String
Admission (POA)
Indicator

RGS - Resource Group

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required Format: Numeric
2 - Not Supported — — —
3 - Resource Group CWE Optional Format: <ID>^<Name>^<CodingSystem>^<Alternate
ID Identification>^Alternate Name
 
 

AIS - Appointment Information – Service

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required —
2 - Not Supported — — —
3 - Universal Service CWE Required Appointment visit type. Mapped using a translation table.
Identifier
Format: <ID>^<Text>

4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Filler Status Code CWE Optional Appointment status Mapped using a translation table
Format: <ID>

11 - Not Supported — — —
12 - Service Filler Info ST Optional —

NTE - Notes and Comments following AIS

Segment-Level Summary

Element Name Type Usage Notes

 Element Name Type Usage Notes
1 - Notes and SI Optional Incremented for each NTE sent.
Comments
2 - Not Supported — — —
3 - Comment FT Optional Additional Appointment service notes.
4 - Comment Type CWE Optional Appointment Service Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

AIG - Appointment Information – General Resource

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required Incremented for each AIG sent
2 - Not Supported — — —
3 - Resource ID CWE Optional Appointment staff/resource.
Format: <ID>^<Name>^<Coding System>

4 - Resource Type CWE Required Type of resource

Format: <ID>^<Text>^<Title>

5 - Resource Group CWE Optional Additional resource type qualifiers.

Format: <Code>^<Name>^<Coding System>

6 - Not Supported — — —
7 - Not Supported — — —
8 - Start Date/Time DTM Optional Appointment date and appointment time
Format: CCYYMMDDHHMM
9 - Start Date/Time NM Optional Offset to the appointment start time
Offset
10 - Start Date Time CNE Optional Configurable. Default is seconds.
Offset Units
Format: "S" or "MIN"
11 - Duration NM Optional Format: Numeric
12 - Duration Units CNE Optional Configurable. Default is seconds.
Format: "S" or "MIN"

NTE - Notes and Comments Following AIG

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Notes for resource.
 Element Name Type Usage Notes
4 - Comment Type CWE Optional Appointment Resource Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

AIP - Appointment Information – Personnel Resource

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required This field is incremented for each AIP sent.
2 - Not Supported — — —
3 - Resource ID XCN Optional Appointment staff/resource. All HL7 separators will be translated to their
corresponding escape sequences.
Format: <Provider ID>^<Last name>^<First name>^<Middle
name>^^^^^<Assigning authority>^^^^<ID type>

4 - Resource Role CWE Required Format: <ID>^<Text>^<Title>

5 - Resource Group CWE Optional Additional resource type qualifiers.

Format: <Code>^<Name>^<Coding System>

6 - Start Date/Time DTM Optional Appointment date and appointment time

Format: CCYYMMDDHHMM

7 - Start Date/Time NM Optional Offset to the appointment start time

Offset
Format: Numeric
8 - Start Date/Time CNE Optional Offset units
Offset Units
Format: "S" or "MIN"
9 - Duration NM Optional Appointment length
10 - Duration Units CNE Optional Duration units
Format: "S" or "MIN"

NTE - Notes and Comments Following AIP

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Notes for provider.
4 - Comment Type CWE Optional Appointment Provider Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time
ZPD - Patient Identification - Additional Patient Information
Segment-Level Summary

Element Name Type Usage Notes

1 - Patient Ancestry ST Optional Patient Ancestry information from I EPT 134
2 - Preferred ST Optional Patient preferred communication method. This field can repeat.
Communication
Example: Email~MyChart~Mail
Method
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Race/Ethnicity ID ST Optional This field is mapped using a translation table.
Method
16 - Not Supported — — —
17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Gender Identity IS Optional The patient's gender identity.
21 - Sexual IS Optional The patient's sexual orientations.
Orientation
22 - Sex Assigned at IS Optional The patient's sex assigned at birth.
Birth
23 - Zpd Patient — Optional Indicates whether a patient should be considered female for obstetric
Menarche Flag purposes. This field can be mapped using a translation table.
Example format: Y
24 - Zpd Patient — Optional This field is an approximation of the patient's physiological features for
Proxy Sex For Clinical the purpose of clinical decision making such as driving reference ranges,
Decisions blood product administration, or health maintenance reminders. This
field is typically more clinically relevant than PID-8.
This field can be mapped using a translation table.
Example format: F, M, or U

ZOR - Order Information - Additional Order Information

Segment-Level Summary

Element Name Type Usage Notes

 Element Name Type Usage Notes
1 - Order Number NM Optional Epic Order Number
2 - Ordering CE Optional Department from which the order was originally placed.
Department
3 - Procedure CE Optional Order procedure
Format: <ID>^<Text>^<Coding System>^<Alternate
ID>^<Alternate Text>^<Alternate Coding System>^^^^<Second
Alternate ID>^<Second Alternate Text>^<Second Alternate
Coding System>

4 - Order Status ST Optional Order status

5 - Releasing CSN CX Optional Releasing CSN
6 - Authorizing XCN Optional Authorizing Provider
Provider
7 - Ordering Provider XCN Optional Ordering Provider
8 - Parent Order NM Optional Epic Parent Order Number
Number
9 - Order Class ID Optional Order Class
10 - Procedure Code CWE Optional —
Modifier
11 - Transportation ST Optional Transportation Mode
Mode
12 - Set ID SI Optional Incremented for each ZOR sent.
Format: Numeric.

NTE - Notes and Comments Following ZOR

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID -- Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Additional Order Notes
4 - Comment Type CWE Optional Appointment request note type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

ZPL - Additional Appointment Information

Segment-Level Summary

Element Name Type Usage Notes

1 - Not Supported — — —
2 - Patient Arrival CWE Optional Specifies the physical location a patient should arrive at for an
Location appointment.
 Element Name Type Usage Notes
Format: <ID>^^<ID type>

3 - Hidden — Optional Indicates whether the appointment should be hidden from the patient.
Appointment Flag
4 - TBD Appointment — Optional Indicates whether the appointment's scheduled time will be determined at
Flag a later time.

ZTP - Patient Communication Preference

Segment-Level Summary

Element Name Type Usage Notes

1 - Communication CWE Optional The type of communication such as health maintenance reminders or lab
Preference Concept results. This field can be mapped using a general table.
Format: <concept ID>^<concept name>

2 - Communication ST Optional ZTP-2.1 contains the media name (for example, phone). ZTP-2.2 contains
Preference Media either Y or N to indicate whether a media is approved.
Example: Text^Y~Phone^Y~E-mail^N

ZCH - Zch - Out - Scheduling

Segment-Level Summary

Element Name Type Usage Notes

1 - Appointment ST Optional Appointment confirmation status documented in Epic and MyChart.
Confirmation Status
2 - Appointment DTM Optional Appointment arrival time
Arrival Time
Format: YYYYMMDDhhmmss
  Message Types: OUT - SCHEDULING (SRM)
MSH - Message Header
Element Name Type Usage Notes
2 - Encoding ST Required Value is typically: ^~\&
Characters
3 - Sending HD Optional Format: Free text, configurable
Application
4 - Sending Facility HD Optional Format: Free text, configurable
5 - Receiving HD Optional Format: Free text, configurable
Application
6 - Receiving Facility — — —
7 - Date/Time of DTM Optional Sending UTC offset is configurable.
Message
 
Example: 20140203133854-0500
8 - Security ST Optional The user that triggered the interface message is sent in this field.
9 - Message Type MSG Required Format: <Message type>^<Trigger event>
Example: SIU^S12
10 - Message Control ST Required A number or other unique identifier for the message.
ID
Format: Free text
11 - Processing ID PT Required This field can contain the following values:
• D-Debugging
• P-Production
• T-Training
12 - Version ID VID Required HL7 version number.
Example: 2.5.1
13 - Sequence NM Optional Optional field used in the sequence number protocol
Number Format: Numeric
14 - Not Supported — — —
15 - Accept ID Optional This field indicates whether request enhanced acknowledgments are
Acknowledgment requested. If null, original acknowledgments are requested.
Type
Potential values include:
• AL-Always
• NE-Never
• <Null>
16 - Application ID Optional This field indicates whether request enhanced application
Acknowledgment acknowledgments are requested. If null, original application
Type acknowledgments are requested.
Values:
• NE
 Element Name Type Usage Notes
• <Null>
17 - Country Code ID Optional This field contains the country code.
18 - Character Set ID Optional Configurable. Supports options for Unicode UTF-8, ASCII, or ISO 8859-1.
Default is no translation.
19 - Not Supported — — —
20 - Not Supported — — —
21 - Conformance ID Optional —
Statement ID
22 - Sending XON Optional Free text
Responsible
Organization
23 - Receiving XON Optional Free text
Responsible
Organization

ARQ - Appointment Request (SRM Only)

Segment-Level Summary

Element Name Type Usage Notes

1 - Placer — Required Visit number assigned for each new appointment. Items specified by the
Appointment ID customer's configuration settings.
Note: If using S02 messages for rescheduled appointments, the visit
number of the original appointment will be sent.
2 - Filler EI Optional —
Appointment ID
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Request Event CWE Optional —
Reason
7 - Appointment CWE Optional Mapped using the PRC Master File with Identity or a translation table.
Reason
Format: ID^Text^^<Alternate ID>
ID^Text^<ID Type>^<Alternate ID>

8 - Not Supported — — —
9 - Appointment NM Optional Appointment length
Duration
10 - Appointment CNE Optional Appointment length unit
Duration Units
Format: "S" or "MIN"
11 - Requested Start DR Optional Appointment date and appointment time
Date/Time Range
Format: CCYYMMDDHHMM ^CCYYMMDDHHMM

12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
 Element Name Type Usage Notes
15 - Entered By XCN Required —
Person
16 - Placer Contact XTN Optional Format:(xxx)xxx-xxxx or xxx-xxxx
Phone Number
17 - Placer Contact XAD Optional Address
Address
City
State
ZIP Code
18 - Not Supported — — —
19 - Entered By XCN Required —
Person
20 - Not Supported — — —
21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Placer Order EI Optional Orders scheduled to the current appointment. May repeat if multiple
Number orders are linked to the appointment.
Format: <Order A ID#1>~<Order B ID#1>...
25 - Filler Order EI Optional Orders scheduled to the current appointment. May repeat if multiple
Number orders are linked to the appointment.
Format: <Order A ID#1>~<Order B ID#1>...

NTE - Notes and Comments Following SCH/ARQ

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional This field is incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Appointment display notes
4 - Comment Type CWE Optional Appointment Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

PID - Patient Identification

Element Name Type Usage Notes
1 - Set ID SI Optional —
2 - Patient ID CX Optional This field is for backward compatibility only.
3 - Patient Identifier CX Required The patient identifier list can contain values for the Social Security number
List or driver's license number.
Element Name Type Usage Notes
Format: <Social Security number>^^^USSSA^SS<License
number>^^^<State>^DL
4 - Alternate Patient CX Optional This field is for backward compatibility only.
ID
5 - Patient Name XPN Required Patient name
Prefix
Suffix
Academic title
Format:
<Last>^<First>^<Middle>^<Suffix>^<Prefix>^<Academic>^<Type>~.
..
6 - Mother's Maiden XPN Optional —
Name
7 - Date/Time of Birth DTM Optional Date of birth is always sent in this field. Time of birth is sent when
available.
8 - Sex IS Optional This field is mapped using a translation table.
9 - Patient Alias XPN Optional Aliases may repeat.
10 - Race CWE Optional The field is mapped using an associated translation table.
11 - Patient Address XAD Optional Street
City
State
ZIP/postal code
Country
County
Country can optionally be mapped using the associated translation table.
County is mapped using the associated translation table.
Format:
<Street 1>^<Street 2>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^^^^<Start
Date>^<End Date>
12 - County Code IS Optional This field is mapped using a translation table.
13 - Phone Number – XTN Optional Phone
Home
E-mail address
Formats:
• [nnn](nnn)nnn-nnnnx<extension>
• ^^^^<Country code>^<City/area
code>^<Number>^<Extension>
• ^^^<Patient e-mail address>
Element Name Type Usage Notes
• #<text>
14 - Phone Number – XTN Optional Formats:
Work
• (nnn)nnn-nnnnx<extension>
• ^^^^^<City/area code>^<Number>^<Extension>
• #<text>
15 - Primary CWE Optional This field is mapped using a translation table.
Language
Either written language or spoken language can be sent in this field. This
is determined by the customer's Epic configuration settings.
16 - Marital Status CWE Optional This field is mapped using a translation table.
17 - Religion CWE Optional This field is mapped using a translation table.
18 - Patient Account CX Optional —
Number
19 - National ST Optional nnn-nn-nnnn or nnnnnnnnn; configurable
Identifier – Patient
20 - Driver's License DLN Optional Format: <Driver's license number>^<Driver's license state>
Number – Patient
Example: G6515665260505^WI
21 - Mother's CX Optional The patient's mother. This field can repeat with any of the following
Identifier values:
• Mother's ID
• Mother's visit ID
• Mother's account ID
• Mother's name
 
22 - Ethnic Group CWE Optional This field is mapped using the associated translation table.
23 - Birth Place XAD Optional Birth city
Birth state
24 - Multiple Birth ID Optional —
Indicator
25 - Birth Order NM Optional Format: Numeric
26 - Citizenship CWE Optional This field is mapped using a translation table.
27 - Veterans Military CWE Optional This field is mapped using a translation table.
Status
28 - Country of CWE Optional This field is mapped using a translation table.
Origin
29 - Patient Death DTM Optional Format: Standard HL7 timestamp
Date and Time
• Death date
• Death time
 Element Name Type Usage Notes
30 - Patient Death ID Optional Values:
Indicator
• Y – The patient is deceased
• N or blank – The patient is not deceased
31 - Identity ID Optional —
Unknown Indicator
32 - Identity IS Optional —
Reliability Code

LAN - Language Detail

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID - Language SI Required Numeric value that is incremented for each LAN segment being sent
Format: Numeric
2 - Language Code CWE Required This field contains the language about which the patient has some
knowledge.
3 - Language Ability CWE Optional This field contains the ability the patient possesses with respect to the
Code language.
4 - Language CWE Optional A flag indicating if an interpreter is needed for this language.
Proficiency Code

NTE - Notes Following PID

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Patient FYIs and comments.
Format: Free text
4 - Comment Type CWE Optional Patient FYI type.
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

PD1 - Patient Additional Demographics

Element Name Type Usage Notes
1 - Not Supported — — —
2 - Not Supported — — —
3 - Primary Facility XON Optional The item sent here is defined by the customer's Epic configuration
settings.
Format: <Facility name>^^<Facility ID>
 Element Name Type Usage Notes
4 - Primary Care XCN Optional <Provider ID>^<Last name>^<First name>^<Middle initial> OR
Provider
<Provider ID>^<Last name>^<First name>^<Middle
initial>^^^^^<Assigning authority>^^^^<Identifier type code>
5 - Not Supported — — —
6 - Handicap IS Optional —
7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Publicity Code CWE Optional —
12 - Protection ID Optional —
Indicator
13 - Protection DT Optional —
Indicator Effective
Date
14 - Place of Worship XON Optional <Place of Worship name>^^<Place of Worship ID>
15 - Advance — — <Code Status Identifier>^<Code Status Title>^<Coding System ID>
Directive Code Status
16 - Immunization CWE Optional —
Registry Status
17 - Immunization DT Optional —
Registry Status
Effective Date
18 - Publicity Code DT Optional —
Effective Date

ROL - Role Information

Segment-Level Summary

Element Name Type Usage Notes

1 - Role Instance ID EI Optional —
2 - Action Code ID Required Specifies the Action Code for the provider.
3 - Role-ROL CWE Required Describes the subject's functional involvement in the activity being
transmitted. The interface currently sends "PP" for Primary Care Provider.
Format: Code
4 - Role Person XCN Required Identifies the person assuming the role.
Formats:
• <Provider ID>^<Last name>^<First name>^<Middle name>
Preferred:
• <Provider ID>^<Last name>^<First name>^<Middle
initial>^^^^^<Assigning authority>^^^^<Identifier type code>
5 - Role Begin Date DTM Optional Identifies the date and time at which the role takes effect.
 Element Name Type Usage Notes
6 - Role End Date DTM Optional Identifies the date and time at which the role takes expires.
7 - Not Supported — — —
8 - Role Action CWE Optional Identifies the reason why the person is assuming or changing the role.
Reason
Format: <Code>^<Text>
9 - Provider Type CWE Optional This field is mapped using the associated translation table.
10 - Organization CWE Optional This field is mapped using the associated translation table.
Unit Type
11 - Office/Home XAD Optional Identifies the office address of the person in this ROL segment.
Address/Birthplace
• Street
• Dwelling number
• City
• State
• ZIP/Postal code
• Country
• County
Format (dwelling number part of street address line 1):
<Street 1>^<Street 2>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^^^^<Start
Date>^<End Date>
Format (dwelling number entered discretely in I SER 1276):
&<Street 1>&<Dwelling Number>^<Street
2>^<City>^<State>^<ZIP code>^<Country>^<Address
Type>^^<County>^^^^<Start Date>^<End Date>

12 - Provider Phone XTN Optional Sends the provider's office phone and fax number.
Number

PV1 - Patient Visit

Segment-Level Summary

Element Name Type Usage Notes

1 - Not Supported — — —
2 - Patient Class IS Required —
3 - Assigned Patient PL Optional <Point of
Location care>^<Room>^<Bed>^<Facility>^^^<Building>^<Floor>^

4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Attending Doctor XCN Optional Attending doctor
8 - Referring Doctor XCN Optional —
9 - Consulting Doctor XCN Optional Format: (preferred)
Element Name Type Usage Notes
<Provider ID>^<Last name>^<First name>^<Middle
initial>^^^^^<Assigning authority>^^^^<Identifier type
code>

10 - Hospital Service IS Optional Format: <code>

11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
16 - Not Supported — — —
17 - Admitting XCN Optional —
Doctor
18 - Patient Type IS Optional —
19 - Visit Number CX Optional Generally set to the same number as SCH-2.
20 - Financial Class FC Optional Retained for backwards compatibility
21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Not Supported — — —
26 - Not Supported — — —
27 - Not Supported — — —
28 - Not Supported — — —
29 - Not Supported — — —
30 - Not Supported — — —
31 - Not Supported — — —
32 - Not Supported — — —
33 - Not Supported — — —
34 - Not Supported — — —
35 - Not Supported — — —
36 - Discharge IS Optional —
Disposition
37 - Not Supported — — —
38 - Not Supported — — —
39 - Not Supported — — —
40 - Not Supported — — —
41 - Not Supported — — —
42 - Not Supported — — —
43 - Not Supported — — —
44 - Admit Date/Time DTM Optional The date and time an appointment check-in occurred in Epic.
Format: YYYYMMDDhhmmss
 Element Name Type Usage Notes
45 - Discharge Date/ DTM Optional The date and time an appointment was checked out in Epic.
Time
Format: YYYYMMDDhhmmss
46 - Not Supported — — —
47 - Not Supported — — —
48 - Not Supported — — —
49 - Not Supported — — —
50 - Alternate Visit ID CX Optional —

PV2 - Patient Visit – Additional Information

Segment-Level Summary

Element Name Type Usage Notes

1 - Not Supported — — —
2 - Not Supported — — —
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Visit User Code IS Optional —
8 - Expected Admit DTM Optional Target date. The value sent in this field will represent the date on which
Date/Time the provider would expect to see the patient for a follow-up visit.
9 - Not Supported — — —
10 - Not Supported — — —
11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
16 - Not Supported — — —
17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Not Supported — — —
21 - Not Supported — — —
22 - Not Supported — — —
23 - Clinic Source XON Optional This field is mapped with identity and can send either the admission
Location source location (EPT 10309) or the referring hospital (EPT 7771).
Format:
<EAF ID>^<Name>^<Name Type>^^^<HL7 Assigning
Authority>^<HL7 ID Type>~<EAF ID>^<Name>^<Name Type>^^^<HL7
Assigning Authority>^<HL7 ID Type>

OBX - Observation Notes

Segment-Level Summary
Sends a generic observation to a third-party system.

Element Name Type Usage Notes

1 - Set ID SI Optional The value sent in this field is a numeric value that is incremented for each
OBX segment.
2 - Value Type ID Required —
3 - Observation ID CWE Required Identifies the type of value sent in OBX-5.
4 - Observation Sub- ST Optional Incremented for each questionnaire or patient item sent.
ID
5 - Observation Value ST Optional —
6 - Units CWE Optional —
7 - Not Supported — — —
8 - Abnormal Flags CWE Optional —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Observation ID Optional —
Result Status
12 - Not Supported — — —
13 - Not Supported — — —
14 - Date/Time of the DTM Optional For height/weight measurements: date and time when the height/weight
Observation is captured
Example
20190729124200
15 - Producer's ID CWE Optional —
16 - Not Supported — — —
17 - Observation CWE Optional Supported values:
Method
• VXC40^per immunization^CDCPHINVS
• VXC41^per visit^CDCPHINVS
18 - Not Supported — — —
19 - Date/Time of the DTM Optional Format: CCYYMMDDhhmmss
Analysis
20 - Not Supported — — —
21 - Observation EI Optional —
Instance Identifier
22 - Not Supported — — —
23 - Performing XON Optional —
Organization Name
24 - Performing XAD Optional —
Organization Address
25 - Performing XCN Optional —
Organization Medical
Director
26 - Not Supported — — —
27 - Not Supported — — —
 Element Name Type Usage Notes
28 - Not Supported — — —
29 - Not Supported — — —
30 - Not Supported — — —
31 - Not Supported — — —
32 - Observation — — —
Value Absent Reason
(standard)

DG1 - Diagnosis
Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required Sequentially assigned for each DG1 segment.
Format: Numeric
2 - Diagnosis Coding ID Required Value: <Code set> or <Null>, depending on configuration
Method
3 - Diagnosis Code CWE Optional Format: (depending on configuration)
• <ID>^<Description>^<ID type>
• <Diagnosis code>^<Description>^<Code set>
• ^<Description>
• <HRV Code>^<Description>^HRV

4 - Diagnosis ST Optional Description, if DG1-3.2 is blank.

Description
Format: String
5 - Diagnosis Date/ DTM Optional The date and time a patient's diagnosis was determined. If only the date is
Time available, it is sent.
Format for date and time: yyyyMMddHHmmss
Format for date only: yyyyMMdd

6 - Diagnosis Type CWE Required Supported formats:

• <Diagnosis Qualifier>
• <Diagnosis Qualifier>^<Diagnosis Type>
• <Diagnosis Type>

7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Not Supported — — —
11 - Not Supported — — —
12 - Not Supported — — —
13 - Not Supported — — —
14 - Not Supported — — —
15 - Not Supported — — —
 Element Name Type Usage Notes
16 - Not Supported — — —
17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Not Supported — — —
21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Not Supported — — —
26 - Present On CWE Optional Format: String
Admission (POA)
Indicator

RGS - Resource Group

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required Format: Numeric
2 - Not Supported — — —
3 - Resource Group CWE Optional Format: <ID>^<Name>^<CodingSystem>^<Alternate
ID Identification>^Alternate Name
 
 

AIS - Appointment Information – Service

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required —
2 - Not Supported — — —
3 - Universal Service CWE Required Appointment visit type. Mapped using a translation table.
Identifier
Format: <ID>^<Text>

4 - Not Supported — — —
5 - Not Supported — — —
6 - Not Supported — — —
7 - Not Supported — — —
8 - Not Supported — — —
9 - Not Supported — — —
10 - Filler Status Code CWE Optional Appointment status Mapped using a translation table
Format: <ID>

11 - Not Supported — — —
12 - Service Filler Info ST Optional —
NTE - Notes and Comments following AIS
Segment-Level Summary

Element Name Type Usage Notes

1 - Notes and SI Optional Incremented for each NTE sent.
Comments
2 - Not Supported — — —
3 - Comment FT Optional Additional Appointment service notes.
4 - Comment Type CWE Optional Appointment Service Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

AIG - Appointment Information – General Resource

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required Incremented for each AIG sent
2 - Not Supported — — —
3 - Resource ID CWE Optional Appointment staff/resource.
Format: <ID>^<Name>^<Coding System>

4 - Resource Type CWE Required Type of resource

Format: <ID>^<Text>^<Title>

5 - Resource Group CWE Optional Additional resource type qualifiers.

Format: <Code>^<Name>^<Coding System>

6 - Not Supported — — —
7 - Not Supported — — —
8 - Start Date/Time DTM Optional Appointment date and appointment time
Format: CCYYMMDDHHMM
9 - Start Date/Time NM Optional Offset to the appointment start time
Offset
10 - Start Date Time CNE Optional Configurable. Default is seconds.
Offset Units
Format: "S" or "MIN"
11 - Duration NM Optional Format: Numeric
12 - Duration Units CNE Optional Configurable. Default is seconds.
Format: "S" or "MIN"

NTE - Notes and Comments Following AIG

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional Incremented for each NTE sent.
and Comments
 Element Name Type Usage Notes
2 - Not Supported — — —
3 - Comment FT Optional Notes for resource.
4 - Comment Type CWE Optional Appointment Resource Note Type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

AIP - Appointment Information – Personnel Resource

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required This field is incremented for each AIP sent.
2 - Not Supported — — —
3 - Resource ID XCN Optional Appointment staff/resource. All HL7 separators will be translated to their
corresponding escape sequences.
Format: <Provider ID>^<Last name>^<First name>^<Middle
name>^^^^^<Assigning authority>^^^^<ID type>

4 - Resource Role CWE Required Format: <ID>^<Text>^<Title>

5 - Resource Group CWE Optional Additional resource type qualifiers.

Format: <Code>^<Name>^<Coding System>

6 - Start Date/Time DTM Optional Appointment date and appointment time

Format: CCYYMMDDHHMM

7 - Start Date/Time NM Optional Offset to the appointment start time

Offset
Format: Numeric
8 - Start Date/Time CNE Optional Offset units
Offset Units
Format: "S" or "MIN"
9 - Duration NM Optional Appointment length
10 - Duration Units CNE Optional Duration units
Format: "S" or "MIN"

NTE - Notes and Comments Following AIP

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID – Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Notes for provider.
4 - Comment Type CWE Optional Appointment Provider Note Type
5 - Not Supported — — —
 Element Name Type Usage Notes
6 - Entered Date/ DTM Optional Note Timestamp
Time

ZOR - Order Information - Additional Order Information

Segment-Level Summary

Element Name Type Usage Notes

1 - Order Number NM Optional Epic Order Number
2 - Ordering CE Optional Department from which the order was originally placed.
Department
3 - Procedure CE Optional Order procedure
Format: <ID>^<Text>^<Coding System>^<Alternate
ID>^<Alternate Text>^<Alternate Coding System>^^^^<Second
Alternate ID>^<Second Alternate Text>^<Second Alternate
Coding System>

4 - Order Status ST Optional Order status

5 - Releasing CSN CX Optional Releasing CSN
6 - Authorizing XCN Optional Authorizing Provider
Provider
7 - Ordering Provider XCN Optional Ordering Provider
8 - Parent Order NM Optional Epic Parent Order Number
Number
9 - Order Class ID Optional Order Class
10 - Procedure Code CWE Optional —
Modifier
11 - Transportation ST Optional Transportation Mode
Mode
12 - Set ID SI Optional Incremented for each ZOR sent.
Format: Numeric.

NTE - Notes and Comments Following ZOR

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID -- Notes SI Optional Incremented for each NTE sent.
and Comments
2 - Not Supported — — —
3 - Comment FT Optional Additional Order Notes
4 - Comment Type CWE Optional Appointment request note type
5 - Not Supported — — —
6 - Entered Date/ DTM Optional Note Timestamp
Time

ZTP - Patient Communication Preference

Segment-Level Summary

Element Name Type Usage Notes

1 - Communication CWE Optional The type of communication such as health maintenance reminders or lab
Preference Concept results. This field can be mapped using a general table.
Format: <concept ID>^<concept name>

2 - Communication ST Optional ZTP-2.1 contains the media name (for example, phone). ZTP-2.2 contains
Preference Media either Y or N to indicate whether a media is approved.
Example: Text^Y~Phone^Y~E-mail^N
  Message Types: SCHEDULE QUERY RESPONSE
MSH - Message Header
Element Name Type Usage Notes
2 - Encoding ST Required Value is typically: ^~\&
Characters
3 - Sending HD Optional Format: Free text, configurable
Application
4 - Sending Facility HD Optional Format: Free text, configurable
5 - Receiving HD Optional Format: Free text, configurable
Application
6 - Receiving Facility HD Optional Format: Free text, configurable
7 - Date/Time of DTM Optional Sending UTC offset is configurable.
Message
 
Example: 20140203133854-0500
8 - Security ST Optional The user that triggered the interface message is sent in this field.
9 - Message Type MSG Required Format: <Message type>^<Trigger event>
Example: SIU^S12
10 - Message Control ST Required A number or other unique identifier for the message.
ID
Format: Free text
11 - Processing ID PT Required This field can contain the following values:
• D-Debugging
• P-Production
• T-Training
12 - Version ID VID Required HL7 version number.
Example: 2.5.1
13 - Sequence NM Optional Optional field used in the sequence number protocol
Number Format: Numeric
14 - Not Supported — — —
15 - Accept ID Optional This field indicates whether request enhanced acknowledgments are
Acknowledgment requested. If null, original acknowledgments are requested.
Type
Potential values include:
• AL-Always
• NE-Never
• <Null>
16 - Application ID Optional This field indicates whether request enhanced application
Acknowledgment acknowledgments are requested. If null, original application
Type acknowledgments are requested.
 Element Name Type Usage Notes
Values:
• NE
• <Null>
17 - Country Code ID Optional This field contains the country code.
18 - Character Set ID Optional Configurable. Supports options for Unicode UTF-8, ASCII, or ISO 8859-1.
Default is no translation.
19 - Not Supported — — —
20 - Not Supported — — —
21 - Conformance ID Optional —
Statement ID
22 - Sending XON Optional Free text
Responsible
Organization
23 - Receiving XON Optional Free text
Responsible
Organization

MSA - Message Acknowledgment

Element Name Type Usage Notes
1 - Acknowledgment ID Required Format: Code
Code
Original Mode Values:
• AA – Application Accept
• AE – Application Error
• AR – Application Reject
Enhanced Mode Values:
• CA – Commit Accept
• CE – Commit Error
• CR – Commit Reject
Notes: Indicates successful/not successful processing of message. The use
of Original Mode or Enhanced Mode acknowledgments is determined in
your interface specification in the HL7 Ack Mode prompt. The default is to
use the Original Mode.
2 - Message Control ST Required Message control ID of the message sent by the original sending system
ID
Format: Alpha-numeric

QAK - Query Acknowledgment

Element Name Type Usage Notes
1 - Query Tag ST Optional If a value is sent in on QRD-4, that same value is returned here.
Format: Numeric
 Element Name Type Usage Notes
2 - Query Response ID Optional • OK - Data found, no errors
Status
• NF - Invalid MRN
• ER - Error in query
3 - Not Supported — — —
4 - Hit Count NM Optional Transmits the number of appointments found. This cannot be larger than
the maximum number passed in QRD-7.01 or as configured.

SCH - Schedule Activity Information

Element Name Type Usage Notes
1 - Placer EI Optional Contains unique appointment number assigned by the placer for each
Appointment ID appointment.
2 - Filler EI Optional —
Appointment ID
3 - Not Supported — — —
4 - Not Supported — — —
5 - Not Supported — — —
6 - Event Reason CWE Required Meaningful only for S15 and S26 events – reason for cancel or no show.
7 - Appointment CWE Optional Format: ID^Text^^<Alternate ID>
Reason
ID^Text^<ID Type>^<Alternate ID>
8 - Not Supported — — —
9 - Appointment NM Optional Appointment length
Duration
10 - Appointment CNE Optional Appointment length units
Duration Units
Format: "S" or "MIN"
11 - Appointment TQ Required Appointment date and appointment time
Timing Quantity
Format: ^^^CCYYMMDDHHMM

12 - Placer Contact XCN Optional Data entry person

Person
Format: ID^Name

13 - Placer Contact XTN Optional Format: (xxx)xxx-xxxx or xxx-xxxx

Phone Number
Or
#<text>
14 - Placer Contact XAD Optional • Address
Address
• City
• State
• ZIP Code
15 - Not Supported — — —
 Element Name Type Usage Notes
16 - Placer Contact XCN Optional Data entry person
Person
Format: ID^Name

17 - Not Supported — — —
18 - Not Supported — — —
19 - Not Supported — — —
20 - Placer Contact XCN Optional Data entry person
Person
Format: ID^Name

21 - Not Supported — — —
22 - Not Supported — — —
23 - Not Supported — — —
24 - Not Supported — — —
25 - Filler Status Code CWE Optional Appointment status. Mapped using a translation table.
Format: <ID>^<Text>

26 - Placer Order — Optional Orders scheduled to the current appointment. May repeat if multiple
Number orders are linked to the appointment.
Format: <Order A ID#1>~<Order B ID#1>...

27 - Filler Order — Optional Orders scheduled to the current appointment. May repeat if multiple
Number orders are linked to the appointment.
Format: <Order A ID#2>~<Order B ID#2>...

PID - Patient Identification

Element Name Type Usage Notes
1 - Set ID SI Optional —
2 - Patient ID CK Optional —
(external)
3 - Patient ID CK Required —
(internal)
4 - Alternate Patient ST Optional —
ID
5 - Patient Name XPN Required All HL7 separators will be translated to their corresponding escape
sequences.
6 - Mother's Maiden XPN Optional —
Name
7 - Date/Time of Birth DTM Optional Date of birth is always sent in this field. Time of birth is sent when
available.
8 - Sex IS Optional This field is mapped using a translation table.
9 - Patient Alias XPN Optional —
10 - Race CWE Optional The field is mapped using an associated translation table.
11 - Patient Address XAD Optional • Street
• City
Element Name Type Usage Notes
• State
• ZIP/Postal code
• Country
• County
Escape characters can be translated.
Format: Standard HL7 address format
Note: Country and county can be mapped using a translation table.
Example:
<Street 1>^<Street 2>^<City>^<State>^<ZIP
code>^<Country>^<Address Type>^^<County>^^^^<Start
Date>^<End Date>

12 - County Code IS Optional This field is mapped using a translation table.

13 - Phone Number – XTN Optional Format: Standard HL7 phone number format. If configured, the number
Home will be sent across several subfields.
Example: 01(848)271-9000or01(848)271-9000^^^^01^848^271-9000
Or
#<text>

14 - Phone Number – XTN Optional Format: Standard HL7 phone number format. If configured, the number
Work will be sent across several subfields.
Example: 01(848)271-9000or01(848)271-9000^^^^01^848^271-9000
Or
#<text>

15 - Language – CWE Optional —

Patient
16 - Marital Status IS Optional —
17 - Religion CWE Optional This field is mapped using a translation table.
18 - Patient Account CX Optional —
Number
19 - SSN – Patient ST Optional nnn-nn-nnnn or nnnnnnnnn, format checking is configurable.
20 - Driver's License DLN Optional <Driver's license number>^<Driver's license state>
Num. – Patient Example: G6515665260505^WI

21 - Mother's CX Optional —
Identifier
22 - Ethnic Group IS Optional This field is mapped according to a translation table.
23 - Birth Place ST Optional Birth city and state
Format: Standard HL7 address format
24 - Multiple Birth ID Optional —
Indicator
 Element Name Type Usage Notes
25 - Birth Order NM Optional Format: Numeric
26 - Citizenship CWE Optional This field is mapped using a translation table.
27 - Veterans Military CWE Optional This field is mapped using a translation table.
Status
28 - Country of CWE Optional This field is mapped using a translation table.
Origin
29 - Patient Death DTM Optional Format: Standard HL7 timestamp
Date and Time
• Death date
• Death time
30 - Patient Death ID Optional Values:
Indicator
• Y – The patient is deceased
• N or blank – The patient is not deceased
31 - Identity ID Optional —
Unknown Indicator
32 - Identity IS Optional —
Reliability Code

RGS - Resource Group

Segment-Level Summary

Element Name Type Usage Notes

1 - Set ID SI Required —
2 - Not Supported — — —
3 - Resource Group CWE Optional Format: <ID>^<Description>
ID

AIG - Appointment Information – General Resource

Element Name Type Usage Notes
1 - Set ID SI Required Incremented for each AIG sent
2 - Not Supported — — —
3 - Resource ID CWE Optional Appointment staff/resource.
Format: <ID>^<Name>^<Coding System>

4 - Resource Type CWE Required Type of resource

Format: <Code>^<Title>

5 - Resource Group CWE Optional —

6 - Not Supported — — —
7 - Not Supported — — —
8 - Start Date/Time DTM Optional Appointment date and appointment time
Format: CCYYMMDDHHMM
9 - Start Date/Time NM Optional Offset to the appointment start time
Offset
 Element Name Type Usage Notes
10 - Start Date Time CNE Optional Configurable. Default is seconds.
Offset Units
Format: "S" or "MIN"
11 - Duration NM Optional Format: Numeric
12 - Duration Units CNE Optional Configurable. Default is seconds.
Format: "S" or "MIN"

AIP - Appointment Information – Personnel Resource

Element Name Type Usage Notes
1 - Set ID SI Required This field is incremented for each AIP sent.
2 - Not Supported — — —
3 - Resource ID XCN Optional Appointment staff/resource
All HL7 separators will be translated to their corresponding escape
sequences.
4 - Resource Role CWE Required Format: <Code>^<Title>

5 - Resource Group CWE Optional —

6 - Start Date/Time DTM Optional Appointment date and appointment time
Format: CCYYMMDDHHMM

7 - Start Date/Time NM Optional Offset to the appointment start time

Offset
Format: Numeric
8 - Start Date/Time CNE Optional Offset units
Offset Units
Format: "S" or "MIN"
9 - Duration NM Optional Appointment length
10 - Duration Units CNE Optional Duration units
Format: "S" or "MIN"
  2021 Epic Systems Corporation. All rights reserved. PROPRIETARY INFORMATION - This item and its contents may not
©
be accessed, used, modified, reproduced, performed, displayed, distributed or disclosed unless and only to the extent
expressly authorized by an agreement with Epic. This item is a Commercial Item, as that term is defined at 48 C.F.R. Sec.
2.101. It contains trade secrets and commercial information that are confidential, privileged and exempt from disclosure
under the Freedom of Information Act and prohibited from disclosure under the Trade Secrets Act. After Visit Summary,
Analyst, App Orchard, ASAP, Beacon, Beaker, BedTime, Bones, Break-the-Glass, Caboodle, Cadence, Canto, Care
Everywhere, Charge Router, Chronicles, Clarity, Cogito ergo sum, Cohort, Colleague, Community Connect, Cupid, Epic,
EpicCare, EpicCare Link, Epicenter, Epic Earth, EpicLink, EpicWeb, Garden Plot, Good Better Best, Grand Central, Haiku,
Happy Together, Healthy Planet, Hyperspace, Kaleidoscope, Kit, Limerick, Lucy, Lumens, MyChart, OpTime, OutReach,
Patients Like Mine, Phoenix, Powered by Epic, Prelude, Radar, Radiant, Resolute, Revenue Guardian, Rover, Share
Everywhere, SmartForms, Sonnet, Stork, System Pulse, Tapestry, Trove, Welcome, Willow, Wisdom, and With the Patient at
Heart are registered trademarks, trademarks, or service marks of Epic Systems Corporation in the United States of America
and/or other countries. Other company, product, and service names referenced herein may be trademarks or service marks
of their respective owners. Patents Notice: www.epic.com/patents.