HAhalaxy
ReferralDefinition

Get ReferralDefinition

Changed on

Retrieves an individual referral type definition

get/main/ReferralDefinition/{id}

Request

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

Path parameters

idstring required

ReferralDefinition identifier

Response

ReferralDefinition resource

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/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/fhir+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)