Waitlist
Source Object: Waitlist
Overview: The "Waitlist" source object contains data related to patients who are on a waiting list for appointments, providing information about their scheduled appointments.
Key Data Fields:
- Appointment ID: Unique identifier for the appointment.
- Appointment Type ID: Identifier for the appointment type.
- Created: Date and time when the waitlist entry was created.
- Day of Week IDs: Identification of the specific day(s) of the week for the appointment.
- Department ID: Identifier for the department associated with the appointment.
- Hour From: Starting time of the appointment.
- Hour To: Ending time of the appointment.
- Note: Additional notes or comments related to the waitlist entry.
- Patient ID: Unique identifier for the patient on the waitlist.
- Priority: Priority level or ranking of the patient on the waitlist.
- Provider ID: Identifier for the healthcare provider associated with the appointment.
- Waitlist ID: Unique identifier for the waitlist entry.
- Allow Any Department: A flag indicating whether the patient is willing to visit any department.
The "Waitlist" source object is essential for managing and scheduling patient appointments efficiently, taking into consideration patient preferences and department availability.
Mapping Table
| Data Field | Example Value | Source Data Field Description | Source Field Data Type | Source Data Field Cardinality | Mapped FHIR++ Resource | Mapped FHIR Data Field | Augmented Mapping | Associated Coding System | Associated FHIR Data Field Extension | Mapping Context |
|---|---|---|---|---|---|---|---|---|---|---|
| appointmentid | - | The booked appointment ID of the appointment that this wait list entry would replace. | integer | 0..1 | Appointment | supportingInformation.reference | ||||
| appointmenttypeid | - | The appointment type ID of the desired appointment. | integer | 0..1 | Appointment | appointmenttype.coding.code | Top Level | |||
| created | - | The date and time that this wait list entry was created. | string | 0..1 | Appointment | created(convert to fhir) | Top Level | |||
| dayofweekids | - | A list of day of week IDs that are desired by the patient, with 1 being Sunday, and 7 being Saturday. | integer | 0..1 | Appointment | extension.valueString | days-of-week-ids | Top Level | ||
| departmentid | - | The department ID of the desired department. This can be blank if any department is acceptable. | integer | 0..1 | Appointment | extension.valueString | department-id | Top Level | ||
| hourfrom | - | The hour (24 hour clock) after which an appointment is desired by a patient. Inclusive. | integer | 0..1 | Appointment | requestedPeriod.extension.valueInteger | hour-from | Top Level | ||
| hourto | - | The hour (24 hour clock) before which an appointment is desired by a patient. Inclusive. | integer | 0..1 | Appointment | requestedPeriod.extension.valueInteger | hour-to | Top Level | ||
| note | - | Practice-facing note about why the wait list entry exists. | string | 0..1 | Appointment | comment | Top Level | |||
| patientid | - | The patient ID of the patient who is on the wait list. | integer | 0..1 | Appointment | participant.actor.reference | Top Level | |||
| priority | - | One of "LOW", "NORMAL", or "HIGH", indicating the priorty of this wait list entry. | string | 0..1 | Appointment | extension.valueString | priority | Top Level | ||
| providerid | - | The provider ID of the desired provider. This can be blank if any provider is acceptable. | integer | 0..1 | Appointment | participant.actor.reference(Practitioner) | Top Level | |||
| waitlistid | - | The wait list ID, used in other calls. | integer | 0..1 | Appointment | id | Top Level | |||
| allowanydepartment | - | While a department is required when creating a wait list entry, this flag indicates that any department is accpetable for an appointment. | Boolean | 0..1 | Appointment | extension.valueBoolean | allow-any-department | Top Level |