Path | Short | Definition | Comments |
---|---|---|---|
Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined | 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. | ||
url | Canonical identifier for this charge item definition, represented as a URI (globally unique) | An absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers. | Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version. The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in [Technical and Business Versions](resource.html#versions). In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the [meta.source](resource.html#meta) element to indicate where the current master source of the resource can be found. |
identifier | Additional identifier for the charge item definition | A formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance. | Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI. |
version | Business version of the charge item definition | The identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets. | There may be different charge item definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the charge item definition with the format [url]|[version]. |
title | Name for this charge item definition (human friendly) | A short, descriptive, user-friendly title for the charge item definition. | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. |
derivedFromUri | Underlying externally-defined charge item definition | The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition. | |
partOf | A larger definition of which this particular definition is a component or step | A larger definition of which this particular definition is a component or step. | |
replaces | Completed or terminated request(s) whose function is taken by this new request | As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance. | |
status | draft | active | retired | unknown | The current state of the ChargeItemDefinition. | Allows filtering of charge item definitions that are appropriate for use versus not. |
experimental | For testing purposes, not real usage | A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage. | Allows filtering of charge item definitions that are appropriate for use versus not. |
date | Date last changed | The date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes. | Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource. |
publisher | Name of the publisher (organization or individual) | The name of the organization or individual that published the charge item definition. | Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the charge item definition. This item SHOULD be populated unless the information is available from context. |
contact | Contact details for the publisher | Contact details to assist a user in finding and communicating with the publisher. | May be a web site, an email address, a telephone number, etc. |
description | Natural language description of the charge item definition | A free text natural language description of the charge item definition from a consumer's perspective. | This description can be used to capture details such as why the charge item definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created). |
useContext | The context that the content is intended to support | The content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances. | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. |
jurisdiction | Intended jurisdiction for charge item definition (if applicable) | A legal or geographic region in which the charge item definition is intended to be used. | It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended. |
copyright | Use and/or publishing restrictions | A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition. | |
approvalDate | When the charge item definition was approved by publisher | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. |
lastReviewDate | When the charge item definition was last reviewed | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | If specified, this date follows the original approval date. |
effectivePeriod | When the charge item definition is expected to be used | The period during which the charge item definition content was or is planned to be in active use. | The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015. |
code | Billing codes or product types this definition applies to | The defined billing details in this resource pertain to the given billing code. | |
instance | Instances this definition applies to | The defined billing details in this resource pertain to the given product instance(s). | In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances. |
applicability | Whether or not the billing code is applicable | Expressions that describe applicability criteria for the billing code. | The applicability conditions can be used to ascertain whether a billing item is allowed in a pecific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children. |
applicability.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
applicability.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
applicability.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
applicability.description | Natural language description of the condition | A brief, natural language description of the condition that effectively communicates the intended semantics. | |
applicability.language | Language of the expression | The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions. | |
applicability.expression | Boolean-valued expression | An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context evironment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied. | Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied. FHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice. |
propertyGroup | Group of properties which are applicable under the same conditions | Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply. | |
propertyGroup.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
propertyGroup.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
propertyGroup.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
propertyGroup.applicability | Conditions under which the priceComponent is applicable | Expressions that describe applicability criteria for the priceComponent. | The applicability conditions can be used to ascertain whether a billing item is allowed in a pecific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children. |
propertyGroup.priceComponent | Components of total line item price | The price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under developement. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated. | |
propertyGroup.priceComponent.id | Unique id for inter-element referencing | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |
propertyGroup.priceComponent.extension | Additional content defined by implementations | May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
propertyGroup.priceComponent.modifierExtension | Extensions that cannot be ignored even if unrecognized | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
propertyGroup.priceComponent.type | base | surcharge | deduction | discount | tax | informational | This code identifies the type of the component. | |
propertyGroup.priceComponent.code | Code identifying the specific component | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | |
propertyGroup.priceComponent.factor | Factor used for calculating this component | The factor that has been applied on the base price for calculating this component. | |
propertyGroup.priceComponent.amount | Monetary amount associated with this component | The amount calculated for this component. |
The ChargeItemDefinition holds all relevant billing information pertaining to a billing code or a product.
Many billing systems have rules associated with the code which may define whether a billing code is applicable in a specific context or whether certain billing details (surcharges, discounts) apply. ChargeItemDefinitions may also be used to hold pricing information pertaining to only one specific instance of a product (e.g. Device, Medication or Substance) which may be a requirement for custom made devices or medications or other products where prices vary by instance. Rules for applicablitily may include
A billing engine will apply the ChargeItemDefinitions to all ChargeItems within a specific Account in order to select all billable items an aquire the pricing details to create an Invoice. However, ChargeItems may be validated against a ChargeItemDefinition at any point in time, using the $apply-Operation
While the ChargeItem resource represents the occurence of a billing code (for services rendered or products supplied to a specific patient), the ChargeItemDefinition represents the properties and rules that a billing engine needs to determine the pricing and applicability of a billing code in the context of a specific setting.
Billing Codes may be defined in a CodeSystem Resource, however, each of these codes - if it is used in a financial context - can have a large number of business rules and properties associated with it, that lay outside the scope of CodeSystem and may change in time independently from the underlying Code's validity period. Even though CodeSystem can associate a concept with any number of additional properties, such a construct would be very hard to maintain. This is why the ChargItemDefinition has been introduced. It allows to maintain the attributes of each billing code independently and has a wider scope to also include business rules.
In most use cases, billing codes will be both defined as semantical concepts in a CodeSystem and as a financial artifact in ChargeItemDefinition.
ChargeItemDefinitions that pertain to codes from the same CodeSystem may be aggregated using the Catalog profile for Composition.
Resources representing products that can be sold or billed (Device, Medication, Substance...), do not specify financial details for the product instance. Most of the time, such products are not billed seperately but are a part of a generic billing code that covers both the product and the service rendered. In some occations however, product prices may vary depending on type or manufactuer or even on instance (e.g. custom made products). For these cases, ChargeItemDefinitions may be created to specify the financial details for a product kind, type or instance.
context | A use context assigned to the charge item definition | (ChargeItemDefinition.useContext.value as CodeableConcept) |
context-quantity | A quantity- or range-valued use context assigned to the charge item definition | (ChargeItemDefinition.useContext.value as Quantity) | (ChargeItemDefinition.useContext.value as Range) |
context-type | A type of use context assigned to the charge item definition | ChargeItemDefinition.useContext.code |
date | The charge item definition publication date | ChargeItemDefinition.date |
description | The description of the charge item definition | ChargeItemDefinition.description |
effective | The time during which the charge item definition is intended to be in use | ChargeItemDefinition.effectivePeriod |
identifier | External identifier for the charge item definition | ChargeItemDefinition.identifier |
jurisdiction | Intended jurisdiction for the charge item definition | ChargeItemDefinition.jurisdiction |
publisher | Name of the publisher of the charge item definition | ChargeItemDefinition.publisher |
status | The current status of the charge item definition | ChargeItemDefinition.status |
title | The human-friendly name of the charge item definition | ChargeItemDefinition.title |
url | The uri that identifies the charge item definition | ChargeItemDefinition.url |
version | The business version of the charge item definition | ChargeItemDefinition.version |
context-type-quantity | A use context type and quantity- or range-based value assigned to the charge item definition | ChargeItemDefinition.useContext |
context-type-value | A use context type and value assigned to the charge item definition | ChargeItemDefinition.useContext |