Appointment

Get Appointment

Changed on

Retrieves an individual appointment

get/main/Appointment/{id}

Request

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

Path parameters

idstring required

Appointment identifier

Response

Request successful

descriptionstring nullable

The appointment comments

startstring date-time

When appointment is to take place

endstring date-time

When appointment is to conclude

minutesDurationinteger

The duration of the appointment in minutes

createdstring date-time nullable

The date that this appointment was initially created

commentstring nullable

Additional comments

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

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

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