---
title: "List ReferralDefinitions"
method: GET
path: "/main/ReferralDefinition"
tags: ["ReferralDefinition"]
---

# List ReferralDefinitions

`GET /main/ReferralDefinition`

Retrieves a collection of referral type definitions for a practice group

## Query parameters

- `page` integer
- `_count` integer
- `pagination` boolean
- `_id` string
- `fundingOrganization` string

## Response `200`

ReferralDefinition collection

- ReferralDefinition[]
  - `name` string, nullable — Name of the referral definition
  - `length` string, nullable — Length/duration of the referral definition
  - `fundingOrganization` FhirReference
    - `reference` string, required — The URL (relative or absolute) to the resource being referenced
    - `type` 'Organization' | 'Patient' | 'Practitioner' | 'PractitionerRole' | 'Appointment' | 'Coverage' | 'Invoice' | 'Communication' | 'Group' | 'DocumentReference' | 'InvoiceLine' | 'PaymentTransaction' | 'Referral' | 'ReferralDefinition' | 'Schedule' | 'Slot' | 'HealthcareService' | 'AllergyIntolerance' | 'Condition' | 'Immunization' | 'Subscription' | 'SubscriptionTopic' | 'ChargeItemDefinition' | 'ServiceRequest' | 'Medication' | 'MedicationRequest' | 'Questionnaire' | 'QuestionnaireResponse' | 'Observation' | 'Binary' | 'Bundle' | 'OperationOutcome' | 'Parameters' | 'List' | 'null', nullable — The type of resource being referenced
    - `id` string, nullable — ID of the FHIR element (optional)
  - `limitQuantity` LimitQuantity
    - `quantity` FhirQuantity
      - `value` integer
      - `comparator` string, nullable
      - `unit` string, nullable
      - `system` string
      - `id` string, nullable — ID of the FHIR element (optional)
    - `quantityOffset` integer — The number of prior units used to include in this referral
    - `quantityUsed` integer — The value and unit of the amount of time used in Halaxy appointments (e.g. 6 appointments, 1 hour, 30 minutes)
    - `id` string, nullable — ID of the FHIR element (optional)
  - `limitMoney` LimitMoney
    - `amount` FhirMoney
      - `value` number, nullable — The numerical value of the amount
      - `currency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'FOK' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KID' | 'KMF' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XTS' | 'XUA' | 'XXX' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL' | 'null', nullable — The currency used in ISO 4217 currency code
      - `id` string, nullable — ID of the FHIR element (optional)
    - `allocationType` 'Appointments only' | 'All fee types' | 'null', nullable — Specifies whether the referral amount is applied to appointment fees only or to all fee types
    - `amountUsed` number, nullable — The amount of the monetary value used in the referral
    - `id` string, nullable — ID of the FHIR element (optional)
  - `includeCancelledAppointment` boolean, nullable — Include cancelled appointments in the referral count/value tracking
  - `text` FhirNarrative
    - `status` 'generated' | 'extensions' | 'additional' | 'empty' — Describes how the narrative was generated
    - `div` string — Limited xhtml content
    - `id` string, nullable — ID of the FHIR element (optional)
  - `contained` AbstractFhirResource[] — Contained, inline Resources
    - `id` string, nullable — Logical id of this artifact
    - `meta` FhirResourceMeta
      - `lastUpdated` string, date-time, nullable — When the resource version last changed
      - `profile` string[] — Profiles this resource claims to conform to
    - `resourceType` string, nullable — Resource Type
  - `id` string, nullable — Logical id of this artifact
  - `meta` FhirResourceMeta
    - `lastUpdated` string, date-time, nullable — When the resource version last changed
    - `profile` string[] — Profiles this resource claims to conform to
  - `resourceType` string, nullable — Resource Type

## Other responses

- `403` — Forbidden

---

[API](https://skmtc.dev/halaxy/apis/halaxy-api.md) · [All operations](https://skmtc.dev/halaxy/apis/halaxy-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/halaxy/halaxy-api/revisions/d72139daaa89/schema)