List Appointments

get

https://au-api.halaxy.com/main/Appointment

Retrieves a collection of appointments

💡
Tip
Explore our Querying Resources guide for helpful tips on filtering requests and retrieving the exact data you need.

Parameters

Query Params

page

integer

Defaults to 1

The collection page number

_count

integer

≥ 0

Defaults to 30

The number of items per page

pagination

boolean

Enable or disable pagination

_id

string

Logical id of this artifact.

date

string

Appointment date/time.

_lastUpdated

string

When the resource last changed.

created

string

When the resource was created.

part-status

string

The Participation status of the patient.

patient

string

An individual patient within an appointment

practitioner

string

An individual practitioner assigned to an appointment

practitioner-role

string

An individual practitioner role assigned to an appointment

_include

string

enum

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.

Allowed:

_sort

string

enum

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.

Allowed:

Headers

string

enum

Defaults to application/fhir+json

Generated from available response content types

Allowed:

Responses

403

Forbidden

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/fhir+json

application/json

Tip

Parameters

200Appointment collection