Incoming Appointment Scheduling Interface …...Incoming Appointment Scheduling Interface Technical...

Incoming Appointment

Scheduling Interface Technical

Specification

Last Updated: May 6, 2019

Epic | 1979 Milky Way | Verona, WI 53593 | Voice: 608.271.9000 | Fax: 608.271.7237 | www.epic.com | [email protected]

© 2019 Epic Systems Corporation. Contains information that is confidential and/or subject to restrictions on use and disclosure.

Table of Contents

1 Message Specifications ............................................................................................................................. 4

1.1 SIU^S12 - Notification of New Appointment Booking and SRM^S01 - Request New Appointment Booking ...... 4

1.2 SIU^S13 - Notification of Appointment Rescheduling and SRM^S02 - Request Appointment Rescheduling ....... 4

1.3 SIU^S14 - Notification of Appointment Modification and SRM^S03 - Request Appointment Modification ......... 5

1.4 SIU^S15 - Notification of Appointment Cancellation and SRM^S04 - Request Appointment Cancellation ........... 5

1.5 SIU^S17 - Notification of Appointment Deletion and SRM^S06 - Request Appointment Deletion ......................... 5

1.6 SIU^S26 Notification that Patient Did Not Show Up for Scheduled Appointment ................................................... 5

1.7 Message Format for Event Types S12, S13, S14, S15, S17, and S26 ............................................................................... 5

1.8 Message Format for Event Types S01, S02, S03, S04, and S06 ....................................................................................... 7

2 Sample Messages ...................................................................................................................................... 9

2.1 S12 – New Appointment .................................................................................................................................................... 9

2.1.1 Format Example .................................................................................................................................................................................. 9

2.2 S01 – New Appointment .................................................................................................................................................... 9

2.2.1 Format Example .................................................................................................................................................................................. 9

2.3 S13 – Appointment Rescheduling ................................................................................................................................... 11

2.3.1 Format Example ................................................................................................................................................................................ 11

2.4 S02 – Appointment Rescheduling ................................................................................................................................... 11

2.4.1 Format Example ................................................................................................................................................................................ 11

2.5 S14 – Appointment Modification .................................................................................................................................... 12

2.5.1 Format Example ................................................................................................................................................................................ 12

2.6 S03 – Appointment Modification .................................................................................................................................... 13

2.6.1 Format Example ................................................................................................................................................................................ 13

2.7 S15 – Appointment Cancellation ..................................................................................................................................... 13

2.7.1 Format Example ................................................................................................................................................................................ 13

2.8 S04 – Appointment Cancellation ..................................................................................................................................... 14

2.8.1 Format Example ................................................................................................................................................................................ 14

2.9 S26 – Notification that Patient Did Not Show for Scheduled Appointment ............................................................. 15

2.9.1 Format Example ................................................................................................................................................................................ 15

3 Supported Segments and Fields ............................................................................................................ 16

3.1 MSH – Message Header ................................................................................................................................................... 16

3.2 MSA – Message Acknowledgment ................................................................................................................................. 17

3.3 SCH – Schedule Activity Information ............................................................................................................................ 18

3.4 ARQ – Appointment Request .......................................................................................................................................... 21

3.5 NTE – Notes and Comments Following SCH or ARQ ................................................................................................. 23

3.6 PID – Patient Identification .............................................................................................................................................. 24

3.7 PD1 – Patient Additional Demographics ....................................................................................................................... 30

3.8 ROL – Role ......................................................................................................................................................................... 32

3.9 PV1 – Patient Visit ............................................................................................................................................................. 33

3.10 PV2 – Patient Visit – Additional Information .............................................................................................................. 36

3.11 OBX – Observation .......................................................................................................................................................... 36

3.12 DG1 – Diagnosis .............................................................................................................................................................. 38

3.13 RGS – Resource Group ................................................................................................................................................... 39

3.14 AIS – Appointment Information – Service ................................................................................................................... 39

3.15 NTE – Notes and Comments Following AIS ............................................................................................................... 40

3.16 AIG – Appointment Information – General Resource ................................................................................................ 41

3.17 NTE – Notes and Comments Following AIG .............................................................................................................. 42

3.18 AIP – Appointment Information – Personnel Resource ............................................................................................. 42

3.19 NTE – Notes and Comments Following AIP ............................................................................................................... 44

3.20 ZPD - Patient Identification - Additional Patient Information .................................................................................. 44

3.21 ZPL - Additional Appointment Information ............................................................................................................... 46

3.22 ZTP – Patient Communication Preference ................................................................................................................... 46

Incoming Appointment Scheduling Interface Technical Specification 4

1Message Specifications

The interface receives scheduling information from external systems unsolicited informational messages in either an SIU or SRM

format.

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.

1.1 SIU^S12 - Notification of New Appointment Booking and SRM^S01 -

Request New Appointment Booking Epic receives a message when a new appointment is booked in an external system. In addition to standard visit data, a visit number,

which was assigned by the external system, is sent to allow the Epic interface to uniquely identify the appointment. At this point a

new contact is created for that patient. A valid visit type is required for new appointments.

1.2 SIU^S13 - Notification of Appointment Rescheduling and SRM^S02 -

Request Appointment Rescheduling Epic receives a message when an appointment is rescheduled in an external system. The new start date and time, the appointment

duration, and other information are provided. Rescheduling an appointment involves changing the status of the old appointment to

Canceled and creating a new appointment.


1.3 SIU^S14 - Notification of Appointment Modification and SRM^S03 -

