HL7 AIP Appointment Information - Personnel Resource
HL7 field reference AIP 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 |
|---|---|---|---|---|---|
| AIP.1 | Set ID - AIP | Yes | No | SI | |
| AIP.2 | Segment Action Code | No | No | ID | 0206 |
| AIP.3 | Personnel Resource ID | No | Yes | XCN | |
| AIP.4 | Resource Type | No | No | CE | 0182 |
| AIP.5 | Resource Group | No | No | CE | |
| AIP.6 | Start Date/Time | No | No | TS | |
| AIP.7 | Start Date/Time Offset | No | No | NM | |
| AIP.8 | Start Date/Time Offset Units | No | No | CE | |
| AIP.9 | Duration | No | No | NM | |
| AIP.10 | Duration Units | No | No | CE | |
| AIP.11 | Allow Substitution Code | No | No | IS | 0279 |
| AIP.12 | Filler Status Code | No | No | CE | 0278 |
AIP is the HL7 Appointment Information - Personnel Resource segment. The AIP segment contains information about the personnel types that can be scheduled. Personnel included in a transaction using this segment are assumed to be controlled by a schedule on a schedule filler application. Personnel not controlled by a schedule are not identified on a schedule request using this segment. The kinds of personnel described on this segment include any healthcare provider in the institution controlled by a schedule (for example: technicians, physicians, nurses, surgeons, anesthesiologists, or CRNAs).
Scheduling segments carry the appointment story in pieces: request, service, resource group, location, personnel, preferences, and timing.
The v2.5.1 structures show AIP 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.
AIP-1 is the sequence number for this personnel resource line within the appointment detail. It is useful when several people are being scheduled, such as a surgeon, anaesthetist, nurse, and technician. It is not a provider identifier.
AIP-2 says what is happening to this personnel resource in an update transaction. Use it carefully for add/change/delete/cancel style changes, and keep it in step with the appointment trigger event. A scheduler may treat "replace this person" as a cancellation plus a new personnel line, not as a simple edit.
AIP-3 identifies the actual person requested or scheduled. It uses an XCN shape, so preserve the staff/provider identifier, assigning authority, and name components rather than flattening the person to "Dr Smith". The name helps users; the identifier keeps the schedule tied to the correct person.
AIP-4 is used when the request is for a kind of person rather than a named person: physician, nurse, technician, anaesthetist, interpreter, or another local staff type. If the placer asks for a type, the filler can allocate the actual person and return AIP-3 later.
AIP-5 narrows the personnel pool. It might mean a clinical team, roster group, department, site, speciality pool, or on-call group. Use it only when the receiving scheduler understands the grouping; otherwise it becomes a decorative code that nobody can act on.
A person can be needed at a different time from the appointment start. A clinician may join after intake, an anaesthetist may be required before the room time, or a technician may only be needed for setup. AIP-6 gives the explicit time; AIP-7 and AIP-8 describe the offset and units.
Agree whether your interface uses absolute times or offsets. Offsets are compact, but the sign and units need to be unmistakable. "15 minutes before" and "15 minutes after" are both plausible until the profile says otherwise.
These fields describe how long the person is needed when that differs from the appointment duration. This is useful for shared staff, theatre lists, procedure setup, supervision, and other workflows where the person's booked time is not the same as the patient's appointment time.
Keep the duration positive and pair it with clear units. If the value is empty, many systems will assume the person is required from the stated start point through the appointment end.
AIP-11 tells the filler whether it can substitute an equivalent person. That might be fine for "any available radiographer" and absolutely not fine for a patient who requested a named consultant.
AIP-12 is the filler application's status for the personnel booking. It belongs naturally in filler confirmations, unsolicited updates, or query responses. A placer request should usually leave it alone and let the scheduling system report what it actually booked.
Related links
- SCH - Scheduling Activity Information
- ARQ - Appointment Request
- RGS - Resource Group
- AIS - Appointment Information
- AIG - Appointment Information - General Resource
- AIL - Appointment Information - Location 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