Appointment Slot
Source Object: Appointment Slot
Overview and Usage: The "Appointment Slot" source object in athena EHR is a key component for managing and scheduling patient appointments. It provides structured data related to available appointment slots and facilitates efficient appointment booking and management.
- Appointment Scheduling: "Appointment Slot" serves as a repository for available appointment slots, capturing crucial details including the appointment ID, type, and date.
- Appointment Type: The "appointmenttype" and "appointmenttypeid" fields specify the type of appointment, allowing for categorization and scheduling of different appointment types.
- Date and Time: "date," "starttime," and "duration" provide information about the date, start time, and duration of the appointment slot, essential for scheduling patient appointments.
- Department and Provider: The "departmentid," "localproviderid," and "providerid" fields link the appointment slot to a specific department and provider, ensuring accurate scheduling and resource allocation.
- Reason for Appointment: "reasonid" and "patientappointmenttypename" capture the reason for the appointment, facilitating effective communication and patient-centered care.
- Rendering Provider: "renderingproviderid" specifies the provider responsible for rendering the services during the appointment.
- Slot Freezing: The "frozenyn" and "freeze" fields indicate whether the appointment slot is frozen or requires cancellation. Slot freezing prevents inadvertent bookings.
- Valid Appointment Types: "validappointmenttypeids" defines the appointment types that are valid for the slot, ensuring appropriate scheduling and resource utilization.
- Appointment Date and Time: The combination of "appointmentdate" and "appointmenttime" further specifies the date and time of the appointment.
The "Appointment Slot" source object streamlines the scheduling and management of patient appointments within athena EHR. It helps healthcare providers efficiently allocate resources and ensures that appointments are accurately booked based on the available slots and providers. Developers can use this source object to build features and applications that support appointment scheduling, availability tracking, and patient-centered care.
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 | - | This is the ID of the appointment to use when booking. | Integer | 0..1 | Slot | identifier[*].value | system=appointment-id | - | Top Level | |
| appointmenttype | - | The practice-friendly (not patient friendly) name for this appointment type. | String | 0..1 | Slot | serviceCategory[1].display | system=athena | - | Top Level | |
| appointmenttypeid | - | This is the ID for the appointment type. | Integer | 0..1 | Slot | serviceCategory[1].code | - | Top Level | ||
| date | - | The appointment date. | String | 0..1 | Slot | start | - | Top Level | ||
| departmentid | - | The athenaNet department ID for the appointment. | Integer | 0..1 | Slot | extension[*].valueInteger | - | department-id | Top Level | |
| duration | - | In minutes | Integer | 0..1 | Slot | end | note:use start and add duration | - | Top Level | |
| frozenyn | - | If true, this appointment slot is frozen. | String | 0..1 | Slot | extension[*].valueBoolean | - | frozen-yn | Top Level | |
| localproviderid | - | The local athenaNet ID for the provider of the appointment. | Integer | 0..1 | Slot | extension[*].valueInteger | - | local-provider-id | Top Level | |
| patientappointmenttypename | - | The patient-friendly name for this appointment type. | String | 0..1 | Slot | identifier[*].value | system=patient-appointment-type-name | - | Top Level | |
| providerid | - | The athenaNet ID for the provider of the appointment. | Integer | 0..1 | Slot | identifier[*].value | system=provider-id | - | Top Level | |
| reasonid | - | A list of reason IDs that could be used for this slot. | Integer | 0..1 | Slot | appointmentType[1].code | - | Top Level | ||
| renderingproviderid | - | The rendering provider ID. | Integer | 0..1 | Slot | extension[*].valueInteger | - | rendering-provider-id | Top Level | |
| starttime | - | As HH:MM (where HH is the 0-23 hour and MM is the minute). This time is local to the department. | String | 0..1 | Slot | start | - | Top Level | ||
| validappointmenttypeids | - | A list of Appointment Type IDs that are valid to be booked in this slot. | Integer | 0..1 | Slot | extension[*].valueInteger | - | valid-appointment-type-ids | Top Level | |
| appointmentdate | - | The appointment date for the new open appointment slot (mm/dd/yyyy). | string | 0..1 | Slot | start | Top Level | |||
| appointmenttime | - | The time (hh24:mi) for the new appointment slot. Multiple times (either as a comma delimited list or multiple POSTed values) are allowed. 24 hour time. | array | 0..1 | Slot | start | Top Level | |||
| appointmenttypeid | - | The appointment type ID to be created. Either this or a reason must be provided. | integer | 0..1 | Slot | appointmentType.coding.code | Top Level | |||
| departmentid | - | The athenaNet department ID. | integer | 0..1 | context | Top Level | ||||
| providerid | - | The athenaNet provider ID. | integer | 0..1 | Slot | extension.valueInteger | provider-id | Top Level | ||
| reasonid | - | The appointment reason (/patientappointmentreasons) to be created. Either this or a raw appointment type ID must be provided. | integer | 0..1 | Slot | extension.valueInteger | reason-id | Top Level | ||
| freeze | - | If true, slot will be frozen, if false, slot will be unfrozen. | boolean | 0..1 | Slot | extension.valueBoolean | frozen | Top Level | ||
| requirescancellation | - | If true, appointment can be cancelled, if false, cannot cancel the appointment. | boolean | 0..1 | Slot | extension.valueBoolean | requires-cancellation | Top Level |