Extensions for Using Data Elements from FHIR R4B in FHIR R5
0.1.0 - STU International flag

Extensions for Using Data Elements from FHIR R4B in FHIR R5 - Downloaded Version null See the Directory of published versions

Resource Profile: Profile_R4B_ChargeItemDefinition_R5

Official URL: http://hl7.org/fhir/4.3/StructureDefinition/profile-ChargeItemDefinition Version: 0.1.0
Standards status: Trial-use Maturity Level: 0 Computable Name: Profile_R4B_ChargeItemDefinition_R5

This cross-version profile allows R4B ChargeItemDefinition content to be represented via FHIR R5 ChargeItemDefinition resources.

Usages:

  • This Profile is not used by any profiles in this Implementation Guide

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition(5.0.0) Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R4B: When the charge item definition is expected to be used (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.effectivePeriod
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ChargeItemDefinition 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}$')
ele-1 error ChargeItemDefinition.implicitRules, ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension, ChargeItemDefinition.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition 0..* ChargeItemDefinition(5.0.0) Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:effectivePeriod 0..1 Period R4B: When the charge item definition is expected to be used (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.effectivePeriod
... applicability
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description 0..1 string R4B: Natural language description of the condition (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.description
..... extension:language 0..1 string R4B: Language of the expression (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.language
.... condition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expression 0..1 string R4B: expression additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.expression
... propertyGroup
.... priceComponent
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 1..1 code R4B: base | surcharge | deduction | discount | tax | informational (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.type
Binding: R4BInvoicePriceComponentTypeForR5 (0.1.0) (required): Codes indicating the kind of the price component.
...... extension:code 0..1 CodeableConcept R4B: Code identifying the specific component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.code
...... extension:factor 0..1 decimal R4B: Factor used for calculating this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.factor
...... extension:amount 0..1 Money R4B: Monetary amount associated with this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.amount

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition(5.0.0) Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cnl-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R4B: When the charge item definition is expected to be used (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.effectivePeriod
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 0..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the charge item definition
... version Σ 0..1 string Business version of the charge item definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this charge item definition (computer friendly)
... title Σ 0..1 string Name for this charge item definition (human friendly)
... derivedFromUri Σ 0..* uri Underlying externally-defined charge item definition
... partOf Σ 0..* canonical(ChargeItemDefinition) A larger definition of which this particular definition is a component or step
... replaces Σ 0..* canonical(ChargeItemDefinition) Completed or terminated request(s) whose function is taken by this new request
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the charge item definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this charge item definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the charge item definition was approved by publisher
... lastReviewDate 0..1 date When the charge item definition was last reviewed by the publisher
... code Σ 0..1 CodeableConcept Billing code or product type this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.
... instance 0..* Reference(Medication | Substance | Device | DeviceDefinition | ActivityDefinition | PlanDefinition | HealthcareService) Instances this definition applies to
... applicability 0..* BackboneElement Whether or not the billing code is applicable
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:description 0..1 string R4B: Natural language description of the condition (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.description
Constraints: ext-1
..... extension:language 0..1 string R4B: Language of the expression (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.language
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition 0..1 Expression Boolean-valued expression
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:expression 0..1 string R4B: expression additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.expression
Constraints: ext-1
..... description Σ 0..1 string Natural language description of the condition
..... name ΣC 0..1 code Short name assigned to expression for reuse
..... language Σ 0..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional BindingsPurpose
MimeTypes Max Binding
..... expression ΣC 0..1 string Expression in specified language
..... reference ΣC 0..1 uri Where the expression is found
.... effectivePeriod Σ 0..1 Period When the charge item definition is expected to be used
.... relatedArtifact 0..1 RelatedArtifact Reference to / quotation of the external source of the group of properties
... propertyGroup 0..* BackboneElement Group of properties which are applicable under the same conditions
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... applicability 0..* See applicability (ChargeItemDefinition) Conditions under which the priceComponent is applicable
.... priceComponent 0..* MonetaryComponent Components of total line item price
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 1..1 code R4B: base | surcharge | deduction | discount | tax | informational (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.type
Binding: R4BInvoicePriceComponentTypeForR5 (0.1.0) (required): Codes indicating the kind of the price component.
Constraints: ext-1
...... extension:code 0..1 CodeableConcept R4B: Code identifying the specific component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.code
Constraints: ext-1
...... extension:factor 0..1 decimal R4B: Factor used for calculating this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.factor
Constraints: ext-1
...... extension:amount 0..1 Money R4B: Monetary amount associated with this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.amount
Constraints: ext-1
..... type Σ 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: PriceComponentType (required): The purpose for which an extended contact detail should be used.
..... code Σ 0..1 CodeableConcept Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
Binding Description: (example): Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
..... factor Σ 0..1 decimal Factor used for calculating this component
..... amount Σ 0..1 Money Explicit value amount to be used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
ChargeItemDefinition.​versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
ChargeItemDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
ChargeItemDefinition.​jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
ChargeItemDefinition.​code Base example Charge Item Code 📍5.0.0 FHIR Std.
ChargeItemDefinition.​applicability.condition.​language Base extensible Expression Language 📍5.0.0 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​type Base required Price Component Type 📍5.0.0 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​code Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ChargeItemDefinition 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}$')
cnl-1 warning ChargeItemDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error ChargeItemDefinition.meta, ChargeItemDefinition.implicitRules, ChargeItemDefinition.language, ChargeItemDefinition.text, ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension, ChargeItemDefinition.url, ChargeItemDefinition.identifier, ChargeItemDefinition.version, ChargeItemDefinition.versionAlgorithm[x], ChargeItemDefinition.name, ChargeItemDefinition.title, ChargeItemDefinition.derivedFromUri, ChargeItemDefinition.partOf, ChargeItemDefinition.replaces, ChargeItemDefinition.status, ChargeItemDefinition.experimental, ChargeItemDefinition.date, ChargeItemDefinition.publisher, ChargeItemDefinition.contact, ChargeItemDefinition.description, ChargeItemDefinition.useContext, ChargeItemDefinition.jurisdiction, ChargeItemDefinition.purpose, ChargeItemDefinition.copyright, ChargeItemDefinition.copyrightLabel, ChargeItemDefinition.approvalDate, ChargeItemDefinition.lastReviewDate, ChargeItemDefinition.code, ChargeItemDefinition.instance, ChargeItemDefinition.applicability, ChargeItemDefinition.applicability.extension, ChargeItemDefinition.applicability.extension:description, ChargeItemDefinition.applicability.extension:language, ChargeItemDefinition.applicability.modifierExtension, ChargeItemDefinition.applicability.condition, ChargeItemDefinition.applicability.condition.extension, ChargeItemDefinition.applicability.condition.extension:expression, ChargeItemDefinition.applicability.condition.description, ChargeItemDefinition.applicability.condition.name, ChargeItemDefinition.applicability.condition.language, ChargeItemDefinition.applicability.condition.expression, ChargeItemDefinition.applicability.condition.reference, ChargeItemDefinition.applicability.effectivePeriod, ChargeItemDefinition.applicability.relatedArtifact, ChargeItemDefinition.propertyGroup, ChargeItemDefinition.propertyGroup.extension, ChargeItemDefinition.propertyGroup.modifierExtension, ChargeItemDefinition.propertyGroup.applicability, ChargeItemDefinition.propertyGroup.priceComponent, ChargeItemDefinition.propertyGroup.priceComponent.extension, ChargeItemDefinition.propertyGroup.priceComponent.extension:type, ChargeItemDefinition.propertyGroup.priceComponent.extension:code, ChargeItemDefinition.propertyGroup.priceComponent.extension:factor, ChargeItemDefinition.propertyGroup.priceComponent.extension:amount, ChargeItemDefinition.propertyGroup.priceComponent.type, ChargeItemDefinition.propertyGroup.priceComponent.code, ChargeItemDefinition.propertyGroup.priceComponent.factor, ChargeItemDefinition.propertyGroup.priceComponent.amount All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension, ChargeItemDefinition.applicability.extension, ChargeItemDefinition.applicability.extension:description, ChargeItemDefinition.applicability.extension:language, ChargeItemDefinition.applicability.modifierExtension, ChargeItemDefinition.applicability.condition.extension, ChargeItemDefinition.applicability.condition.extension:expression, ChargeItemDefinition.propertyGroup.extension, ChargeItemDefinition.propertyGroup.modifierExtension, ChargeItemDefinition.propertyGroup.priceComponent.extension, ChargeItemDefinition.propertyGroup.priceComponent.extension:type, ChargeItemDefinition.propertyGroup.priceComponent.extension:code, ChargeItemDefinition.propertyGroup.priceComponent.extension:factor, ChargeItemDefinition.propertyGroup.priceComponent.extension:amount Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition(5.0.0) Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cnl-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R4B: When the charge item definition is expected to be used (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.effectivePeriod
Constraints: ext-1
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ChargeItemDefinition 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}$')
ele-1 error ChargeItemDefinition.implicitRules, ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension, ChargeItemDefinition.status All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition 0..* ChargeItemDefinition(5.0.0) Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:effectivePeriod 0..1 Period R4B: When the charge item definition is expected to be used (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.effectivePeriod
... applicability
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
..... extension:description 0..1 string R4B: Natural language description of the condition (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.description
..... extension:language 0..1 string R4B: Language of the expression (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.language
.... condition
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:expression 0..1 string R4B: expression additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.expression
... propertyGroup
.... priceComponent
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:type 1..1 code R4B: base | surcharge | deduction | discount | tax | informational (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.type
Binding: R4BInvoicePriceComponentTypeForR5 (0.1.0) (required): Codes indicating the kind of the price component.
...... extension:code 0..1 CodeableConcept R4B: Code identifying the specific component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.code
...... extension:factor 0..1 decimal R4B: Factor used for calculating this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.factor
...... extension:amount 0..1 Money R4B: Monetary amount associated with this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.amount

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition(5.0.0) Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cnl-0
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: AllLanguages (required): IETF language tag for a human language
Additional BindingsPurpose
CommonLanguages Starter
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
.... extension:effectivePeriod 0..1 Period R4B: When the charge item definition is expected to be used (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.effectivePeriod
Constraints: ext-1
... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
Constraints: ext-1
... url ΣC 0..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
Constraints: cnl-1
... identifier Σ 0..* Identifier Additional identifier for the charge item definition
... version Σ 0..1 string Business version of the charge item definition
... versionAlgorithm[x] Σ 0..1 How to compare versions
Binding: VersionAlgorithm (extensible)
.... versionAlgorithmString string
.... versionAlgorithmCoding Coding
... name ΣC 0..1 string Name for this charge item definition (computer friendly)
... title Σ 0..1 string Name for this charge item definition (human friendly)
... derivedFromUri Σ 0..* uri Underlying externally-defined charge item definition
... partOf Σ 0..* canonical(ChargeItemDefinition) A larger definition of which this particular definition is a component or step
... replaces Σ 0..* canonical(ChargeItemDefinition) Completed or terminated request(s) whose function is taken by this new request
... status ?!Σ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher/steward (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description Σ 0..1 markdown Natural language description of the charge item definition
... useContext Σ 0..* UsageContext The context that the content is intended to support
... jurisdiction Σ 0..* CodeableConcept Intended jurisdiction for charge item definition (if applicable)
Binding: JurisdictionValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... purpose 0..1 markdown Why this charge item definition is defined
... copyright 0..1 markdown Use and/or publishing restrictions
... copyrightLabel 0..1 string Copyright holder and year(s)
... approvalDate 0..1 date When the charge item definition was approved by publisher
... lastReviewDate 0..1 date When the charge item definition was last reviewed by the publisher
... code Σ 0..1 CodeableConcept Billing code or product type this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.
... instance 0..* Reference(Medication | Substance | Device | DeviceDefinition | ActivityDefinition | PlanDefinition | HealthcareService) Instances this definition applies to
... applicability 0..* BackboneElement Whether or not the billing code is applicable
.... id 0..1 string Unique id for inter-element referencing
.... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
..... extension:description 0..1 string R4B: Natural language description of the condition (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.description
Constraints: ext-1
..... extension:language 0..1 string R4B: Language of the expression (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.language
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... condition 0..1 Expression Boolean-valued expression
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:expression 0..1 string R4B: expression additional types
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.applicability.expression
Constraints: ext-1
..... description Σ 0..1 string Natural language description of the condition
..... name ΣC 0..1 code Short name assigned to expression for reuse
..... language Σ 0..1 code text/cql | text/fhirpath | application/x-fhir-query | etc.
Binding: ExpressionLanguage (extensible): The media type of the expression language.
Additional BindingsPurpose
MimeTypes Max Binding
..... expression ΣC 0..1 string Expression in specified language
..... reference ΣC 0..1 uri Where the expression is found
.... effectivePeriod Σ 0..1 Period When the charge item definition is expected to be used
.... relatedArtifact 0..1 RelatedArtifact Reference to / quotation of the external source of the group of properties
... propertyGroup 0..* BackboneElement Group of properties which are applicable under the same conditions
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Constraints: ext-1
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
Constraints: ext-1
.... applicability 0..* See applicability (ChargeItemDefinition) Conditions under which the priceComponent is applicable
.... priceComponent 0..* MonetaryComponent Components of total line item price
..... id 0..1 id Unique id for inter-element referencing
..... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
Constraints: ext-1
...... extension:type 1..1 code R4B: base | surcharge | deduction | discount | tax | informational (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.type
Binding: R4BInvoicePriceComponentTypeForR5 (0.1.0) (required): Codes indicating the kind of the price component.
Constraints: ext-1
...... extension:code 0..1 CodeableConcept R4B: Code identifying the specific component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.code
Constraints: ext-1
...... extension:factor 0..1 decimal R4B: Factor used for calculating this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.factor
Constraints: ext-1
...... extension:amount 0..1 Money R4B: Monetary amount associated with this component (new)
URL: http://hl7.org/fhir/4.3/StructureDefinition/extension-ChargeItemDefinition.propertyGroup.priceComponent.amount
Constraints: ext-1
..... type Σ 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: PriceComponentType (required): The purpose for which an extended contact detail should be used.
..... code Σ 0..1 CodeableConcept Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
Binding Description: (example): Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
..... factor Σ 0..1 decimal Factor used for calculating this component
..... amount Σ 0..1 Money Explicit value amount to be used

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​language Base required All Languages 📍5.0.0 FHIR Std.
ChargeItemDefinition.​versionAlgorithm[x] Base extensible Version Algorithm 📍5.0.0 FHIR Std.
ChargeItemDefinition.​status Base required PublicationStatus 📍5.0.0 FHIR Std.
ChargeItemDefinition.​jurisdiction Base extensible Jurisdiction ValueSet 📍5.0.0 FHIR Std.
ChargeItemDefinition.​code Base example Charge Item Code 📍5.0.0 FHIR Std.
ChargeItemDefinition.​applicability.condition.​language Base extensible Expression Language 📍5.0.0 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​type Base required Price Component Type 📍5.0.0 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​code Base example Not State Unknown

Constraints

Id Grade Path(s) Description Expression
cnl-0 warning ChargeItemDefinition 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}$')
cnl-1 warning ChargeItemDefinition.url URL should not contain | or # - these characters make processing canonical references problematic exists() implies matches('^[^|# ]+$')
ele-1 error ChargeItemDefinition.meta, ChargeItemDefinition.implicitRules, ChargeItemDefinition.language, ChargeItemDefinition.text, ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension, ChargeItemDefinition.url, ChargeItemDefinition.identifier, ChargeItemDefinition.version, ChargeItemDefinition.versionAlgorithm[x], ChargeItemDefinition.name, ChargeItemDefinition.title, ChargeItemDefinition.derivedFromUri, ChargeItemDefinition.partOf, ChargeItemDefinition.replaces, ChargeItemDefinition.status, ChargeItemDefinition.experimental, ChargeItemDefinition.date, ChargeItemDefinition.publisher, ChargeItemDefinition.contact, ChargeItemDefinition.description, ChargeItemDefinition.useContext, ChargeItemDefinition.jurisdiction, ChargeItemDefinition.purpose, ChargeItemDefinition.copyright, ChargeItemDefinition.copyrightLabel, ChargeItemDefinition.approvalDate, ChargeItemDefinition.lastReviewDate, ChargeItemDefinition.code, ChargeItemDefinition.instance, ChargeItemDefinition.applicability, ChargeItemDefinition.applicability.extension, ChargeItemDefinition.applicability.extension:description, ChargeItemDefinition.applicability.extension:language, ChargeItemDefinition.applicability.modifierExtension, ChargeItemDefinition.applicability.condition, ChargeItemDefinition.applicability.condition.extension, ChargeItemDefinition.applicability.condition.extension:expression, ChargeItemDefinition.applicability.condition.description, ChargeItemDefinition.applicability.condition.name, ChargeItemDefinition.applicability.condition.language, ChargeItemDefinition.applicability.condition.expression, ChargeItemDefinition.applicability.condition.reference, ChargeItemDefinition.applicability.effectivePeriod, ChargeItemDefinition.applicability.relatedArtifact, ChargeItemDefinition.propertyGroup, ChargeItemDefinition.propertyGroup.extension, ChargeItemDefinition.propertyGroup.modifierExtension, ChargeItemDefinition.propertyGroup.applicability, ChargeItemDefinition.propertyGroup.priceComponent, ChargeItemDefinition.propertyGroup.priceComponent.extension, ChargeItemDefinition.propertyGroup.priceComponent.extension:type, ChargeItemDefinition.propertyGroup.priceComponent.extension:code, ChargeItemDefinition.propertyGroup.priceComponent.extension:factor, ChargeItemDefinition.propertyGroup.priceComponent.extension:amount, ChargeItemDefinition.propertyGroup.priceComponent.type, ChargeItemDefinition.propertyGroup.priceComponent.code, ChargeItemDefinition.propertyGroup.priceComponent.factor, ChargeItemDefinition.propertyGroup.priceComponent.amount All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error ChargeItemDefinition.extension, ChargeItemDefinition.extension:effectivePeriod, ChargeItemDefinition.modifierExtension, ChargeItemDefinition.applicability.extension, ChargeItemDefinition.applicability.extension:description, ChargeItemDefinition.applicability.extension:language, ChargeItemDefinition.applicability.modifierExtension, ChargeItemDefinition.applicability.condition.extension, ChargeItemDefinition.applicability.condition.extension:expression, ChargeItemDefinition.propertyGroup.extension, ChargeItemDefinition.propertyGroup.modifierExtension, ChargeItemDefinition.propertyGroup.priceComponent.extension, ChargeItemDefinition.propertyGroup.priceComponent.extension:type, ChargeItemDefinition.propertyGroup.priceComponent.extension:code, ChargeItemDefinition.propertyGroup.priceComponent.extension:factor, ChargeItemDefinition.propertyGroup.priceComponent.extension:amount Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron