# ChargeItemDefinition

Canonical page: https://docs.ovok.com/api/fhir/r4/charge-item-definition

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.

These interaction paths describe standard FHIR R4 patterns. Availability can depend on the API capabilities enabled for your Ovok project.

| **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 [#top-level-elements]

| **Element** | **Type** | **Cardinality** | **Description** |
| --- | --- | --- | --- |
| <span id="element-id"></span>`id` | [string](/fhir-elements/primitive/string) | `0..1` | Logical id of this artifact |
| <span id="element-meta"></span>`meta` | [Meta](/fhir-elements/complex/meta) | `0..1` | Metadata about the resource |
| <span id="element-implicit-rules"></span>`implicitRules` | [uri](/fhir-elements/primitive/uri) | `0..1` | A set of rules under which this content was created |
| <span id="element-language"></span>`language` | [code](/fhir-elements/primitive/code) | `0..1` | Language of the resource content |
| <span id="element-text"></span>`text` | [Narrative](/fhir-elements/complex/narrative) | `0..1` | Text summary of the resource, for human interpretation |
| <span id="element-contained"></span>`contained` | [Resource](/fhir-elements/foundation/resource) | `0..*` | Contained, inline Resources |
| <span id="element-extension"></span>`extension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Additional content defined by implementations |
| <span id="element-modifier-extension"></span>`modifierExtension` | [Extension](/fhir-elements/complex/extension) | `0..*` | Extensions that cannot be ignored |
| <span id="element-url"></span>`url` | [uri](/fhir-elements/primitive/uri) | `1..1` | Canonical identifier for this charge item definition, represented as a URI (globally unique) |
| <span id="element-identifier"></span>`identifier` | [Identifier](/fhir-elements/complex/identifier) | `0..*` | Additional identifier for the charge item definition |
| <span id="element-version"></span>`version` | [string](/fhir-elements/primitive/string) | `0..1` | Business version of the charge item definition |
| <span id="element-title"></span>`title` | [string](/fhir-elements/primitive/string) | `0..1` | Name for this charge item definition (human friendly) |
| <span id="element-derived-from-uri"></span>`derivedFromUri` | [uri](/fhir-elements/primitive/uri) | `0..*` | Underlying externally-defined charge item definition |
| <span id="element-part-of"></span>`partOf` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | A larger definition of which this particular definition is a component or step |
| <span id="element-replaces"></span>`replaces` | [canonical](/fhir-elements/primitive/canonical) | `0..*` | Completed or terminated request(s) whose function is taken by this new request |
| <span id="element-status"></span>`status` | [code](/fhir-elements/primitive/code) | `1..1` | draft \| active \| retired \| unknown |
| <span id="element-experimental"></span>`experimental` | [boolean](/fhir-elements/primitive/boolean) | `0..1` | For testing purposes, not real usage |
| <span id="element-date"></span>`date` | [dateTime](/fhir-elements/primitive/date-time) | `0..1` | Date last changed |
| <span id="element-publisher"></span>`publisher` | [string](/fhir-elements/primitive/string) | `0..1` | Name of the publisher (organization or individual) |
| <span id="element-contact"></span>`contact` | [ContactDetail](/fhir-elements/complex/contact-detail) | `0..*` | Contact details for the publisher |
| <span id="element-description"></span>`description` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Natural language description of the charge item definition |
| <span id="element-use-context"></span>`useContext` | [UsageContext](/fhir-elements/complex/usage-context) | `0..*` | The context that the content is intended to support |
| <span id="element-jurisdiction"></span>`jurisdiction` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..*` | Intended jurisdiction for charge item definition (if applicable) |
| <span id="element-copyright"></span>`copyright` | [markdown](/fhir-elements/primitive/markdown) | `0..1` | Use and/or publishing restrictions |
| <span id="element-approval-date"></span>`approvalDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the charge item definition was approved by publisher |
| <span id="element-last-review-date"></span>`lastReviewDate` | [date](/fhir-elements/primitive/date) | `0..1` | When the charge item definition was last reviewed |
| <span id="element-effective-period"></span>`effectivePeriod` | [Period](/fhir-elements/complex/period) | `0..1` | When the charge item definition is expected to be used |
| <span id="element-code"></span>`code` | [CodeableConcept](/fhir-elements/complex/codeable-concept) | `0..1` | Billing codes or product types this definition applies to |
| <span id="element-instance"></span>`instance` | [Reference](/fhir-elements/complex/reference) | `0..*` | Instances this definition applies to |
| <span id="element-applicability"></span>`applicability` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Whether or not the billing code is applicable |
| <span id="element-property-group"></span>`propertyGroup` | [BackboneElement](/fhir-elements/complex/backbone-element) | `0..*` | Group of properties which are applicable under the same conditions |

## Resource-specific search parameters [#resource-specific-search-parameters]

| **Parameter** | **Type** | **Description** |
| --- | --- | --- |
| `context` | token | A use context assigned to the charge item definition |
| `context-quantity` | quantity | A quantity- or range-valued use context assigned to the charge item definition |
| `context-type` | token | A type of use context assigned to the charge item definition |
| `context-type-quantity` | composite | A use context type and quantity- or range-based value assigned to the charge item definition |
| `context-type-value` | composite | A use context type and value assigned to the charge item definition |
| `date` | date | The charge item definition publication date |
| `description` | string | The description of the charge item definition |
| `effective` | date | The time during which the charge item definition is intended to be in use |
| `identifier` | token | External identifier for the charge item definition |
| `jurisdiction` | token | Intended jurisdiction for the charge item definition |
| `publisher` | string | Name of the publisher of the charge item definition |
| `status` | token | The current status of the charge item definition |
| `title` | string | The human-friendly name of the charge item definition |
| `url` | uri | The uri that identifies the charge item definition |
| `version` | token | The business version of the charge item definition |

## Reference [#reference]

Official FHIR R4 spec: [ChargeItemDefinition](https://hl7.org/fhir/R4/chargeitemdefinition.html).  
Maturity: Draft (FMM 0).
