This page is part of the FHIR Specification (v4.5.0: R5 Preview #3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4
Patient Administration Work Group | Maturity Level: 0 | Trial Use | Security Category: Business | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the ChargeItemDefinition resource.
ChargeItemDefinition | |||||||||
Element Id | ChargeItemDefinition | ||||||||
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. | ||||||||
Cardinality | 0..* | ||||||||
Type | MetadataResource | ||||||||
Invariants |
| ||||||||
ChargeItemDefinition.url | |||||||||
Element Id | ChargeItemDefinition.url | ||||||||
Definition | 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. | ||||||||
Cardinality | 1..1 | ||||||||
Type | uri | ||||||||
Requirements | Allows the charge item definition to be referenced by a single globally unique identifier. | ||||||||
Summary | true | ||||||||
Comments | 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. 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 element to indicate where the current master source of the resource can be found. | ||||||||
ChargeItemDefinition.identifier | |||||||||
Element Id | ChargeItemDefinition.identifier | ||||||||
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. | ||||||||
Note | This is a business identifier, not a resource identifier (see discussion) | ||||||||
Cardinality | 0..* | ||||||||
Type | Identifier | ||||||||
Requirements | Allows externally provided and/or usable business identifiers to be easily associated with the module. | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.version | |||||||||
Element Id | ChargeItemDefinition.version | ||||||||
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. | ||||||||
Note | This is a business versionId, not a resource version id (see discussion) | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | 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]. | ||||||||
ChargeItemDefinition.title | |||||||||
Element Id | ChargeItemDefinition.title | ||||||||
Definition | A short, descriptive, user-friendly title for the charge item definition. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Summary | true | ||||||||
Comments | This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc. | ||||||||
ChargeItemDefinition.derivedFromUri | |||||||||
Element Id | ChargeItemDefinition.derivedFromUri | ||||||||
Definition | The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition. | ||||||||
Cardinality | 0..* | ||||||||
Type | uri | ||||||||
Summary | true | ||||||||
ChargeItemDefinition.partOf | |||||||||
Element Id | ChargeItemDefinition.partOf | ||||||||
Definition | A larger definition of which this particular definition is a component or step. | ||||||||
Cardinality | 0..* | ||||||||
Type | canonical(ChargeItemDefinition) | ||||||||
Alternate Names | container | ||||||||
Summary | true | ||||||||
ChargeItemDefinition.replaces | |||||||||
Element Id | ChargeItemDefinition.replaces | ||||||||
Definition | As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance. | ||||||||
Cardinality | 0..* | ||||||||
Type | canonical(ChargeItemDefinition) | ||||||||
Alternate Names | supersedes; prior; renewed order | ||||||||
Summary | true | ||||||||
ChargeItemDefinition.status | |||||||||
Element Id | ChargeItemDefinition.status | ||||||||
Definition | The current state of the ChargeItemDefinition. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | PublicationStatus (Required) | ||||||||
Type | code | ||||||||
Is Modifier | true (Reason: This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration) | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of charge item definitions that are appropriate for use versus not. | ||||||||
ChargeItemDefinition.experimental | |||||||||
Element Id | ChargeItemDefinition.experimental | ||||||||
Definition | 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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | boolean | ||||||||
Requirements | Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition. | ||||||||
Summary | true | ||||||||
Comments | Allows filtering of charge item definitions that are appropriate for use versus not. | ||||||||
ChargeItemDefinition.date | |||||||||
Element Id | ChargeItemDefinition.date | ||||||||
Definition | 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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | dateTime | ||||||||
Alternate Names | Revision Date | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.publisher | |||||||||
Element Id | ChargeItemDefinition.publisher | ||||||||
Definition | The name of the organization or individual that published the charge item definition. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Requirements | Helps establish the "authority/credibility" of the charge item definition. May also allow for contact. | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.contact | |||||||||
Element Id | ChargeItemDefinition.contact | ||||||||
Definition | Contact details to assist a user in finding and communicating with the publisher. | ||||||||
Cardinality | 0..* | ||||||||
Type | ContactDetail | ||||||||
Summary | true | ||||||||
Comments | May be a web site, an email address, a telephone number, etc. | ||||||||
ChargeItemDefinition.description | |||||||||
Element Id | ChargeItemDefinition.description | ||||||||
Definition | A free text natural language description of the charge item definition from a consumer's perspective. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Summary | true | ||||||||
Comments | 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). | ||||||||
ChargeItemDefinition.useContext | |||||||||
Element Id | ChargeItemDefinition.useContext | ||||||||
Definition | 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. | ||||||||
Cardinality | 0..* | ||||||||
Type | UsageContext | ||||||||
Requirements | Assist in searching for appropriate content. | ||||||||
Summary | true | ||||||||
Comments | When multiple useContexts are specified, there is no expectation that all or any of the contexts apply. | ||||||||
ChargeItemDefinition.jurisdiction | |||||||||
Element Id | ChargeItemDefinition.jurisdiction | ||||||||
Definition | A legal or geographic region in which the charge item definition is intended to be used. | ||||||||
Cardinality | 0..* | ||||||||
Terminology Binding | Jurisdiction (Extensible) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.copyright | |||||||||
Element Id | ChargeItemDefinition.copyright | ||||||||
Definition | 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. | ||||||||
Cardinality | 0..1 | ||||||||
Type | markdown | ||||||||
Requirements | Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content. | ||||||||
Alternate Names | License; Restrictions | ||||||||
ChargeItemDefinition.approvalDate | |||||||||
Element Id | ChargeItemDefinition.approvalDate | ||||||||
Definition | The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Comments | The 'date' element may be more recent than the approval date because of minor changes or editorial corrections. | ||||||||
ChargeItemDefinition.lastReviewDate | |||||||||
Element Id | ChargeItemDefinition.lastReviewDate | ||||||||
Definition | The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date. | ||||||||
Cardinality | 0..1 | ||||||||
Type | date | ||||||||
Requirements | Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant. | ||||||||
Comments | If specified, this date follows the original approval date. | ||||||||
ChargeItemDefinition.effectivePeriod | |||||||||
Element Id | ChargeItemDefinition.effectivePeriod | ||||||||
Definition | The period during which the charge item definition content was or is planned to be in active use. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Period | ||||||||
Requirements | Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the charge item definition are or are expected to be used instead. | ||||||||
Summary | true | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.code | |||||||||
Element Id | ChargeItemDefinition.code | ||||||||
Definition | The defined billing details in this resource pertain to the given billing code. | ||||||||
Cardinality | 0..1 | ||||||||
Terminology Binding | ChargeItemCode (Example) | ||||||||
Type | CodeableConcept | ||||||||
Summary | true | ||||||||
ChargeItemDefinition.instance | |||||||||
Element Id | ChargeItemDefinition.instance | ||||||||
Definition | The defined billing details in this resource pertain to the given product instance(s). | ||||||||
Cardinality | 0..* | ||||||||
Type | Reference(Medication | Substance | Device) | ||||||||
Patterns | Reference(Medication,Substance,Device): No common pattern | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.applicability | |||||||||
Element Id | ChargeItemDefinition.applicability | ||||||||
Definition | Expressions that describe applicability criteria for the billing code. | ||||||||
Cardinality | 0..* | ||||||||
Comments | The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children. | ||||||||
ChargeItemDefinition.applicability.description | |||||||||
Element Id | ChargeItemDefinition.applicability.description | ||||||||
Definition | A brief, natural language description of the condition that effectively communicates the intended semantics. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
ChargeItemDefinition.applicability.language | |||||||||
Element Id | ChargeItemDefinition.applicability.language | ||||||||
Definition | The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
ChargeItemDefinition.applicability.expression | |||||||||
Element Id | ChargeItemDefinition.applicability.expression | ||||||||
Definition | An expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied. | ||||||||
Cardinality | 0..1 | ||||||||
Type | string | ||||||||
Comments | 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. | ||||||||
ChargeItemDefinition.propertyGroup | |||||||||
Element Id | ChargeItemDefinition.propertyGroup | ||||||||
Definition | Group of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply. | ||||||||
Cardinality | 0..* | ||||||||
ChargeItemDefinition.propertyGroup.applicability | |||||||||
Element Id | ChargeItemDefinition.propertyGroup.applicability | ||||||||
Definition | Expressions that describe applicability criteria for the priceComponent. | ||||||||
Cardinality | 0..* | ||||||||
Type | See ChargeItemDefinition.applicability | ||||||||
Comments | The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children. | ||||||||
ChargeItemDefinition.propertyGroup.priceComponent | |||||||||
Element Id | ChargeItemDefinition.propertyGroup.priceComponent | ||||||||
Definition | 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 development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated. | ||||||||
Cardinality | 0..* | ||||||||
ChargeItemDefinition.propertyGroup.priceComponent.type | |||||||||
Element Id | ChargeItemDefinition.propertyGroup.priceComponent.type | ||||||||
Definition | This code identifies the type of the component. | ||||||||
Cardinality | 1..1 | ||||||||
Terminology Binding | InvoicePriceComponentType (Required) | ||||||||
Type | code | ||||||||
ChargeItemDefinition.propertyGroup.priceComponent.code | |||||||||
Element Id | ChargeItemDefinition.propertyGroup.priceComponent.code | ||||||||
Definition | A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc. | ||||||||
Cardinality | 0..1 | ||||||||
Type | CodeableConcept | ||||||||
ChargeItemDefinition.propertyGroup.priceComponent.factor | |||||||||
Element Id | ChargeItemDefinition.propertyGroup.priceComponent.factor | ||||||||
Definition | The factor that has been applied on the base price for calculating this component. | ||||||||
Cardinality | 0..1 | ||||||||
Type | decimal | ||||||||
ChargeItemDefinition.propertyGroup.priceComponent.amount | |||||||||
Element Id | ChargeItemDefinition.propertyGroup.priceComponent.amount | ||||||||
Definition | The amount calculated for this component. | ||||||||
Cardinality | 0..1 | ||||||||
Type | Money |