CH LAB-Order (R4)
3.0.0-ci-build - ci-build
CH LAB-Order (R4), published by HL7 Switzerland. This guide is not an authorized publication; it is the continuous build for version 3.0.0-ci-build built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7ch/ch-lab-order/ and changes regularly. See the Directory of published versions
| Official URL: http://fhir.ch/ig/ch-lab-order/StructureDefinition/ch-lab-chargeitemdefinition-r4 | Version: 3.0.0-ci-build | |||
| Active as of 2025-10-19 | Computable Name: ChLab_ChargeItemDefinitionR4 | |||
Copyright/Legal: CC0-1.0 |
||||
R4-compatible profile for laboratory catalog billing and charge definitions.
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots and how the different presentations work.
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ChargeItemDefinition | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined Constraints: cid-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Billing codes or product types this definition applies to Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ChargeItemDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ChargeItemDefinition | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined | |
![]() ![]() |
1..1 | CodeableConcept | Billing codes or product types this definition applies to | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | InvoicePriceComponentType | 📦4.0.1 | FHIR Std. |
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ChargeItemDefinition | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined Constraints: cid-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the charge item definition | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the charge item definition | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this charge item definition (human friendly) | ||||
![]() ![]() |
Σ | 0..* | uri | Underlying externally-defined charge item definition | ||||
![]() ![]() |
Σ | 0..* | canonical(ChargeItemDefinition) | A larger definition of which this particular definition is a component or step | ||||
![]() ![]() |
Σ | 0..* | canonical(ChargeItemDefinition) | Completed or terminated request(s) whose function is taken by this new request | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the charge item definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the charge item definition was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the charge item definition was last reviewed | |||||
![]() ![]() |
Σ | 0..1 | Period | When the charge item definition is expected to be used | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Billing codes or product types this definition applies to Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. | ||||
![]() ![]() |
0..* | Reference(Medication | Substance | Device) | Instances this definition applies to | |||||
![]() ![]() |
0..* | BackboneElement | Whether or not the billing code is applicable | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Natural language description of the condition | |||||
![]() ![]() ![]() |
0..1 | string | Language of the expression | |||||
![]() ![]() ![]() |
0..1 | string | Boolean-valued expression | |||||
![]() ![]() |
0..* | BackboneElement | Group of properties which are applicable under the same conditions | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | See applicability (ChargeItemDefinition) | Conditions under which the priceComponent is applicable | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Components of total line item price | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Monetary amount associated with this component | |||||
Documentation for this format | ||||||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ChargeItemDefinition
Key Elements View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
C | 0..* | ChargeItemDefinition | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined Constraints: cid-0 |
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created |
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored |
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) |
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. |
![]() ![]() |
Σ | 1..1 | CodeableConcept | Billing codes or product types this definition applies to Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. |
Documentation for this format | ||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ChargeItemDefinition
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
|---|---|---|---|---|
![]() |
0..* | ChargeItemDefinition | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined | |
![]() ![]() |
1..1 | CodeableConcept | Billing codes or product types this definition applies to | |
![]() ![]() |
||||
![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() |
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required) | |
Documentation for this format | ||||
| Path | Status | Usage | ValueSet | Version | Source |
| ChargeItemDefinition.propertyGroup.priceComponent.type | Base | required | InvoicePriceComponentType | 📦4.0.1 | FHIR Std. |
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() | ||||
|---|---|---|---|---|---|---|---|---|
![]() |
C | 0..* | ChargeItemDefinition | Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined Constraints: cid-0 | ||||
![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() |
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 | |||||
![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() |
?! | 0..* | Extension | Extensions that cannot be ignored | ||||
![]() ![]() |
Σ | 1..1 | uri | Canonical identifier for this charge item definition, represented as a URI (globally unique) | ||||
![]() ![]() |
Σ | 0..* | Identifier | Additional identifier for the charge item definition | ||||
![]() ![]() |
Σ | 0..1 | string | Business version of the charge item definition | ||||
![]() ![]() |
Σ | 0..1 | string | Name for this charge item definition (human friendly) | ||||
![]() ![]() |
Σ | 0..* | uri | Underlying externally-defined charge item definition | ||||
![]() ![]() |
Σ | 0..* | canonical(ChargeItemDefinition) | A larger definition of which this particular definition is a component or step | ||||
![]() ![]() |
Σ | 0..* | canonical(ChargeItemDefinition) | Completed or terminated request(s) whose function is taken by this new request | ||||
![]() ![]() |
?!Σ | 1..1 | code | draft | active | retired | unknown Binding: PublicationStatus (required): The lifecycle status of an artifact. | ||||
![]() ![]() |
Σ | 0..1 | boolean | For testing purposes, not real usage | ||||
![]() ![]() |
Σ | 0..1 | dateTime | Date last changed | ||||
![]() ![]() |
Σ | 0..1 | string | Name of the publisher (organization or individual) | ||||
![]() ![]() |
Σ | 0..* | ContactDetail | Contact details for the publisher | ||||
![]() ![]() |
Σ | 0..1 | markdown | Natural language description of the charge item definition | ||||
![]() ![]() |
Σ | 0..* | UsageContext | The context that the content is intended to support | ||||
![]() ![]() |
Σ | 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. | ||||
![]() ![]() |
0..1 | markdown | Use and/or publishing restrictions | |||||
![]() ![]() |
0..1 | date | When the charge item definition was approved by publisher | |||||
![]() ![]() |
0..1 | date | When the charge item definition was last reviewed | |||||
![]() ![]() |
Σ | 0..1 | Period | When the charge item definition is expected to be used | ||||
![]() ![]() |
Σ | 1..1 | CodeableConcept | Billing codes or product types this definition applies to Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition. | ||||
![]() ![]() |
0..* | Reference(Medication | Substance | Device) | Instances this definition applies to | |||||
![]() ![]() |
0..* | BackboneElement | Whether or not the billing code is applicable | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..1 | string | Natural language description of the condition | |||||
![]() ![]() ![]() |
0..1 | string | Language of the expression | |||||
![]() ![]() ![]() |
0..1 | string | Boolean-valued expression | |||||
![]() ![]() |
0..* | BackboneElement | Group of properties which are applicable under the same conditions | |||||
![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() |
0..* | See applicability (ChargeItemDefinition) | Conditions under which the priceComponent is applicable | |||||
![]() ![]() ![]() |
0..* | BackboneElement | Components of total line item price | |||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
0..* | Extension | Additional content defined by implementations | |||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
1..1 | code | base | surcharge | deduction | discount | tax | informational Binding: InvoicePriceComponentType (required) | |||||
![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | Code identifying the specific component | |||||
![]() ![]() ![]() ![]() |
0..1 | decimal | Factor used for calculating this component | |||||
![]() ![]() ![]() ![]() |
0..1 | Money | Monetary amount associated with this component | |||||
Documentation for this format | ||||||||
| 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. |
| Id | Grade | Path(s) | Description | Expression |
| 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 ChargeItemDefinition
Other representations of profile: CSV, Excel, Schematron