HAhalaxy
ChargeItemDefinition

Get ChargeItemDefinition

Changed on

Retrieves an individual fee

get/main/ChargeItemDefinition/{id}

Request

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

Path parameters

idstring required

ChargeItemDefinition identifier

Response

ChargeItemDefinition resource

titlestring nullable

The name of the fee (e.g. Short Consultation)

status'draft' | 'active' | 'retired' | 'unknown' | 'null' nullable

The status of the fee - active if propertyGroup is current, retired if propertyGroup is archived, unknown if fee has multiple records of propertyGroup

publisherstring nullable

The name of the funder of this fee

datestring date-time nullable

The date when the fee was last modified

containedFhirResourceInterface[]

Contained, inline Resources

idstring nullable

Logical id of this artifact

resourceTypestring nullable

Resource Type

Example response

{
  "status": "unknown",
  "useContext": [
    {
      "valueQuantity": {
        "system": "http://unitsofmeasure.org"
      },
      "valueRange": {
        "low": {
          "system": "http://unitsofmeasure.org"
        },
        "high": {
          "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)