Previous Page TOC Index Next Page

10.5.4 AIS - appointment information - service segment

The AIS segment contains information about various kinds of services that can be scheduled. Services included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Services not controlled by a schedule are not identified on a schedule request using this segment.

Figure 10-6. AIS attributes

SEQ

LEN

DT

R/O/C

RP/#

TBL#

ITEM#

ELEMENT NAME

1

4

SI

R



00890

Set ID - AIS

2

3

ID

C


0206

00763

Segment Action Code

3

200

CE

R



00238

Universal Service Identifier

4

26

TS

C



01202

Start Date/Time

5

20

NM

C



00891

Start Date/Time Offset

6

200

CE

C



00892

Start Date/Time Offset Units

7

20

NM

O



00893

Duration

8

200

CE

O



00894

Duration Units

9

10

IS

C


0279

00895

Allow Substitution Code

10

200

CE

C


0278

00889

Filler Status Code

10.5.4.0 AIS field definitions

10.5.4.1 Set ID - AIS (SI) 00890

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.

10.5.4.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 2, Section 2.23.4.2, "Action code/unique identifier mode update definition," for valid values.

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

10.5.4.3 Universal service identifier (CE) 00238

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 a service to be scheduled. This field may contain a Universal Service Identifier describing the observation/test/battery/procedure or other activity that is to be performed during the requested appointment, similar to the Universal Service Identifier defined for the OBR segment in the Order Entry chapter (Chapter 4). This code can be based on local and/or universal codes. The use of universal codes is recommended.

10.5.4.4 Start date/time (TS) 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 AIS-4-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 AIS-4-start date/time offset and any valid time unit code in AIS-5-start date/time offset units.

10.5.4.5 Start date/time offset (NM) 00891

Definition: This field contains the offset this service needs for the appointment, expressed in units of time relative to the scheduled start date/time. 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. The first component contains the offset amount. An offset of zero (0), or an unvalued field indicates that the service is required at the start date/time of the appointment.

A positive offset (an unsigned or positive number) indicates that the service is required after the appointment’s start date/time. Specifying a negative offset indicates that the service 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 AIS-4-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 AIS-4-start date/time offset and any valid time unit code in AIS-5-start date/time offset units.

10.5.4.6 Start date/time offset units (CE) 00892

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 start date/time offset. This field should be valued according to the recommendations 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-10 through 7-13, for a list of ISO and ANSI+ unit codes.

This field is conditionally required. If a value for AIS-4-start date/time offset is provided, then a value is required for this field.

10.5.4.7 Duration (NM) 00893

Definition: This field contains the duration for which the resource is requested/scheduled for this appointment, if different from 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.

10.5.4.8 Duration units (CE) 00894

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 duration. This field should be valued according to the recommendations 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-10 through 7-13, for a list of ISO and ANSI+ unit codes.

10.5.4.9 Allow substitutions code (IS) 00895

Definition: This field contains a code indicating whether the identified resource can be substituted with an equivalent resource by the filler application. Refer to user-defined table 0279 - Allow substitution codes for suggested codes.

User-defined Table 0279 - Allow substitution codes

Value

Description

NO

Substitution of this resource is not allowed

CONFIRM

Contact the Placer Contact Person prior to making any substitutions of this resource

NOTIFY

Notify the Placer Contact Person, through normal institutional procedures, that a substitution of this resource has been made

YES

Substitution of this resource is allowed

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

10.5.4.10 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 that describes the requested/scheduled status of the resource or activity, from the point of view of the filler application. Refer to user-defined table 0278 - Filler status codes for suggested codes.

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.

Previous Page TOC Index Next Page