Sign in

v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
Referral

List Referrals

Retrieves a collection of referral records for patients in a practice group

get/main/Referral

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

ID of the referral

subjectstring

Patient who is the subject of the referral

coveragestring

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

_lastUpdatedstring datetime

Date the referral was last updated.

createdstring datetime

Date the referral was created.

_include'Referral:subject' | 'Referral:coverage'

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.
_sort'_lastUpdated' | 'created' | '-_lastUpdated' | '-created'

Each item in the comma-separated list is a search parameter, optionally with a ' - ' prefix. The prefix indicates decreasing order; in its absence, the parameter is applied in increasing order.

Response

Referral collection

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"
      }
    }
  }
]