The AIG segment contains information about various kinds of resources (other than those with specifically defined segments in this chapter) 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. Resources described by this segment are general kinds of resources, such as equipment, that are identified with a simple identification code.
HL7 Attribute Table - AIG - Appointment Information - General Resource
| Base Framework | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
 AIG | ||||||||||
  | 1 | 00896 | Set ID - AIG | 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 | 00897 | Resource ID | C Condition defined for this element | MAY | [0..1] | CWE Coded with Exceptions | |||
| 4 | 00898 | Resource Type | SHOULD | [1..1] | CWE Coded with Exceptions | ||||
| 5 | 00899 | Resource Group | MAY | [0..*] | CWE Coded with Exceptions | ||||
| 6 | 00900 | Resource Quantity | = Truncation allowed. | MAY | [0..1] | 5 | NM Numeric | ||
| 7 | 00901 | Resource Quantity Units | MAY | [0..1] | CNE Coded with No Exceptions | ||||
| 8 | 01202 | Start Date/Time | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | |||
| 9 | 00891 | Start Date/Time Offset | C Condition defined for this element | MAY | [0..1] | NM Numeric | |||
| 10 | 00892 | Start Date/Time Offset Units | C Condition defined for this element | MAY | [0..1] | CNE Coded with No Exceptions | |||
| 11 | 00893 | Duration | MAY | [0..1] | NM Numeric | ||||
| 12 | 00894 | Duration Units | MAY | [0..1] | CNE Coded with No Exceptions | ||||
| 13 | 00895 | Allow Substitution Code | C Condition defined for this element | MAY | [0..1] | repr: AllowSubstitutionCodes (CD) | CWE Coded with Exceptions | ||
 | 14 | 00889 | Filler Status Code | C Condition defined for this element | MAY | [0..1] | repr: FillerStatusCodes (CD) | CWE Coded with Exceptions | ||
