Sign in

v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB
ReferralDefinition

List ReferralDefinitions

Retrieves a collection of referral type definitions for a practice group

get/main/ReferralDefinition

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

ID of the referral definition

fundingOrganizationstring

Funder ID

Response

ReferralDefinition collection

namestring nullable

Name of the referral definition

lengthstring nullable

Length/duration of the referral definition

includeCancelledAppointmentboolean nullable

Include cancelled appointments in the referral count/value tracking

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

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