HL7 AIG Appointment Information - General Resource
HL7 field reference AIG fields from HL7 v2.5.1 Show fields
These are the generated fields for the version selected at the top of the page. The document stays the same, but the reference panel follows that version.
Fields
| Field | Name | Required | Repeatable | Type | Table |
|---|---|---|---|---|---|
| AIG.1 | Set ID - AIG | Yes | No | SI | |
| AIG.2 | Segment Action Code | No | No | ID | 0206 |
| AIG.3 | Resource ID | No | No | CE | |
| AIG.4 | Resource Type | Yes | No | CE | |
| AIG.5 | Resource Group | No | Yes | CE | |
| AIG.6 | Resource Quantity | No | No | NM | |
| AIG.7 | Resource Quantity Units | No | No | CE | |
| AIG.8 | Start Date/Time | No | No | TS | |
| AIG.9 | Start Date/Time Offset | No | No | NM | |
| AIG.10 | Start Date/Time Offset Units | No | No | CE | |
| AIG.11 | Duration | No | No | NM | |
| AIG.12 | Duration Units | No | No | CE | |
| AIG.13 | Allow Substitution Code | No | No | IS | 0279 |
| AIG.14 | Filler Status Code | No | No | CE | 0278 |
AIG is the HL7 Appointment Information - General Resource segment. The AIG segment contains information about various kinds of resources 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.
Scheduling segments carry the appointment story in pieces: request, service, resource group, location, personnel, preferences, and timing.
The v2.5.1 structures show AIG in SIU_S12 (Notification of new appointment booking), SQM_S25 (Schedule query message and response), SQR_S25 (Schedule query message and response), SRM_S01 (Request new appointment booking), and 1 other message structure. That tells you where it can appear, but the local implementation guide still decides which optional fields are meaningful.
Scheduling flows are easier to reason about when the request, resource, and appointment fields are visible together. HL7 Soup Web is helpful for inspection, and Integration Soup can keep resource mapping and routing rules explicit.
So this page stays intentionally practical: what each field is for, what shape the generated v2.5.1 data gives it, and where I would be careful before mapping it.
AIG-1 is the line number for this general resource within the current resource group. It is useful when a request has several pieces of equipment or other schedulable things attached to it, but it is not the equipment identifier. The scanner, pump, cart, or other resource identity belongs in AIG-3.
AIG-2 tells the filler whether this resource detail is being added, changed, deleted, cancelled, or otherwise acted on in an update-style scheduling transaction. Do not treat it as a general status field. If the real business event is replacing one resource with another, make sure the trigger/event and segment action agree, otherwise the receiving scheduler can end up changing the wrong booked slot.
AIG-3 is for a specific resource, such as a named piece of equipment or a known asset code. AIG-4 is for the type of resource when the request is for a class rather than a particular instance. In practice that is the difference between "MRI-2" and "MRI scanner", or "portable pump 17" and "infusion pump".
Use a specific resource ID only when the placer really cares which item is used, or when the filler is reporting the item it actually booked. If any equivalent item will do, send the type clearly and let the filler allocate the actual resource. That keeps the request from accidentally over-constraining the schedule.
AIG-5 narrows the pool. It might be a department, modality group, equipment pool, campus, or other local grouping that helps the filler choose from the right set of resources. It is especially useful when AIG-4 says the type but the organization has more than one pool of that type.
AIG-6 says how many of the resource are needed, and AIG-7 says what that number means. If the unit is omitted the practical assumption is usually "one each", but that assumption should be explicit in a profile when equipment counts affect capacity.
This matters for pooled resources: two infusion pumps, three transport chairs, one interpreter phone, or a single portable machine all have different scheduling consequences. Do not send a quantity if the receiver will ignore it and book only one item anyway.
A general resource can be needed before, at, or after the appointment start. AIG-8 gives an explicit resource start time; AIG-9 and AIG-10 express that same idea as an offset and unit from the appointment start. Pick one style deliberately.
Offsets are powerful but easy to misread. A negative offset can mean the resource is needed before the appointment starts, such as equipment setup time. If you use offsets, document the sign convention and units, and test an example that crosses midnight or daylight-saving boundaries.
These fields are for the resource's own duration when it is not needed for the whole appointment. A recovery bay, room setup item, or portable device might be needed for a shorter or longer span than the clinical service itself.
The duration must be a positive useful number with units. Leaving it empty normally means the resource is needed from its start point until the end of the appointment. That is a sensible default only if both systems share the same idea of appointment end time.
AIG-13 tells the filler whether an equivalent resource can be substituted. That is a request-side rule: can the scheduler swap MRI-2 for MRI-1, or a generic resource for the named one?
AIG-14 is different. It is the filler application's view of the resource status, so it belongs in filler-originated messages or responses. A placer request should not invent filler status just because the field is available.
Related links
- SCH - Scheduling Activity Information
- ARQ - Appointment Request
- RGS - Resource Group
- AIS - Appointment Information
- AIL - Appointment Information - Location Resource
- AIP - Appointment Information - Personnel Resource
- APR - Appointment Preferences
- TQ1 - Timing/Quantity
- SIU_S12 - Notification of new appointment booking
- SQM_S25 - Schedule query message and response
- SQR_S25 - Schedule query message and response