Order Catalog Implementation Guide
current - CI Build International flag

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

Resource Profile: LabChargeItemDefinition Profile

Official URL: http://hl7.org/fhir/uv/order-catalog/StructureDefinition/LabChargeItemDefinition Version: current
Draft as of 2020-02-09 Computable Name: LabChargeItemDefinition

This profile constrains the usage of ChargeItemDefinition to represent the rules and other properties attached to a billing code used by a laboratory service

Usage:

Formal Views of Profile Content

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

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition 0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... LanguageSynonym 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... Slices for useContext S0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code.system, value:code.code
.... useContext:ClinicalFocus S0..*UsageContextClinical focus justifying this billing code
..... code
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 0..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1CodeableConceptValue that defines the context
...... coding 0..*CodingCode defined by a terminology system
Binding: All possible clinical contexts for any lab test (example): All contexts for any laboratory test

... code S1..1CodeableConceptBilling code or product type this definition applies to

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ChargeItemDefinition.useContext:ClinicalFocus.value[x].codingexampleClinicalFocus
NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code.system, value:code.code
.... useContext:ClinicalFocus SΣ0..*UsageContextClinical focus justifying this billing code
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
...... coding Σ0..*CodingCode defined by a terminology system
Binding: All possible clinical contexts for any lab test (example): All contexts for any laboratory test


