ChargeItemDefinition
The ChargeItemDefinition resource provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.
Endpoints
alpha
https://api.dev.ovok.com/fhir/R4/ChargeItemDefinition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R4/ChargeItemDefinition/[id] |
| Vread | GET | /fhir/R4/ChargeItemDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R4/ChargeItemDefinition/[id] |
| Patch | PATCH | /fhir/R4/ChargeItemDefinition/[id] |
| Delete | DELETE | /fhir/R4/ChargeItemDefinition/[id] |
| Create | POST | /fhir/R4/ChargeItemDefinition |
| Search | GET | /fhir/R4/ChargeItemDefinition |
| History | GET | /fhir/R4/ChargeItemDefinition/[id]/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 1..1 | Canonical identifier for this charge item definition, represented as a URI (globally unique) |
identifier | Identifier | 0..* | Additional identifier for the charge item definition |
version | string | 0..1 | Business version of the charge item definition |
title | string | 0..1 | Name for this charge item definition (human friendly) |
derivedFromUri | uri | 0..* | Underlying externally-defined charge item definition |
partOf | canonical | 0..* | A larger definition of which this particular definition is a component or step |
replaces | canonical | 0..* | Completed or terminated request(s) whose function is taken by this new request |
status | code | 1..1 | draft | active | retired | unknown modifier |
experimental | boolean | 0..1 | For testing purposes, not real usage |
date | dateTime | 0..1 | Date last changed |
publisher | string | 0..1 | Name of the publisher (organization or individual) |
contact | ContactDetail | 0..* | Contact details for the publisher |
description | markdown | 0..1 | Natural language description of the charge item definition |
useContext | UsageContext | 0..* | The context that the content is intended to support |
jurisdiction | CodeableConcept | 0..* | Intended jurisdiction for charge item definition (if applicable) |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
approvalDate | date | 0..1 | When the charge item definition was approved by publisher |
lastReviewDate | date | 0..1 | When the charge item definition was last reviewed |
effectivePeriod | Period | 0..1 | When the charge item definition is expected to be used |
code | CodeableConcept | 0..1 | Billing codes or product types this definition applies to |
instance | Reference | 0..* | Instances this definition applies to |
applicability | BackboneElement | 0..* | Whether or not the billing code is applicable |
propertyGroup | BackboneElement | 0..* | Group of properties which are applicable under the same conditions |
Resource-specific search parameters
Reference
- Official FHIR R4 spec:
ChargeItemDefinition - Maturity: Draft (FMM 0).