Sign in

v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
Slot

List Slots

Retrieves a collection of time intervals that are available for booking appointments

get/main/Slot

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

The logical id of the resource

durationstring

The duration of the slot

statusstring

The free/busy status of the appointment

practitionerstring

The practitioner available for the slot

organizationstring

The Organization the slot if apart of the Slot

practitioner-rolestring

The PractitionerRole that is apart of the Slot

startstring datetime

The Appointment start date/time.

endstring datetime

The Appointment end date/time.

schedulestring

The schedule the slot is a part of

_include'Slot:practitioner' | 'Slot:organization' | 'Slot:practitioner-role'

The _include parameter can be used to include related search results to reduce overall network delay of repeated retrievals of related resources.

Modifiers

  • _include:iterate = can be used to include related resources based on already included resources.

Response

Slot collection

status'busy' | 'free' | 'busy-unavailable' | 'busy-tentative' | 'entered-in-error' required

busy | free | busy-unavailable | busy-tentative | entered-in-error

startstring date-time required

Date/Time that the slot is to begin

endstring date-time required

Date/Time that the slot is to conclude

overbookedboolean nullable

This slot has already been overbooked, appointments are unlikely to be accepted for this time

commentstring nullable

Comments on the slot to describe any extended information. Such as custom constraints on the slot

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type