German Practice Management FHIR Profiles (R4)
Version 0.99.1 - release

Resource Profile: Praxis Billing Rule ChargeItemDefinition

Official URL: https://fhir.cognovis.de/praxis/StructureDefinition/praxis-billing-rule-chargeitemdefinition Version: 0.99.1
Active as of 2026-08-22 Computable Name: PraxisBillingRuleChargeItemDefinition
Other Identifiers: OID:2.16.840.1.113883.3.7985.42.223

Copyright/Legal: Copyright 2026+ cognovis GmbH. Cognovis-authored material is licensed under Apache-2.0; third-party material retains its own terms as documented in THIRD_PARTY_NOTICES.md.

Versioned billing catalog entry with source provenance and typed declarative code-local rules.

Code-local applicability is represented only by the closed set of must-understand modifier extensions defined by this IG. Executable expressions are forbidden. Relational and aggregate rules belong in PraxisBillingRuleSetLibrary instead.

Usages:

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..* PraxisChargeItemDefinitionDE Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cid-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... version SΣ 1..1 string Business version of the charge item definition
... title SΣ 1..1 string Name for this charge item definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... description SΣ 0..1 markdown Natural language description of the charge item definition
... effectivePeriod SΣ 1..1 Period When the charge item definition is expected to be used
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... code SΣ 1..1 CodeableConcept Billing codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.
... applicability S 0..* BackboneElement Whether or not the billing code is applicable
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Closed by value:url
..... modifierExtension:patientAttribute ?!SΣC 0..* (Complex) Billing Patient Attribute Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-patient-attribute-rule
Constraints: billing-patient-attribute-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:providerEligibility ?!SΣC 0..* (Complex) Billing Provider Eligibility Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-provider-eligibility-rule
Constraints: billing-provider-eligibility-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:settingConstraint ?!SΣC 0..* (Complex) Billing Setting Constraint Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-setting-constraint-rule
Constraints: billing-setting-constraint-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:factorBound ?!SΣC 0..* (Complex) Billing Factor Bound Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-factor-bound-rule
Constraints: billing-rule-class-semantic-version
..... modifierExtension:countingScopeQualifier ?!SΣC 0..1 (Complex) Billing Counting Scope Qualifier
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-counting-scope-qualifier
Constraints: billing-counting-scope-has-parameter, billing-counting-scope-anchor-direction-requires-anchor
... propertyGroup S 0..* BackboneElement Group of properties which are applicable under the same conditions
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... priceComponent S 0..* BackboneElement Components of total line item price
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code S 0..1 CodeableConcept Code identifying the specific component
..... factor S 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
ChargeItemDefinition.​code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-counting-scope-anchor-direction-requires-anchor error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier An anchor direction is only meaningful together with a declared anchor code or anchor section. extension.where(url = 'anchorDirection').exists() implies extension.where(url = 'anchorCode' or url = 'anchorSection').exists()
billing-counting-scope-has-parameter error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier A counting-scope qualifier must declare at least one typed counting parameter. extension.where(url = 'anchorCode' or url = 'anchorDirection' or url = 'anchorSection' or url = 'sameSelector' or url = 'windowMultiple').exists()
billing-patient-attribute-has-parameter error ChargeItemDefinition.applicability.modifierExtension:patientAttribute A patient-attribute rule must declare at least one typed patient attribute parameter. extension.where(url = 'minimumAge' or url = 'maximumAge' or url = 'gender' or url = 'status').exists()
billing-provider-eligibility-has-parameter error ChargeItemDefinition.applicability.modifierExtension:providerEligibility A provider-eligibility rule must declare at least one typed provider parameter. extension.where(url = 'specialty' or url = 'authorization' or url = 'relationship').exists()
billing-rule-class-semantic-version error ChargeItemDefinition.applicability.modifierExtension:patientAttribute, ChargeItemDefinition.applicability.modifierExtension:providerEligibility, ChargeItemDefinition.applicability.modifierExtension:settingConstraint, ChargeItemDefinition.applicability.modifierExtension:factorBound A typed billing rule must declare semantic major 1 for the BillingRuleClass CodeSystem. extension.where(url = 'ruleClass').value.ofType(Coding).version = '1'
billing-setting-constraint-has-parameter error ChargeItemDefinition.applicability.modifierExtension:settingConstraint A setting-constraint rule must declare at least one typed setting parameter. extension.where(url = 'careSetting' or url = 'billingCase' or url = 'startTime' or url = 'endTime' or url = 'treatmentKind').exists()
billing-source-manifest-digest error ChargeItemDefinition.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
cid-0 warning ChargeItemDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error ChargeItemDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItemDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItemDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from PraxisChargeItemDefinitionDE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition 0..* PraxisChargeItemDefinitionDE Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest S 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
... version S 1..1 string Business version of the charge item definition
... effectivePeriod S 1..1 Period When the charge item definition is expected to be used
.... start S 1..1 dateTime Starting time with inclusive boundary
.... end S 1..1 dateTime End time with inclusive boundary, if not ongoing
.... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Closed by value:url
..... modifierExtension:patientAttribute S 0..* (Complex) Billing Patient Attribute Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-patient-attribute-rule
..... modifierExtension:providerEligibility S 0..* (Complex) Billing Provider Eligibility Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-provider-eligibility-rule
..... modifierExtension:settingConstraint S 0..* (Complex) Billing Setting Constraint Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-setting-constraint-rule
..... modifierExtension:factorBound S 0..* (Complex) Billing Factor Bound Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-factor-bound-rule
..... modifierExtension:countingScopeQualifier S 0..1 (Complex) Billing Counting Scope Qualifier
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-counting-scope-qualifier
.... language 0..0 Language of the expression
.... expression 0..0 Boolean-valued expression

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* PraxisChargeItemDefinitionDE Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cid-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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the charge item definition
... version SΣ 1..1 string Business version of the charge item definition
... title SΣ 1..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 ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 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: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the charge item definition was approved by publisher
... lastReviewDate 0..1 date When the charge item definition was last reviewed
... effectivePeriod SΣ 1..1 Period When the charge item definition is expected to be used
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... code SΣ 1..1 CodeableConcept Billing codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.
... instance 0..* Reference(Medication | Substance | Device) Instances this definition applies to
... applicability S 0..* BackboneElement Whether or not the billing code is applicable
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Closed by value:url
..... modifierExtension:patientAttribute ?!SΣC 0..* (Complex) Billing Patient Attribute Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-patient-attribute-rule
Constraints: billing-patient-attribute-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:providerEligibility ?!SΣC 0..* (Complex) Billing Provider Eligibility Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-provider-eligibility-rule
Constraints: billing-provider-eligibility-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:settingConstraint ?!SΣC 0..* (Complex) Billing Setting Constraint Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-setting-constraint-rule
Constraints: billing-setting-constraint-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:factorBound ?!SΣC 0..* (Complex) Billing Factor Bound Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-factor-bound-rule
Constraints: billing-rule-class-semantic-version
..... modifierExtension:countingScopeQualifier ?!SΣC 0..1 (Complex) Billing Counting Scope Qualifier
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-counting-scope-qualifier
Constraints: billing-counting-scope-has-parameter, billing-counting-scope-anchor-direction-requires-anchor
.... description 0..1 string Natural language description of the condition
... propertyGroup S 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... applicability 0..* See applicability (ChargeItemDefinition) Conditions under which the priceComponent is applicable
.... priceComponent S 0..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code S 0..1 CodeableConcept Code identifying the specific component
..... factor S 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ChargeItemDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
ChargeItemDefinition.​jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ChargeItemDefinition.​code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-counting-scope-anchor-direction-requires-anchor error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier An anchor direction is only meaningful together with a declared anchor code or anchor section. extension.where(url = 'anchorDirection').exists() implies extension.where(url = 'anchorCode' or url = 'anchorSection').exists()
billing-counting-scope-has-parameter error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier A counting-scope qualifier must declare at least one typed counting parameter. extension.where(url = 'anchorCode' or url = 'anchorDirection' or url = 'anchorSection' or url = 'sameSelector' or url = 'windowMultiple').exists()
billing-patient-attribute-has-parameter error ChargeItemDefinition.applicability.modifierExtension:patientAttribute A patient-attribute rule must declare at least one typed patient attribute parameter. extension.where(url = 'minimumAge' or url = 'maximumAge' or url = 'gender' or url = 'status').exists()
billing-provider-eligibility-has-parameter error ChargeItemDefinition.applicability.modifierExtension:providerEligibility A provider-eligibility rule must declare at least one typed provider parameter. extension.where(url = 'specialty' or url = 'authorization' or url = 'relationship').exists()
billing-rule-class-semantic-version error ChargeItemDefinition.applicability.modifierExtension:patientAttribute, ChargeItemDefinition.applicability.modifierExtension:providerEligibility, ChargeItemDefinition.applicability.modifierExtension:settingConstraint, ChargeItemDefinition.applicability.modifierExtension:factorBound A typed billing rule must declare semantic major 1 for the BillingRuleClass CodeSystem. extension.where(url = 'ruleClass').value.ofType(Coding).version = '1'
billing-setting-constraint-has-parameter error ChargeItemDefinition.applicability.modifierExtension:settingConstraint A setting-constraint rule must declare at least one typed setting parameter. extension.where(url = 'careSetting' or url = 'billingCase' or url = 'startTime' or url = 'endTime' or url = 'treatmentKind').exists()
billing-source-manifest-digest error ChargeItemDefinition.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
cid-0 warning ChargeItemDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error ChargeItemDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItemDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItemDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* PraxisChargeItemDefinitionDE Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cid-0
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... version SΣ 1..1 string Business version of the charge item definition
... title SΣ 1..1 string Name for this charge item definition (human friendly)
... status ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... description SΣ 0..1 markdown Natural language description of the charge item definition
... effectivePeriod SΣ 1..1 Period When the charge item definition is expected to be used
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... code SΣ 1..1 CodeableConcept Billing codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.
... applicability S 0..* BackboneElement Whether or not the billing code is applicable
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Closed by value:url
..... modifierExtension:patientAttribute ?!SΣC 0..* (Complex) Billing Patient Attribute Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-patient-attribute-rule
Constraints: billing-patient-attribute-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:providerEligibility ?!SΣC 0..* (Complex) Billing Provider Eligibility Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-provider-eligibility-rule
Constraints: billing-provider-eligibility-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:settingConstraint ?!SΣC 0..* (Complex) Billing Setting Constraint Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-setting-constraint-rule
Constraints: billing-setting-constraint-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:factorBound ?!SΣC 0..* (Complex) Billing Factor Bound Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-factor-bound-rule
Constraints: billing-rule-class-semantic-version
..... modifierExtension:countingScopeQualifier ?!SΣC 0..1 (Complex) Billing Counting Scope Qualifier
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-counting-scope-qualifier
Constraints: billing-counting-scope-has-parameter, billing-counting-scope-anchor-direction-requires-anchor
... propertyGroup S 0..* BackboneElement Group of properties which are applicable under the same conditions
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... priceComponent S 0..* BackboneElement Components of total line item price
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code S 0..1 CodeableConcept Code identifying the specific component
..... factor S 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
ChargeItemDefinition.​code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-counting-scope-anchor-direction-requires-anchor error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier An anchor direction is only meaningful together with a declared anchor code or anchor section. extension.where(url = 'anchorDirection').exists() implies extension.where(url = 'anchorCode' or url = 'anchorSection').exists()
billing-counting-scope-has-parameter error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier A counting-scope qualifier must declare at least one typed counting parameter. extension.where(url = 'anchorCode' or url = 'anchorDirection' or url = 'anchorSection' or url = 'sameSelector' or url = 'windowMultiple').exists()
billing-patient-attribute-has-parameter error ChargeItemDefinition.applicability.modifierExtension:patientAttribute A patient-attribute rule must declare at least one typed patient attribute parameter. extension.where(url = 'minimumAge' or url = 'maximumAge' or url = 'gender' or url = 'status').exists()
billing-provider-eligibility-has-parameter error ChargeItemDefinition.applicability.modifierExtension:providerEligibility A provider-eligibility rule must declare at least one typed provider parameter. extension.where(url = 'specialty' or url = 'authorization' or url = 'relationship').exists()
billing-rule-class-semantic-version error ChargeItemDefinition.applicability.modifierExtension:patientAttribute, ChargeItemDefinition.applicability.modifierExtension:providerEligibility, ChargeItemDefinition.applicability.modifierExtension:settingConstraint, ChargeItemDefinition.applicability.modifierExtension:factorBound A typed billing rule must declare semantic major 1 for the BillingRuleClass CodeSystem. extension.where(url = 'ruleClass').value.ofType(Coding).version = '1'
billing-setting-constraint-has-parameter error ChargeItemDefinition.applicability.modifierExtension:settingConstraint A setting-constraint rule must declare at least one typed setting parameter. extension.where(url = 'careSetting' or url = 'billingCase' or url = 'startTime' or url = 'endTime' or url = 'treatmentKind').exists()
billing-source-manifest-digest error ChargeItemDefinition.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
cid-0 warning ChargeItemDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error ChargeItemDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItemDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItemDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from PraxisChargeItemDefinitionDE

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition 0..* PraxisChargeItemDefinitionDE Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest S 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
... version S 1..1 string Business version of the charge item definition
... effectivePeriod S 1..1 Period When the charge item definition is expected to be used
.... start S 1..1 dateTime Starting time with inclusive boundary
.... end S 1..1 dateTime End time with inclusive boundary, if not ongoing
.... Slices for modifierExtension 0..* Extension Extension
Slice: Unordered, Closed by value:url
..... modifierExtension:patientAttribute S 0..* (Complex) Billing Patient Attribute Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-patient-attribute-rule
..... modifierExtension:providerEligibility S 0..* (Complex) Billing Provider Eligibility Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-provider-eligibility-rule
..... modifierExtension:settingConstraint S 0..* (Complex) Billing Setting Constraint Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-setting-constraint-rule
..... modifierExtension:factorBound S 0..* (Complex) Billing Factor Bound Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-factor-bound-rule
..... modifierExtension:countingScopeQualifier S 0..1 (Complex) Billing Counting Scope Qualifier
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-counting-scope-qualifier
.... language 0..0 Language of the expression
.... expression 0..0 Boolean-valued expression

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItemDefinition C 0..* PraxisChargeItemDefinitionDE Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
Constraints: cid-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: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... 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 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:sourceManifest SC 1..1 (Complex) Billing Source Manifest
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-source-manifest
Constraints: billing-source-manifest-digest
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url SΣ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
... identifier Σ 0..* Identifier Additional identifier for the charge item definition
... version SΣ 1..1 string Business version of the charge item definition
... title SΣ 1..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 ?!SΣ 1..1 code draft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.
Required Pattern: active
... experimental Σ 0..1 boolean For testing purposes, not real usage
... date Σ 0..1 dateTime Date last changed
... publisher Σ 0..1 string Name of the publisher (organization or individual)
... contact Σ 0..* ContactDetail Contact details for the publisher
... description SΣ 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: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.
... copyright 0..1 markdown Use and/or publishing restrictions
... approvalDate 0..1 date When the charge item definition was approved by publisher
... lastReviewDate 0..1 date When the charge item definition was last reviewed
... effectivePeriod SΣ 1..1 Period When the charge item definition is expected to be used
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... start SΣC 1..1 dateTime Starting time with inclusive boundary
.... end SΣC 1..1 dateTime End time with inclusive boundary, if not ongoing
... code SΣ 1..1 CodeableConcept Billing codes or product types this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.
... instance 0..* Reference(Medication | Substance | Device) Instances this definition applies to
... applicability S 0..* BackboneElement Whether or not the billing code is applicable
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... Slices for modifierExtension ?!Σ 0..* Extension Extension
Slice: Unordered, Closed by value:url
..... modifierExtension:patientAttribute ?!SΣC 0..* (Complex) Billing Patient Attribute Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-patient-attribute-rule
Constraints: billing-patient-attribute-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:providerEligibility ?!SΣC 0..* (Complex) Billing Provider Eligibility Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-provider-eligibility-rule
Constraints: billing-provider-eligibility-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:settingConstraint ?!SΣC 0..* (Complex) Billing Setting Constraint Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-setting-constraint-rule
Constraints: billing-setting-constraint-has-parameter, billing-rule-class-semantic-version
..... modifierExtension:factorBound ?!SΣC 0..* (Complex) Billing Factor Bound Rule
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-factor-bound-rule
Constraints: billing-rule-class-semantic-version
..... modifierExtension:countingScopeQualifier ?!SΣC 0..1 (Complex) Billing Counting Scope Qualifier
URL: https://fhir.cognovis.de/praxis/StructureDefinition/billing-counting-scope-qualifier
Constraints: billing-counting-scope-has-parameter, billing-counting-scope-anchor-direction-requires-anchor
.... description 0..1 string Natural language description of the condition
... propertyGroup S 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... applicability 0..* See applicability (ChargeItemDefinition) Conditions under which the priceComponent is applicable
.... priceComponent S 0..* BackboneElement Components of total line item price
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type S 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.
..... code S 0..1 CodeableConcept Code identifying the specific component
..... factor S 0..1 decimal Factor used for calculating this component
..... amount S 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItemDefinition.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
ChargeItemDefinition.​status Base required PublicationStatus 📍4.0.1 FHIR Std.
ChargeItemDefinition.​jurisdiction Base extensible Jurisdiction 📍4.0.1 FHIR Std.
ChargeItemDefinition.​code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItemDefinition.​propertyGroup.priceComponent.​type Base required InvoicePriceComponentType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
billing-counting-scope-anchor-direction-requires-anchor error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier An anchor direction is only meaningful together with a declared anchor code or anchor section. extension.where(url = 'anchorDirection').exists() implies extension.where(url = 'anchorCode' or url = 'anchorSection').exists()
billing-counting-scope-has-parameter error ChargeItemDefinition.applicability.modifierExtension:countingScopeQualifier A counting-scope qualifier must declare at least one typed counting parameter. extension.where(url = 'anchorCode' or url = 'anchorDirection' or url = 'anchorSection' or url = 'sameSelector' or url = 'windowMultiple').exists()
billing-patient-attribute-has-parameter error ChargeItemDefinition.applicability.modifierExtension:patientAttribute A patient-attribute rule must declare at least one typed patient attribute parameter. extension.where(url = 'minimumAge' or url = 'maximumAge' or url = 'gender' or url = 'status').exists()
billing-provider-eligibility-has-parameter error ChargeItemDefinition.applicability.modifierExtension:providerEligibility A provider-eligibility rule must declare at least one typed provider parameter. extension.where(url = 'specialty' or url = 'authorization' or url = 'relationship').exists()
billing-rule-class-semantic-version error ChargeItemDefinition.applicability.modifierExtension:patientAttribute, ChargeItemDefinition.applicability.modifierExtension:providerEligibility, ChargeItemDefinition.applicability.modifierExtension:settingConstraint, ChargeItemDefinition.applicability.modifierExtension:factorBound A typed billing rule must declare semantic major 1 for the BillingRuleClass CodeSystem. extension.where(url = 'ruleClass').value.ofType(Coding).version = '1'
billing-setting-constraint-has-parameter error ChargeItemDefinition.applicability.modifierExtension:settingConstraint A setting-constraint rule must declare at least one typed setting parameter. extension.where(url = 'careSetting' or url = 'billingCase' or url = 'startTime' or url = 'endTime' or url = 'treatmentKind').exists()
billing-source-manifest-digest error ChargeItemDefinition.extension:sourceManifest The source digest must be a lowercase SHA-256 value prefixed with sha256:. extension.where(url = 'sourceDigest').value.ofType(string).matches('^sha256:[0-9a-f]{64}$')
cid-0 warning ChargeItemDefinition Name should be usable as an identifier for the module by machine processing applications such as code generation name.matches('[A-Z]([A-Za-z0-9_]){0,254}')
dom-2 error ChargeItemDefinition If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItemDefinition If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5 error ChargeItemDefinition If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItemDefinition A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel, Schematron