Request Appointment Modification Epic receives a message when modifications are made to appointment status or appointment notes in an external system. The change

is made to the original appointment contact. If the appointment to update is not found, the interface can be set up to book a new

appointment based on the information in the message. The PID, PD1, PV1, and PV2 information can be updated based on the

customer's Epic configuration settings.

1.4 SIU^S15 - Notification of Appointment Cancellation and SRM^S04 -

Request Appointment Cancellation Epic receives a message when an appointment is canceled in an external system. The status of the appointment changes to Canceled.

1.5 SIU^S17 - Notification of Appointment Deletion and SRM^S06 - Request

Appointment Deletion Epic receives a message when an appointment is deleted in an external system. The status of the appointment changes to Canceled.

1.6 SIU^S26 Notification that Patient Did Not Show Up for Scheduled

Appointment Epic receives a message when a scheduled patient does not check in or leaves without being seen for an appointment. The

appointment contact is given a status of No Show.

1.7 Message Format for Event Types S12, S13, S14, S15, S17, and S26

SIU General Schedule Request Message Chapter

MSH Message Header 2


SIU General Schedule Request Message Chapter

SCH Schedule Activity Information 10

[ { NTE } ] Notes and Comments 2

PID Patient Identification 3

[ PD1 ] Patient Additional Demographics 3

[ ROL ] Role 15

[ PV1 ] Patient Visit Information 3

[ PV2 ] Patient Visit – Additional Info 3

[ { OBX } ] Notes and Comments 7

[ { DG1 } ] Diagnosis 6

{ RGS 10

{ AIS Appointment Info. - Service 10


}

[ { AIG Appt. Info. - General Resource 10


}]

[ { AIP Appointment Info. - Personnel 10


}]}


1.8 Message Format for Event Types S01, S02, S03, S04, and S06

SRM General Schedule Request Message Chapter


ARQ Schedule Activity Information 10


PID Patient Identification 3

[ PD1 ] Patient Additional Demographics 3

[ ROL ] Role 15

[ PV1 ] Patient Visit Information 3

[ { OBX } ] Notes and Comments 7

[ { DG1 } ] Diagnosis 6

{ RGS 10

{ AIS Appointment Info. - Service 10


}

[ { AIG Appt. Info. - General Resource 10


}]

[ { AIP Appointment Info. - Personnel 10


}]}


SRR General Schedule Request Message Chapter


MSA Message Acknowledgment 2

[ERR] Error Information 2

Epic's scheduling system requires a provider and a department in order to schedule a visit for a patient. Therefore, Epic currently

requires an RGS segment (which contains the department), and either one AIP segment or one AIG segment, but not both (because

the scheduled provider comes from either the AIP segment if the provider is a person, or the AIG segment if the provider is a

resource).


2Sample Messages

2.1 S12 – New Appointment

2.1.1 Format Example MSH|^~\&|SENDING APP|SENDING FAC|RECEIVING|RECEIVING FAC|1997052711090000||SIU^S12|1055|P|2.3||

SCH|1|36996|||||||30|MIN|^^^199705271115||||||||||||||1^SCH

NTE|1||This is a Display Note.

PID|||556301^^^^MRN1||WILLIAMS^JACK^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||271-

9000||||||333-44-4433|||||||||||N

RGS|1||1ÎNTERNAL MEDICINE

AIS|1||001ÔFFICE VISIT

NTE|1||These are patient instructions for visit type 001

NTE|2||Fast 24 hours before the appointment

AIG|1||399^RESOURCEÔNE^^^^|||||199705271130|15|MIN|15|MIN

NTE|1||Resource Specific Notes

AIP|1||400^FREDRICKS^TINA^^^^|||199705271115|0|MIN|15|MIN

NTE|1||Appointment notes pertaining to a provider

2.2 S01 – New Appointment

2.2.1 Format Example MSH|^~\&|SENDING APP|SENDING FAC|EPIC|EPIC|2005080710350000||SRM^S01|1919|P|2.3||

ARQ|1|119953350||||1^SCH|||60|MIN|200510141500||||||||593^RUCHALA^JOANNA^^^^|(60

8)238-5653|||

NTE|1||The patient has a stomach ache.


NTE|2||The patient watches 12 hours of TV a day.

PID|||556345||SMITH^GEORGE^^^^|PALOMA^BONNY^J.^^^|19720124|M|BOWMAN^JEFFREY^^^

^~PALOMA^PICASSO^^^^|B|1255 MAIN St^ROOM 12^Whitefish Bay^WI^53217^^^|MILWAUKEE|

962-3222|258-9515|ENGLISH|M|METHODIST||323-44-4456|R240-4272-3576-09|||^Ôrlando

^FL|||||||N

OBX|1|TX|||The patient gets 6 hours of sleep a night.

OBX|2|TX|||The patient takes aspirin for a heart problem.

DG1|1||002.0^TYPHOID FEVERÎ9



NTE|1||The patient should drink 8 glasses of water a day.

NTE|2||The patient should get 20 mins of exercise 3 times a week.

AIG|1||39^White^ROOM^^^|||||200510141500|0|MIN|15|MIN

NTE|1||ROOM White is a room with an MRI scan machine.

NTE|2||It can be used in half hour intervals.

AIG|2||41^ROOMÊLMO^^^|||||200510141515|0|MIN|15|MIN

NTE|1||The Elmo room is for kids.

NTE|2||The Elmo room is soft and fuzzy.

AIP|1||38^BARKER^BILL^^^|||200510141515|0|MIN|15|MIN

