ChargeItemDefinition
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.
Properties
| Name | Required | Type | Description |
|---|---|---|---|
| url | Yes | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) |
| identifier | No | Identifier[] | Additional identifier for the charge item definition |
| version | No | string | Business version of the charge item definition |
| title | No | string | Name for this charge item definition (human friendly) |
| derivedFromUri | No | uri[] | Underlying externally-defined charge item definition |
| partOf | No | canonical[] | A larger definition of which this particular definition is a component or step |
| replaces | No | canonical[] | Completed or terminated request(s) whose function is taken by this new request |
| status | Yes | code | draft / active / retired / unknown |
| experimental | No | boolean | For testing purposes, not real usage |
| date | No | dateTime | Date last changed |
| publisher | No | string | Name of the publisher (organization or individual) |
| contact | No | ContactDetail[] | Contact details for the publisher |
| description | No | markdown | Natural language description of the charge item definition |
| useContext | No | UsageContext[] | The context that the content is intended to support |
| jurisdiction | No | CodeableConcept[] | Intended jurisdiction for charge item definition (if applicable) |
| copyright | No | markdown | Use and/or publishing restrictions |
| approvalDate | No | date | When the charge item definition was approved by publisher |
| lastReviewDate | No | date | When the charge item definition was last reviewed |
| effectivePeriod | No | Period | When the charge item definition is expected to be used |
| code | No | CodeableConcept | Billing codes or product types this definition applies to |
| instance | No | Reference<Medication / Substance / Device>[] | Instances this definition applies to |
| applicability | No | ChargeItemDefinitionApplicability | Whether or not the billing code is applicable |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - description | No | string | Natural language description of the condition |
| - language | No | string | Language of the expression |
| - expression | No | string | Boolean-valued expression |
| propertyGroup | No | ChargeItemDefinitionPropertyGroup | Group of properties which are applicable under the same conditions |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - applicability | No | [] | Conditions under which the priceComponent is applicable |
| - priceComponent | No | ChargeItemDefinitionPropertyGroupPriceComponent | Components of total line item price |
| - id | No | string | Unique id for inter-element referencing |
| - extension | No | Extension[] | Additional content defined by implementations |
| - modifierExtension | No | Extension[] | Extensions that cannot be ignored even if unrecognized |
| - type | Yes | code | base / surcharge / deduction / discount / tax / informational |
| - code | No | CodeableConcept | Code identifying the specific component |
| - factor | No | decimal | Factor used for calculating this component |
| - amount | No | Money | Monetary amount associated with this component |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| context | token | A use context assigned to the charge item definition | ChargeItemDefinition.useContext.value |
| context-quantity | quantity | A quantity- or range-valued use context assigned to the charge item definition | ChargeItemDefinition.useContext.value |
| context-type | token | A type of use context assigned to the charge item definition | ChargeItemDefinition.useContext.code |
| date | date | The charge item definition publication date | ChargeItemDefinition.date |
| description | string | The description of the charge item definition | ChargeItemDefinition.description |
| effective | date | The time during which the charge item definition is intended to be in use | ChargeItemDefinition.effectivePeriod |
| identifier | token | External identifier for the charge item definition | ChargeItemDefinition.identifier |
| jurisdiction | token | Intended jurisdiction for the charge item definition | ChargeItemDefinition.jurisdiction |
| publisher | string | Name of the publisher of the charge item definition | ChargeItemDefinition.publisher |
| status | token | The current status of the charge item definition | ChargeItemDefinition.status |
| title | string | The human-friendly name of the charge item definition | ChargeItemDefinition.title |
| url | uri | The uri that identifies the charge item definition | ChargeItemDefinition.url |
| version | token | The business version of the charge item definition | ChargeItemDefinition.version |
| context-type-quantity | composite | A use context type and quantity- or range-based value assigned to the charge item definition | ChargeItemDefinition.useContext |
| context-type-value | composite | A use context type and value assigned to the charge item definition | ChargeItemDefinition.useContext |
Inherited Properties
| Name | Required | Type | Description |
|---|---|---|---|
| id | No | string | Logical id of this artifact |
| meta | No | Meta | Metadata about the resource |
| implicitRules | No | uri | A set of rules under which this content was created |
| language | No | code | Language of the resource content |
| text | No | Narrative | Text summary of the resource, for human interpretation |
| contained | No | Resource[] | Contained, inline Resources |
| extension | No | Extension[] | Additional content defined by implementations |
| modifierExtension | No | Extension[] | Extensions that cannot be ignored |
To view the FHIR specification for this resource, see ChargeItemDefinition.