HAhalaxy
ReferralDefinition

List ReferralDefinitions

Changed on

Retrieves a collection of referral type definitions for a practice group

get/main/ReferralDefinition

Request

  • Base URL
    https://au-api.halaxy.com
  • URL
    https://au-api.halaxy.com/main/ReferralDefinition
  • Auth
    OAuth 2
    Client credentials
    Token URL: /main/oauth/token

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

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

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

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property ////// from the response with the status (media type: application/fhir+json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      removed the optional property /// from the response with the status (media type: application/json)

    • warning

      added the new ValueSet enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSet enum value to the ////// response property for the response status (media type: application/json)

    • warning

      added the new ValueSetConcept enum value to the ///////// response property for the response status (media type: application/fhir+json)

    • warning

      added the new ValueSetConcept enum value to the ////// response property for the response status (media type: application/json)