NTE|1||Dr. Barker speaks Latin and Greek.

NTE|2||Dr. Barker has been a doctor for 15 years

RGS|2||5^RADIOLOGY


AIG|1||43^XRAY^SEVEN^^^|||||200510141530|0|MIN|30|MIN

NTE|1||XRAY SEVEN cannot be booked for patients weighing over 200 pounds.

AIP|1||42^CRICKET,JOANNA^^^|||200510141545|0|MIN|15|MIN

NTE|1||Dr. Cricket has latex allergy.


2.3 S13 – Appointment Rescheduling


SCH|1|36996|||||||30|MIN|^^^199705271300||||||||||||||9^RESCH

NTE|1||This is a Display Note

PID|||556301^^MRN1||WILLIAMS^JACK^^^^||19720324|M|||123 MAIN ST^^PRIOR LAKE^MN^22334^||271-

9000||||||333-44-4433|||||||||||N

OBX|1|TX|PERM^PERMANENT PATIENT COMMENTS||THESE ARE PERMANENT COMMENTS

DG1|1||002.0^TYPHOID FEVER^I9



NTE|1||These are 001 patient instructions.

NTE|2||Fast 24 hours before appointment.





2.4 S02 – Appointment Rescheduling

2.4.1 Format Example MSH|^~\&|SENDING APP|SENDING FAC|CADD|RECEIVING FAC|2005072113110000||SRM^S02|1898|P|2.3||

ARQ|1|38950||||1^SCH|||30|MIN|200507211330||||589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY

BLVD^ALTERNATE ADDR^MADISON^^53719^||589^LEE^STEVEN^^^^

NTE|1||SRM TEST RESCH


PID|||556345||SMITH^GEORGE^^^^||19720124|M|||123 MAIN ST, ROOM 12^^PRIOR LAKE^MN^22334^||271-

9001|271-9000|||||333-44-4456||||

OBX|1|TX|||THESE ARE PERMANENT COMMENTS


AIS|1|001ÔFFICE VISIT

NTE|1||These are patient instructions

AIG|1||399^ROOMÔNE^^^^|||||200507211345|15|MIN|15|MIN

NTE|1||Resource

AIP|1||400^BROOM^TINA^^^^|||200507211330|0|MIN|15|MIN

2.5 S14 – Appointment Modification


SCH|1|37005|||||||30|MIN|^^^199705271300||||||||||||||6ÂRRIVED



9000||||||333-44-4433|||||||||||N





NTE|2||Fast 24 hours before appointment






2.6 S03 – Appointment Modification


ARQ|1|38954||||6ÂRRIVED|||30|MIN|200507211330||||589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY


NTE|1||SRM TEST RESCH


9001|271-9000|||||333-44-4456||||





AIG|1||399^ROOMÔNE^^^^|||||200507211345|15|MIN|15|MIN

NTE|1||Resource


RGS|2||10ÔPTHAMOLOGY


AIG|1|402^RESOURCE^TWO^^^^|||||200507211345|0|MIN|15|MIN

AIP|1||405^RUCHALA^JOANNA^^^^|||200597211330|0|MIN|15|MIN

2.7 S15 – Appointment Cancellation


SCH|1|37006|||||||30|MIN|^^^199705271400||||||||||||||3^CAN




9000||||||333-44-4433|||||||||||N

OBX|1|TX|PERM^PERMANENT PATIENT COMMENTS (PROFILE)||THESE

ARE PERMANENT COMMENTS









2.8 S04 – Appointment Cancellation


ARQ|1|38959||||1^PT|||15|MIN|200507211400||||589^LEE^STEVEN^^^^|(608)271-9000|5301 TOKAY


NTE|1||test appointment


9001|271-9000|||||333-44-4456||||







2.9 S26 – Notification that Patient Did Not Show for Scheduled Appointment


SCH|1|37006|||||||30|MIN|^^^199706111000||||||||||||||4^NO SHOW



9000||||||333-44-4433|||||||||||N









NTE|1|| Appointment notes pertaining to a provider


3Supported Segments and Fields

Shaded fields in the table are not used by this interface.

3.1 MSH – Message Header

Element Name Type Usage Notes

1-Field Separator ST R Value is typically: |

2-Encoding Characters ST R Value is typically: ^~\&

3-Sending Application HD O Free text

4-Sending Facility HD O Free text, configurable

5-Receiving Application HD O Free text

6-Receiving Facility HD O Free text

7-Date/Time of Message DTM O

8-Security ST O

9-Message Type CM R Format: <Message type>^<Trigger event>

10-Message Control ID ST R Value returned in Acknowledgment message (MSA).

11-Processing ID PT R Values:

D – Debugging

P – Production

T – Training

12-Version ID ID R HL7 version number, e.g., 2.3

13-Sequence Number NM O Optional field used in sequence number protocol; Epic's default is not



to use sequence number protocol.

14-Continuation Pointer ST O In conjunction with the HL7 DSC segment, this field is used to define

continuations of messages. It allows large messages to be broken into

multiple smaller messages, which is necessary under certain

implementation limitations.

Consult HL7 chapter 2 and your Epic EDI representative for more

information.

15-Accept Acknowledgment Type ID O This field identifies the conditions under which Accept

Acknowledgments are required to be returned in response to this

message. Required for enhanced acknowledgment mode. If null,

acknowledgments are sent in original acknowledgment mode.

Values:

AL – Always

ER – Error/reject conditions only

NE – Never

SU – Successful completion only

16-Application Acknowledgment type ID O

