v1

latestOpenAPI 3.1.02026-07-2649128242.2 KB

ChargeItemDefinition

List ChargeItemDefinitions

Retrieves a list or collection of fees

get/main/ChargeItemDefinition

Query parameters

pageinteger

The collection page number

_countinteger

The number of items per page

paginationboolean

Enable or disable pagination

_idstring

The logical id of the resource

context-type'0' | '1' | '2'

Type of resource (fee type: 0=Appointment, 1=Item, 2=ProRata)

property-group-status'1' | '2'

Status of propertyGroup extension coding (fee pricing status: 1=current, 2=archived)

createdstring datetime

When the resource was created

titlestring

Title of the resource (fee name)

publisherstring

Publisher of the resource (funder name)

codestring

Resource code (fee item number)

_lastUpdatedstring datetime

Date the resource was last updated

Response

ChargeItemDefinition collection

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