Previous Page TOC Index Next Page

10.5.2 SCH - schedule activity information segment

The SCH segment contains general information about the scheduled appointment.

Figure 10-4. SCH attributes

SEQ

LEN

DT

R/O/C

RP/#

TBL#

ITEM#

ELEMENT NAME

1

75

EI

R



00860

Placer Appointment ID

2

75

EI

C



00861

Filler Appointment ID

3

5

NM

C



00862

Occurrence Number

4

75

EI

O



00863

Placer Group Number

5

200

CE

O



00864

Schedule ID

6

200

CE

R



00883

Event Reason

7

200

CE

O


0276

00866

Appointment Reason

8

200

CE

O


0277

00867

Appointment Type

9

20

NM

O



00868

Appointment Duration

10

200

CE

O



00869

Appointment Duration Units

11

200

TQ

R

Y


00884

Appointment Timing Quantity

12

48

XCN

O



00874

Placer Contact Person

13

40

XTN

O



00875

Placer Contact Phone Number

14

106

XAD

O



00876

Placer Contact Address

15

80

PL

O



00877

Placer Contact Location

16

38

XCN

R



00885

Filler Contact Person

17

40

XTN

O



00886

Filler Contact Phone Number

18

106

XAD

O



00887

Filler Contact Address

19

80

PL

O



00888

Filler Contact Location

20

48

XCN

R



00878

Entered by Person

21

40

XTN

O

Y


00879

Entered by Phone Number

22

80

PL

O



00880

Entered by Location

23

75

EI

O



00881

Parent Placer Appointment ID

24

75

EI

O



00882

Parent Filler Appointment ID

25

200

CE

O


0278

00889

Filler Status Code

10.5.2.0 SCH field definitions

10.5.2.1 Placer appointment ID (EI) 00860

Components: <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>

Definition: This field contains the placer application’s permanent identifier for the appointment request (and the scheduled appointment itself, when it has been confirmed as a booked slot by the filler application). This is a composite field.

The first component is a string that identifies an individual appointment request, or a booked appointment. It is assigned by the placer application, and identifies an appointment request, and the subsequent scheduled appointment, uniquely among all such requests and/or booked appointments from a particular requesting application. If SCH-1-placer appointment ID identifies a parent of a repeating schedule request, then the individual child scheduled appointments can be uniquely identified either by a new SCH-1-placer appointment ID or by SCH-20-parent’s placer appointment ID plus an SCH-3-occurrence number.

The second component contains the assigning authority identifying information. Section 2.8.15, "EI - entity identifier," in Chapter 2 describes the structure and content of these components with respect to the EI data type.

10.5.2.2 Filler appointment ID (EI) 00861

Components: <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>

Definition: This field contains the filler application’s permanent identifier for the appointment request (and the scheduled appointment itself, when it has been confirmed as a booked slot by the filler application). This is a composite field.

The first component is a string of up to fifteen characters that identifies an individual appointment request, or a booked appointment. It is assigned by the filler application, and identifies an appointment request, and the subsequent scheduled appointment, uniquely among all such requests and/or booked appointments from a particular processing application. If SCH-2-filler appointment ID identifies a parent of a repeating schedule request, then the individual child scheduled appointments can be uniquely identified either by a new SCH-2-filler appointment ID or by SCH-21-parent’s filler appointment ID plus an SCH-3-occurrence number.

The second through fourth components contain the assigning authority identifying information. Section 2.8.15, "EI - entity identifier," in Chapter 2 describes the structure and content of these components with respect to the EI data type.

10.5.2.3 Occurrence number (NM) 00862

Definition: This field is used in conjunction with SCH-1-placer appointment ID and/or SCH-2-filler appointment ID to uniquely identify an individual occurrence (a child) of a parent repeating schedule appointment.

This field is conditionally required. If the transaction using this segment is intended to apply only to one occurrence of a repeating appointment, and an occurrence number is required to uniquely identify the child appointment (that is, the child does not have a separate and unique SCH-1-placer appointment ID or SCH-2-filler appointment ID), then this field is required.

10.5.2.4 Placer group number (EI) 00863

Components: <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>

Definition: This field allows a placer application to group sets of appointment requests together, and subsequently to identify the group.

The first component is a string that identifies a group of appointment requests. It is assigned by the placer application, and it identifies an appointment group uniquely among all such groups of requests from a particular requesting application.

The second through fourth components contain the assigning authority identifying information. Section 2.8.15, "EI - entity identifier," in Chapter 2 describes the structure and content of these components with respect to the EI data.

10.5.2.5 Schedule ID (CE) 00864

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Definition: This field contains an identifier code for the schedule in which this appointment is (or will be) booked. This field is provided for instances in which filler applications maintain multiple schedules, and when a particular resource or set of resources is controlled by more than one of those schedules.

This field is provided on the SCH segment for informational purposes to applications fulfilling the placer, querying and auxiliary roles.