17-Country Code ID O

18-Character Set ID O

19-Principal Language of Message CWE O

3.2 MSA – Message Acknowledgment




1-Acknowledgment Code ID R Indicates successful/not successful processing of message

Original Mode Values:

AA – Application Accept

AE – Application Error

AR – Application Reject

Enhanced Mode Values:

CA – Commit Accept

CE – Commit Error

CR – Commit Reject

2-Message Control ID ST R

3-Text Message ST O Optional field that can contain an error message

4-Expected Sequence Number NM O Optional field used in sequence number protocol; Epic's default is not

to use sequence number protocol.

5-Delayed Acknowledgment Type ID O

6-Error Condition CWE O

3.3 SCH – Schedule Activity Information


1-Placer Appointment ID EI O Visit number assigned by the scheduling system for each new

appointment.

Note: For rescheduled appointments send the visit number of the

original appointment



2-Filler Appointment ID O Visit number assigned by the receiving system for each new

appointment.

Note: For rescheduled appointments send the visit number of the

original appointment

3-Occurrence Number NM O

4-Placer Group Number O This data type becomes EIP in HL7 versions 2.8 and above.

5-Schedule ID CWE O

6-Event Reason CWE O For an S15 event, send the reason for cancellation. This field may be

required if the customer's Epic configuration settings indicate. Mapped

using a translation table

Format: <ID>^<Text>

7-Appointment Reason CWE O The customer's Epic configuration settings determine whether this

field or field AIS-3 is used to specify the visit type.

<ID>^<Text>^<ID Type>

8-Appointment Type CWE O

9-Appointment Duration NM R Appointment length

Note: This field is required.

10-Appointment Duration Units CNE O Appointment length units. If a value is not received in this field, then

the value from a profile variable will be used.

Format: "S" or "MIN"

11-Appointment Timing Quantity TQ R Appointment date and appointment time. If an appointment start time

is not in an increment of 5 minutes, it will be rounded up or down

depending on the value of the customer's Epic configuration settings.

Format: ^^^CCYYMMDDHHMM



12-Placer Contact Person XCN O

13-Placer Contact Phone Number XTN O

14-Placer Contact Address XAD O

15-Placer Contact Location PL O

16-Filler Contact Person XCN O

17-Filler Contact Phone Number XTN O

18-Filler Contact Address XAD O

19-Filler Contact Location PL O

20-Entered By Person XCN R Format: <ID>

Note: If a value is not received a default is used for audit purposes.

21-Entered By Phone Number XTN O

22-Entered By Location PL O

23-Parent Placer Appointment ID EI O

24-Parent Filler Appointment ID EI O

25-Filler Status Code CWE O Appointment status

Format: <ID>^<Text>

The value received in this field will be translated using a translation

table. If an appointment status is not received in this field or if an

invalid status is received, then the interface will do the following:

For S12 and S13 events, the status of the appointment will be

Scheduled.

For S14 events, the status will not be updated.



For S15 events, the status will be Canceled.

For S26 events, the interface the status will be No Show.

For S26 events, the interface will only accept appointment statuses of

No Show and Left Without Being Seen.

26-Placer Order Number O Epic order number

27-Filler Order Number O The ID of an order in an external system.

Format: <External Order ID>^<Application ID (optional)>

3.4 ARQ – Appointment Request This required segment defines a request for the booking of an appointment.


1-Placer Appointment ID EI O Visit number assigned by the scheduling system for each new

appointment.

Note: For rescheduled appointments, the visit number of the original

appointment will be sent.

2-Filler Appointment ID EI O Visit number assigned by receiving system for each new appointment.

Note: For rescheduled appointments, the visit number of the original

appointment is expected if using S02 events.

Format: ID

3-Occurrence Number NM O

4-Placer Group Number EI O

5-Schedule ID CWE O



6-Request Event Reason CWE O For S04 events, send the reason for cancellation. For all other events,

send the appointment status.

Format: <ID>^<Text>

Note: If an appointment status is not received in this field or if an

invalid status is received, then the interface will do the following:

For S01 and S02 events, the status of the appointment will be

Scheduled.

For S03 events, the status will not be updated.

For S04 events, the status will be Canceled.

For S04 events, you are required to send the reason for cancellation in

this field.

7-Appointment Reason CWE O The customer's Epic configuration settings determine whether this

field or field AIS-3 is used to specify the visit type.


8-Appointment Type CWE O

9-Appointment Duration NM R Appointment length

10-Appointment Duration Units CNE O Appointment length unit If a value is not received in this field, then the

default unit used is "S."

Format: "S" or "MIN"

11-Requested Start Date/Time Range DR R Appointment date and appointment time

Format: CCYYMMDDHHMM

If an appointment start time is not an increment of 5 minutes, it will be

rounded up or down depending on the customer's Epic configuration

settings.

12-Priority ST O



13-Repeating Interval RI O

14-Interval Duration ST O

15-Placer Contact Person XCN O

16-Placer Contact Phone Number XTN O

17-Placer Contact Address XAD O

18-Placer Contact Location PL O

19-Entered By Person XCN O Format: <ID>

20-Entered By Phone Number XTN O

21-Entered By Location PL O

22-Parent Placer Appointment ID EI O

23-Parent Filer Appointment ID EI O

24-Placer Order Number O Epic order number.

This field may repeat.

25-Filler Order Number O Format: <External Order ID>^<Application ID (optional)>

This field may repeat.

3.5 NTE – Notes and Comments Following SCH or ARQ This optional segment is used to send across scheduling instructions. Multiple lines are to be sent across as multiple NTE segments.


