Order Catalog Implementation Guide
current - CI Build International flag

Order Catalog Implementation Guide, published by HL7 International - Orders and Observations Work Group. This is not an authorized publication; it is the continuous build for version current). This version is based on the current content of https://github.com/HL7/fhir-order-catalog/ and changes regularly. See the Directory of published versions

Resource Profile: LabChargeItemDefinition - Detailed Descriptions

Draft as of 2020-02-09

Definitions for the LabChargeItemDefinition resource profile.

Guidance on how to interpret the contents of this table can be found here.

1. ChargeItemDefinition
2. ChargeItemDefinition.title
Control0..?
3. ChargeItemDefinition.title.extension
Control0..?
SlicingThis element introduces a set of slices on ChargeItemDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
4. ChargeItemDefinition.title.extension:LanguageSynonym
SliceNameLanguageSynonym
Control0..?
TypeExtension(Translation) (Complex Extension)
5. ChargeItemDefinition.useContext
Must Supporttrue
SlicingThis element introduces a set of slices on ChargeItemDefinition.useContext. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code.system
  • value @ code.system,
6. ChargeItemDefinition.useContext:ClinicalFocus
SliceNameClinicalFocus
Control0..?
Must Supporttrue
Comments

When multiple clinical focus contexts are specified the billing code is applicable if at least one of these contexts is present in the instance

7. ChargeItemDefinition.useContext:ClinicalFocus.code
Control0..?
8. ChargeItemDefinition.useContext:ClinicalFocus.code.system
Control0..?
Fixed Valuehttp://terminology.hl7.org/CodeSystem/usage-context-type
9. ChargeItemDefinition.useContext:ClinicalFocus.code.code
Control0..?
Fixed Valuefocus
10. ChargeItemDefinition.useContext:ClinicalFocus.value[x]
Control0..?
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
11. ChargeItemDefinition.useContext:ClinicalFocus.value[x].coding
Control0..?
BindingFor example codes, see All possible clinical contexts for any lab test All contexts for any laboratory tes
12. ChargeItemDefinition.code
Control10..1
Must Supporttrue

Guidance on how to interpret the contents of this table can be found here.

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

Control0..*
Summaryfalse
InvariantsDefined on this element
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.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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
3. 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.

Control0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained 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.

4. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
5. ChargeItemDefinition.status
Definition

The current state of the ChargeItemDefinition.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus

The lifecycle status of an artifact.

Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. 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.

Control0..*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

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

InvariantsDefined on this element
ele-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.useContext. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code.system
  • value @ code.system,
7. ChargeItemDefinition.useContext:ClinicalFocus
SliceNameClinicalFocus
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.

Control0..*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple clinical focus contexts are specified the billing code is applicable if at least one of these contexts is present in the instance

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
8. ChargeItemDefinition.useContext:ClinicalFocus.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable

A code that specifies a type of context being specified by a usage context.

TypeCoding
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
9. ChargeItemDefinition.useContext:ClinicalFocus.code.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

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

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/usage-context-type
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
10. ChargeItemDefinition.useContext:ClinicalFocus.code.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1 This element is affected by the following invariants: cod-1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Valuefocus
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. ChargeItemDefinition.useContext:ClinicalFocus.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet

A code that defines the specific value for the context being specified.

TypeChoice of: CodeableConcept, Reference(PlanDefinition|ResearchStudy|InsurancePlan|HealthcareService|Group|Location|Organization), Quantity, Range
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. ChargeItemDefinition.useContext:ClinicalFocus.value[x].coding
Definition

A reference to a code defined by a terminology system.

Control0..*
BindingFor example codes, see All possible clinical contexts for any lab testFor codes, see (unbound) All contexts for any laboratory tes
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. ChargeItemDefinition.code
Definition

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

Control10..1
BindingFor example codes, see ChargeItemCode

Billing Code defined by this ChargeItemDefinition.

TypeCodeableConcept
Must Supporttrue
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here.

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

Control0..*
Summaryfalse
2. ChargeItemDefinition.id
Definition

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

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

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

Control0..1
TypeMeta
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
4. 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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
5. ChargeItemDefinition.language
Definition

The base language in which the resource is written.

