The resource includes details about the referring provider, the receiving provider (if any), the patient, referral date, expiry date, and any monetary or appointment limits. This resource is essential for tracking referral usage and coordinating patient care.
ℹ️In Halaxy, referrals are added to a claim in the Funding tab in the patient's profile. See: Guide to referrals
| Endpoint | Function | Description |
|---|
GET /main/Referral | List Referrals | Retrieves a list or collection of referral records of patients in a practice group |
GET /main/Referral/{id} | Get Referral | Retrieves an individual patient referral record of in a practice group |
POST /main/Referral | Create Referral | Creates a referral records for a patient |
PATCH /main/Referral/{id} | Update Referral | Updates specific fields in an existing referral |
Property | Description |
|---|
id | string
The identifier of this referral record
|
coverage | Reference(Coverage)
The claim details where this referral is or will be filed under. This refers to the patient's high-level identifiers for their health fund eligibility - such as membership card details. "reference": "/main/Coverage/{id}"
"type: "Coverage"
See also: Coverage |
period | The period when the referral is valid start date
end date |
performer | Reference(Practitioner)
The practitioner this referral is assigned to (i.e. this referral can only be used for appointments by this practitioner)
"reference": "/main/Practitioner/PR-{id}"
"type": "Practitioner"
|
requester | Reference(PractitionerRole)
The referring professional contact and their practice (i.e. the external practitioner referring the patient)
"reference": "/main/PractitionerRole/EP-{id}"\
"type": "PractitionerRole"
|
referralDefinition | string
The name of the referral type used
See article: Guide to referral types |
created | date-time
The date and time when the referral record was created
|
priority | boolean
Indicates if this referral is the patient's preferred referral for this funder
If true, the next created appointment with a fee linked to the funder automatically uses this referral. If false, the most recently created referral is automatically used. |
active | boolean
Indicates if this referral is an active and valid referral
|
limitQuantity | quantity
The amount of time covered by the referral (e.g. 6 appointments) quantityOffset integer
The number of prior units used to include in this referral (In Halaxy, this is the amount set in Add Prior Appointments / Hours / Minutes) quantityUsed integer
The number of units used in Halaxy appointments |
limitMoney | amount
The monetary value covered by the referral
value: number
currency: string - use ISO 4217 currency code (e.g. AUD) amountUsed number
The amount of the monetary value used in the referral allocationType string
Specifies whether the referral amount is applied to appointment fees only or to all fee types
Appointments only or All fee types |
subject | Reference(Patient)
The patient for whom this referral is for
"reference": "/main/Patient/{id}"
"type": "Patient"
See also: Patient |
includeCancelledAppointment | boolean
Indicates whether cancelled appointments are included the referral
If true, cancelled appointments are deducted from the appointment / time / monetary limit in the referral. If false, cancelled appointments are not counted towards appointment / time / monetary limits in the referral. |
comment | string
Any notes to add to the referral
|
expiryType | string Medicare/DVA referrals only
Type of referral expiry
standard non-standard indefinite |
attachments | array of strings
File attachments to the referral (POST only)
contentType enum required
The format of the file attachment
Supported formats:
application/msword | application/vnd.ms-excel | application/vnd.openxmlformats-officedocument.wordprocessingml.document | application/vnd.openxmlformats-officedocument.spreadsheetml.sheet | application/pdf | image/jpeg | image/png data required
Must be encoded to base64
Maximum file size: 200MB title string required
The file name |
