Update Referral

patch

https://au-api.halaxy.com/main/Referral/{id}

Updates specific fields in an existing referral

🖊️
Note
This PATCH request currently only supports adding a new file attachment to an existing referral. This does not delete or replace any previous file attachments. This does not include editing other properties in referrals.

Parameters

Path Params

string

required

Referral identifier

Body Params

A Referral.

coverage

FhirReference | null

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

period

FhirPeriodDate | null

Period when the referral is valid

performer

FhirReference | null

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

requester

FhirReference | null

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

referralDefinition

FhirReference | null

The name of the referral type used

created

date-time | null

Date when the referral was created

active

boolean | null

Indicates if this referral is an active and valid referral

limitQuantity

LimitQuantity | null

Limit on the quantity of services

limitMoney

LimitMoney | null

Limit on the monetary value of services

subject

FhirReference | null

The URL reference to the patient whom this referral is for

includeCancelledAppointment

boolean | null

Indicates whether the referral is also applied to cancelled appointments

comment

string | null

Notes added to the referral

attachments

array of objects

File attachments to the referral

attachments

Note

Parameters

200Referral resource updated