Administrative Incubator
0.1.0 - International flag

Administrative Incubator, published by HL7 International / Patient Administration. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/admin-incubator/ and changes regularly. See the Directory of published versions

Resource: Charge Item Definition - Detailed Descriptions

Page standards status: Trial-use Maturity Level: 1

Definitions for the ChargeItemDefinition resource

Guidance on how to interpret the contents of this table can be foundhere

0. 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.


A resource that includes narrative, extensions, and contained resources.

ShortDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determinedA resource with narrative, extensions, and contained resources
Control0..*
Is Modifierfalse
Must Supportfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
2. ChargeItemDefinition.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
Comments

Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

Control0..1
Typeid
Is Modifierfalse
Must Supportfalse
Summarytrue
4. ChargeItemDefinition.meta
Definition

The 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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ChargeItemDefinition.implicitRules
Definition

A 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.

ShortA set of rules under which this content was created
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ChargeItemDefinition.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Control0..1
BindingThe codes SHALL be taken from AllLanguageshttp://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3
(required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

IETF language tag for a human language

Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supportfalse
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ChargeItemDefinition.text
Definition

A 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.

ShortText summary of the resource, for human interpretation
Comments

Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Control0..1
This element is affected by the following invariants: dom-6
TypeNarrative
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ChargeItemDefinition.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

ShortContained, inline Resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

Control0..*
This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. ChargeItemDefinition.extension
Definition

May 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 managable, 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.

ShortAdditional content defined by implementations
Comments

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.

Control0..*
TypeExtension
Is Modifierfalse
Must Supportfalse
Summaryfalse
Alternate Namesextensions, user content
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
SlicingThis element introduces a set of slices on ChargeItemDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. ChargeItemDefinition.modifierExtension
    Definition

    May 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 managable, 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).

    ShortExtensions that cannot be ignored
    Comments

    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Must Supportfalse
    Summarytrue
    Requirements

    Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

    Alternate Namesextensions, user content
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    SlicingThis element introduces a set of slices on ChargeItemDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
    • value @ url
    • 18. 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 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.

      ShortCanonical identifier for this charge item definition, represented as a URI (globally unique)
      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.

      Control0..1
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Allows the charge item definition to be referenced by a single globally unique identifier.

      Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
      20. 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.

      ShortAdditional identifier for the charge item definition
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Control0..*
      TypeIdentifier
      Summarytrue
      Requirements

      Allows externally provided and/or usable business identifiers to be easily associated with the module.

      22. 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.

      ShortBusiness version of the charge item definition
      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]. The version SHOULD NOT contain a '#' - see Business Version.

      NoteThis is a business version Id, not a resource version Id (see discussion)
      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      24. ChargeItemDefinition.versionAlgorithm[x]
      Definition

      Indicates the mechanism used to compare versions to determine which is more current.

      ShortHow to compare versions
      Comments

      If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

      Control0..1
      BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithmhttp://hl7.org/fhir/ValueSet/version-algorithm
      (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
      TypeChoice of: string, Coding
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      26. ChargeItemDefinition.name
      Definition

      A natural language name identifying the ChargeItemDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

      ShortName for this charge item definition (computer friendly)
      Comments

      The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

      Control0..1
      This element is affected by the following invariants: cnl-0
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Support human navigation and code generation.

      28. ChargeItemDefinition.title
      Definition

      A short, descriptive, user-friendly title for the charge item definition.

      ShortName for this charge item definition (human friendly)
      Comments

      This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      30. 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.

      ShortUnderlying externally-defined charge item definition
      Control0..*
      Typeuri
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      32. ChargeItemDefinition.partOf
      Definition

      A larger definition of which this particular definition is a component or step.

      ShortA larger definition of which this particular definition is a component or step
      Control0..*
      Typecanonical(Charge Item Definition)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate Namescontainer
      34. ChargeItemDefinition.replaces
      Definition

      As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

      ShortCompleted or terminated request(s) whose function is taken by this new request
      Control0..*
      Typecanonical(Charge Item Definition)
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate Namessupersedes, prior, renewed order
      36. ChargeItemDefinition.status
      Definition

      The current state of the ChargeItemDefinition.

      Shortdraft | active | retired | unknown
      Comments

      Allows filtering of charge item definitions that are appropriate for use versus not.

      See guidance around (not) making local changes to elements here.

      Control1..1
      BindingThe codes SHALL be taken from PublicationStatushttp://hl7.org/fhir/ValueSet/publication-status
      (required to http://hl7.org/fhir/ValueSet/publication-status)

      The lifecycle status of an artifact.

      Typecode
      Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      38. ChargeItemDefinition.experimental
      Definition

      A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

      ShortFor testing only - never for real usage
      Comments

      Allows filtering of charge item definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

      Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

      Control0..1
      Typeboolean
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.

      Meaning if MissingIf absent, this resource is treated as though it is not experimental.
      40. ChargeItemDefinition.date
      Definition

      The date (and optionally time) when the charge item definition was last significantly changed. 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.

      ShortDate last changed
      Comments

      The date is often not tracked until the resource is published, but may be present on draft content. 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.

      See guidance around (not) making local changes to elements here.

      Control0..1
      TypedateTime
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Alternate NamesRevision Date
      42. ChargeItemDefinition.account
      Definition

      A set of candidate accounts to which charge items using this definition may be assigned.

      ShortCandidate account(s) for charge items
      Comments

      An Account resource may represent either a patient-oriented account or an organizational account (e.g., a cost center). This property is intended for use with the cost center style accounts, and is not expected to refer to patient-oriented accounts. For example, if a ChargeItemDefinition is created to bill for a research procedure, this property could indicate that all charges for that procedure could be directed to the specified account.

      Control0..*
      TypeReference(Account)
      Summarytrue
      44. ChargeItemDefinition.publisher
      Definition

      The name of the organization or individual responsible for the release and ongoing maintenance of the charge item definition.

      ShortName of the publisher/steward (organization or individual)
      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.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      Requirements

      Helps establish the "authority/credibility" of the charge item definition. May also allow for contact.

      46. ChargeItemDefinition.contact
      Definition

      Contact details to assist a user in finding and communicating with the publisher.

      ShortContact details for the publisher
      Comments

      May be a web site, an email address, a telephone number, etc.

      See guidance around (not) making local changes to elements here.

      Control0..*
      TypeContactDetail
      Summarytrue
      48. ChargeItemDefinition.description
      Definition

      A free text natural language description of the charge item definition from a consumer's perspective.

      ShortNatural language description of the charge item definition
      Comments

      This description can be used to capture details such as 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).

      Control0..1
      Typemarkdown
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Summarytrue
      50. 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.

      ShortThe context that the content is intended to support
      Comments

      When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

      Control0..*
      TypeUsageContext
      Summarytrue
      Requirements

      Assist in searching for appropriate content.

      52. ChargeItemDefinition.jurisdiction
      Definition

      A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

      ShortJurisdiction of the authority that maintains the charge item definition (if applicable)
      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.

      DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

      Control0..*
      BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSethttp://terminology.hl7.org/ValueSet/jurisdiction
      (extensible to http://terminology.hl7.org/ValueSet/jurisdiction)

      Countries and regions within which this artifact is targeted for use.

      TypeCodeableConcept
      Summarytrue
      54. ChargeItemDefinition.purpose
      Definition

      Explanation of why this charge item definition is needed and why it has been designed as it has.

      ShortWhy this charge item definition is defined
      Comments

      This element does not describe the usage of the charge item definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this charge item definition.

      Control0..1
      Typemarkdown
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      56. ChargeItemDefinition.copyright
      Definition

      A copyright statement relating to the charge item definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the charge item definition.

      ShortNotice about intellectual property ownership, can include restrictions on use
      Control0..1
      Typemarkdown
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Requirements

      Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.

      Alternate NamesLicense, Restrictions
      58. ChargeItemDefinition.copyrightLabel
      Definition

      A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

      ShortCopyright holder and year(s)
      Comments

      The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

      Control0..1
      Typestring
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Requirements

      Defines the content expected to be rendered in all representations of the artifact.

      60. 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.

      ShortWhen the charge item definition was approved by publisher
      Comments

      The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

      See guidance around (not) making local changes to elements here.

      Control0..1
      Typedate
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      62. 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.

      ShortWhen the charge item definition was last reviewed by the publisher
      Comments

      If specified, this date follows the original approval date.

      See guidance around (not) making local changes to elements here.

      Control0..1
      Typedate
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      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.

      64. ChargeItemDefinition.code
      Definition

      The defined billing details in this resource pertain to the given billing code.

      ShortBilling code or product type this definition applies to
      Control0..1
      BindingFor example codes, see ChargeItemCodehttp://hl7.org/fhir/ValueSet/chargeitem-billingcodes
      (example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes)

      Billing Code defined by this ChargeItemDefinition.

      TypeCodeableConcept
      Summarytrue
      66. ChargeItemDefinition.instance
      Definition

      The defined billing details in this resource pertain to the given product instance(s).

      ShortInstances this definition applies to
      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.

      Control0..*
      TypeReference(Medication, Substance, Device, DeviceDefinition, ActivityDefinition, PlanDefinition, HealthcareService)
      68. ChargeItemDefinition.applicability
      Definition

      Expressions that describe applicability criteria for the billing code.

      ShortWhether or not the billing code is applicable
      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.

      Control0..*
      TypeBackboneElement
      Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
      70. ChargeItemDefinition.applicability.id
      Definition

      Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

      ShortUnique id for inter-element referencing
      Control0..1
      This element is affected by the following invariants: ele-1
      Typeidstring
      Is Modifierfalse
      XML FormatIn the XML format, this property is represented as an attribute.
      Summaryfalse
      72. ChargeItemDefinition.applicability.extension
      Definition

      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 managable, 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.

      ShortAdditional content defined by implementations
      Comments

      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.

      Control0..*
      TypeExtension
      Is Modifierfalse
      Summaryfalse
      Alternate Namesextensions, user content
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      SlicingThis element introduces a set of slices on ChargeItemDefinition.applicability.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 74. ChargeItemDefinition.applicability.modifierExtension
        Definition

        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 managable, 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).

        ShortExtensions that cannot be ignored even if unrecognized
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
        Summarytrue
        Requirements

        Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

        Alternate Namesextensions, user content, modifiers
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        76. ChargeItemDefinition.applicability.condition
        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.

        ShortBoolean-valued expression
        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.

        Control0..1
        TypeExpression
        78. ChargeItemDefinition.applicability.effectivePeriod
        Definition

        The period during which the charge item definition content was or is planned to be in active use.

        ShortWhen the charge item definition is expected to be used
        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.

        Control0..1
        TypePeriod
        Summarytrue
        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.

        80. ChargeItemDefinition.applicability.relatedArtifact
        Definition

        Reference to / quotation of the external source of the group of properties.

        ShortReference to / quotation of the external source of the group of properties
        Control0..1
        TypeRelatedArtifact
        82. 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.

        ShortGroup of properties which are applicable under the same conditions
        Control0..*
        TypeBackboneElement
        Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
        84. ChargeItemDefinition.propertyGroup.id
        Definition

        Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

        ShortUnique id for inter-element referencing
        Control0..1
        This element is affected by the following invariants: ele-1
        Typeidstring
        Is Modifierfalse
        XML FormatIn the XML format, this property is represented as an attribute.
        Summaryfalse
        86. ChargeItemDefinition.propertyGroup.extension
        Definition

        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 managable, 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.

        ShortAdditional content defined by implementations
        Comments

        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.

        Control0..*
        TypeExtension
        Is Modifierfalse
        Summaryfalse
        Alternate Namesextensions, user content
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        SlicingThis element introduces a set of slices on ChargeItemDefinition.propertyGroup.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
        • value @ url
        • 88. ChargeItemDefinition.propertyGroup.modifierExtension
          Definition

          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 managable, 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).

          ShortExtensions that cannot be ignored even if unrecognized
          Comments

          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.

          Control0..*
          TypeExtension
          Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
          Summarytrue
          Requirements

          Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

          Alternate Namesextensions, user content, modifiers
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          90. ChargeItemDefinition.propertyGroup.applicability
          Definition

          Expressions that describe applicability criteria for the priceComponent.

          ShortConditions under which the priceComponent is applicable
          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.

          Control0..*
          TypeSeettp://hl7.org/fhir/StructureDefinition/ChargeItemDefinition#ChargeItemDefinition.applicability
          92. 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.

          ShortComponents of total line item price
          Control0..*
          TypeMonetaryComponent

          Guidance on how to interpret the contents of this table can be foundhere

          0. 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.

          ShortDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
          Control0..*
          Invariantscnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
          2. 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 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.

          ShortCanonical identifier for this charge item definition, represented as a URI (globally unique)
          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.

          Control0..1
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Allows the charge item definition to be referenced by a single globally unique identifier.

          Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
          4. 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.

          ShortAdditional identifier for the charge item definition
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Requirements

          Allows externally provided and/or usable business identifiers to be easily associated with the module.

          6. 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.

          ShortBusiness version of the charge item definition
          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]. The version SHOULD NOT contain a '#' - see Business Version.

          NoteThis is a business version Id, not a resource version Id (see discussion)
          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          8. ChargeItemDefinition.versionAlgorithm[x]
          Definition

          Indicates the mechanism used to compare versions to determine which is more current.

          ShortHow to compare versions
          Comments

          If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

          Control0..1
          BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
          (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
          TypeChoice of: string, Coding
          [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          10. ChargeItemDefinition.name
          Definition

          A natural language name identifying the ChargeItemDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

          ShortName for this charge item definition (computer friendly)
          Comments

          The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

          Control0..1
          This element is affected by the following invariants: cnl-0
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Support human navigation and code generation.

          12. ChargeItemDefinition.title
          Definition

          A short, descriptive, user-friendly title for the charge item definition.

          ShortName for this charge item definition (human friendly)
          Comments

          This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          14. 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.

          ShortUnderlying externally-defined charge item definition
          Control0..*
          Typeuri
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          16. ChargeItemDefinition.partOf
          Definition

          A larger definition of which this particular definition is a component or step.

          ShortA larger definition of which this particular definition is a component or step
          Control0..*
          Typecanonical(Charge Item Definition)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Alternate Namescontainer
          18. ChargeItemDefinition.replaces
          Definition

          As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

          ShortCompleted or terminated request(s) whose function is taken by this new request
          Control0..*
          Typecanonical(Charge Item Definition)
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Alternate Namessupersedes, prior, renewed order
          20. ChargeItemDefinition.status
          Definition

          The current state of the ChargeItemDefinition.

          Shortdraft | active | retired | unknown
          Comments

          Allows filtering of charge item definitions that are appropriate for use versus not.

          See guidance around (not) making local changes to elements here.

          Control1..1
          BindingThe codes SHALL be taken from PublicationStatus
          (required to http://hl7.org/fhir/ValueSet/publication-status)

          The lifecycle status of an artifact.

          Typecode
          Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          22. ChargeItemDefinition.experimental
          Definition

          A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

          ShortFor testing only - never for real usage
          Comments

          Allows filtering of charge item definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

          Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

          Control0..1
          Typeboolean
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.

          Meaning if MissingIf absent, this resource is treated as though it is not experimental.
          24. ChargeItemDefinition.date
          Definition

          The date (and optionally time) when the charge item definition was last significantly changed. 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.

          ShortDate last changed
          Comments

          The date is often not tracked until the resource is published, but may be present on draft content. 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.

          See guidance around (not) making local changes to elements here.

          Control0..1
          TypedateTime
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Alternate NamesRevision Date
          26. ChargeItemDefinition.account
          Definition

          A set of candidate accounts to which charge items using this definition may be assigned.

          ShortCandidate account(s) for charge items
          Comments

          An Account resource may represent either a patient-oriented account or an organizational account (e.g., a cost center). This property is intended for use with the cost center style accounts, and is not expected to refer to patient-oriented accounts. For example, if a ChargeItemDefinition is created to bill for a research procedure, this property could indicate that all charges for that procedure could be directed to the specified account.

          Control0..*
          TypeReference(Account)
          28. ChargeItemDefinition.publisher
          Definition

          The name of the organization or individual responsible for the release and ongoing maintenance of the charge item definition.

          ShortName of the publisher/steward (organization or individual)
          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.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Helps establish the "authority/credibility" of the charge item definition. May also allow for contact.

          30. ChargeItemDefinition.contact
          Definition

          Contact details to assist a user in finding and communicating with the publisher.

          ShortContact details for the publisher
          Comments

          May be a web site, an email address, a telephone number, etc.

          See guidance around (not) making local changes to elements here.

          Control0..*
          TypeContactDetail
          32. ChargeItemDefinition.description
          Definition

          A free text natural language description of the charge item definition from a consumer's perspective.

          ShortNatural language description of the charge item definition
          Comments

          This description can be used to capture details such as 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).

          Control0..1
          Typemarkdown
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          34. 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.

          ShortThe context that the content is intended to support
          Comments

          When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

          Control0..*
          TypeUsageContext
          Requirements

          Assist in searching for appropriate content.

          36. ChargeItemDefinition.jurisdiction
          Definition

          A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

          ShortJurisdiction of the authority that maintains the charge item definition (if applicable)
          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.

          DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

          Control0..*
          BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
          (extensible to http://terminology.hl7.org/ValueSet/jurisdiction)

          Countries and regions within which this artifact is targeted for use.

          TypeCodeableConcept
          38. ChargeItemDefinition.purpose
          Definition

          Explanation of why this charge item definition is needed and why it has been designed as it has.

          ShortWhy this charge item definition is defined
          Comments

          This element does not describe the usage of the charge item definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this charge item definition.

          Control0..1
          Typemarkdown
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          40. ChargeItemDefinition.copyright
          Definition

          A copyright statement relating to the charge item definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the charge item definition.

          ShortNotice about intellectual property ownership, can include restrictions on use
          Control0..1
          Typemarkdown
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.

          Alternate NamesLicense, Restrictions
          42. ChargeItemDefinition.copyrightLabel
          Definition

          A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

          ShortCopyright holder and year(s)
          Comments

          The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

          Control0..1
          Typestring
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Requirements

          Defines the content expected to be rendered in all representations of the artifact.

          44. 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.

          ShortWhen the charge item definition was approved by publisher
          Comments

          The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

          See guidance around (not) making local changes to elements here.

          Control0..1
          Typedate
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          46. 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.

          ShortWhen the charge item definition was last reviewed by the publisher
          Comments

          If specified, this date follows the original approval date.

          See guidance around (not) making local changes to elements here.

          Control0..1
          Typedate
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          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.

          48. ChargeItemDefinition.code
          Definition

          The defined billing details in this resource pertain to the given billing code.

          ShortBilling code or product type this definition applies to
          Control0..1
          BindingFor example codes, see ChargeItemCode
          (example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes)

          Billing Code defined by this ChargeItemDefinition.

          TypeCodeableConcept
          50. ChargeItemDefinition.instance
          Definition

          The defined billing details in this resource pertain to the given product instance(s).

          ShortInstances this definition applies to
          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.

          Control0..*
          TypeReference(Medication, Substance, Device, DeviceDefinition, ActivityDefinition, PlanDefinition, HealthcareService)
          52. ChargeItemDefinition.applicability
          Definition

          Expressions that describe applicability criteria for the billing code.

          ShortWhether or not the billing code is applicable
          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.

          Control0..*
          TypeBackboneElement
          54. ChargeItemDefinition.applicability.condition
          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.

          ShortBoolean-valued expression
          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.

          Control0..1
          TypeExpression
          56. ChargeItemDefinition.applicability.effectivePeriod
          Definition

          The period during which the charge item definition content was or is planned to be in active use.

          ShortWhen the charge item definition is expected to be used
          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.

          Control0..1
          TypePeriod
          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.

          58. ChargeItemDefinition.applicability.relatedArtifact
          Definition

          Reference to / quotation of the external source of the group of properties.

          ShortReference to / quotation of the external source of the group of properties
          Control0..1
          TypeRelatedArtifact
          60. 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.

          ShortGroup of properties which are applicable under the same conditions
          Control0..*
          TypeBackboneElement
          62. ChargeItemDefinition.propertyGroup.applicability
          Definition

          Expressions that describe applicability criteria for the priceComponent.

          ShortConditions under which the priceComponent is applicable
          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.

          Control0..*
          TypeSeettp://hl7.org/fhir/StructureDefinition/ChargeItemDefinition#ChargeItemDefinition.applicability
          64. 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.

          ShortComponents of total line item price
          Control0..*
          TypeMonetaryComponent

          Guidance on how to interpret the contents of this table can be foundhere

          0. 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.

          ShortDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
          Control0..*
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())
          dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource (contained.where((('#'+id.trace('id') in %resource.descendants().select(reference | as(uri))) or descendants().where(reference='#' | as(uri)='#').exists()).not()).trace('unmatched', id).empty())
          dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
          dom-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
          dom-6: A resource should have narrative for robust management (text.`div`.exists())
          cnl-0: Name should be usable as an identifier for the module by machine processing applications such as code generation (name.exists() implies name.matches('^[A-Z]([A-Za-z0-9_]){1,254}$'))
          2. ChargeItemDefinition.id
          Definition

          The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

          ShortLogical id of this artifact
          Comments

          Within the context of the FHIR RESTful interactions, the resource has an id except for cases like the create and conditional update. Otherwise, the use of the resouce id depends on the given use case.

          Control0..1
          Typeid
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          4. ChargeItemDefinition.meta
          Definition

          The 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.

          ShortMetadata about the resource
          Control0..1
          TypeMeta
          Is Modifierfalse
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          6. ChargeItemDefinition.implicitRules
          Definition

          A 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.

          ShortA set of rules under which this content was created
          Comments

          Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of its narrative along with other profiles, value sets, etc.

          Control0..1
          Typeuri
          Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies its meaning or interpretation
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          8. ChargeItemDefinition.language
          Definition

          The base language in which the resource is written.

          ShortLanguage of the resource content
          Comments

          Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

          Control0..1
          BindingThe codes SHALL be taken from AllLanguages
          (required to http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot3)

          IETF language tag for a human language

          Typecode
          Is Modifierfalse
          Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
          Must Supportfalse
          Summaryfalse
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          10. ChargeItemDefinition.text
          Definition

          A 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.

          ShortText summary of the resource, for human interpretation
          Comments

          Contained resources do not have a narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

          Control0..1
          This element is affected by the following invariants: dom-6
          TypeNarrative
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesnarrative, html, xhtml, display
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          12. ChargeItemDefinition.contained
          Definition

          These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, nor can they have their own independent transaction scope. This is allowed to be a Parameters resource if and only if it is referenced by a resource that provides context/meaning.

          ShortContained, inline Resources
          Comments

          This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags in their meta elements, but SHALL NOT have security labels. Contained resources may be a resource type defined in the FHIR specification, or an additional resource.

          Control0..*
          This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
          TypeResource
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesinline resources, anonymous resources, contained resources
          14. ChargeItemDefinition.extension
          Definition

          May 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 managable, 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.

          ShortAdditional content defined by implementations
          Comments

          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.

          Control0..*
          TypeExtension
          Is Modifierfalse
          Must Supportfalse
          Summaryfalse
          Alternate Namesextensions, user content
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          SlicingThis element introduces a set of slices on ChargeItemDefinition.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 16. ChargeItemDefinition.modifierExtension
            Definition

            May 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 managable, 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).

            ShortExtensions that cannot be ignored
            Comments

            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.

            Control0..*
            TypeExtension
            Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
            Must Supportfalse
            Summarytrue
            Requirements

            Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

            Alternate Namesextensions, user content
            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            SlicingThis element introduces a set of slices on ChargeItemDefinition.modifierExtension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 18. 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 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.

              ShortCanonical identifier for this charge item definition, represented as a URI (globally unique)
              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.

              Control0..1
              Typeuri
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Allows the charge item definition to be referenced by a single globally unique identifier.

              Invariantscnl-1: URL should not contain | or # - these characters make processing canonical references problematic (exists() implies matches('^[^|# ]+$'))
              20. 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.

              ShortAdditional identifier for the charge item definition
              NoteThis is a business identifier, not a resource identifier (see discussion)
              Control0..*
              TypeIdentifier
              Summarytrue
              Requirements

              Allows externally provided and/or usable business identifiers to be easily associated with the module.

              22. 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.

              ShortBusiness version of the charge item definition
              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]. The version SHOULD NOT contain a '#' - see Business Version.

              NoteThis is a business version Id, not a resource version Id (see discussion)
              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              24. ChargeItemDefinition.versionAlgorithm[x]
              Definition

              Indicates the mechanism used to compare versions to determine which is more current.

              ShortHow to compare versions
              Comments

              If set as a string, this is a FHIRPath expression that has two additional context variables passed in - %version1 and %version2 and will return a negative number if version1 is newer, a positive number if version2 and a 0 if the version ordering can't be successfully be determined.

              Control0..1
              BindingUnless not suitable, these codes SHALL be taken from VersionAlgorithm
              (extensible to http://hl7.org/fhir/ValueSet/version-algorithm)
              TypeChoice of: string, Coding
              [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              26. ChargeItemDefinition.name
              Definition

              A natural language name identifying the ChargeItemDefinition. This name should be usable as an identifier for the module by machine processing applications such as code generation.

              ShortName for this charge item definition (computer friendly)
              Comments

              The name is not expected to be globally unique. The name should be a simple alphanumeric type name to ensure that it is machine-processing friendly.

              Control0..1
              This element is affected by the following invariants: cnl-0
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Support human navigation and code generation.

              28. ChargeItemDefinition.title
              Definition

              A short, descriptive, user-friendly title for the charge item definition.

              ShortName for this charge item definition (human friendly)
              Comments

              This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              30. 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.

              ShortUnderlying externally-defined charge item definition
              Control0..*
              Typeuri
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              32. ChargeItemDefinition.partOf
              Definition

              A larger definition of which this particular definition is a component or step.

              ShortA larger definition of which this particular definition is a component or step
              Control0..*
              Typecanonical(Charge Item Definition)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate Namescontainer
              34. ChargeItemDefinition.replaces
              Definition

              As new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.

              ShortCompleted or terminated request(s) whose function is taken by this new request
              Control0..*
              Typecanonical(Charge Item Definition)
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate Namessupersedes, prior, renewed order
              36. ChargeItemDefinition.status
              Definition

              The current state of the ChargeItemDefinition.

              Shortdraft | active | retired | unknown
              Comments

              Allows filtering of charge item definitions that are appropriate for use versus not.

              See guidance around (not) making local changes to elements here.

              Control1..1
              BindingThe codes SHALL be taken from PublicationStatus
              (required to http://hl7.org/fhir/ValueSet/publication-status)

              The lifecycle status of an artifact.

              Typecode
              Is Modifiertrue because This is labeled as "Is Modifier" because applications should not use a retired {{title}} without due consideration
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              38. ChargeItemDefinition.experimental
              Definition

              A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and no version of this resource will ever be intended for genuine usage.

              ShortFor testing only - never for real usage
              Comments

              Allows filtering of charge item definitions that are appropriate for use versus not.. Experimental resources might include example instances in implementation guides, instances created solely for testing purposes, etc. If experimental is 'true' for any version of a resource, it should be true for all versions of the resource. (If experimental changes, then it is being misused or a resource that was never intended for real-world use has unexpectedly changed its purpose.).

              Experimental resources are not expected to be stable and may well have breaking changes without a corresponding change to the 'version' element.

              Control0..1
              Typeboolean
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.

              Meaning if MissingIf absent, this resource is treated as though it is not experimental.
              40. ChargeItemDefinition.date
              Definition

              The date (and optionally time) when the charge item definition was last significantly changed. 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.

              ShortDate last changed
              Comments

              The date is often not tracked until the resource is published, but may be present on draft content. 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.

              See guidance around (not) making local changes to elements here.

              Control0..1
              TypedateTime
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Alternate NamesRevision Date
              42. ChargeItemDefinition.account
              Definition

              A set of candidate accounts to which charge items using this definition may be assigned.

              ShortCandidate account(s) for charge items
              Comments

              An Account resource may represent either a patient-oriented account or an organizational account (e.g., a cost center). This property is intended for use with the cost center style accounts, and is not expected to refer to patient-oriented accounts. For example, if a ChargeItemDefinition is created to bill for a research procedure, this property could indicate that all charges for that procedure could be directed to the specified account.

              Control0..*
              TypeReference(Account)
              Summarytrue
              44. ChargeItemDefinition.publisher
              Definition

              The name of the organization or individual responsible for the release and ongoing maintenance of the charge item definition.

              ShortName of the publisher/steward (organization or individual)
              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.

              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              Helps establish the "authority/credibility" of the charge item definition. May also allow for contact.

              46. ChargeItemDefinition.contact
              Definition

              Contact details to assist a user in finding and communicating with the publisher.

              ShortContact details for the publisher
              Comments

              May be a web site, an email address, a telephone number, etc.

              See guidance around (not) making local changes to elements here.

              Control0..*
              TypeContactDetail
              Summarytrue
              48. ChargeItemDefinition.description
              Definition

              A free text natural language description of the charge item definition from a consumer's perspective.

              ShortNatural language description of the charge item definition
              Comments

              This description can be used to capture details such as 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).

              Control0..1
              Typemarkdown
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              50. 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.

              ShortThe context that the content is intended to support
              Comments

              When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

              Control0..*
              TypeUsageContext
              Summarytrue
              Requirements

              Assist in searching for appropriate content.

              52. ChargeItemDefinition.jurisdiction
              Definition

              A legal or geographic region in which the authority that maintains the resource is operating. In general, the jurisdiction is also found in the useContext. The useContext may reference additional jurisdictions because the defining jurisdiction does not necessarily limit the jurisdictions of use.

              ShortJurisdiction of the authority that maintains the charge item definition (if applicable)
              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.

              DEPRECATION NOTE: For consistency, implementations are encouraged to migrate to using the new 'jurisdiction' code in the useContext element. (I.e. useContext.code indicating http://terminology.hl7.org/CodeSystem/usage-context-type#jurisdiction and useContext.valueCodeableConcept indicating the jurisdiction.)

              Control0..*
              BindingUnless not suitable, these codes SHALL be taken from Jurisdiction ValueSet
              (extensible to http://terminology.hl7.org/ValueSet/jurisdiction)

              Countries and regions within which this artifact is targeted for use.

              TypeCodeableConcept
              Summarytrue
              54. ChargeItemDefinition.purpose
              Definition

              Explanation of why this charge item definition is needed and why it has been designed as it has.

              ShortWhy this charge item definition is defined
              Comments

              This element does not describe the usage of the charge item definition. Instead, it provides traceability of ''why'' the resource is either needed or ''why'' it is defined as it is. This may be used to point to source materials or specifications that drove the structure of this charge item definition.

              Control0..1
              Typemarkdown
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              56. ChargeItemDefinition.copyright
              Definition

              A copyright statement relating to the charge item definition and/or its contents. Copyright statements are notices of intellectual property ownership and can include restrictions on the use and publishing of the charge item definition.

              ShortNotice about intellectual property ownership, can include restrictions on use
              Control0..1
              Typemarkdown
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Requirements

              Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.

              Alternate NamesLicense, Restrictions
              58. ChargeItemDefinition.copyrightLabel
              Definition

              A short string (<50 characters), suitable for inclusion in a page footer that identifies the copyright holder, effective period, and optionally whether rights are restricted. (e.g. 'All rights reserved', 'Some rights reserved').

              ShortCopyright holder and year(s)
              Comments

              The copyright symbol and the '(c)' textual representation SHOULD NOT be included in this string. It will be added by software when rendering the notation. Full details about licensing, restrictions, warrantees, etc. goes in the more general 'copyright' element.

              Control0..1
              Typestring
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Requirements

              Defines the content expected to be rendered in all representations of the artifact.

              60. 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.

              ShortWhen the charge item definition was approved by publisher
              Comments

              The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

              See guidance around (not) making local changes to elements here.

              Control0..1
              Typedate
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              62. 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.

              ShortWhen the charge item definition was last reviewed by the publisher
              Comments

              If specified, this date follows the original approval date.

              See guidance around (not) making local changes to elements here.

              Control0..1
              Typedate
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              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.

              64. ChargeItemDefinition.code
              Definition

              The defined billing details in this resource pertain to the given billing code.

              ShortBilling code or product type this definition applies to
              Control0..1
              BindingFor example codes, see ChargeItemCode
              (example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes)

              Billing Code defined by this ChargeItemDefinition.

              TypeCodeableConcept
              Summarytrue
              66. ChargeItemDefinition.instance
              Definition

              The defined billing details in this resource pertain to the given product instance(s).

              ShortInstances this definition applies to
              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.

              Control0..*
              TypeReference(Medication, Substance, Device, DeviceDefinition, ActivityDefinition, PlanDefinition, HealthcareService)
              68. ChargeItemDefinition.applicability
              Definition

              Expressions that describe applicability criteria for the billing code.

              ShortWhether or not the billing code is applicable
              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.

              Control0..*
              TypeBackboneElement
              Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
              70. ChargeItemDefinition.applicability.id
              Definition

              Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

              ShortUnique id for inter-element referencing
              Control0..1
              This element is affected by the following invariants: ele-1
              Typeid
              Is Modifierfalse
              XML FormatIn the XML format, this property is represented as an attribute.
              Summaryfalse
              72. ChargeItemDefinition.applicability.extension
              Definition

              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 managable, 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.

              ShortAdditional content defined by implementations
              Comments

              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.

              Control0..*
              TypeExtension
              Is Modifierfalse
              Summaryfalse
              Alternate Namesextensions, user content
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              SlicingThis element introduces a set of slices on ChargeItemDefinition.applicability.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 74. ChargeItemDefinition.applicability.modifierExtension
                Definition

                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 managable, 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).

                ShortExtensions that cannot be ignored even if unrecognized
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                Summarytrue
                Requirements

                Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                Alternate Namesextensions, user content, modifiers
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                76. ChargeItemDefinition.applicability.condition
                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.

                ShortBoolean-valued expression
                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.

                Control0..1
                TypeExpression
                78. ChargeItemDefinition.applicability.effectivePeriod
                Definition

                The period during which the charge item definition content was or is planned to be in active use.

                ShortWhen the charge item definition is expected to be used
                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.

                Control0..1
                TypePeriod
                Summarytrue
                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.

                80. ChargeItemDefinition.applicability.relatedArtifact
                Definition

                Reference to / quotation of the external source of the group of properties.

                ShortReference to / quotation of the external source of the group of properties
                Control0..1
                TypeRelatedArtifact
                82. 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.

                ShortGroup of properties which are applicable under the same conditions
                Control0..*
                TypeBackboneElement
                Invariantsele-1: All FHIR elements must have a @value or children or both (hasValue() or (children().count() > id.count()))
                84. ChargeItemDefinition.propertyGroup.id
                Definition

                Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

                ShortUnique id for inter-element referencing
                Control0..1
                This element is affected by the following invariants: ele-1
                Typeid
                Is Modifierfalse
                XML FormatIn the XML format, this property is represented as an attribute.
                Summaryfalse
                86. ChargeItemDefinition.propertyGroup.extension
                Definition

                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 managable, 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.

                ShortAdditional content defined by implementations
                Comments

                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.

                Control0..*
                TypeExtension
                Is Modifierfalse
                Summaryfalse
                Alternate Namesextensions, user content
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                SlicingThis element introduces a set of slices on ChargeItemDefinition.propertyGroup.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
                • value @ url
                • 88. ChargeItemDefinition.propertyGroup.modifierExtension
                  Definition

                  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 managable, 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).

                  ShortExtensions that cannot be ignored even if unrecognized
                  Comments

                  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.

                  Control0..*
                  TypeExtension
                  Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
                  Summarytrue
                  Requirements

                  Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

                  Alternate Namesextensions, user content, modifiers
                  Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                  90. ChargeItemDefinition.propertyGroup.applicability
                  Definition

                  Expressions that describe applicability criteria for the priceComponent.

                  ShortConditions under which the priceComponent is applicable
                  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.

                  Control0..*
                  TypeSeettp://hl7.org/fhir/StructureDefinition/ChargeItemDefinition#ChargeItemDefinition.applicability
                  92. 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.

                  ShortComponents of total line item price
                  Control0..*
                  TypeMonetaryComponent