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.
HL7 Attribute Table - AIS - Appointment Information
| Base Framework | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
 AIS | ||||||||||
  | 1 | 00890 | Set ID - AIS | SHOULD | [1..1] | [1..4] | SI Sequence ID | |||
 | 2 | 00763 | Segment Action Code | C Condition defined for this element | MAY | [0..1] | [1..1] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | |
| 3 | 00238 | Universal Service Identifier | SHOULD | [1..1] | CWE Coded with Exceptions | ||||
| 4 | 01202 | Start Date/Time | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | |||
| 5 | 00891 | Start Date/Time Offset | C Condition defined for this element | MAY | [0..1] | NM Numeric | |||
| 6 | 00892 | Start Date/Time Offset Units | C Condition defined for this element | MAY | [0..1] | CNE Coded with No Exceptions | |||
| 7 | 00893 | Duration | MAY | [0..1] | NM Numeric | ||||
| 8 | 00894 | Duration Units | MAY | [0..1] | CNE Coded with No Exceptions | ||||
| 9 | 00895 | Allow Substitution Code | C Condition defined for this element | MAY | [0..1] | repr: AllowSubstitutionCodes (CD) | CWE Coded with Exceptions | ||
| 10 | 00889 | Filler Status Code | C Condition defined for this element | MAY | [0..1] | repr: FillerStatusCodes (CD) | CWE Coded with Exceptions | ||
| 11 | 01474 | Placer Supplemental Service Information | MAY | [0..*] | ex.:SupplementalServiceInformationValues (CD) | CWE Coded with Exceptions | |||
 | 12 | 01475 | Filler Supplemental Service Information | MAY | [0..*] | ex.:SupplementalServiceInformationValues (CD) | CWE Coded with Exceptions | |||
