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
dev
https://api.sandbox.ovok.com/fhir/R5/ChargeItemDefinition| Interaction | Method | Path |
|---|---|---|
| Read | GET | /fhir/R5/ChargeItemDefinition/[id] |
| Vread | GET | /fhir/R5/ChargeItemDefinition/[id]/_history/[vid] |
| Update | PUT | /fhir/R5/ChargeItemDefinition/[id] |
| Patch | PATCH | /fhir/R5/ChargeItemDefinition/[id] |
| Delete | DELETE | /fhir/R5/ChargeItemDefinition/[id] |
| Create | POST | /fhir/R5/ChargeItemDefinition |
| Search | GET | /fhir/R5/ChargeItemDefinition?... |
| History | GET | /fhir/R5/ChargeItemDefinition/[id]/_history |
| Type-history | GET | /fhir/R5/ChargeItemDefinition/_history |
Top-level elements
| Element | Type(s) | Cardinality | Description |
|---|---|---|---|
url | uri | 0..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 |
versionAlgorithm[x] | string / Coding | 0..1 | How to compare versions |
name | string | 0..1 | Name for this charge item definition (computer friendly) |
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 |
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/steward (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) |
purpose | markdown | 0..1 | Why this charge item definition is defined |
copyright | markdown | 0..1 | Use and/or publishing restrictions |
copyrightLabel | string | 0..1 | Copyright holder and year(s) |
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 by the publisher |
code | CodeableConcept | 0..1 | Billing code or product type 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
| Parameter | Type | Description |
|---|---|---|
context | token | A use context assigned to the activity definition |
context-quantity | quantity | A quantity- or range-valued use context assigned to the activity definition |
context-type | token | A type of use context assigned to the activity definition |
context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the activity definition |
context-type-value | composite | A use context type and value assigned to the activity definition |
date | date | The activity definition publication date |
description | string | The description of the activity definition |
effective | date | The time during which the activity definition is intended to be in use |
identifier | token | External identifier for the activity definition |
jurisdiction | token | Intended jurisdiction for the activity definition |
publisher | string | Name of the publisher of the activity definition |
status | token | The current status of the activity definition |
title | string | The human-friendly name of the activity definition |
url | uri | The uri that identifies the activity definition |
version | token | The business version of the activity definition |
Reference
- Official FHIR R5 spec:
ChargeItemDefinition - Maturity: Trial Use 1 (FMM 1).