1-Set ID – Notes and Comments SI O Incremented for each NTE sent

Format: Numeric



2-Source of Comment ID O

3-Comment FT O Appointment display notes.

Format: Text

4-Comment Type CWE O

3.6 PID – Patient Identification


1-Set ID – PID SI O

2-Patient ID CX O This field is for backward compatibility only.

3-Patient Identifier List CX R Format: <ID>^^^<HL7 Assigning Authority>^<HL7 Coding System / HL7 ID Type>~<ID2>^^^<HL7 Assigning

Authority>^<HL7 Coding System / HL7 ID Type>

A patient's Social Security number and driver's license number are

filed as received in PID-19 and PID-20.

4-Alternate Patient ID – PID CX O This field is for backward compatibility only.

5-Patient Name XPN R Format: <Last Name>^<First Name>^<Middle Name>^<Suffix>^<Prefix>^<Academic degree>^<Name

Type>^^^^^^^<Title>

6-Mother's Maiden Name XPN O Escape characters can be translated.

7-Date/Time of Birth DTM O Only date of birth is supported for patient validation.

8-Sex IS O Patient sex. Must receive exactly "" to delete previous values. Only the

first component is filed.

Format: <Sex>^^^^^^^^



9-Patient Alias XPN O Aliases may repeat. Escape characters can be translated. The aliases

received in the message can either append to overwrite the patient's

current alias list. If the seventh component (name type code) of the

field is M, the value in the first component will be treated as patient

maiden name. The example format to receive patient maiden name:

<Patient maiden name>^^^^^^M~

10-Race CWE O Patient race. Only the first component of the field is filed. This field

must contain exactly "" to delete stored data.

Format: <race>^^^^^^^^~<race>^^^^^^^^

11-Patient Address XAD O Permanent Address

Street

Dwelling Number

City

State

ZIP/Postal code

Country

County

District

Start Date

Confidential Address

Street

Dwelling Number

City



State

ZIP/Postal code

County

Country

District

Start Date

End Date

Temporary Address

Street

Dwelling Number

City

State

ZIP/Postal code

County

Country

District

Start Date

End Date

Format:

Escape characters can be translated

This field can repeat, with permanent, confidential, and temporary

addresses sent in separate repetitions. The different addresses are



denoted by a flag in the <Address Type> piece of the field (piece 7)

State, county, and country category values can be mapped using a

translation table.

ZIP/postal code is required to be in the U.S. or Canadian format unless

the interface is configured to receive international formats.

Format:

<Street 1>^<Street 2>^<City>^<State>^<ZIP

code>^<Country>^<Address

Type>^^<County>^<District>^^^<Start Date>^<End Date>

Or

&<Street 1>&House Number>^<Street

2>^<City>^<State>^<ZIP code>^<Country>^<Address

Type>^^<County>^<District>^^^<Start Date>^<End Date>

12-County Code IS O This field is for backward compatibility only. You should use the

county component of the patient address in PID-11 instead.

13-Phone Number – Home XTN O Phone

E-mail address

Multiple e-mail addresses

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>

14-Phone Number – Work XTN O (nnn)nnn-nnnnx<extension>

or

^^^^^<City/area code>^<Number>^<Extension>



or

#<text>

15-Primary Language CWE O The value received in the field can either be stored as the patient

language, spoken language, or both.

To delete information, this field must contain exactly "".

Format: <code>^^^^^^^^~

16-Marital Status CWE O Patient marital status. Only the first component is used. This field must

contain exactly "" to delete stored data.

Format: <code>^^^^^^^^

17-Religion CWE O Patient religion. Only the first component is used. This field must


Format: <religion>^^^^^^^^

18-Patient Account Number CX O Format: Alpha-numeric, or if using this field for visit number storage

and using Identity, <value>^^^^<ID Type>

19-SSN Number – Patient ST O Format depends on the country.

Format checking options are configurable.

Social security number can also be received in PID-3.

20-Driver's License Number – Patient DLN O Format: <Driver's license number>^<Driver's license state>

Note: State can optionally be mapped using a translation table.

Driver's license number can also be received in PID-3.

Example: G6515665260505^WI

21-Mother's Identifier CX O This field is used to link a newborn to his or her mother. It should

contain the MRN or a visit identifier for the mother of the patient in the

PID segment of the message.



22-Ethnic Group CWE O Patient ethnic group. Only the first component is used. This field must


Format: <ethnic group>^^^^^^^^~

23-Birth Place XAD O Birth city and state

HL7 address format is used rather than the string format defined in the

standard. State can be mapped using a translation table

24-Multiple Birth Indicator ID O This field can be set to "Y" or "N" to denote whether the patient was

born as part of a multiple birth (twins, triplets, etc.).

25-Birth Order NM O

26-Citizenship CWE O This field can be mapped using a translation table.

27-Veterans Military Status CWE O This field can be mapped using a translation table.

28-Nationality CWE O This field can be mapped using a translation table.

29-Patient Death Date and Time DTM O Receiving "" will delete the date and time of death.

This field can also optionally set the member term date to the date of

death for any current or future coverages associated with this patient.

30-Patient Death Indicator ID O Y – The patient is deceased

N – The patient is not deceased

Marking a patient deceased can be configured to cancel future

appointments.

31-Identity Unknown Indicator ID O This field can be mapped using a translation table

32-Identity Reliability Code CWE O Indicates whether a national ID received in PID-3 or PID-19 should be

considered verified.

