0.1.0 - ci-build

MHNSushi - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: ChargeItemDefinition (MY Core)

Official URL: https://veinscdr.mhnexus.com/baseR4/StructureDefinition/ChargeItemDefinition-my-core Version: 0.1.0
Active as of 2024-02-12 Computable Name: ChargeItemDefinitionMyCore

Provides the properties that apply to the (billing) codes necessary to calculate costs and prices. The properties may differ largely depending on type and realm, therefore this resource gives only a rough structure and requires profiling for each type of billing code system.

Usage:

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

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
cid-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url Σ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ChargeItemDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cid-0warningChargeItemDefinitionName 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-2errorChargeItemDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemDefinitionIf 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-4errorChargeItemDefinitionIf 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-5errorChargeItemDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition 0..* ChargeItemDefinition Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... propertyGroup
.... priceComponent
..... code 0..1 CodeableConcept Code identifying the specific component
Binding: ValueSetRevenueCode (MY Core) (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ChargeItemDefinition.propertyGroup.priceComponent.codeexampleValueSetRevenueCodeMyCore (a valid code from CodeSystemRevenueCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/revenue-code-my-core
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
cid-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 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 Σ 0..1 string Business version of the charge item definition
... 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 (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: 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 Σ 0..1 Period When the charge item definition is expected to be used
... code Σ 0..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 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 0..1 string Natural language description of the condition
.... language 0..1 string Language of the expression
.... expression 0..1 string Boolean-valued expression
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... applicability 0..* See applicability (ChargeItemDefinition) Conditions under which the priceComponent is applicable
.... priceComponent 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 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

..... code 0..1 CodeableConcept Code identifying the specific component
Binding: ValueSetRevenueCode (MY Core) (example)
..... factor 0..1 decimal Factor used for calculating this component
..... amount 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ChargeItemDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItemDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ChargeItemDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ChargeItemDefinition.codeexampleChargeItemCode
http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
from the FHIR Standard
ChargeItemDefinition.propertyGroup.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
ChargeItemDefinition.propertyGroup.priceComponent.codeexampleValueSetRevenueCodeMyCore (a valid code from CodeSystemRevenueCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/revenue-code-my-core
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cid-0warningChargeItemDefinitionName 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-2errorChargeItemDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemDefinitionIf 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-4errorChargeItemDefinitionIf 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-5errorChargeItemDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
cid-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... url Σ 1..1 uri Canonical identifier for this charge item definition, represented as a URI (globally unique)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ChargeItemDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
cid-0warningChargeItemDefinitionName 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-2errorChargeItemDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemDefinitionIf 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-4errorChargeItemDefinitionIf 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-5errorChargeItemDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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()

Differential View

This structure is derived from ChargeItemDefinition

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition 0..* ChargeItemDefinition Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
... propertyGroup
.... priceComponent
..... code 0..1 CodeableConcept Code identifying the specific component
Binding: ValueSetRevenueCode (MY Core) (example)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
ChargeItemDefinition.propertyGroup.priceComponent.codeexampleValueSetRevenueCodeMyCore (a valid code from CodeSystemRevenueCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/revenue-code-my-core
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItemDefinition C 0..* ChargeItemDefinition Definition of properties and rules about how the price and the applicability of a ChargeItem can be determined
cid-0: Name should be usable as an identifier for the module by machine processing applications such as code generation
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... url Σ 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 Σ 0..1 string Business version of the charge item definition
... 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 (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: 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 Σ 0..1 Period When the charge item definition is expected to be used
... code Σ 0..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 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... description 0..1 string Natural language description of the condition
.... language 0..1 string Language of the expression
.... expression 0..1 string Boolean-valued expression
... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... applicability 0..* See applicability (ChargeItemDefinition) Conditions under which the priceComponent is applicable
.... priceComponent 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 1..1 code base | surcharge | deduction | discount | tax | informational
Binding: InvoicePriceComponentType (required): Codes indicating the kind of the price component.

..... code 0..1 CodeableConcept Code identifying the specific component
Binding: ValueSetRevenueCode (MY Core) (example)
..... factor 0..1 decimal Factor used for calculating this component
..... amount 0..1 Money Monetary amount associated with this component

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
ChargeItemDefinition.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItemDefinition.statusrequiredPublicationStatus
http://hl7.org/fhir/ValueSet/publication-status|4.0.1
from the FHIR Standard
ChargeItemDefinition.jurisdictionextensibleJurisdiction ValueSet
http://hl7.org/fhir/ValueSet/jurisdiction
from the FHIR Standard
ChargeItemDefinition.codeexampleChargeItemCode
http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
from the FHIR Standard
ChargeItemDefinition.propertyGroup.priceComponent.typerequiredInvoicePriceComponentType
http://hl7.org/fhir/ValueSet/invoice-priceComponentType|4.0.1
from the FHIR Standard
ChargeItemDefinition.propertyGroup.priceComponent.codeexampleValueSetRevenueCodeMyCore (a valid code from CodeSystemRevenueCode (MY Core))
http://fhir.hie.moh.gov.my/ValueSet/revenue-code-my-core
from this IG

Constraints

IdGradePath(s)DetailsRequirements
cid-0warningChargeItemDefinitionName 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-2errorChargeItemDefinitionIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemDefinitionIf 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-4errorChargeItemDefinitionIf 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-5errorChargeItemDefinitionIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemDefinitionA resource should have narrative for robust management
: text.`div`.exists()
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

 

Other representations of profile: CSV, Excel, Schematron