The root for the expression is on the segment.
| Seq. | Referenced Elements | Introduction | Invariant | Comment |
|---|---|---|---|---|
| 1 | ? |
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
|---|---|---|---|---|---|---|---|---|---|---|
| AIS | ||||||||||
| 1 | 00890 | Set ID - AIS | SHALL | [1..1] | [1..4] | SI Sequence ID | |||
| 2 | 00763 | Segment Action Code | C Condition defined for this element | MAY | [0..1] | [1..1] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | |
| 3 | 00238 | Universal Service Identifier | SHALL | [1..1] | CWE Coded with Exceptions | ||||
| 4 | 01202 | Start Date/Time | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | |||
| 5 | 00891 | Start Date/Time Offset | C Condition defined for this element | MAY | [0..1] | NM Numeric | |||
| 6 | 00892 | Start Date/Time Offset Units | C Condition defined for this element | MAY | [0..1] | CNE Coded with No Exceptions | |||
| 7 | 00893 | Duration | MAY | [0..1] | NM Numeric | ||||
| 8 | 00894 | Duration Units | MAY | [0..1] | CNE Coded with No Exceptions | ||||
| 9 | 00895 | Allow Substitution Code | C Condition defined for this element | MAY | [0..1] | repr: AllowSubstitutionCodes (CD) hl7VS-allowSubstitutionCodes (VS) allowSubstitution (CS) | CWE Coded with Exceptions | ||
| 10 | 00889 | Filler Status Code | C Condition defined for this element | MAY | [0..1] | repr: FillerStatusCodes (CD) hl7VS-fillerStatusCodes (VS) fillerStatus (CS) | CWE Coded with Exceptions | ||
| 11 | 01474 | Placer Supplemental Service Information | MAY | [0..*] | ex.:SupplementalServiceInformationValues (CD) hl7VS-supplementalServiceInformation (VS) supplementalServiceInformation (CS) | CWE Coded with Exceptions | |||
| 12 | 01475 | Filler Supplemental Service Information | MAY | [0..*] | ex.:SupplementalServiceInformationValues (CD) hl7VS-supplementalServiceInformation (VS) supplementalServiceInformation (CS) | CWE Coded with Exceptions | |||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
| AIS | ||||||||||||
| 1 | 00890 | Set ID - AIS | SHOULD | [1..1] | [1..4] | SI Sequence ID | SHALL | ||||
| 2 | 00763 | Segment Action Code | C Condition defined for this element | MAY | [0..1] | [1..1] | univ: SegmentActionCode (CD) hl7VS-segmentActionCode (VS) segmentAction (CS) | ID Coded Value for HL7 Defined Tables | MAY | ||
| 3 | 00238 | Universal Service Identifier | SHOULD | [1..1] | CWE Coded with Exceptions | SHALL | |||||
| 4 | 01202 | Start Date/Time | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | MAY | ||||
| 5 | 00891 | Start Date/Time Offset | C Condition defined for this element | MAY | [0..1] | NM Numeric | MAY | ||||
| 6 | 00892 | Start Date/Time Offset Units | C Condition defined for this element | MAY | [0..1] | CNE Coded with No Exceptions | MAY | ||||
| 7 | 00893 | Duration | MAY | [0..1] | NM Numeric | MAY | |||||
| 8 | 00894 | Duration Units | MAY | [0..1] | CNE Coded with No Exceptions | MAY | |||||
| 9 | 00895 | Allow Substitution Code | C Condition defined for this element | MAY | [0..1] | repr: AllowSubstitutionCodes (CD) | CWE Coded with Exceptions | MAY | hl7VS-allowSubstitutionCodes (VS) allowSubstitution (CS) | ||
| 10 | 00889 | Filler Status Code | C Condition defined for this element | MAY | [0..1] | repr: FillerStatusCodes (CD) | CWE Coded with Exceptions | MAY | hl7VS-fillerStatusCodes (VS) fillerStatus (CS) | ||
| 11 | 01474 | Placer Supplemental Service Information | MAY | [0..*] | ex.:SupplementalServiceInformationValues (CD) | CWE Coded with Exceptions | MAY | hl7VS-supplementalServiceInformation (VS) supplementalServiceInformation (CS) | |||
| 12 | 01475 | Filler Supplemental Service Information | MAY | [0..*] | ex.:SupplementalServiceInformationValues (CD) | CWE Coded with Exceptions | MAY | hl7VS-supplementalServiceInformation (VS) supplementalServiceInformation (CS) | |||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
| AIS |
||||||||||||
|
1 | 00890 | Set ID - AIS | O | [1..4] | SI Sequence ID |
R | |||||
|
2 | 00763 | Segment Action Code | C Condition defined for this element |
O | [1..1] | ID Coded Value for HL7 Defined Tables |
(0206) | ||||
|
3 | 00238 | Universal Service Identifier | O | CWE Coded with Exceptions |
R | ||||||
|
4 | 01202 | Start Date/Time | C Condition defined for this element |
O | DTM Date/Time |
||||||
|
5 | 00891 | Start Date/Time Offset | C Condition defined for this element |
O | NM Numeric |
||||||
|
6 | 00892 | Start Date/Time Offset Units | C Condition defined for this element |
O | CNE Coded with No Exceptions |
||||||
|
7 | 00893 | Duration | O | NM Numeric |
|||||||
|
8 | 00894 | Duration Units | O | CNE Coded with No Exceptions |
|||||||
|
9 | 00895 | Allow Substitution Code | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0279) | |||||
|
10 | 00889 | Filler Status Code | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0278) | |||||
|
11 | 01474 | Placer Supplemental Service Information | O | Y | CWE Coded with Exceptions |
(0411) | |||||
|
12 | 01475 | Filler Supplemental Service Information | O | Y | CWE Coded with Exceptions |
(0411) | |||||
| Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
|---|---|---|---|---|---|---|---|---|---|
| AIS |
|||||||||
|
1 | 00890 | Set ID - AIS | R | [1..4] | SI Sequence ID |
|||
|
2 | 00763 | Segment Action Code | C | [1..1] | (0206) | ID Coded Value for HL7 Defined Tables |
||
|
3 | 00238 | Universal Service Identifier | R | CWE Coded with Exceptions |
||||
|
4 | 01202 | Start Date/Time | C | DTM Date/Time |
||||
|
5 | 00891 | Start Date/Time Offset | C | NM Numeric |
||||
|
6 | 00892 | Start Date/Time Offset Units | C | CNE Coded with No Exceptions |
||||
|
7 | 00893 | Duration | O | NM Numeric |
||||
|
8 | 00894 | Duration Units | O | CNE Coded with No Exceptions |
||||
|
9 | 00895 | Allow Substitution Code | C | (0279) | CWE Coded with Exceptions |
|||
|
10 | 00889 | Filler Status Code | C | (0278) | CWE Coded with Exceptions |
|||
|
11 | 01474 | Placer Supplemental Service Information | O | Y | (0411) | CWE Coded with Exceptions |
||
|
12 | 01475 | Filler Supplemental Service Information | O | Y | (0411) | CWE Coded with Exceptions |
||
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.
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.
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.
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-5-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-5-Start Date/Time Offset and any valid time unit code in AIS-6-Start Date/Time Offset Units.
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-5-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-5-Start Date/Time Offset and any valid time unit code in AIS-6-Start Date/Time Offset Units.
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-6 through 7-9, for a list of ISO and ANSI+ unit codes.
This field is conditionally required. If a value for AIS-5-Start Date/Time Offset is provided, then a value is required for this field.
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.
|
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. |
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.
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-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. |
Definition: This field contains a code indicating whether the identified resource can be substituted with an equivalent resource by the filler application. This field is conditionally required. It is required for all request messages. It is optional for all unsolicited transactions, and for all query messages. Refer to User-Defined Table 0279 - Allow Substitution Codes in Chapter 2C, Code Tables, for suggested codes.
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 in Chapter 2C, Code Tables, 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.
Definition: This field contains supplemental service and/or logistical information sent from the placer system to the filler system for the universal procedure code reported in field AIS-3. This field will be used to provide scheduling information detail that is not available in other, specific fields in the AIS segment. Multiple supplemental service information elements may be reported. Refer to User-defined Table 0411 - Supplemental Service Information Values in Chapter 2C, Code Tables, for valid values.
Definition: This field contains supplemental service and/or logistical information sent from the filler system to the placer system for the procedure code reported in field AIS-3. This field will be used to report scheduling information details that is not available in other, specific fields in the AIS segment. Typically it will reflect the same information as was sent to the filler system in AIS-11-Placer Supplemental information unless the scheduling was modified in which case the filler system will report what was actually performed using this field. Multiple supplemental service information elements may be reported. Refer to User-defined Table 0411 - Supplemental service information values in Chapter 2C, Code Tables, for valid values..
The Demo site for our new HL7 Version 2+ (plus) Standard