33-Last Update Date/Time DTM O



34-Last Update Facility HD O

35-Species Code CWE O

36-Breed Code CWE O

37-Strain ST O

38-Production Class Code CWE O

3.7 PD1 – Patient Additional Demographics


1-Living Dependency IS O

2-Living Arrangement IS O

3-Primary Facility XON O The value received here is stored as the patient's primary location. It

must correspond to a facility, service area, or location record in the

facility database.

Preferred format:

^^^^^^<AUTH>^<IDTYPE>^^<ID>

Other accepted formats:

^^<ID>^^^^<AUTH>^<IDTYPE>^^

<NAME>^^^^^^^^^

4-Primary Care Provider XCN O Format: Preferred<ID>^^^^^^^^<Assigning authority>^^^^<ID type>or<Provider ID>^<Last

name>^<First name>^<Middle initial>

Note: This field can be configured to be ignored – PV1-7 would be

used instead.



Information about other types of primary care providers can be sent in

the ROL segment.

5-Student Indicator IS O

6-Handicap IS O

7-Living Will IS O

8-Organ Donor IS O

9-Separate Bill ID O

10-Duplicate Patient CX O

11-Publicity Code CWE O

12-Protection Indicator ID O

13-Protection Indicator Effective Date DT O

14-Place of Worship XON O <Place of Worship name>^^<Place of Worship ID>

15-Advance Directive Code CWE O The value received here will populate the patient advance directive

status. The default format is to receive a Y for a patient with advance

directive information or an N for a patient without advance directive

information. This field can optionally be translated using a translation

table.

16-Immunization Registry Status IS O

17-Immunization Registry Status

Effective Date

DT O

18-Publicity Code Effective Date DT O

19-Military Branch CWE O This filed is mapped via a translation table.

Format: <ID>^<Description>^Coding System



20-Military Rank CWE O This filed is mapped via a translation table.


21-Military Component CWE O This filed is mapped via a translation table.


22-Advance Directive Date DT O This date will be used to populate the advance directive reviewed date

and pairs with PD1-15. If this field is omitted, the interface uses EVN-6,

then MSH-7, and finally the current date, until a valid date is found.

3.8 ROL – Role This segment contains information regarding the associations of those involved in providing healthcare to the patient. The ROL

segment can repeat. Each ROL segment can contain Primary Care Provider information.


2-Role Action Code CWE O This field is only used when filing primary care provider information.

3-Role CWE O This field is mapped using one of two translation tables.

4-Role Person XCN O Format: <ID>^^^^^^^^<Assigning authority>^^^^<ID type>

(preferred)

or: <ID>

5-Role Begin Date/Time DTM O Begin date and time.

6-Role End Date/Time DTM O End date and time.

7-Role Duration CWE O

8-Role Action Reason CWE O Reason for Change

This field is mapped using a translation table.

This field is supported only when filing primary care provider



information from a ROL segment.

3.9 PV1 – Patient Visit


1-Set ID – Patient Visit SI O

2-Patient Class IS R

3-Assigned Patient Location O <Department>^<Room>^<Bed>^<Facility>^^^<Building>^<F

loor>

4-Admission Type IS O

5-Pre-admit Number CX O

6-Prior Patient Location PL O

7-Attending Doctor XCN O Preferred Format: <ID>^^^^^^^^<Assigning authority>^^^^<ID type>

Or: <Provider ID>^<Name>

8-Referring Doctor XCN O Preferred Format: <ID>^^^^^^^^<Assigning authority>^^^^<ID type>

Or <Provider ID>^<Name>

9-Consulting Doctor XCN O

10-Hospital Service IS O

11-Temporary Location PL O

12-Pre-admit Test Indicator IS O

13-Re-admission Indicator IS O



14-Admit Source IS O

15-Ambulatory Status IS O

16-VIP Indicator IS O

17-Admitting Doctor XCN O <ID>^^^^^^^^<Assigning authority>^^^^<ID type>

Or<Provider ID>^<Name>

18-Patient Type IS O Mapped using a translation table.

19-Visit Number CX O External visit number

20-Financial Class FC O Mapped using a translation table.

21-Charge Price Indicator IS O

22-Courtesy Code IS O

23-Credit Rating IS O

24-Contract Code IS O

25-Contract Effective Date DT O

26-Contract Amount NM O

27-Contract Period NM O

28-Interest Code IS O

29-Transfer to Bad Debt Code IS O

30-Transfer to Bad Debt Date DT O

31-Bad Debt Agency Code IS O

32-Bad Debt Transfer Amount NM O

33-Bad Debt Recovery Amount NM O



34-Delete Account Indicator IS O

35-Delete Account Date DT O

36-Discharge Disposition IS O Item is specified in the customer's Epic configuration settings.

Mapped using a translation table.

37-Discharged to Location CM O

38-Diet Type IS O

39-Servicing Facility IS O

40-Bed Status IS O

41-Account Status IS O

42-Pending Location PL O

43-Prior Temporary Location O

44-Admit Date/Time DTM O Available starting in Epic 2018 and in Epic 2017 with SU E8322677

Format: YYYYMMDDhhmmss

45-Discharge Date/Time DTM O Available starting in Epic 2018 and in Epic 2017 with SU E8322677

Format: YYYYMMDDhhmmss

46-Current Patient Balance NM O

47-Total Charges NM O

48-Total Adjustments NM O

49-Total Payments NM O

50-Alternate Visit ID CX O Format: String


3.10 PV2 – Patient Visit – Additional Information


1-Prior Pending Location PL O