10.5.2.6 Event reason (CE) 00863

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Definition: This field contains an identifier code for the reason that the notification event was triggered. This field may contain a code describing the cancel reason, the delete reason, the discontinue reason, the add reason, the block reason or any other code describing the reason that a specific event will occur.

10.5.2.7 Appointment reason (CE) 00866

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Definition: This field contains an identifier code for the reason that the appointment is to take place. This field may contain a Universal Service Identifier describing the observation/test/battery/procedure or other activity that is to take place during the requested appointment, similar to the Universal Service Identifier defined for the OBR segment in the Order Entry chapter (Chapter 4). It may also contain a site-specific code describing a pre-defined set of reasons that an appointment may be set to occur. This code can be based on local and/or universal codes. The use of universal codes is recommended. Refer to user-defined table 0276 - Appointment reason codes for suggested codes.

10.5.2.8 Appointment type (CE) 00867

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Definition: This field contains identifier code for the type of appointment. Refer to user-defined table 0277 - Appointment type codes for suggested codes.

10.5.2.9 Appointment duration (NM) 00868

Definition: This field contains amount of time requested and allotted for the appointment. In cases of repeating appointments, this field describes the duration of one instance of the appointment. If this field is unvalued, then the institution’s standard duration for the type of appointment requested will be assumed.

The appointment duration field must contain a positive, non-zero number. A negative number or zero (0) is nonsensical in the context of a duration.

10.5.2.10 Appointment duration units (CE) 00869

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Definition: This field contains a code describing the units of time used for expressing the Appointment Duration field. This field should be valued according to the recommendations in Chapters 2 and 7. If this component is not valued, the ISO base unit of seconds (code "s") is assumed. Refer to Chapter 7, Figures 7-10 through 7-13, for a list of ISO and ANSI+ unit codes.

10.5.2.11 Appointment timing quantity (TQ) 00884

Components: <quantity (CQ)> ^ <interval (CM)> ^<duration (CM)> ^ <start date/time (TS)> ^ <end date/time (TS)> ^ <priority (ID)> ^ <condition (ST)> ^ <text (TX)> ^ <conjunction (ID)> ^ <order sequencing (CM)>

Definition: This field contains the scheduled appointment’s timing and quantity, as scheduled by the filler application. Chapter 4, Section 4.4, ""Quantity/Timing (TQ) Definition," fully describes the components and the appropriate data values for the components of this field.

10.5.2.12 Placer contact person (XCN) 00874

Components: <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type (ID)> ^ <identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)>

Subcomponents of assigning authority: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Subcomponents of assigning facility ID: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition: This field identifies the person responsible for requesting the scheduling of a requested appointment. Most often, this person will be the same person responsible for executing the appointment.

10.5.2.13 Placer contact phone number (XTN) 00875

Components: [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ phone number (NM)> ^ <extension (NM)> ^ <any text (ST)>

Definition: This field contains the phone number used to contact the SCH-12-placer contact person.

10.5.2.14 Placer contact address (XAD) 00876

Components: <street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code(ST)> ^ <country (ID)> ^ <address type (ID)> ^ <other geographic designation (ST)> ^ <county/parish code (IS)> ^ <census tract (IS)>

Definition: This field contains the address used to contact the SCH-12-placer contact person.

10.5.2.15 Placer contact location (PL) 00877

Components: <point of care (IS)> ^ <room (IS)> ^ <bed (IS)> ^ <facility (HD)> ^ <location status (IS)> ^ <person location type (IS)> ^ <building (IS)> ^ <floor (IS)> ^ <location description (ST)>

Subcomponents of facility: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition: This field contains a code that identifies the location of the SCH-12-placer contact person.

10.5.2.16 Filler contact person (XCN) 00885

Components: <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type (ID)> ^ <identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)>

Subcomponents of assigning authority: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Subcomponents of assigning facility ID: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition: This field identifies the person responsible for the scheduling of the requested appointment. Most often, this person will be the same person responsible for maintaining the schedule and for reviewing appointment requests.

10.5.2.17 Filler contact phone number (XTN) 00886

