Helix AU Core - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Get Slots Operation

$getSlots Operation (July 2025)

Overview

The $getSlots operation is a type-level custom operation in the Hub FHIR API designed to streamline appointment scheduling workflows.

• It allows partner systems to retrieve available appointment slots in a single, efficient call—eliminating the need to manually query and filter Slot resources.
• $getSlots operation is used to:
  • Check real-time availability of appointment slots.
  • reserve a slot for booking. -This operation is ideal for partner systems such as:
  • Referral platforms
  • Booking portals
  • Clinical dashboards

Usage Context

Simplifies Complex Queries: Instead of requiring clients to construct complex search queries on the Slot resource (e.g., filtering by time, practitioner, location, and status), $getSlots wraps this logic into a single, reusable operation.

Improves Performance: $getSlots can return only the most relevant slots, reducing the volume of data transferred and improving response times.

Enables Smart Scheduling: It can be extended to support intelligent filtering, such as:

• Showing slots only for providers with matching specialties.
• Excluding lunch breaks or administrative blocks.
• Returning grouped slots for multi-resource appointments.

Example Request

It returns a FHIR Bundle and Slotsresources for appointment booking.

GET/Slot/$getslots

Notes

• The slot time window (start to end) must not exceed 14 days.
• If no status is provided, the default behavior is to return only free slots.
• The operation can be invoked using either the GET or POST method.
• All date/time values must be in YYYY-MM-DDThh:mm:ssZformat.
  • Example: 2025-07-15T09:00:00Z