The root for the expression is on the segment.
| Seq. | Referenced Elements | Introduction | Invariant | Comment |
|---|---|---|---|---|
| 1 | AIG-2,3,8,9,10,13,14 | ? |
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | |
|---|---|---|---|---|---|---|---|---|---|---|
| AIG | ||||||||||
| 1 | 00896 | Set ID - AIG | 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 | 00897 | Resource ID | C Condition defined for this element | MAY | [0..1] | CWE Coded with Exceptions | |||
| 4 | 00898 | Resource Type | SHALL | [1..1] | CWE Coded with Exceptions | ||||
| 5 | 00899 | Resource Group | MAY | [0..*] | CWE Coded with Exceptions | ||||
| 6 | 00900 | Resource Quantity | = Truncation allowed. | MAY | [0..1] | 5 | NM Numeric | ||
| 7 | 00901 | Resource Quantity Units | MAY | [0..1] | CNE Coded with No Exceptions | ||||
| 8 | 01202 | Start Date/Time | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | |||
| 9 | 00891 | Start Date/Time Offset | C Condition defined for this element | MAY | [0..1] | NM Numeric | |||
| 10 | 00892 | Start Date/Time Offset Units | C Condition defined for this element | MAY | [0..1] | CNE Coded with No Exceptions | |||
| 11 | 00893 | Duration | MAY | [0..1] | NM Numeric | ||||
| 12 | 00894 | Duration Units | MAY | [0..1] | CNE Coded with No Exceptions | ||||
| 13 | 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 | ||
| 14 | 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 | ||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Implement | Cardinality | Length | C.LEN | Vocabulary | Data Type | Implement | Vocabulary | |
| AIG | ||||||||||||
| 1 | 00896 | Set ID - AIG | 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 | 00897 | Resource ID | C Condition defined for this element | MAY | [0..1] | CWE Coded with Exceptions | MAY | ||||
| 4 | 00898 | Resource Type | SHOULD | [1..1] | CWE Coded with Exceptions | SHALL | |||||
| 5 | 00899 | Resource Group | MAY | [0..*] | CWE Coded with Exceptions | MAY | |||||
| 6 | 00900 | Resource Quantity | = Truncation allowed. | MAY | [0..1] | 5 | NM Numeric | MAY | |||
| 7 | 00901 | Resource Quantity Units | MAY | [0..1] | CNE Coded with No Exceptions | MAY | |||||
| 8 | 01202 | Start Date/Time | C Condition defined for this element | MAY | [0..1] | DTM Date/Time | MAY | ||||
| 9 | 00891 | Start Date/Time Offset | C Condition defined for this element | MAY | [0..1] | NM Numeric | MAY | ||||
| 10 | 00892 | Start Date/Time Offset Units | C Condition defined for this element | MAY | [0..1] | CNE Coded with No Exceptions | MAY | ||||
| 11 | 00893 | Duration | MAY | [0..1] | NM Numeric | MAY | |||||
| 12 | 00894 | Duration Units | MAY | [0..1] | CNE Coded with No Exceptions | MAY | |||||
| 13 | 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) | ||
| 14 | 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) | ||
| Base Framework | Base Standard Profile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Seq# | Data Element | Description | Flags | Optionality | Repetition | Length | C.LEN | Table | Data Type | Optionality | Table | |
| AIG |
||||||||||||
|
1 | 00896 | Set ID - AIG | 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 | 00897 | Resource ID | C Condition defined for this element |
O | CWE Coded with Exceptions |
||||||
|
4 | 00898 | Resource Type | O | CWE Coded with Exceptions |
R | ||||||
|
5 | 00899 | Resource Group | O | Y | CWE Coded with Exceptions |
||||||
|
6 | 00900 | Resource Quantity | O | 5# | NM Numeric |
||||||
|
7 | 00901 | Resource Quantity Units | O | CNE Coded with No Exceptions |
|||||||
|
8 | 01202 | Start Date/Time | C Condition defined for this element |
O | DTM Date/Time |
||||||
|
9 | 00891 | Start Date/Time Offset | C Condition defined for this element |
O | NM Numeric |
||||||
|
10 | 00892 | Start Date/Time Offset Units | C Condition defined for this element |
O | CNE Coded with No Exceptions |
||||||
|
11 | 00893 | Duration | O | NM Numeric |
|||||||
|
12 | 00894 | Duration Units | O | CNE Coded with No Exceptions |
|||||||
|
13 | 00895 | Allow Substitution Code | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0279) | |||||
|
14 | 00889 | Filler Status Code | C Condition defined for this element |
O | CWE Coded with Exceptions |
(0278) | |||||
| Seq# | Data Element | Description | Optionality | Repetition | Length | C.LEN | Table | Data Type | |
|---|---|---|---|---|---|---|---|---|---|
| AIG |
|||||||||
|
1 | 00896 | Set ID - AIG | R | [1..4] | SI Sequence ID |
|||
|
2 | 00763 | Segment Action Code | C | [1..1] | (0206) | ID Coded Value for HL7 Defined Tables |
||
|
3 | 00897 | Resource ID | C | CWE Coded with Exceptions |
||||
|
4 | 00898 | Resource Type | R | CWE Coded with Exceptions |
||||
|
5 | 00899 | Resource Group | O | Y | CWE Coded with Exceptions |
|||
|
6 | 00900 | Resource Quantity | O | 5# | NM Numeric |
|||
|
7 | 00901 | Resource Quantity Units | O | CNE Coded with No Exceptions |
||||
|
8 | 01202 | Start Date/Time | C | DTM Date/Time |
||||
|
9 | 00891 | Start Date/Time Offset | C | NM Numeric |
||||
|
10 | 00892 | Start Date/Time Offset Units | C | CNE Coded with No Exceptions |
||||
|
11 | 00893 | Duration | O | NM Numeric |
||||
|
12 | 00894 | Duration Units | O | CNE Coded with No Exceptions |
||||
|
13 | 00895 | Allow Substitution Code | C | (0279) | CWE Coded with Exceptions |
|||
|
14 | 00889 | Filler Status Code | C | (0278) | 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 2, Code Tables, for valid values.
This field is conditionally required. It is required for all updating or modifying trigger events.
Definition: This field contains the ID number and name of the resource being requested or scheduled for an appointment. This field is used to identify a specific resource being requested, or a specific resource that has been scheduled for an appointment. If the specific resource is not known but the type of resource is, AIG-4 Resource Type is used to identify the type of resource required or scheduled.
At a minimum, the ID number component should be supplied to identify either the specific resource being requested or the specific resource that has been scheduled. For inter-enterprise communications, for which a shared ID number may not be available, the minimum components required to uniquely identify a resource may be defined by site-specific negotiations.
This field is conditionally required for this segment. In new schedule request messages, it is required if the request asks that a specific resource be scheduled. For all other request messages, the specific resource should be identified if the information is available (either because a specific resource was initially requested, or because the filler application returned the ID of the specific resource that has been scheduled).
This field is required for all unsolicited transactions from the filler application.
This field is optional for all query transactions.
Definition: This field identifies the role of the resource requested/scheduled for this appointment. For requests, if a specific resource is not identified in AIG-3-Resource ID, then this field identifies the type of resource that should be scheduled by the filler application. At a minimum, the type of the identifier component should be valued.
Definition: This field identifies the requested resource as a member of the indicated group. If, in a Schedule Request Message (SRM), no specific resource is requested, but a resource type is requested, this field can be used to further qualify the type of resource being requested.
Definition: This field contains the quantity of the specified resource or resource type identified in either or both of the preceding two fields. If it is not valued, this field defaults to a value of one (1).
Definition: This field contains the units of the resource requested, whose quantity is given in the preceding field. This field should be valued according to the recommendations in Chapters 2 and 7. If this field is not valued, the unit of each (code "ea") will be assumed. Refer to Chapter 7, Figures 7-6 through 7-9, 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. |
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 AIG-9-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 AIG-9-Start Date/Time Offset and any valid time unit code in AIG-10-Start Date/Time Offset Units.
Definition: This field contains the offset that 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 indicates 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 AIG-8-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 AIG-9-Start Date/Time Offset and any valid time unit code in AIG10-Start Date/Time Offset Units.
Definition: This field contains a code describing the units of time used for expressing AIG-9-Start Date/Time Offset. 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 AIG-9-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.
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 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.
Definition: This field contains a code describing the units of time used for expressing the AIG-11-Duration field. 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 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. |
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.
This field is conditionally required. It is required for all request messages. It is optional for all unsolicited transactions, and for all query messages.
Definition: This field contains a code that describes the requested/scheduled status of scheduling 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.
The Demo site for our new HL7 Version 2+ (plus) Standard
