API Reference

List Patients

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

Retrieves a list or collection of patient records

Query Params
integer
Defaults to 1

The collection page number

integer
≥ 0
Defaults to 30

The number of items per page

boolean

Enable or disable pagination

_summary[]
array of strings
_summary[]
string

The logical id of the resource

string

search by family, given or preferred name

string

A portion of the family name of the patient

string

A portion of the given name of the patient

string

A value in an email contact

string

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

string

The status of a patient

string

The last updated date of the patient

date

The birthdate of the patient

string

The date of creation of the patient

string

The Practitioner or Clinic that has a relationship with the patient

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

Updated 10 months ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/fhir+json
application/json

Updated 10 months ago