HAhalaxy
Schedule

List Schedules

Changed on

Retrieves a collection of practitioner schedules in a practice group

get/main/Schedule

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/Schedule
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

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

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

[
  {
    "active": true
  }
]

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the /// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the /// response property for the response status (media type: application/json)