HAhalaxy
Slot

Get Slot

Changed on

Retrieves an individual time interval available for booking appointments

get/main/Slot/{id}

Request

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

Path parameters

idstring required

Slot identifier

Response

Slot resource

status'busy' | 'free' | 'busy-unavailable' | 'busy-tentative' | 'entered-in-error' required

busy | free | busy-unavailable | busy-tentative | entered-in-error

startstring date-time required

Date/Time that the slot is to begin

endstring date-time required

Date/Time that the slot is to conclude

overbookedboolean nullable

This slot has already been overbooked, appointments are unlikely to be accepted for this time

commentstring nullable

Comments on the slot to describe any extended information. Such as custom constraints on the slot

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

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/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/fhir+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 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)

    • 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)