API Reference

List Practitioners

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

Retrieves a collection of practitioner and administrator records within a practice group

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

The family, given or preferred name of the resource

string

The family portion of the name

string

The given portion of the name

string

A value in an email contact

boolean

Whether the practitioner is active

string
enum

The _profile parameter can be used to select different types of a resources.

Allowed:
string

Practitioner _lastUpdated

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