List Patients

get

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

Retrieves a list or collection of patient records

💡
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

_summary[]

array of strings

_summary[]

Allowed:

_id

string

The logical id of the resource

name

string

search by family, given or preferred name

family

string

A portion of the family name of the patient

given

string

A portion of the given name of the patient

string

A value in an email contact

phone

string

A value in a phone contact. Supports local and international (E.164) format. Includes contact phone numbers.

status

string

The status of a patient

_lastUpdated

string

The last updated date of the patient

birthdate

date

The birthdate of the patient

created

string

The date of creation of the patient

general-practitioner

string

The Practitioner or Clinic that has a relationship with the patient

_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

Tip

Parameters

200Patient collection