Release 4 5 Preview #2
This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

8.25 Resource ChargeItemDefinition - Content

Patient Administration Work Group Maturity Level : 0   Trial Use Security Category : Business Compartments : Not linked to any defined compartments

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.

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 applicability may include

  • a billing code is only applicable in an outpatient setting
  • a surcharge that applies only to services provided outside regular business hours
  • a discount that applies only to patients up to the age of 14
  • a billing code that may only be charged once per Encounter
  • a billing code that can only be charged in combination with another code from the same billing system

A billing engine will apply the ChargeItemDefinitions to all ChargeItems within a specific Account in order to select all billable items an acquire 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 occurrence 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 occasions 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.

This resource is referenced by ChargeItem and itself itself.

This resource does not implement any patterns.

Structure

Name Flags Card. Type Description & Constraints doco
. . ChargeItemDefinition I TU DomainResource MetadataResource Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright , approvalDate , lastReviewDate , effectivePeriod
. . . url Σ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the charge item definition
. . . version Σ 0..1 string Business version of the charge item definition
. . . derivedFromUri Σ 0..* uri Underlying externally-defined charge item definition
. . . partOf Σ 0..* canonical ( ChargeItemDefinition ) A larger definition of which this particular definition is a component or step
. . . replaces Σ 0..* canonical ( ChargeItemDefinition ) Completed or terminated request(s) whose function is taken by this new request
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 0..1 markdown Natural language description of the charge item definition
. . . useContext Σ 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable)
Jurisdiction ( Extensible )
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . approvalDate 0..1 date When the charge item definition was approved by publisher
. . . lastReviewDate 0..1 date When the charge item definition was last reviewed
. . . effectivePeriod Σ 0..1 Period When the charge item definition is expected to be used
. . . code Σ 0..1 CodeableConcept Billing codes or product types this definition applies to
ChargeItemCode ( Example )
. . . instance 0..* Reference ( Medication | Substance | Device ) Instances this definition applies to
. . . applicability 0..* BackboneElement Whether or not the billing code is applicable
. . . . description 0..1 string Natural language description of the condition
. . . . language 0..1 string Language of the expression
. . . . expression 0..1 string Boolean-valued expression
. . . propertyGroup 0..* BackboneElement Group of properties which are applicable under the same conditions
. . . . applicability 0..* see applicability Conditions under which the priceComponent is applicable
. . . . priceComponent 0..* BackboneElement Components of total line item price
. . . . . type 1..1 code base | surcharge | deduction | discount | tax | informational
InvoicePriceComponentType ( Required )
. . . . . code 0..1 CodeableConcept Code identifying the specific component
. . . . . factor 0..1 decimal Factor used for calculating this component
. . . . . amount 0..1 Money Monetary amount associated with this component

doco Documentation for this format

UML Diagram ( Legend )

