Create Schedule

post

https://au-api.halaxy.com/main/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.

Body Params

active

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*

reference

string

required

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

type

string | null

enum

The type of resource being referenced

meta

Metadata about the resource

resourceType

string | null

Resource Type

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

400

Invalid input

422

Unprocessable entity

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

application/json

201Schedule resource created