Referral Definition

ℹ️
In Halaxy, referral types are used as a template for frequently used referrals. See: Guide to referral types

Endpoints

Endpoint	Function	Description
`GET` `/main/ReferralDefinition`	List Referral Definitions	Retrieves a list or collection of referral types of the practice group
`GET` `/main/ReferralDefinition/`{id}	Get Referral Definition	Retrieves an individual referral type in a practice group

Property	Description
`id`	`string` The identifier of this referral type
`name`	`string` The name of the referral type
`length`	`string` Length/duration of the referral type
`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`
`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.
`fundingOrganization`	`string` The identifier of the funder