HAhalaxy
Referral

Create Referral

Changed on

Creates a new Referral record

post/main/Referral

Request

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

Request body

createdstring date-time nullable

Date when the referral was created

priorityboolean nullable

If true, appointments with fees using the same funder automatically apply this referral. If false (or null), the most recently created referral is applied instead

activeboolean nullable

Indicates if this referral is an active and valid referral

includeCancelledAppointmentboolean nullable

Indicates whether the referral is also applied to cancelled appointments

commentstring nullable

Notes added to the referral

expiryType'standard' | 'non-standard' | 'indefinite' | 'null' nullable

Type of referral expiry - Medicare and DVA referrals only

containedFhirResourceInterfaceJsonfhir[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example request

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

Response

Referral resource created

createdstring date-time nullable

Date when the referral was created

priorityboolean nullable

If true, appointments with fees using the same funder automatically apply this referral. If false (or null), the most recently created referral is applied instead

activeboolean nullable

Indicates if this referral is an active and valid referral

includeCancelledAppointmentboolean nullable

Indicates whether the referral is also applied to cancelled appointments

commentstring nullable

Notes added to the referral

expiryType'standard' | 'non-standard' | 'indefinite' | 'null' nullable

Type of referral expiry - Medicare and DVA referrals only

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

The identifier of this referral record

resourceTypestring nullable

Resource Type

Example response

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

Changes

  • 1a14a579daecRevision changes
    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (media type: application/json)

    • warning

      removed the request property // (media type: application/fhir+json)

    • warning

      removed the request property // (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

      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 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 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 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 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)

    • 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)

    • 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)

    • 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)

    • 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)

    • warning

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

    • warning

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      added the new image/gif enum value to the request property // (media type: application/fhir+json)

    • info

      added the new image/gif enum value to the request property // (media type: application/json)