v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB

Referral

Get Referral

Retrieves an individual referral record

get/main/Referral/{id}

Path parameters

idstring required

Referral identifier

Response

Referral resource

createdstring date-time nullable

Date when the referral was created

priorityboolean nullable

If true, appointments with fees using the same funder automatically apply this referral. If false (or null), the most recently created referral is applied instead

activeboolean nullable

Indicates if this referral is an active and valid referral

includeCancelledAppointmentboolean nullable

Indicates whether the referral is also applied to cancelled appointments

commentstring nullable

Notes added to the referral

expiryType'standard' | 'non-standard' | 'indefinite' | 'null' nullable

Type of referral expiry - Medicare and DVA referrals only

idstring nullable

The identifier of this referral record

resourceTypestring nullable

Resource Type

Example response

{
  "limitQuantity": {
    "quantity": {
      "system": "http://unitsofmeasure.org"
    }
  }
}