2-Accommodation Code CWE O

3-Admit Reason CWE O

4-Transfer Reason CWE O

5-Patient Valuables ST O

6-Patient Valuables Location ST O

7-Visit User Code IS O

8-Expected Admit Date/Time DTM O The value received in this field will represent the date on which the

provider would expect to see the patient for a follow-up visit.

23-Clinic Source Location XON O This field is mapped with identity and stored as 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>

3.11 OBX – Observation This optional segment contains permanent patient comments or a patient image. Multiple comment lines are sent as multiple

segments; however, only a single patient image can be filed per message. The OBX is not required, but if it is present, OBX-2, 3, and 5

are required elements.


1-Set ID – Observation Segment SI O Incremented for each set of OBX segments sent



2-Value Type ID R Supported types are:

RP - Reference Pointer

TX - Text

3-Observation Identifier CWE R

4-Observation Sub-ID ST O

5-Observation Value CWE R Permanent patient comments or the file name of the patient image.

6-Units CWE O

7-References Range ST O

8-Abnormal Flags ID O

9-Probability NM O

10-Nature of Abnormal Test ID O

11-Observ Result Status ID O

12-Date Last Obs Normal Values DTM O

13-User Defined Access Checks ST O

14-Date/Time of the Observation DTM O

15-Producer's ID CWE O

16-Responsible Observer CN O

17-Observation Method CWE O


3.12 DG1 – Diagnosis Diagnosis and procedure information from the DG1 and PR1 segments will only be filed to encounter-level items; an Incoming

Financial Transactions interface must be used to file financial transactions into Resolute. The AR Interface Settings in EpicCare's

Clinical Administration determines how diagnoses and procedures are stored. DG1 and PR1 segments are available for use in events

other than DFT^P03.


1-Set ID – DG1 SI R

2-Diagnosis Coding Method ID R This field has been retained for backward compatibility only. The

diagnosis description code set shoudl normally be sent as a component

of DG1.3.

3-Diagnosis Code CWE O Format: <Diagnosis code>^<Description>^<Code set>

4-Diagnosis Description ST O This field has been retained for backward compatibility only. The

diagnosis description should normally be sent as a component of DG1-

3.

5-Diagnosis Date/Time DTM O

6-Diagnosis Type IS R

7-Major Diagnostic Category CWE O

8-Diagnostic Related Group CWE O

9-DRG Approval Indicator ID O

10-DRG Grouper Review Code IS O

11-Outlier Type CWE O

12-Outlier Days NM O

13-Outlier Cost CP O



14-Grouper Version and Type ST O

15-Diagnosis Priority ID O

16-Diagnosing Clinician XCN O

17-Diagnosis Classification IS O

18-Confidential Indicator ID O

19-Attestation Date/Time DTM O

21-Diagnosis Action Code ID O Available starting in August 2018

26-Diagnosis Present on Admission IS O

3.13 RGS – Resource Group This segment groups services and resources described in AIS, AIG, and AIP segments by department.


1-Set ID – RGS SI R

2-Segment Action Code ID O

3-Resource Group ID CWE R Format: <ID>^<Text>^<ID Type>

3.14 AIS – Appointment Information – Service This segment contains information about the Epic visit types that are scheduled for the appointment. Since an appointment can have

multiple visit types, the segment can repeat. However, only the first visit type received is linked to the appointment.


1-Set ID – AIS SI R Incremented for each AIS sent




3-Universal Service Identifier CWE R The visit type associated with the appointment.


The interface can pull the visit type from SCH-7 or ARQ-7 instead of

this field depending on configuration.

4-Start Date/Time DTM O

5-Start Date/Time Offset NM O

6-Start Date/Time Offset Units CNE O

7-Duration NM O

8-Duration Units CNE O

9-Allow Substitution Code IS O

10-Filler Status Code CWE O See field SCH-25 or ARQ-6.The interface will not file the value from

this field unless indicated to do so by configuration settings.

3.15 NTE – Notes and Comments Following AIS This optional segment is used to send across instructions specific to a visit type.




3-Comment FT O Special appointment notes pertaining to the visit type. Stored only

based on customer's Epic configuration settings.



3.16 AIG – Appointment Information – General Resource This segment contains information about the Epic resources used for the appointment. This includes actual resources such as

machines and rooms, and scheduled classes. This segment can repeat if an appointment requires the use of multiple resources.


1-Set ID – AIG SI R Incremented for each AIG sent


3-Resource ID CWE R Appointment staff/resource.

4-Resource Type CWE O Appointment staff/resource type.

5-Resource Group CWE O

6-Resource Quantity NM O

7-Resource Quantity Units CNE O

8-Start Date/Time DTM O Appointment date and appointment time


If a value is not received in this field, then the appointment time and

date received in the SCH or ARQ segment will be used.

If an appointment start time is not in an increment of 5 minutes, it will

be rounded up or down depending on the customer's configuration

settings.

9-Start Date/Time Offset NM O Offset to the appointment start time

Format: Numeric value either in minutes or seconds depending upon

the offset unit

10-Start Date Time Offset Units CNE O Format: "S" or "MIN"

If a value is not received in this field, then the value from a profile

variable will be used.



11-Duration NM O Format: Numeric value either in minutes or seconds depending upon

the duration unit

If a value is not received in this field, then the duration received in the

ARQ or SCH segment will be used for this value.

12-Duration Units CNE O Format: "S" or "MIN"

If a value is not received in this field, the value from a profile variable

will be used.


14-Filler Status Code CWE O

