Create Schedule

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.

When this operation is used, the generated time period accounts for both temporary schedules and online booking preferences (e.g. advanced booking limits).

🚧

Prerequisite

To use this endpoint, practitioners must already have their practice hours set up at each location they practice in. See article: Add or change practice hours


Parameters

Body Params

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.

boolean
Defaults to true

Indicates whether this schedule is in active use

actor
array of objects
required
length between 1 and 1

References to the practitioner identifiers that this schedule is for, including Practitioner (identifier within practice group), PractitionerRole (identifier within clinic), Organization (clinic ID)

actor*
string
required

The URL (relative or absolute) to the resource being referenced

string | null
enum

The type of resource being referenced

FhirResourceMeta.jsonfhir | null

Metadata about the resource

string | null

Resource Type

Headers
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

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