API Reference

List Referrals

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

Retrieves a collection of referral records for patients in 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

string

ID of the referral

string

Patient who is the subject of the referral

string

Reference to the coverage for the referral. In Halaxy a Coverage record relates to the Claim details in the UI

string

Date the referral was last updated.

string

Date the referral was created.

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