Schedule & Availability
Definition
A schedule in Care records when a resource can be booked at a facility. The resource is a practitioner, a location, or a healthcare service. Each schedule holds one or more availability sessions. A session states the days of the week, the start time and the end time when the resource is available.
Care creates bookable slots from the schedule. Staff and patients book appointments against these slots.
Key Attributes
| Components | What it captures |
|---|---|
| Template Name | The name of the schedule template. This is required. |
| Valid From | The first date that the schedule applies. This is required. |
| Valid Till | The last date that the schedule applies. This is required. |
| Resource | The practitioner, location, or healthcare service that the schedule belongs to. |
| Availability sessions | One or more sessions. Each session holds a session title, a slot type, the days of the week, a start time and an end time. |
| Public | Whether patients can see the schedule and book against it. A private schedule shows the message "This schedule is private". |
Resource types
A schedule belongs to one of these resource types:
| Resource type | What it schedules |
|---|---|
| Practitioner | A user, for example a doctor or a nurse. |
| Location | A place inside the facility, for example a consultation room. |
| Healthcare Service | A service that the facility offers. |
A facility holds only one schedulable resource for each practitioner, each location, and each healthcare service.
Availability sessions
Each session in a schedule holds these values:
| Component | What it captures |
|---|---|
| Session Title | The name of the session, for example "IP Rounds". This is required. |
| Slot type | Appointment Slot, Open, or Closed. This is required. |
| Days of the week | The days that the session repeats. You select at least one day. |
| Start time and end time | The time range of the session on each selected day. The start time must be earlier than the end time. |
| Slot size in minutes | The length of one slot. This is required for an appointment slot. |
| Tokens per slot | The number of patients that Care books into one slot. This is required for an appointment slot. |
| Reason | Free text that explains the session. This is optional. |
Slot types
| Slot type | What it means |
|---|---|
| Appointment Slot | Care divides the session into slots of a fixed size. Patients book a specific slot. |
| Open | The resource is available for the whole session, and Care does not divide the session into slots. |
| Closed | The resource is not available for booking during the session. |
Validation rules
- The Valid From date must not be in the past.
- The Valid From date must not be later than the Valid Till date.
- The start time of a session must be earlier than its end time.
- Sessions in a schedule must not overlap.
- For an appointment slot, the length of the session must be a multiple of the slot size in minutes.
- For an appointment slot, the number of slots in one session must not be more than the limit that your deployment sets.
Permissions
| Permission | What it allows |
|---|---|
| Can Create on Schedule | Create and change schedules and their sessions. |
| Can list schedule on Object | See the schedules of a resource. |
Configuration
The maximum number of slots in one availability session depends on your deployment's configuration.
Related
- Flow: Create a schedule template
- Flow: View schedule templates
- Flow: Edit a schedule template
- Flow: Delete a schedule template