3.17 NTE – Notes and Comments Following AIG This optional segment is used to send across instructions specific to a resource. Multiple lines are to be sent across as multiple NTE

segments.




3-Comment FT O


3.18 AIP – Appointment Information – Personnel Resource This segment contains information about the Epic providers used for the appointment. This segment can repeat if an appointment

requires the use of multiple providers.




1-Set ID – AIP SI R Incremented for each AIP sent


3-Personnel Resource ID XCN R Appointment staff/resource.

Format: <ID>^^^^^^^^<Assigning authority>^^^^<ID type>

4-Resource Role CWE O

5-Resource Group CWE O

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


If a value is not received in this field, then the appointment time and

date received in the SCH or ARQ segment will be used.

If an appointment start time is not an increment of 5 minutes, it will be

rounded up or down depending on the value of the customer's Epic

configuration settings.

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

Format: Numeric value either in minutes or seconds depending upon

the offset unit.

8-Start Date/Time Offset Units CNE O Format: "S" or "MIN"

If a value is not received in this field, then the value configured in the

system will be used.

9-Duration NM O Format: Numeric value either in minutes or seconds depending upon

the duration unit

If a value is not received in this field, then the duration received in

ARQ-9 or SCH-9 will be used for this value.

10-Duration Units CNE O Format: "S" or "MIN"



If a value is not received in this field, then the value configured in the

system will be used.


12-Filler Status Code CWE O

3.19 NTE – Notes and Comments Following AIP This optional segment is used to send across instructions specific to a provider. Multiple lines are to be sent across as multiple NTE

segments.




3-Comment FT O Appointment notes pertaining to a provider.


3.20 ZPD - Patient Identification - Additional Patient Information


1-Patient Ancestry ST O This field is mapped using a translation table.

This field can repeat.

2-Preferred Communication Method ST O A patient's preferred communication method. This field can repeat.

Format: <code>

10-Pay Grade CWE O This field is mapped using a translation table.

Format: <ID>^<Description>^<Coding System>



11-Assigned Unit CWE O This field is mapped using a translation table.


12-Military Patient Category CWE O This field is mapped using a translation table.


13-Family Member Prefix CWE O This field is mapped using a translation table.


14-Scheduling Grouper ST O Format:

<String>

Or

<String>^<Description>

15-Race/Ethnicity ID Method ST O This field is mapped using a translation table.

16-Patient Texting Opt-In CWE O This field indicates whether a patient prefers to receive appointment

reminder texts.

Format: <code>

17-Patient/Client Death Place

18-Contact Interpreter Required

19-Nationality IS O This field applies to Finland only.

20-Gender Identity CWE O Must receive exactly "" to delete previous values. Only the first

component is filed.

Format: <Gender Identity>^^^^^^^^

22-Sex Assigned at Birth CWE O Must receive exactly "" to delete previous values. Only the first

component is filed.

Format: <Sex Assigned at Birth>^^^^^^^^


3.21 ZPL - Additional Appointment Information


2-Patient Arrival Location CWE Specifies the physical location a patient should arrive at for an

appointment.

Format: <ID>^^<ID type>

3-Hidden Appointment Flag O Available starting in Epic 2018

Available in Epic 2017 with SU E8306166

Indicates whether the appointment should be hidden from the patient.

Accepted values:

0 (No)

1 (Yes)

4-TBD Appointment Flag O Available starting in Epic 2018

Available in Epic 2017 with SU E8306166

Indicates whether the appointment's scheduled time will be

determined at a later time.

Accepted values:

0 (No)

1 (Yes)

3.22 ZTP – Patient Communication Preference Available starting in May 2019, February 2019 with SUs E8703185, E8703186, and E8703722, November 2018 with SUs E8607304,

E8607305, and E8607690, and August 2018 with SUs E8511589, E8511590, and E8511855.


This repeating segment contains information about how a patient prefers to be contacted by a healthcare organization. For example,

a patient might want to receive text messages and phone calls for appointment reminders and receive MyChart notifications as a

reminder to schedule a flu shot or yearly check-up.

Example:

ZTP|123^Appointment Reminders|Text^Y~Phone^Y~Email^N~MyChart^N

ZTP|456^Health Maintenance Reminder|Text^N~Phone^N~Email^N~MyChart^Y


1-Communication Preference Concept CWE O The type of communication such as health maintenance reminders or

lab results. This field can be mapped using a translation table.

Format: <concept ID><concept name>

2-Communication Preference Media ST O ZTP-2.1 should contain the media name (for example, phone). ZTP-2.2

should contain a value that represents either Yes or No to indicate

whether a media is approved. If a media is received and ZTP-2.2 is

blank, the interface files the media as approved.

If the deletion character ("") is received in ZTP 2.2, the communication

preference is updated to match the default settings for the

communication concept in Epic.

Example: Text^Y~Phone^Y~E-mail^N

© 2019 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, 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, Good Better Best, Grand Central, Haiku, Happy Together, Healthy Planet,

Hyperspace, Kaleidoscope, Kit, Limerick, Lucy, MyChart, OpTime, OutReach, Patients Like Mine, Phoenix, Powered by Epic, Prelude, Radar, Resolute, Revenue Guardian, Rover, Share Everywhere, SmartForms, Sonnet, Stork, 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. U.S. and international patents issued and pending.

Incoming Appointment Scheduling Interface …...Incoming Appointment Scheduling Interface Technical...

Documents

Transcript of Incoming Appointment Scheduling Interface …...Incoming Appointment Scheduling Interface Technical...