... code SΣ1..1CodeableConceptBilling code or product type this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.useContext:ClinicalFocus.codeextensibleFixed Value: focus
ChargeItemDefinition.useContext:ClinicalFocus.value[x]exampleContext of Use ValueSet
ChargeItemDefinition.useContext:ClinicalFocus.value[x].codingexampleClinicalFocus
ChargeItemDefinition.codeexampleChargeItemCode

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningChargeItemDefinitionName 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-1warningChargeItemDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: url.matches('([^|#])*')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the charge item definition
... version Σ0..1stringBusiness version of the charge item definition
... name ΣC0..1stringName for this charge item definition (computer friendly)
... title Σ0..1stringName for this charge item definition (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... LanguageSynonym 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... derivedFromUri Σ0..*uriUnderlying 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..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the charge item definition
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code.system, value:code.code
.... useContext:ClinicalFocus SΣ0..*UsageContextClinical focus justifying this billing code
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
Binding: All possible clinical contexts for any lab test (example): All contexts for any laboratory test


...... text Σ0..1stringPlain text representation of the concept
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for charge item definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this charge item definition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the charge item definition was approved by publisher
... lastReviewDate 0..1dateWhen the charge item definition was last reviewed
... code SΣ1..1CodeableConceptBilling 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..*BackboneElementWhether or not the billing code is applicable
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition 0..1ExpressionBoolean-valued expression
.... effectivePeriod Σ0..1PeriodWhen the charge item definition is expected to be used
.... relatedArtifact 0..1RelatedArtifactReference to / quotation of the external source of the group of properties
... propertyGroup 0..*BackboneElementGroup of properties which are applicable under the same conditions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 0..*MonetaryComponentComponents of total line item price

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.useContext:ClinicalFocus.codeextensibleFixed Value: focus
ChargeItemDefinition.useContext:ClinicalFocus.value[x]exampleContext of Use ValueSet
ChargeItemDefinition.useContext:ClinicalFocus.value[x].codingexampleClinicalFocus
ChargeItemDefinition.jurisdictionextensibleJurisdiction ValueSet
ChargeItemDefinition.codeexampleChargeItemCode

Constraints

IdGradePath(s)DetailsRequirements
cnl-1warningChargeItemDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: url.matches('([^|#])*')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItemDefinition

Summary

Mandatory: 1 element
Must-Support: 3 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element ChargeItemDefinition.useContext is sliced based on the values of value:code.system, value:code.code

Differential View

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition 0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... title
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... LanguageSynonym 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
... Slices for useContext S0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code.system, value:code.code
.... useContext:ClinicalFocus S0..*UsageContextClinical focus justifying this billing code
..... code
...... system 0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code 0..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... value[x] 1..1CodeableConceptValue that defines the context
...... coding 0..*CodingCode defined by a terminology system
Binding: All possible clinical contexts for any lab test (example): All contexts for any laboratory test

... code S1..1CodeableConceptBilling code or product type this definition applies to

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSet
ChargeItemDefinition.useContext:ClinicalFocus.value[x].codingexampleClinicalFocus

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code.system, value:code.code
.... useContext:ClinicalFocus SΣ0..*UsageContextClinical focus justifying this billing code
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: focus
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
...... coding Σ0..*CodingCode defined by a terminology system
Binding: All possible clinical contexts for any lab test (example): All contexts for any laboratory test


... code SΣ1..1CodeableConceptBilling code or product type this definition applies to
Binding: ChargeItemCode (example): Billing Code defined by this ChargeItemDefinition.


doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.useContext:ClinicalFocus.codeextensibleFixed Value: focus
ChargeItemDefinition.useContext:ClinicalFocus.value[x]exampleContext of Use ValueSet
ChargeItemDefinition.useContext:ClinicalFocus.value[x].codingexampleClinicalFocus
ChargeItemDefinition.codeexampleChargeItemCode

Constraints

IdGradePath(s)DetailsRequirements
cnl-0warningChargeItemDefinitionName 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-1warningChargeItemDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: url.matches('([^|#])*')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C0..*ChargeItemDefinitionDefinition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... language 0..1codeLanguage of the resource content
Binding: CommonLanguages (preferred): IETF language tag

Additional BindingsPurpose
AllLanguagesMax Binding
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension 0..*ExtensionAdditional content defined by implementations
... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored
... url ΣC1..1uriCanonical identifier for this charge item definition, represented as a URI (globally unique)
... identifier Σ0..*IdentifierAdditional identifier for the charge item definition
... version Σ0..1stringBusiness version of the charge item definition
... name ΣC0..1stringName for this charge item definition (computer friendly)
... title Σ0..1stringName for this charge item definition (human friendly)
.... id 0..1stringxml:id (or equivalent in JSON)
.... Slices for extension 0..*ExtensionExtension
Slice: Unordered, Open by value:url
.... LanguageSynonym 0..*(Complex)Language Translation (Localization)
URL: http://hl7.org/fhir/StructureDefinition/translation
.... value 0..1stringPrimitive value for string
Max Length: 1048576
... derivedFromUri Σ0..*uriUnderlying 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..1codedraft | active | retired | unknown
Binding: PublicationStatus (required): The lifecycle status of an artifact.

... experimental Σ0..1booleanFor testing purposes, not real usage
... date Σ0..1dateTimeDate last changed
... publisher Σ0..1stringName of the publisher/steward (organization or individual)
... contact Σ0..*ContactDetailContact details for the publisher
... description Σ0..1markdownNatural language description of the charge item definition
... Slices for useContext SΣ0..*UsageContextThe context that the content is intended to support
Slice: Unordered, Open by value:code.system, value:code.code
.... useContext:ClinicalFocus SΣ0..*UsageContextClinical focus justifying this billing code
..... id 0..1idUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... code Σ1..1CodingType of context being specified
Binding: UsageContextType (extensible)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ0..1uriIdentity of the terminology system
Fixed Value: http://terminology.hl7.org/CodeSystem/usage-context-type
...... version Σ0..1stringVersion of the system - if relevant
...... code Σ0..1codeSymbol in syntax defined by the system
Fixed Value: focus
...... display Σ0..1stringRepresentation defined by the system
...... userSelected Σ0..1booleanIf this coding was chosen directly by the user
..... value[x] Σ1..1CodeableConceptValue that defines the context
Binding: Context of Use ValueSet (example)
...... id 0..1idUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... coding Σ0..*CodingCode defined by a terminology system
Binding: All possible clinical contexts for any lab test (example): All contexts for any laboratory test


...... text Σ0..1stringPlain text representation of the concept
... jurisdiction Σ0..*CodeableConceptIntended jurisdiction for charge item definition (if applicable)
Binding: Jurisdiction ValueSet (extensible): Countries and regions within which this artifact is targeted for use.


... purpose 0..1markdownWhy this charge item definition is defined
... copyright 0..1markdownUse and/or publishing restrictions
... approvalDate 0..1dateWhen the charge item definition was approved by publisher
... lastReviewDate 0..1dateWhen the charge item definition was last reviewed
... code SΣ1..1CodeableConceptBilling 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..*BackboneElementWhether or not the billing code is applicable
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... condition 0..1ExpressionBoolean-valued expression
.... effectivePeriod Σ0..1PeriodWhen the charge item definition is expected to be used
.... relatedArtifact 0..1RelatedArtifactReference to / quotation of the external source of the group of properties
... propertyGroup 0..*BackboneElementGroup of properties which are applicable under the same conditions
.... id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... applicability 0..*See applicability (ChargeItemDefinition)Conditions under which the priceComponent is applicable
.... priceComponent 0..*MonetaryComponentComponents of total line item price

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet
ChargeItemDefinition.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItemDefinition.statusrequiredPublicationStatus
ChargeItemDefinition.useContext:ClinicalFocus.codeextensibleFixed Value: focus
ChargeItemDefinition.useContext:ClinicalFocus.value[x]exampleContext of Use ValueSet
ChargeItemDefinition.useContext:ClinicalFocus.value[x].codingexampleClinicalFocus
ChargeItemDefinition.jurisdictionextensibleJurisdiction ValueSet
ChargeItemDefinition.codeexampleChargeItemCode

Constraints

IdGradePath(s)DetailsRequirements
cnl-1warningChargeItemDefinition.urlURL should not contain | or # - these characters make processing canonical references problematic
: url.matches('([^|#])*')
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItemDefinition

Summary

Mandatory: 1 element
Must-Support: 3 elements
Fixed Value: 2 elements

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element ChargeItemDefinition.useContext is sliced based on the values of value:code.system, value:code.code

 

Other representations of profile: CSV, Excel, Schematron