Generate Schedule Slots

The $generate operation populates the Slots for a Schedule. It will use the online booking preferences to ensure that the available times adhere to buffer time, lead time and advance booking limit.

Path Params
string
required

Schedule identifier

Body Params

The new Schedule resource

Schedule resources provide a container for time-slots that can be booked using an appointment. It provides the window of time (period) that slots are defined for and what type of appointments can be booked. The schedule does not provide any information about actual appointments. This separation greatly assists where access to the appointments would not be permitted for security or privacy reasons, while still being able to determine if an appointment might be available.

FhirPeriodDateTime.jsonfhir | null

The period to generate slots with the Schedules planning horizon. Start and End must be at least 24 hours apart. Leave blank to re-generate to entire planning horizon

boolean | null

Pass true to update the planning horizon. Default is false.

Headers
string
enum

Specifies whether the response is immediate or asynchronous. Setting this to respond-async triggers the async pattern.

Allowed:
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
string
enum
Defaults to application/fhir+json

Generated from available request content types

Allowed:
Responses

400

Invalid input

403

Forbidden

422

Unprocessable entity

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json
application/json