API Reference

Create Referral

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

Creates a new Referral record

Body Params
coverage

The URL reference to the coverage (i.e. claim details) where this referral is or will be filed under

period

Period when the referral is valid

performer

The URL reference to the practitioner that this referral is assigned to, wherein the ID includes the prefix PR-

requester

The URL reference to the referring external practitioner/clinic (PractitionerRole), wherein the ID includes the prefix EP-

referralDefinition

The name of the referral type used

date-time | null

Date when the referral was created

boolean | null

Indicates if this referral is an active and valid referral

limitQuantity

Limit on the quantity of services

limitMoney

Limit on the monetary value of services

subject

The URL reference to the patient whom this referral is for

boolean | null

Indicates whether the referral is also applied to cancelled appointments

string | null

Notes added to the referral

attachments
array of objects

File attachments to the referral

attachments
meta

Metadata about the resource

string | null

Resource Type

Headers
string
enum
Defaults to application/fhir+json

Generated from available response content types

Allowed:
Responses

400

Invalid input

403

Forbidden

422

Unprocessable entity

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