ChargeItemDefinition ( DomainResource MetadataResource ) 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 url : uri [1..1] 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 identifier : Identifier [0..*] 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 version : string [0..1] A short, descriptive, user-friendly title for the charge item definition title : string [0..1] The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition derivedFromUri : uri [0..*] A larger definition of which this particular definition is a component or step partOf : canonical [0..*] « ChargeItemDefinition » As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance replaces : canonical [0..*] « ChargeItemDefinition » The current state of the ChargeItemDefinition (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » 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 experimental : boolean [0..1] 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 date : dateTime [0..1] The name of the organization or individual that published the charge item definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the charge item definition from a consumer's perspective description : markdown [0..1] 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 useContext : UsageContext [0..*] A legal or geographic region in which the charge item definition is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » 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 copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the charge item definition content was or is planned to be in active use effectivePeriod : Period [0..1] The defined billing details in this resource pertain to the given billing code code : CodeableConcept [0..1] « Billing Code defined by this ChargeItemDefinition. (Strength=Example) ChargeItemCode ?? » The defined billing details in this resource pertain to the given product instance(s) instance : Reference [0..*] « Medication | Substance | Device » Applicability A brief, natural language description of the condition that effectively communicates the intended semantics description : string [0..1] The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions language : string [0..1] 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 expression : string [0..1] PropertyGroup PriceComponent This code identifies the type of the component type : code [1..1] « Codes indicating the kind of the price component. (Strength=Required) InvoicePriceComponentType ! » A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc code : CodeableConcept [0..1] The factor that has been applied on the base price for calculating this component factor : decimal [0..1] The amount calculated for this component amount : Money [0..1] Expressions that describe applicability criteria for the billing code applicability [0..*] Expressions that describe applicability criteria for the priceComponent applicability [0..*] 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 priceComponent [0..*] 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 [0..*]

XML Template

<ChargeItemDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from  -->

 <url value="[uri]"/><!-- 1..1 Canonical identifier for this charge item definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the charge item definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the charge item definition -->
 <title value="[string]"/><!-- 0..1 Name for this charge item definition (human friendly) -->
 <derivedFromUri value="[uri]"/><!-- 0..* Underlying externally-defined charge item definition -->
 <partOf><!-- 0..* canonical(ChargeItemDefinition) A larger definition of which this particular definition is a component or step --></partOf>
 <replaces><!-- 0..* canonical(ChargeItemDefinition) Completed or terminated request(s) whose function is taken by this new request --></replaces>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the charge item definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the charge item definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the charge item definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the charge item definition is expected to be used --></effectivePeriod>
 <code><!-- 0..1 CodeableConcept Billing codes or product types this definition applies to --></code>
 <</instance>

 <instance><!-- 0..* Reference(Device|Medication|Substance) Instances this definition applies to --></instance>

 <applicability>  <!-- 0..* Whether or not the billing code is applicable -->
  <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
  <language value="[string]"/><!-- 0..1 Language of the expression -->
  <expression value="[string]"/><!-- 0..1 Boolean-valued expression -->
 </applicability>
 <propertyGroup>  <!-- 0..* Group of properties which are applicable under the same conditions -->
  <applicability><!-- 0..* Content as for ChargeItemDefinition.applicability Conditions under which the priceComponent is applicable --></applicability>
  <priceComponent>  <!-- 0..* Components of total line item price -->
   <type value="[code]"/><!-- 1..1 base | surcharge | deduction | discount | tax | informational -->
   <code><!-- 0..1 CodeableConcept Code identifying the specific component --></code>
   <factor value="[decimal]"/><!-- 0..1 Factor used for calculating this component -->
   <amount><!-- 0..1 Money Monetary amount associated with this component --></amount>
  </priceComponent>
 </propertyGroup>
</ChargeItemDefinition>

JSON Template

{doco
  "resourceType" : "ChargeItemDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from 

  "url" : "<uri>", // R!  Canonical identifier for this charge item definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the charge item definition
  "version" : "<string>", // Business version of the charge item definition
  "title" : "<string>", // Name for this charge item definition (human friendly)
  "derivedFromUri" : ["<uri>"], // Underlying externally-defined charge item definition
  "partOf" : [{ canonical(ChargeItemDefinition) }], // A larger definition of which this particular definition is a component or step
  "replaces" : [{ canonical(ChargeItemDefinition) }], // Completed or terminated request(s) whose function is taken by this new request
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the charge item definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for charge item definition (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the charge item definition was approved by publisher
  "lastReviewDate" : "<date>", // When the charge item definition was last reviewed
  "effectivePeriod" : { Period }, // When the charge item definition is expected to be used
  "code" : { CodeableConcept }, // Billing codes or product types this definition applies to
  "

  "instance" : [{ Reference(Device|Medication|Substance) }], // Instances this definition applies to

  "applicability" : [{ // Whether or not the billing code is applicable
    "description" : "<string>", // Natural language description of the condition
    "language" : "<string>", // Language of the expression
    "expression" : "<string>" // Boolean-valued expression
  }],
  "propertyGroup" : [{ // Group of properties which are applicable under the same conditions
    "applicability" : [{ Content as for ChargeItemDefinition.applicability }], // Conditions under which the priceComponent is applicable
    "priceComponent" : [{ // Components of total line item price
      "type" : "<code>", // R!  base | surcharge | deduction | discount | tax | informational
      "code" : { CodeableConcept }, // Code identifying the specific component
      "factor" : <decimal>, // Factor used for calculating this component
      "amount" : { Money } // Monetary amount associated with this component
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:ChargeItemDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from 

  fhir:ChargeItemDefinition.url [ uri ]; # 1..1 Canonical identifier for this charge item definition, represented as a URI (globally unique)
  fhir:ChargeItemDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the charge item definition
  fhir:ChargeItemDefinition.version [ string ]; # 0..1 Business version of the charge item definition
  fhir:ChargeItemDefinition.title [ string ]; # 0..1 Name for this charge item definition (human friendly)
  fhir:ChargeItemDefinition.derivedFromUri [ uri ], ... ; # 0..* Underlying externally-defined charge item definition
  fhir:ChargeItemDefinition.partOf [ canonical(ChargeItemDefinition) ], ... ; # 0..* A larger definition of which this particular definition is a component or step
  fhir:ChargeItemDefinition.replaces [ canonical(ChargeItemDefinition) ], ... ; # 0..* Completed or terminated request(s) whose function is taken by this new request
  fhir:ChargeItemDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ChargeItemDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ChargeItemDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ChargeItemDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ChargeItemDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ChargeItemDefinition.description [ markdown ]; # 0..1 Natural language description of the charge item definition
  fhir:ChargeItemDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ChargeItemDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for charge item definition (if applicable)
  fhir:ChargeItemDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ChargeItemDefinition.approvalDate [ date ]; # 0..1 When the charge item definition was approved by publisher
  fhir:ChargeItemDefinition.lastReviewDate [ date ]; # 0..1 When the charge item definition was last reviewed
  fhir:ChargeItemDefinition.effectivePeriod [ Period ]; # 0..1 When the charge item definition is expected to be used
  fhir:ChargeItemDefinition.code [ CodeableConcept ]; # 0..1 Billing codes or product types this definition applies to
  fhir:

  fhir:ChargeItemDefinition.instance [ Reference(Device|Medication|Substance) ], ... ; # 0..* Instances this definition applies to

  fhir:ChargeItemDefinition.applicability [ # 0..* Whether or not the billing code is applicable
    fhir:ChargeItemDefinition.applicability.description [ string ]; # 0..1 Natural language description of the condition
    fhir:ChargeItemDefinition.applicability.language [ string ]; # 0..1 Language of the expression
    fhir:ChargeItemDefinition.applicability.expression [ string ]; # 0..1 Boolean-valued expression
  ], ...;
  fhir:ChargeItemDefinition.propertyGroup [ # 0..* Group of properties which are applicable under the same conditions
    fhir:ChargeItemDefinition.propertyGroup.applicability [ See ChargeItemDefinition.applicability ], ... ; # 0..* Conditions under which the priceComponent is applicable
    fhir:ChargeItemDefinition.propertyGroup.priceComponent [ # 0..* Components of total line item price
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.type [ code ]; # 1..1 base | surcharge | deduction | discount | tax | informational
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.code [ CodeableConcept ]; # 0..1 Code identifying the specific component
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.factor [ decimal ]; # 0..1 Factor used for calculating this component
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.amount [ Money ]; # 0..1 Monetary amount associated with this component
    ], ...;
  ], ...;
]

Changes since R3

ChargeItemDefinition
ChargeItemDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.4.0
ChargeItemDefinition.propertyGroup.priceComponent.type
  • Change value set from http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.0 to http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.4.0

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

Structure

Name Flags Card. Type Description & Constraints doco
. . ChargeItemDefinition I TU DomainResource MetadataResource Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
+ Warning: Name should be usable as an identifier for the module by machine processing applications such as code generation
Elements defined in Ancestors: id , meta , implicitRules , language , text , contained , extension , modifierExtension , url , identifier , version , name , title , status , experimental , date , publisher , contact , description , useContext , jurisdiction , purpose , copyright , approvalDate , lastReviewDate , effectivePeriod
. . . url Σ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
. . . identifier Σ 0..* Identifier Additional identifier for the charge item definition
. . . version Σ 0..1 string Business version of the charge item definition
. . . derivedFromUri Σ 0..* uri Underlying externally-defined charge item definition
. . . partOf Σ 0..* canonical ( ChargeItemDefinition ) A larger definition of which this particular definition is a component or step
. . . replaces Σ 0..* canonical ( ChargeItemDefinition ) Completed or terminated request(s) whose function is taken by this new request
. . . status ?! Σ 1..1 code draft | active | retired | unknown
PublicationStatus ( Required )
. . . experimental Σ 0..1 boolean For testing purposes, not real usage
. . . date Σ 0..1 dateTime Date last changed
. . . publisher Σ 0..1 string Name of the publisher (organization or individual)
. . . contact Σ 0..* ContactDetail Contact details for the publisher
. . . description Σ 0..1 markdown Natural language description of the charge item definition
. . . useContext Σ 0..* UsageContext The context that the content is intended to support
. . . jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable)
Jurisdiction ( Extensible )
. . . copyright 0..1 markdown Use and/or publishing restrictions
. . . approvalDate 0..1 date When the charge item definition was approved by publisher
. . . lastReviewDate 0..1 date When the charge item definition was last reviewed
. . . effectivePeriod Σ 0..1 Period When the charge item definition is expected to be used
. . . code Σ 0..1 CodeableConcept Billing codes or product types this definition applies to
ChargeItemCode ( Example )
. . . instance 0..* Reference ( Medication | Substance | Device ) Instances this definition applies to
. . . applicability 0..* BackboneElement Whether or not the billing code is applicable
. . . . description 0..1 string Natural language description of the condition
. . . . language 0..1 string Language of the expression
. . . . expression 0..1 string Boolean-valued expression
. . . propertyGroup 0..* BackboneElement Group of properties which are applicable under the same conditions
. . . . applicability 0..* see applicability Conditions under which the priceComponent is applicable
. . . . priceComponent 0..* BackboneElement Components of total line item price
. . . . . type 1..1 code base | surcharge | deduction | discount | tax | informational
InvoicePriceComponentType ( Required )
. . . . . code 0..1 CodeableConcept Code identifying the specific component
. . . . . factor 0..1 decimal Factor used for calculating this component
. . . . . amount 0..1 Money Monetary amount associated with this component

doco Documentation for this format

UML Diagram ( Legend )

ChargeItemDefinition ( DomainResource MetadataResource ) 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 url : uri [1..1] 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 identifier : Identifier [0..*] 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 version : string [0..1] A short, descriptive, user-friendly title for the charge item definition title : string [0..1] The URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition derivedFromUri : uri [0..*] A larger definition of which this particular definition is a component or step partOf : canonical [0..*] « ChargeItemDefinition » As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance replaces : canonical [0..*] « ChargeItemDefinition » The current state of the ChargeItemDefinition (this element modifies the meaning of other elements) status : code [1..1] « The lifecycle status of an artifact. (Strength=Required) PublicationStatus ! » 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 experimental : boolean [0..1] 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 date : dateTime [0..1] The name of the organization or individual that published the charge item definition publisher : string [0..1] Contact details to assist a user in finding and communicating with the publisher contact : ContactDetail [0..*] A free text natural language description of the charge item definition from a consumer's perspective description : markdown [0..1] 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 useContext : UsageContext [0..*] A legal or geographic region in which the charge item definition is intended to be used jurisdiction : CodeableConcept [0..*] « Countries and regions within which this artifact is targeted for use. (Strength=Extensible) Jurisdiction ValueSet + » 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 copyright : markdown [0..1] The date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage approvalDate : date [0..1] The date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date lastReviewDate : date [0..1] The period during which the charge item definition content was or is planned to be in active use effectivePeriod : Period [0..1] The defined billing details in this resource pertain to the given billing code code : CodeableConcept [0..1] « Billing Code defined by this ChargeItemDefinition. (Strength=Example) ChargeItemCode ?? » The defined billing details in this resource pertain to the given product instance(s) instance : Reference [0..*] « Medication | Substance | Device » Applicability A brief, natural language description of the condition that effectively communicates the intended semantics description : string [0..1] The media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions language : string [0..1] 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 expression : string [0..1] PropertyGroup PriceComponent This code identifies the type of the component type : code [1..1] « Codes indicating the kind of the price component. (Strength=Required) InvoicePriceComponentType ! » A code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc code : CodeableConcept [0..1] The factor that has been applied on the base price for calculating this component factor : decimal [0..1] The amount calculated for this component amount : Money [0..1] Expressions that describe applicability criteria for the billing code applicability [0..*] Expressions that describe applicability criteria for the priceComponent applicability [0..*] 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 priceComponent [0..*] 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 [0..*]

XML Template

<ChargeItemDefinition xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from  -->

 <url value="[uri]"/><!-- 1..1 Canonical identifier for this charge item definition, represented as a URI (globally unique) -->
 <identifier><!-- 0..* Identifier Additional identifier for the charge item definition --></identifier>
 <version value="[string]"/><!-- 0..1 Business version of the charge item definition -->
 <title value="[string]"/><!-- 0..1 Name for this charge item definition (human friendly) -->
 <derivedFromUri value="[uri]"/><!-- 0..* Underlying externally-defined charge item definition -->
 <partOf><!-- 0..* canonical(ChargeItemDefinition) A larger definition of which this particular definition is a component or step --></partOf>
 <replaces><!-- 0..* canonical(ChargeItemDefinition) Completed or terminated request(s) whose function is taken by this new request --></replaces>
 <status value="[code]"/><!-- 1..1 draft | active | retired | unknown -->
 <experimental value="[boolean]"/><!-- 0..1 For testing purposes, not real usage -->
 <date value="[dateTime]"/><!-- 0..1 Date last changed -->
 <publisher value="[string]"/><!-- 0..1 Name of the publisher (organization or individual) -->
 <contact><!-- 0..* ContactDetail Contact details for the publisher --></contact>
 <description value="[markdown]"/><!-- 0..1 Natural language description of the charge item definition -->
 <useContext><!-- 0..* UsageContext The context that the content is intended to support --></useContext>
 <jurisdiction><!-- 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable) --></jurisdiction>
 <copyright value="[markdown]"/><!-- 0..1 Use and/or publishing restrictions -->
 <approvalDate value="[date]"/><!-- 0..1 When the charge item definition was approved by publisher -->
 <lastReviewDate value="[date]"/><!-- 0..1 When the charge item definition was last reviewed -->
 <effectivePeriod><!-- 0..1 Period When the charge item definition is expected to be used --></effectivePeriod>
 <code><!-- 0..1 CodeableConcept Billing codes or product types this definition applies to --></code>
 <</instance>

 <instance><!-- 0..* Reference(Device|Medication|Substance) Instances this definition applies to --></instance>

 <applicability>  <!-- 0..* Whether or not the billing code is applicable -->
  <description value="[string]"/><!-- 0..1 Natural language description of the condition -->
  <language value="[string]"/><!-- 0..1 Language of the expression -->
  <expression value="[string]"/><!-- 0..1 Boolean-valued expression -->
 </applicability>
 <propertyGroup>  <!-- 0..* Group of properties which are applicable under the same conditions -->
  <applicability><!-- 0..* Content as for ChargeItemDefinition.applicability Conditions under which the priceComponent is applicable --></applicability>
  <priceComponent>  <!-- 0..* Components of total line item price -->
   <type value="[code]"/><!-- 1..1 base | surcharge | deduction | discount | tax | informational -->
   <code><!-- 0..1 CodeableConcept Code identifying the specific component --></code>
   <factor value="[decimal]"/><!-- 0..1 Factor used for calculating this component -->
   <amount><!-- 0..1 Money Monetary amount associated with this component --></amount>
  </priceComponent>
 </propertyGroup>
</ChargeItemDefinition>

JSON Template

{doco
  "resourceType" : "ChargeItemDefinition",
  // from Resource: id, meta, implicitRules, and language
  // from 

  "url" : "<uri>", // R!  Canonical identifier for this charge item definition, represented as a URI (globally unique)
  "identifier" : [{ Identifier }], // Additional identifier for the charge item definition
  "version" : "<string>", // Business version of the charge item definition
  "title" : "<string>", // Name for this charge item definition (human friendly)
  "derivedFromUri" : ["<uri>"], // Underlying externally-defined charge item definition
  "partOf" : [{ canonical(ChargeItemDefinition) }], // A larger definition of which this particular definition is a component or step
  "replaces" : [{ canonical(ChargeItemDefinition) }], // Completed or terminated request(s) whose function is taken by this new request
  "status" : "<code>", // R!  draft | active | retired | unknown
  "experimental" : <boolean>, // For testing purposes, not real usage
  "date" : "<dateTime>", // Date last changed
  "publisher" : "<string>", // Name of the publisher (organization or individual)
  "contact" : [{ ContactDetail }], // Contact details for the publisher
  "description" : "<markdown>", // Natural language description of the charge item definition
  "useContext" : [{ UsageContext }], // The context that the content is intended to support
  "jurisdiction" : [{ CodeableConcept }], // Intended jurisdiction for charge item definition (if applicable)
  "copyright" : "<markdown>", // Use and/or publishing restrictions
  "approvalDate" : "<date>", // When the charge item definition was approved by publisher
  "lastReviewDate" : "<date>", // When the charge item definition was last reviewed
  "effectivePeriod" : { Period }, // When the charge item definition is expected to be used
  "code" : { CodeableConcept }, // Billing codes or product types this definition applies to
  "

  "instance" : [{ Reference(Device|Medication|Substance) }], // Instances this definition applies to

  "applicability" : [{ // Whether or not the billing code is applicable
    "description" : "<string>", // Natural language description of the condition
    "language" : "<string>", // Language of the expression
    "expression" : "<string>" // Boolean-valued expression
  }],
  "propertyGroup" : [{ // Group of properties which are applicable under the same conditions
    "applicability" : [{ Content as for ChargeItemDefinition.applicability }], // Conditions under which the priceComponent is applicable
    "priceComponent" : [{ // Components of total line item price
      "type" : "<code>", // R!  base | surcharge | deduction | discount | tax | informational
      "code" : { CodeableConcept }, // Code identifying the specific component
      "factor" : <decimal>, // Factor used for calculating this component
      "amount" : { Money } // Monetary amount associated with this component
    }]
  }]
}

Turtle Template

@prefix fhir: <http://hl7.org/fhir/> .doco
[ a fhir:ChargeItemDefinition;
  fhir:nodeRole fhir:treeRoot; # if this is the parser root
  # from Resource: .id, .meta, .implicitRules, and .language
  # from 

  fhir:ChargeItemDefinition.url [ uri ]; # 1..1 Canonical identifier for this charge item definition, represented as a URI (globally unique)
  fhir:ChargeItemDefinition.identifier [ Identifier ], ... ; # 0..* Additional identifier for the charge item definition
  fhir:ChargeItemDefinition.version [ string ]; # 0..1 Business version of the charge item definition
  fhir:ChargeItemDefinition.title [ string ]; # 0..1 Name for this charge item definition (human friendly)
  fhir:ChargeItemDefinition.derivedFromUri [ uri ], ... ; # 0..* Underlying externally-defined charge item definition
  fhir:ChargeItemDefinition.partOf [ canonical(ChargeItemDefinition) ], ... ; # 0..* A larger definition of which this particular definition is a component or step
  fhir:ChargeItemDefinition.replaces [ canonical(ChargeItemDefinition) ], ... ; # 0..* Completed or terminated request(s) whose function is taken by this new request
  fhir:ChargeItemDefinition.status [ code ]; # 1..1 draft | active | retired | unknown
  fhir:ChargeItemDefinition.experimental [ boolean ]; # 0..1 For testing purposes, not real usage
  fhir:ChargeItemDefinition.date [ dateTime ]; # 0..1 Date last changed
  fhir:ChargeItemDefinition.publisher [ string ]; # 0..1 Name of the publisher (organization or individual)
  fhir:ChargeItemDefinition.contact [ ContactDetail ], ... ; # 0..* Contact details for the publisher
  fhir:ChargeItemDefinition.description [ markdown ]; # 0..1 Natural language description of the charge item definition
  fhir:ChargeItemDefinition.useContext [ UsageContext ], ... ; # 0..* The context that the content is intended to support
  fhir:ChargeItemDefinition.jurisdiction [ CodeableConcept ], ... ; # 0..* Intended jurisdiction for charge item definition (if applicable)
  fhir:ChargeItemDefinition.copyright [ markdown ]; # 0..1 Use and/or publishing restrictions
  fhir:ChargeItemDefinition.approvalDate [ date ]; # 0..1 When the charge item definition was approved by publisher
  fhir:ChargeItemDefinition.lastReviewDate [ date ]; # 0..1 When the charge item definition was last reviewed
  fhir:ChargeItemDefinition.effectivePeriod [ Period ]; # 0..1 When the charge item definition is expected to be used
  fhir:ChargeItemDefinition.code [ CodeableConcept ]; # 0..1 Billing codes or product types this definition applies to
  fhir:

  fhir:ChargeItemDefinition.instance [ Reference(Device|Medication|Substance) ], ... ; # 0..* Instances this definition applies to

  fhir:ChargeItemDefinition.applicability [ # 0..* Whether or not the billing code is applicable
    fhir:ChargeItemDefinition.applicability.description [ string ]; # 0..1 Natural language description of the condition
    fhir:ChargeItemDefinition.applicability.language [ string ]; # 0..1 Language of the expression
    fhir:ChargeItemDefinition.applicability.expression [ string ]; # 0..1 Boolean-valued expression
  ], ...;
  fhir:ChargeItemDefinition.propertyGroup [ # 0..* Group of properties which are applicable under the same conditions
    fhir:ChargeItemDefinition.propertyGroup.applicability [ See ChargeItemDefinition.applicability ], ... ; # 0..* Conditions under which the priceComponent is applicable
    fhir:ChargeItemDefinition.propertyGroup.priceComponent [ # 0..* Components of total line item price
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.type [ code ]; # 1..1 base | surcharge | deduction | discount | tax | informational
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.code [ CodeableConcept ]; # 0..1 Code identifying the specific component
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.factor [ decimal ]; # 0..1 Factor used for calculating this component
      fhir:ChargeItemDefinition.propertyGroup.priceComponent.amount [ Money ]; # 0..1 Monetary amount associated with this component
    ], ...;
  ], ...;
]

Changes since Release 3

ChargeItemDefinition
ChargeItemDefinition.status
  • Change value set from http://hl7.org/fhir/ValueSet/publication-status|4.0.0 to http://hl7.org/fhir/ValueSet/publication-status|4.4.0
ChargeItemDefinition.propertyGroup.priceComponent.type
  • Change value set from http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.0 to http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.4.0

This resource did not exist in Release 2 See the Full Difference for further information

This analysis is available as XML or JSON .

 

See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON , XML Schema / Schematron + JSON Schema , ShEx (for Turtle ) + see , the extensions spreadsheet version & the dependency analysis a

Path Definition Type Reference
ChargeItemDefinition.status The lifecycle status of an artifact. Required PublicationStatus
ChargeItemDefinition.jurisdiction Countries and regions within which this artifact is targeted for use. Extensible Jurisdiction ValueSet
ChargeItemDefinition.code Billing Code defined by this ChargeItemDefinition. Example ChargeItemCode
ChargeItemDefinition.propertyGroup.priceComponent.type Codes indicating the kind of the price component. Required InvoicePriceComponentType

id Level Location Description Expression
cid-0 cnl-0 Warning (base) Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
context token A use context assigned to the charge item definition (ChargeItemDefinition.useContext.value as CodeableConcept)
context-quantity 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 token A type of use context assigned to the charge item definition ChargeItemDefinition.useContext.code
context-type-quantity composite A use context type and quantity- or range-based value assigned to the charge item definition On ChargeItemDefinition.useContext:
  context-type: code
  context-quantity: value.as(Quantity) | value.as(Range)
context-type-value composite A use context type and value assigned to the charge item definition On ChargeItemDefinition.useContext:
  context-type: code
  context: value.as(CodeableConcept)
date N date The charge item definition publication date ChargeItemDefinition.date
description N 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 N string Name of the publisher of the charge item definition ChargeItemDefinition.publisher
status N token The current status of the charge item definition ChargeItemDefinition.status
title N string The human-friendly name of the charge item definition ChargeItemDefinition.title
url N uri The uri that identifies the charge item definition ChargeItemDefinition.url
version N token The business version of the charge item definition ChargeItemDefinition.version