HAhalaxy
Appointment

List Appointments

Changed on

Retrieves a collection of appointments

get/main/Appointment

Request

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

Logical id of this artifact.

datestring datetime

Appointment date/time.

_lastUpdatedstring datetime

When the resource last changed.

createdstring datetime

When the resource was created.

part-statusstring

The Participation status of the patient.

patientstring

An individual patient within an appointment

practitionerstring

An individual practitioner assigned to an appointment

practitioner-rolestring

An individual practitioner role assigned to an appointment

organizationstring

The clinic (Organization) at which the appointment takes place. Pass the Organization's ID including its prefix, e.g. CL-100 for clinic ID 100.

_include'Appointment:patient' | 'Appointment:practitioner-role' | 'PractitionerRole:practitioner' | 'PractitionerRole:organization'

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.
_sort'date' | '-date'

Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.

Response

Appointment collection

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

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

    • warning

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

    • info

      added the new optional query request parameter organization