Skip to main content

ChargeItemDefinition

PropertyValue
Publisher
NameChargeItemDefinition
URLhttp://hl7.org/fhir/StructureDefinition/ChargeItemDefinition
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
ChargeItemDefinition0..*ChargeItemDefinitionThe 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.
ChargeItemDefinition.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
ChargeItemDefinition.meta0..1MetaThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
ChargeItemDefinition.implicitRules0..1uriA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
ChargeItemDefinition.language0..1codeThe base language in which the resource is written.
ChargeItemDefinition.text0..1NarrativeA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
ChargeItemDefinition.contained0..*ResourceThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
ChargeItemDefinition.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. 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.
ChargeItemDefinition.modifierExtension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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).
ChargeItemDefinition.url1..1uriAn 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.
ChargeItemDefinition.identifier0..*IdentifierA 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.
ChargeItemDefinition.version0..1stringThe 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.
ChargeItemDefinition.title0..1stringA short, descriptive, user-friendly title for the charge item definition.
ChargeItemDefinition.derivedFromUri0..*uriThe URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
ChargeItemDefinition.partOf0..*canonicalA larger definition of which this particular definition is a component or step.
ChargeItemDefinition.replaces0..*canonicalAs new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
ChargeItemDefinition.status1..1codeThe current state of the ChargeItemDefinition.
ChargeItemDefinition.experimental0..1booleanA 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.
ChargeItemDefinition.date0..1dateTimeThe 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.
ChargeItemDefinition.publisher0..1stringThe name of the organization or individual that published the charge item definition.
ChargeItemDefinition.contact0..*ContactDetailContact details to assist a user in finding and communicating with the publisher.
ChargeItemDefinition.description0..1markdownA free text natural language description of the charge item definition from a consumer's perspective.
ChargeItemDefinition.useContext0..*UsageContextThe 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.
ChargeItemDefinition.jurisdiction0..*CodeableConceptA legal or geographic region in which the charge item definition is intended to be used.
ChargeItemDefinition.copyright0..1markdownA 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.
ChargeItemDefinition.approvalDate0..1dateThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
ChargeItemDefinition.lastReviewDate0..1dateThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
ChargeItemDefinition.effectivePeriod0..1PeriodThe period during which the charge item definition content was or is planned to be in active use.
ChargeItemDefinition.code0..1CodeableConceptThe defined billing details in this resource pertain to the given billing code.
ChargeItemDefinition.instance0..*ReferenceThe defined billing details in this resource pertain to the given product instance(s).
ChargeItemDefinition.applicability0..*BackboneElementExpressions that describe applicability criteria for the billing code.
ChargeItemDefinition.applicability.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ChargeItemDefinition.applicability.extension0..*ExtensionMay 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.
ChargeItemDefinition.applicability.modifierExtension0..*ExtensionMay 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).
ChargeItemDefinition.applicability.description0..1stringA brief, natural language description of the condition that effectively communicates the intended semantics.
ChargeItemDefinition.applicability.language0..1stringThe media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions.
ChargeItemDefinition.applicability.expression0..1stringAn 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.
ChargeItemDefinition.propertyGroup0..*BackboneElementGroup of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
ChargeItemDefinition.propertyGroup.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ChargeItemDefinition.propertyGroup.extension0..*ExtensionMay 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.
ChargeItemDefinition.propertyGroup.modifierExtension0..*ExtensionMay 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).
ChargeItemDefinition.propertyGroup.applicability0..*ChargeItemDefinitionExpressions that describe applicability criteria for the priceComponent.
ChargeItemDefinition.propertyGroup.priceComponent0..*BackboneElementThe 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.
ChargeItemDefinition.propertyGroup.priceComponent.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
ChargeItemDefinition.propertyGroup.priceComponent.extension0..*ExtensionMay 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.
ChargeItemDefinition.propertyGroup.priceComponent.modifierExtension0..*ExtensionMay 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).
ChargeItemDefinition.propertyGroup.priceComponent.type1..1codeThis code identifies the type of the component.
ChargeItemDefinition.propertyGroup.priceComponent.code0..1CodeableConceptA code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
ChargeItemDefinition.propertyGroup.priceComponent.factor0..1decimalThe factor that has been applied on the base price for calculating this component.
ChargeItemDefinition.propertyGroup.priceComponent.amount0..1MoneyThe amount calculated for this component.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
contexttokenA use context assigned to the charge item definition(ChargeItemDefinition.useContext.value.ofType(CodeableConcept))
context-quantityquantityA quantity- or range-valued use context assigned to the charge item definition(ChargeItemDefinition.useContext.value.ofType(Quantity)) / (ChargeItemDefinition.useContext.value.ofType(Range))
context-typetokenA type of use context assigned to the charge item definitionChargeItemDefinition.useContext.code
datedateThe charge item definition publication dateChargeItemDefinition.date
descriptionstringThe description of the charge item definitionChargeItemDefinition.description
effectivedateThe time during which the charge item definition is intended to be in useChargeItemDefinition.effectivePeriod
identifiertokenExternal identifier for the charge item definitionChargeItemDefinition.identifier
jurisdictiontokenIntended jurisdiction for the charge item definitionChargeItemDefinition.jurisdiction
publisherstringName of the publisher of the charge item definitionChargeItemDefinition.publisher
statustokenThe current status of the charge item definitionChargeItemDefinition.status
titlestringThe human-friendly name of the charge item definitionChargeItemDefinition.title
urluriThe uri that identifies the charge item definitionChargeItemDefinition.url
versiontokenThe business version of the charge item definitionChargeItemDefinition.version
context-type-quantitycompositeA use context type and quantity- or range-based value assigned to the charge item definitionChargeItemDefinition.useContext
context-type-valuecompositeA use context type and value assigned to the charge item definitionChargeItemDefinition.useContext