Control0..1
BindingThe codes SHALL be taken from AllLanguages IETF language tag for a human languag
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
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).

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
6. 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.

Control0..1 This element is affected by the following invariants: dom-6
TypeNarrative
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
7. 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.

Control0..* This element is affected by the following invariants: dom-2, dom-4, dom-3, dom-5
TypeResource
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained 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.

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

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
9. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
10. 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.

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.

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.

InvariantsDefined on this element
cnl-1: URL should not contain | or # - these characters make processing canonical references problematic (: exists() implies matches('^[^|# ]+$'))
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
11. 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.

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.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
12. 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.

NoteThis is a business versionId, 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
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
13. ChargeItemDefinition.versionAlgorithm[x]
Definition

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

Control0..1
BindingThe codes SHALL be taken from VersionAlgorithm; other codes may be used where these codes are not suitable
TypeChoice of: string, Coding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
14. 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.

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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
15. ChargeItemDefinition.title
Definition

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

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
16. ChargeItemDefinition.title.id
Definition

unique id for the element within a resource (for internal references)

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
17. ChargeItemDefinition.title.extension
Definition

An Extension

Control0..*
TypeExtension
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ChargeItemDefinition.title.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
18. ChargeItemDefinition.title.extension:LanguageSynonym
SliceNameLanguageSynonym
Definition

Language translation from base language of resource to another language.

Control0..*
TypeExtension(Translation) (Complex Extension)
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
19. ChargeItemDefinition.title.value
Definition

The actual value

Control0..1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
Max Length1048576
20. 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.

Control0..*
Typeuri
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
21. ChargeItemDefinition.partOf
Definition

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

Control0..*
Typecanonical(ChargeItemDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namescontainer
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
22. ChargeItemDefinition.replaces
Definition

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

Control0..*
Typecanonical(ChargeItemDefinition)
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Alternate Namessupersedes, prior, renewed order
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
23. ChargeItemDefinition.status
Definition

The current state of the ChargeItemDefinition.

Control1..1
BindingThe codes SHALL be taken from PublicationStatus The lifecycle status of an artifact
Typecode
Is Modifiertrue
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Comments

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
24. ChargeItemDefinition.experimental
Definition

A Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.

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.

Comments

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

Meaning if MissingIf absent, this resource is treated as though it is not experimental.
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
25. 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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
26. ChargeItemDefinition.publisher
Definition

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

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

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

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
27. ChargeItemDefinition.contact
Definition

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

Control0..*
TypeContactDetail
Summarytrue
Comments

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
28. ChargeItemDefinition.description
Definition

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
29. 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.

Control0..*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

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

InvariantsDefined on this element
ele-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.useContext. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ code.system
  • value @ code.system,
30. ChargeItemDefinition.useContext:ClinicalFocus
SliceNameClinicalFocus
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.

Control0..*
TypeUsageContext
Must Supporttrue
Summarytrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple clinical focus contexts are specified the billing code is applicable if at least one of these contexts is present in the instance

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
31. ChargeItemDefinition.useContext:ClinicalFocus.id
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
32. ChargeItemDefinition.useContext:ClinicalFocus.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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ChargeItemDefinition.useContext.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
33. ChargeItemDefinition.useContext:ClinicalFocus.code
Definition

A code that identifies the type of context being specified by this usage context.

Control1..1
BindingThe codes SHALL be taken from UsageContextType; other codes may be used where these codes are not suitable A code that specifies a type of context being specified by a usage context
TypeCoding
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
34. ChargeItemDefinition.useContext:ClinicalFocus.code.id
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
35. ChargeItemDefinition.useContext:ClinicalFocus.code.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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ChargeItemDefinition.useContext.code.extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
36. ChargeItemDefinition.useContext:ClinicalFocus.code.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

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

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should be an absolute reference to some definition that establishes the system clearly and unambiguously.

Fixed Valuehttp://terminology.hl7.org/CodeSystem/usage-context-type
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
37. ChargeItemDefinition.useContext:ClinicalFocus.code.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, 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
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
38. ChargeItemDefinition.useContext:ClinicalFocus.code.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1 This element is affected by the following invariants: cod-1
Typecode
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
Summarytrue
Requirements

Need to refer to a particular code in the system.

Fixed Valuefocus
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
39. ChargeItemDefinition.useContext:ClinicalFocus.code.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

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

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
40. ChargeItemDefinition.useContext:ClinicalFocus.code.userSelected
Definition

Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

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

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
41. ChargeItemDefinition.useContext:ClinicalFocus.value[x]
Definition

A value that defines the context specified in this context of use. The interpretation of the value is defined by the code.

Control1..1
BindingFor example codes, see ContextOfUseValueSet A code that defines the specific value for the context being specified
TypeCodeableConcept
[x] NoteSee Choice of Data Types for further information about how to use [x]
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
42. ChargeItemDefinition.useContext:ClinicalFocus.value[x].id
Definition

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

Control0..1 This element is affected by the following invariants: ele-1
Typeid
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
43. ChargeItemDefinition.useContext:ClinicalFocus.value[x].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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
SlicingThis element introduces a set of slices on ChargeItemDefinition.useContext.value[x].extension. The slices are unordered and Open, and can be differentiated using the following discriminators:
  • value @ url
44. ChargeItemDefinition.useContext:ClinicalFocus.value[x].coding
Definition

A reference to a code defined by a terminology system.

Control0..*
BindingFor example codes, see All possible clinical contexts for any lab test All contexts for any laboratory tes
TypeCoding
Summarytrue
Requirements

Allows for alternative encodings within a code system, and translations to other code systems.

Comments

Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
45. ChargeItemDefinition.useContext:ClinicalFocus.value[x].text
Definition

A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

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

The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

Comments

Very often the text is the same as a displayName of one of the codings.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
46. ChargeItemDefinition.jurisdiction
Definition

A legal or geographic region in which the charge item definition is intended to be used.

Control0..*
BindingThe codes SHALL be taken from JurisdictionValueSet; other codes may be used where these codes are not suitable Countries and regions within which this artifact is targeted for use
TypeCodeableConcept
Obligations
Obligations
??
Standards StatusDeprecated (from Trial Use)
Summarytrue
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.)

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
47. ChargeItemDefinition.purpose
Definition

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

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
48. ChargeItemDefinition.copyright
Definition

A copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.

Control0..1
Typemarkdown
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Obligations
Obligations
??
??
Summaryfalse
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
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
49. 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 resctricted. (e.g. 'All rights reserved', 'Some rights reserved').

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

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

Comments

The (c) symbol 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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
50. 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.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
51. 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.

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

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
52. ChargeItemDefinition.code
Definition

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

Control1..1
BindingFor example codes, see ChargeItemCode Billing Code defined by this ChargeItemDefinition
TypeCodeableConcept
Must Supporttrue
Summarytrue
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
53. ChargeItemDefinition.instance
Definition

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

Control0..*
TypeReference(Medication|Substance|Device|DeviceDefinition|ActivityDefinition|PlanDefinition|HealthcareService)
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
54. ChargeItemDefinition.applicability
Definition

Expressions that describe applicability criteria for the billing code.

Control0..*
TypeBackboneElement
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
55. 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.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
56. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
57. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
58. 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.

Control0..1
TypeExpression
Summaryfalse
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
59. ChargeItemDefinition.applicability.effectivePeriod
Definition

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

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.

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
60. ChargeItemDefinition.applicability.relatedArtifact
Definition

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

Control0..1
TypeRelatedArtifact
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
61. 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.

Control0..*
TypeBackboneElement
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
62. 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.

Control0..1 This element is affected by the following invariants: ele-1
Typestring
XML RepresentationIn the XML format, this property is represented as an attribute.
Summaryfalse
63. 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.

Control0..*
TypeExtension
Summaryfalse
Alternate Namesextensions, user content
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
64. 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).

Control0..*
TypeExtension
Is Modifiertrue
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
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
ext-1: Must have either extensions or value[x], not both (: extension.exists() != value.exists())
65. ChargeItemDefinition.propertyGroup.applicability
Definition

Expressions that describe applicability criteria for the priceComponent.

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

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))
66. 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.

Control0..*
TypeMonetaryComponent
Summaryfalse
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() or (children().count() > id.count()))