AIL - Appointment Information - Location Resource Segment

The AIL segment contains information about location resources (meeting rooms, operating rooms, examination rooms, or other locations) that can be scheduled. Resources included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Resources not controlled by a schedule are not identified on a schedule request using this segment. Location resources are identified with this specific segment because of the specific encoding of locations used by the HL7 specification.

HL7 Attribute Table - AIL - Appointment Information - Location Resource Segment

Seq#	Data Element Name	DataType	Usage	Vocabulary	Cardinality	Item #	Length	C.LEN	Flags
AIL
1	Set ID - AIL	SI	R		[1..1]	00902	[1..4]
2	Segment Action Code	ID	C	0206(R) Segment Action Code(Required)	[0..1]	00763	[1..1]
3	Location Resource ID	PL	C		[0..*]	00903
4	Location Type - AIL	CWE	C	0305 Person Location Type	[0..1]	00904
5	Location Group	CWE	O		[0..1]	00905
6	Start Date/Time	DTM	C		[0..1]	01202
7	Start Date/Time Offset	NM	C		[0..1]	00891
8	Start Date/Time Offset Units	CNE	C		[0..1]	00892
9	Duration	NM	O		[0..1]	00893
10	Duration Units	CNE	O		[0..1]	00894
11	Allow Substitution Code	CWE	C	0279(S) Allow Substitution Codes(Suggested)	[0..1]	00895
12	Filler Status Code	CWE	C	0278(S) Filler status codes(Suggested)	[0..1]	00889

AIL-1: Set ID - AIL (SI) 00902

Definition: This field contains a number that uniquely identifies the information represented by this segment in this transaction for the purposes of addition, change or deletion.

AIL-2: Segment Action Code (ID) 00763

Definition: This field contains the action to be taken when updating or modifying information in this segment from previously sent interface transactions. Refer to HL7 Table 0206 - Segment Action Code in Chapter 2C, Code Tables, for valid values

This field is conditionally required. It is required for all updating or modifying trigger events.

AIL-3: Location Resource ID (PL) 00903

Definition: This field contains a coded identification of the location being requested or scheduled for an appointment. This field is used to identify a specific location being requested, or a specific location that has been scheduled for an appointment. If the specific location is not known but the type of location is, AIL-4-Location Type-AIL is used to identify the type of location required or scheduled. This field is conditionally required for this segment. In new schedule request messages, it is required if the request asks that a specific location be scheduled. For all other request messages, the specific location should be identified if the information is available (either because a specific location was initially requested, or because the filler application returned the coded identification of the specific location that has been scheduled).

This field is repeating in order to accommodate both local and enterprise-wide identifiers.

This field is required for all unsolicited transactions from the filler application. It is optional for all query transactions.

AIL-4: Location Type - AIL (CWE) 00904

Definition: This field identifies the type of the location requested/scheduled for this appointment. For all messages, this field is conditionally required if a specific location is not identified in AIL-3-Location resource ID. Refer to HL7 Table 0305 – Person Location Type in Chapter 2C, Code Tables, for suggested values.

AIL-5: Location Group (CWE) 00905

Definition: This field identifies the requested resource as a member of the indicated group. If, in a Schedule Request Message (SRM), no specific location is requested, but a location type is requested, AIL-5 Location Group can be used to further qualify the type of resource being requested.

AIL-6: Start Date/Time (DTM) 01202

Definition: This field contains the date and time this service needs for the appointment. This field allows the application to identify that the service is required for the appointment at a different time than the appointment's start date/time

This field is conditionally required. If a value for AIL-7 Start Date/Time Offset is not provided, then a value is required for this field. To specify that there is no difference between the appointment's start date/time and the resource's start date/time either replicate the appointment's start date/time into this field, or specify an offset of zero (0) in AIL-7 Start Date/Time Offset and any valid time unit code in AIL-8-Start Date/Time Offset Units.

AIL-7: Start Date/Time Offset (NM) 00891

Definition: This field contains the offset this resource needs for the appointment, expressed in units of time relative to the scheduled start date/time. This field indicates to the application that the resource is required for the appointment at a different time than the appointment's start date/time. The first component contains the offset amount. An offset of zero (0), or an unvalued field, indicates that the resource is required at the start date/time of the appointment.

A positive offset (an unsigned or positive number) indicates that the resource is required after the appointment's start date/time. Specifying a negative offset indicates that the resource is required prior to the specified start date/time of the appointment. Negative offsets are allowed, and sites should clearly define the effect of a negative offset on the appointment's start date/time.

This field is conditionally required. If a value for AIL-6 Start Date/Time is not provided, then a value is required for this field. To specify that there is no difference between the appointment's start date/time and the resource's start date/time either replicate the appointment's start date/time into this field, or specify an offset of zero (0) in AIL-7 Start Date/Time Offset and any valid time unit code in AIL-8 Start Date/Time Offset Units.

AIL-8: Start Date/Time Offset Units (CNE) 00892

Definition: This field contains a code describing the units of time used for expressing the AIL-7 Start Date/Time Offset field. This field should be valued according to the recommendations made in Chapters 2 and 7. If this field is not valued, the ISO base unit of seconds (code "s") will be assumed. Refer to Chapter 7, Figures 7-6 through 7-9, for a list of ISO+ and ANS+ unit codes.

This field is conditionally required. If a value for AIL-7 Start Date/Time Offset is provided, then a value is required for this field.

AIL-9: Duration (NM) 00893

Definition: This field contains the duration for which the resource is requested/scheduled for this appointment, if it is different than the overall duration of the requested/scheduled appointment. This field indicates to the application that a resource is required for a different amount of time than the appointment's overall duration. An unvalued duration indicates that the resource is required from its start date/time offset (specified in the previous two fields) until the end of the appointment. If no start date/time offset is specified, then the resource is required for the full duration of the appointment.

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

AIL-10: Duration Units (CNE) 00894

Definition: This field contains a code describing the units of time used associated with AIL-9 Duration. This field should be valued according to the recommendations made in Chapters 2 and 7. If this field is not valued, the ISO base unit of seconds (code "s") will be assumed. Refer to Chapter 7 for a list of ISO+ and ANS+ 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.

AIL-11: Allow Substitution Code (CWE) 00895

Definition: This field contains a code indicating whether the identified location can be replaced with an equivalent substitute location by the filler application. Refer to User-Defined Table 0279 - Allow Substitution Codes in Chapter 2C, Code Tables, for suggested values.

This field is conditionally required. It is required for all request messages. It is optional for all unsolicited transactions, and for all query messages.

AIL-12: Filler Status Code (CWE) 00889

Definition: This field contains a code that describes the requested/scheduled status of the location, from the point of view of the filler application. Refer to User-Defined Table 0278 - Filler Status Codes in Chapter 2C, Code Tables, for suggested values.

This is a conditionally required field. Because the information contained in this field is only appropriate in transactions originating from a filler application, it is required for those messages. This includes all unsolicited transactions originating from a filler application, as well as all response messages originating from a filler application. This field is optional for all transactions originating from placer, querying and auxiliary applications. It is recommended that this field be left unvalued in transactions originating from applications other than the filler application.