Components: [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ phone number (NM)> ^ <extension (NM)> ^ <any text (ST)>

Definition: This field contains the phone number used to contact the SCH-16-filler contact person.

10.5.2.18 Filler contact address (XAD) 00887

Components: <street address (ST)> ^ <other designation (ST)> ^ <city (ST)> ^ <state or province (ST)> ^ <zip or postal code(ST)> ^ <country (ID)> ^ <address type (ID)> ^ <other geographic designation (ST)> ^ <county/parish code (IS)> ^ <census tract (IS)>

Definition: This field contains the address used to contact the SCH-16-filler contact person..

10.5.2.19 Filler contact location (PL) 00888

Components: <point of care (IS)> ^ <room (IS)> ^ <bed (IS)> ^ <facility (HD)> ^ <location status (IS)> ^ <person location type (IS)> ^ <building (IS)> ^ <floor (IS)> ^ <location description (ST)>

Subcomponents of facility: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition: This field contains a code that identifies the location of the SCH-16-filler contact person.

10.5.2.20 Entered by person (XCN) 00878

Components: <ID number (ST)> ^ <family name (ST)> ^ <given name (ST)> ^ <middle initial or name (ST)> ^ <suffix (e.g., JR or III) (ST)> ^ <prefix (e.g., DR) (ST)> ^ <degree (e.g., MD) (ST)> ^ <source table (IS)> ^ <assigning authority (HD)> ^ <name type (ID)> ^ <identifier check digit (ST)> ^ <code identifying the check digit scheme employed (ID)> ^ <identifier type code (IS)> ^ <assigning facility ID (HD)>

Subcomponents of assigning authority: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Subcomponents of assigning facility ID: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition: This field identifies the person responsible for entering the request for the scheduling of an appointment. It is included to provide an audit trail of persons responsible for the request. This person may be someone other than the placer contact person, who is responsible for entering orders and requests.

10.5.2.21 Entered by phone number (XTN) 00879

Components: [NNN] [(999)]999-9999 [X99999] [B99999] [C any text] ^ <telecommunication use code (ID)> ^ <telecommunication equipment type (ID)> ^ <email address (ST)> ^ <country code (NM)> ^ <area/city code (NM)> ^ phone number (NM)> ^ <extension (NM)> ^ <any text (ST)>

Definition: This field contains the phone number used to contact the ARQ-19-entered by person.

10.5.2.22 Entered by location (PL) 00880

Components: <point of care (IS)> ^ <room (IS)> ^ <bed (IS)> ^ <facility (HD)> ^ <location status (IS)> ^ <patient location type (IS)> ^ <building (IS)> ^ <floor (IS)> ^ <location description (ST)>

Subcomponents of facility: <namespace ID (IS)> & <universal ID (ST)> & <universal ID type (ID)>

Definition: This field contains a code that identifies the location of the entered by person.

10.5.2.23 Parent placer appointment ID (EI) 00881

Components: <entity identifier (ST)> ^ <namespace ID (IS)> ^ <universal ID (ST)> ^ <universal ID type (ID)>

Definition: This field relates a child to its parent, when a parent-child relationship exists. It contains the placer application’s permanent identifier for the parent of the appointment request. This is a composite field.

The first component is a string that identifies the parent appointment request. It is assigned by the placer application, and identifies an appointment request uniquely among all such requests from a particular requesting application.

The second through fourth components contain the assigning authority identifying information. Section 2.8.15, "EI - entity identifier," in Chapter 2 describes the structure and content of these components with respect to the EI data type.

10.5.2.24 Filler appointment ID (EI) 00882

Components: <entity identifier (ST)> ^ <namespace ID (ID)> ^ <universal ID (ST)> ^ <universal ID type (ID)>

Definition: This field relates a child to its parent, when a parent-child relationship exists. It contains the filler application’s permanent identifier for the parent of the appointment request. This is a composite field.

The first component is a string that identifies the parent appointment request. It is assigned by the filler application, and it identifies an appointment request uniquely among all such requests on a particular processing application.

The second through fourth components contain the assigning authority identifying information. Section 2.8.15, "EI - entity identifier," in Chapter 2 describes the structure and content of these components with respect to the EI data type.

This is a conditionally required field. On initial messages where a filler has not yet assigned a filler appointment ID, this field should not contain a value. In all other subsequent messages, where a filler application has assigned a filler appointment ID, this field is required.

10.5.2.25 Filler status code (CE) 00889

Components: <identifier (ST)> ^ <text (ST)> ^ <name of coding system (ST)> ^ <alternate identifier (ST)> ^ <alternate text (ST)> ^ <name of alternate coding system (ST)>

Definition: This field contains a code describing the status of the appointment with respect to the filler application. Refer to user-defined table 0278 - Filler status codes for suggested codes.

User-defined Table 0278 - Filler status codes

Value

Description

PENDING

Appointment has not yet been confirmed

WAITLIST

Appointment has been placed on a waiting list for a particular slot, or set of slots

BOOKED

The indicated appointment is booked

STARTED

The indicated appointment has begun and is currently in progress

COMPLETE

The indicated appointment has completed normally (was not discontinued, canceled, or deleted)

CANCELLED

The indicated appointment was stopped from occurring (canceled prior to starting)

DC

The indicated appointment was discontinued (DC’ed while in progress, discontinued parent appointment, or discontinued child appointment)

DELETED

The indicated appointment was deleted from the filler application

BLOCKED

The indicated time slot(s) is(are) blocked

OVERBOOK

The appointment has been confirmed; however it is confirmed in an overbooked state

Previous Page TOC Index Next Page