The Demo site for our new HL7 Version 2+ (plus) Standard
visit the hl7 website

Draft Website - For Review Purposes Only

SCH - Schedule Activity Information Segment

The SCH segment contains general information about the scheduled appointment.

HL7 Attribute Table - SCH - Schedule Activity Information Segment
Seq# Data Element Name DataType Usage Vocabulary Cardinality Item # Length C.LEN Flags
SCH
1 Placer Appointment ID EI C [0..1] 00860
2 Filler Appointment ID EI C [0..1] 00861
3 Occurrence Number NM C [0..1] 00862 5 #
4 Placer Order Group Number EI O [0..1] 00218
5 Schedule ID CWE O [0..1] 00864
6 Event Reason CWE R [1..1] 00883
7 Appointment Reason CWE O [0..1] 00866
8 Appointment Type CWE O [0..1] 00867
9 Appointment Duration NM W [0..1] 00868 5 #
10 Appointment Duration Units CNE B [0..1] 00869
11 Appointment Timing Quantity W [0..1] 00884
12 Placer Contact Person XCN O [0..*] 00874
13 Placer Contact Phone Number XTN O [0..1] 00875
14 Placer Contact Address XAD O [0..*] 00876
15 Placer Contact Location PL O [0..1] 00877
16 Filler Contact Person XCN R [1..*] 00885
17 Filler Contact Phone Number XTN O [0..1] 00886
18 Filler Contact Address XAD O [0..*] 00887
19 Filler Contact Location PL O [0..1] 00888
20 Entered By Person XCN R [1..*] 00878
21 Entered By Phone Number XTN O [0..*] 00879
22 Entered By Location PL O [0..1] 00880
23 Parent Placer Appointment ID EI O [0..1] 00881
24 Parent Filler Appointment ID EI C [0..1] 00882
25 Filler Status Code CWE O [0..1] 00889
26 Placer Order Number EI C [0..*] 00216
27 Filler Order Number EI C [0..*] 00217
28 Alternate Placer Order Group Number EIP O [0..1] 03547

SCH-1: Placer Appointment ID (EI) 00860

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-23-Parent Placer Appointment ID plus an SCH-3-Occurrence Number.

If a schedule request originates from a placer it MUST have a placer appointment ID. If the filler sends responses, it may use the placer appointment ID and/or assign a filler appointment ID (which it would echo back to the placer to enable the placer application to associate the two). If the placer appointment ID is not present, the filler appointment ID must be present and vice versa.

SCH-2: Filler Appointment ID (EI) 00861

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-25-Parent Filler Appointment ID plus an SCH-3-Occurrence Number.

SCH-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.

SCH-4: Placer Order Group Number (EI) 00218

Definition: This field contains a unique identifier for the Placer Group as referenced by the Placer application, the Filler application, or both. A Placer Group is a set of appointments grouped together by the placer application, and subsequently identified by the placer application and/or by the filler application.

Within each of the two subcomponents, the first component is a string that identifies a group of appointment requests. It is assigned by the Placer or Filler application, and it identifies an appointment group uniquely among all such groups of requests from a particular requesting application.

SCH-5: Schedule ID (CWE) 00864

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.

SCH-6: Event Reason (CWE) 00883

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.

This field should not have been made required but is retained as such for reasons of backwards compatibility.

SCH-7: Appointment Reason (CWE) 00866

Definition: This field contains an identifier code for the reason that the appointment is to take place. This field may contain a Universal Service ID describing the observation/test/battery/procedure or other activity that is to take place during the requested appointment, similar to the Universal Service ID 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 in Chapter 2C, Code Tables, for suggested values.

SCH-8: Appointment Type (CWE) 00867

Definition: This field contains the identifier code for the type of appointment. Refer to User-Defined Table 0277 - Appointment Type Codes in Chapter 2C, Code Tables, for suggested values.

SCH-9: Appointment Duration (NM) 00868

