Sign in

v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
Schedule

List Schedules

Retrieves a collection of practitioner schedules in a practice group

get/main/Schedule

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

activeboolean

Whether the schedule is active

actorstring

The Resource that the Schedule is provided for

_include'Schedule:actor'

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

Schedule collection

activeboolean

Indicates whether this schedule is in active use

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

[
  {
    "active": true
  }
]