v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB

ChargeItemDefinition

Get ChargeItemDefinition

Retrieves an individual fee

get/main/ChargeItemDefinition/{id}

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

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"
        }
      }
    }
  ]
}