As of version 2.5, this field was retained for backward compatibility only and withdrawn and removed as of v2.7. Refer to the TQ1 segment described in Chapter 4.

SCH-10: Appointment Duration Units (CNE) 00869

As of version 2.5, this field is retained for backward compatibility only. Refer to the TQ1 segment described in Chapter 4.

Definition: This field contains a code describing the units of time used for expressing the ARQ-9-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-6 through 7-9, for a list of ISO and ANSI+ unit codes.

As of v2.6, the known applicable external coding systems include those in the table below. If the code set you are using is in this table, then you must use that designation.

Unit of Measure Coding Systems from HL7 Table 0396

Coding System

Description

Comment

ISO+

ISO 2955.83 (units of measure) with HL7 extensions

See chapter 7.

ANS+

HL7 set of units of measure

HL7 set of units of measure based upon ANSI X3.50 - 1986, ISO 2988-83, and US customary units / see chapter 7.


SCH-11: Appointment Timing Quantity () 00884

As of version 2.5, this field was retained for backward compatibility only and withdrawn and removed as of v2.7. Refer to the TQ1 segment described in Chapter 4.

SCH-12: Placer Contact Person (XCN) 00874

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.

SCH-13: Placer Contact Phone Number (XTN) 00875

Definition: This field contains the phone number used to contact the SCH-12-Placer Contact Person.

SCH-14: Placer Contact Address (XAD) 00876

Definition: This field contains the address used to contact the SCH-12-Placer Contact Person.

SCH-15: Placer Contact Location (PL) 00877

Definition: This field contains a code that identifies the location of the SCH-12-Placer Contact Person.

SCH-16: Filler Contact Person (XCN) 00885

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.

This field should not have been made required but is retained as such for reasons of backward compatibility.

SCH-17: Filler Contact Phone Number (XTN) 00886

Definition: This field contains the phone number used to contact the SCH-16-Filler Contact Person.

SCH-18: Filler Contact Address (XAD) 00887

Definition: This field contains the address used to contact the SCH-16-Filler Contact Person.

SCH-19: Filler Contact Location (PL) 00888

Definition: This field contains a code that identifies the location of the SCH-16-Filler Contact Person.

SCH-20: Entered By Person (XCN) 00878

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.

This field should not have been made required but is retained as such for reasons of backwards compatibility.

SCH-21: Entered By Phone Number (XTN) 00879

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

SCH-22: Entered By Location (PL) 00880

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

SCH-23: Parent Placer Appointment ID (EI) 00881

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.

SCH-24: Parent Filler Appointment ID (EI) 00882

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.

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.

SCH-25: Filler Status Code (CWE) 00889

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 in Chapter 2C, Code Tables, for suggested values.

SCH-26: Placer Order Number (EI) 00216

Definition: This field is the placer application's order number for the order associated with this scheduling filler application response.

This field is described in detail in Section 4.5.1.2. It is an optional field, but if a Placer order number is present, then a Filler order number (Section 10.6.2.27) must also be present. Both this field and the Filler order number below may have been sent as part of the appointment request in the ARQ segment or they may be assigned by the scheduling filler application only.

SCH-27: Filler Order Number (EI) 00217

Definition: This field is the order number assigned by the filler application for the order associated with this scheduling filler response.

This field is described in detail in Chapter 4, Orders, section 4.5.1.3. It is conditionally mandatory depending on the presence of the placer order number (section 10.6.2.26). This conditionally mandatory requirement addresses the concern that a Scheduling system cannot and should not create or fill an order. Therefore, an order must have been accepted by the order filler application before scheduling the resources associated with that order.

SCH-28: Alternate Placer Order Group Number (EIP) 03547

Definition: This field contains a unique identifier for the Placer Group as referenced by the Placer application, the Filler application, or both. A Placer Group is a set of appointments grouped together by the placer application, and subsequently identified by the placer application and/or by the filler application.

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