ChargeItemDefinition (MY Core)

Defining URL http://fhir.hie.moh.gov.my/StructureDefinition/ChargeItemDefinition-my-core
Version 1.0.0
Name ChargeItemDefinitionMyCore
Definition Describes the intention of how one or more practitioners intend to deliver care for a particular patient, group or community for a period of time, possibly limited to care for a specific condition or set of conditions.
Title ChargeItemDefinition (MY Core)
Status Active as of 11-3-2022
Publisher Malaysia MOH - HIE Steering Committee
Copyright Used by permission of HL7 International, all rights reserved Creative Commons License

ChargeItemDefinition
DefinitionThe ChargeItemDefinition resource 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.
Cardinality0...*
Invariants
  • dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
    contained.contained.empty()
  • dom-4: 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-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
    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-6: A resource should have narrative for robust management
    text.`div`.exists()
  • dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
    contained.meta.security.empty()
  • cid-0: 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}')
Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
ChargeItemDefinition.id
DefinitionThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
Cardinality0...1
Typestring
SummaryTrue
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

ChargeItemDefinition.meta
DefinitionThe metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
Cardinality0...1
TypeMeta
SummaryTrue
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.implicitRules
DefinitionA reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Cardinality0...1
Typeuri
ModifierTrue
SummaryTrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ChargeItemDefinition.language
DefinitionThe base language in which the resource is written.
Cardinality0...1
Typecode
Binding

A human language.

CommonLanguages (preferred)
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ChargeItemDefinition.text
DefinitionA human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Cardinality0...1
TypeNarrative
Aliasnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
  • rim: Act.text?
ChargeItemDefinition.contained
DefinitionThese resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
Cardinality0...*
TypeResource
Aliasinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

Mappings
  • rim: Entity. Role, or Act
  • rim: N/A
ChargeItemDefinition.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
Aliasextensions, user content
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.url
DefinitionAn absolute URI that is used to identify this charge item definition when it is referenced in a specification, model, design or an instance; also called its canonical identifier. This SHOULD be globally unique and SHOULD be a literal address at which at which an authoritative instance of this charge item definition is (or will be) published. This URL can be the target of a canonical reference. It SHALL remain the same when the charge item definition is stored on different servers.
Cardinality1...1
Typeuri
SummaryTrue
Requirements

Allows the charge item definition to be referenced by a single globally unique identifier.

Comments

Can be a urn:uuid: or a urn:oid: but real http: addresses are preferred. Multiple instances may share the same URL if they have a distinct version.

The determination of when to create a new version of a resource (same url, new version) vs. defining a new artifact is up to the author. Considerations for making this decision are found in Technical and Business Versions.

In some cases, the resource can no longer be found at the stated url, but the url itself cannot change. Implementations can use the meta.source element to indicate where the current master source of the resource can be found.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.url
  • w5: FiveWs.identifier
  • rim: N/A
ChargeItemDefinition.identifier
DefinitionA formal identifier that is used to identify this charge item definition when it is represented in other formats, or referenced in a specification, model, design or an instance.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

Allows externally provided and/or usable business identifiers to be easily associated with the module.

Comments

Typically, this is used for identifiers that can go in an HL7 V3 II (instance identifier) data type, and can then identify this charge item definition outside of FHIR, where it is not possible to use the logical URI.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CX / EI (occasionally, more often EI maps to a resource id or a URL)
  • rim: II - The Identifier class is a little looser than the v3 type II because it allows URIs as well as registered OIDs or GUIDs. Also maps to Role[classCode=IDENT]
  • servd: Identifier
  • workflow: Definition.identifier
  • w5: FiveWs.identifier
  • rim: N/A
  • objimpl: no-gen-base
ChargeItemDefinition.version
DefinitionThe identifier that is used to identify this version of the charge item definition when it is referenced in a specification, model, design or instance. This is an arbitrary value managed by the charge item definition author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available. There is also no expectation that versions can be placed in a lexicographical sequence. To provide a version consistent with the Decision Support Service specification, use the format Major.Minor.Revision (e.g. 1.0.0). For more information on versioning knowledge assets, refer to the Decision Support Service specification. Note that a version is required for non-experimental active assets.
Cardinality0...1
Typestring
SummaryTrue
Comments

There may be different charge item definition instances that have the same identifier but different versions. The version can be appended to the url in a reference to allow a reference to a particular business version of the charge item definition with the format [url]|[version].

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.version
  • w5: FiveWs.version
  • rim: N/A
ChargeItemDefinition.title
DefinitionA short, descriptive, user-friendly title for the charge item definition.
Cardinality0...1
Typestring
SummaryTrue
Comments

This name does not need to be machine-processing friendly and may contain punctuation, white-space, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.title
  • rim: N/A
ChargeItemDefinition.derivedFromUri
DefinitionThe URL pointing to an externally-defined charge item definition that is adhered to in whole or in part by this definition.
Cardinality0...*
Typeuri
SummaryTrue
Comments

see http://en.wikipedia.org/wiki/Uniform_resource_identifier

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.partOf
DefinitionA larger definition of which this particular definition is a component or step.
Cardinality0...*
Typecanonical(ChargeItemDefinition)
SummaryTrue
Aliascontainer
Comments

see Canonical References

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.replaces
DefinitionAs new versions of a protocol or guideline are defined, allows identification of what versions are replaced by a new instance.
Cardinality0...*
Typecanonical(ChargeItemDefinition)
SummaryTrue
Aliassupersedes, prior, renewed order
Comments

see Canonical References

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.status
DefinitionThe current state of the ChargeItemDefinition.
Cardinality1...1
Typecode
Binding

The lifecycle status of an artifact.

PublicationStatus (required)
ModifierTrue
SummaryTrue
Comments

Allows filtering of charge item definitions that are appropriate for use versus not.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.status {different ValueSet}
  • w5: FiveWs.status
  • rim: N/A
ChargeItemDefinition.experimental
DefinitionA Boolean value to indicate that this charge item definition is authored for testing purposes (or education/evaluation/marketing) and is not intended to be used for genuine usage.
Cardinality0...1
Typeboolean
SummaryTrue
Requirements

Enables experimental content to be developed following the same lifecycle that would be used for a production-level charge item definition.

Comments

Allows filtering of charge item definitions that are appropriate for use versus not.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.experimental
  • w5: FiveWs.class
  • rim: N/A
ChargeItemDefinition.date
DefinitionThe date (and optionally time) when the charge item definition was published. The date must change when the business version changes and it must change if the status code changes. In addition, it should change when the substantive content of the charge item definition changes.
Cardinality0...1
TypedateTime
SummaryTrue
AliasRevision Date
Comments

Note that this is not the same as the resource last-modified-date, since the resource may be a secondary representation of the charge item definition. Additional specific dates may be added as extensions or be found by consulting Provenances associated with past versions of the resource.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.date
  • w5: FiveWs.recorded
  • rim: N/A
ChargeItemDefinition.publisher
DefinitionThe name of the organization or individual that published the charge item definition.
Cardinality0...1
Typestring
SummaryTrue
Requirements

Helps establish the "authority/credibility" of the charge item definition. May also allow for contact.

Comments

Usually an organization but may be an individual. The publisher (or steward) of the charge item definition is the organization or individual primarily responsible for the maintenance and upkeep of the charge item definition. This is not necessarily the same individual or organization that developed and initially authored the content. The publisher is the primary point of contact for questions or issues with the charge item definition. This item SHOULD be populated unless the information is available from context.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.publisher {as string instead of CodeableConcept}
  • w5: FiveWs.witness
  • rim: N/A
ChargeItemDefinition.contact
DefinitionContact details to assist a user in finding and communicating with the publisher.
Cardinality0...*
TypeContactDetail
SummaryTrue
Comments

May be a web site, an email address, a telephone number, etc.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.contact
  • rim: N/A
ChargeItemDefinition.description
DefinitionA free text natural language description of the charge item definition from a consumer's perspective.
Cardinality0...1
Typemarkdown
SummaryTrue
Comments

This description can be used to capture details such as why the charge item definition was built, comments about misuse, instructions for clinical use and interpretation, literature references, examples from the paper world, etc. It is not a rendering of the charge item definition as conveyed in the 'text' field of the resource itself. This item SHOULD be populated unless the information is available from context (e.g. the language of the charge item definition is presumed to be the predominant language in the place the charge item definition was created).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.description
  • rim: N/A
ChargeItemDefinition.useContext
DefinitionThe content was developed with a focus and intent of supporting the contexts that are listed. These contexts may be general categories (gender, age, ...) or may be references to specific programs (insurance plans, studies, ...) and may be used to assist with indexing and searching for appropriate charge item definition instances.
Cardinality0...*
TypeUsageContext
SummaryTrue
Requirements

Assist in searching for appropriate content.

Comments

When multiple useContexts are specified, there is no expectation that all or any of the contexts apply.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.useContext
  • rim: N/A
ChargeItemDefinition.jurisdiction
DefinitionA legal or geographic region in which the charge item definition is intended to be used.
Cardinality0...*
TypeCodeableConcept
Binding

Countries and regions within which this artifact is targeted for use.

Jurisdiction ValueSet (extensible)
SummaryTrue
Comments

It may be possible for the charge item definition to be used in jurisdictions other than those for which it was originally designed or intended.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • workflow: Definition.jurisdiction
  • rim: N/A
ChargeItemDefinition.copyright
DefinitionA copyright statement relating to the charge item definition and/or its contents. Copyright statements are generally legal restrictions on the use and publishing of the charge item definition.
Cardinality0...1
Typemarkdown
AliasLicense, Restrictions
Requirements

Consumers must be able to determine any legal restrictions on the use of the charge item definition and/or its content.

Comments

Systems are not required to have markdown support, so the text should be readable without markdown processing. The markdown syntax is GFM - see https://github.github.com/gfm/

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.copyright
  • rim: N/A
  • objimpl: no-gen-base
ChargeItemDefinition.approvalDate
DefinitionThe date on which the resource content was approved by the publisher. Approval happens once when the content is officially approved for usage.
Cardinality0...1
Typedate
Comments

The 'date' element may be more recent than the approval date because of minor changes or editorial corrections.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.approvalDate
  • rim: N/A
  • objimpl: no-gen-base
ChargeItemDefinition.lastReviewDate
DefinitionThe date on which the resource content was last reviewed. Review happens periodically after approval but does not change the original approval date.
Cardinality0...1
Typedate
Requirements

Gives a sense of how "current" the content is. Resources that have not been reviewed in a long time may have a risk of being less appropriate/relevant.

Comments

If specified, this date follows the original approval date.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Definition.lastReviewDate
  • rim: N/A
  • objimpl: no-gen-base
ChargeItemDefinition.effectivePeriod
DefinitionThe period during which the charge item definition content was or is planned to be in active use.
Cardinality0...1
TypePeriod
SummaryTrue
Requirements

Allows establishing a transition before a resource comes into effect and also allows for a sunsetting process when new versions of the charge item definition are or are expected to be used instead.

Comments

The effective period for a charge item definition determines when the content is applicable for usage and is independent of publication and review dates. For example, a measure intended to be used for the year 2016 might be published in 2015.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • per-1: If present, start SHALL have a lower value than end
    start.hasValue().not() or end.hasValue().not() or (start <= end)
Mappings
  • rim: n/a
  • v2: DR
  • rim: IVL<TS>[lowClosed="true" and highClosed="true"] or URG<TS>[lowClosed="true" and highClosed="true"]
  • workflow: Definition.effectivePeriod
  • rim: N/A
  • objimpl: no-gen-base
ChargeItemDefinition.code
DefinitionThe defined billing details in this resource pertain to the given billing code.
Cardinality0...1
TypeCodeableConcept
Binding

Billing Code defined by this ChargeItemDefinition.

ChargeItemCode (example)
SummaryTrue
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: N/A
ChargeItemDefinition.instance
DefinitionThe defined billing details in this resource pertain to the given product instance(s).
Cardinality0...*
TypeReference(Medication | Substance | Device)
Comments

In case of highly customized, individually produced or fitted devices/substances, the pricing information may be different for each instance of the product. This reference links pricing details to specific product instances.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ref-1: SHALL have a contained resource if a local reference is provided
    reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))
Mappings
  • rim: n/a
  • rim: The target of a resource reference is a RIM entry point (Act, Role, or Entity)
  • rim: N/A
ChargeItemDefinition.applicability
DefinitionExpressions that describe applicability criteria for the billing code.
Cardinality0...*
TypeBackboneElement
Comments

The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.applicability.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ChargeItemDefinition.applicability.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.applicability.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.applicability.description
DefinitionA brief, natural language description of the condition that effectively communicates the intended semantics.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.applicability.language
DefinitionThe media type of the language for the expression, e.g. "text/cql" for Clinical Query Language expressions or "text/fhirpath" for FHIRPath expressions.
Cardinality0...1
Typestring
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.applicability.expression
DefinitionAn expression that returns true or false, indicating whether the condition is satisfied. When using FHIRPath expressions, the %context environment variable must be replaced at runtime with the ChargeItem resource to which this definition is applied.
Cardinality0...1
Typestring
Comments

Please note that FHIRPath Expressions can only be evaluated in the scope of the current ChargeItem resource to which this definition is being applied. FHIRPath expressions can traverse into other resources linked from the ChargeItem resource, however, testing rules such as that a billing code may be billed only once per encounter need a wider scope. In such scenarios, CQL may be the appropriate choice.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup
DefinitionGroup of properties which are applicable under the same conditions. If no applicability rules are established for the group, then all properties always apply.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ChargeItemDefinition.propertyGroup.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.applicability
DefinitionExpressions that describe applicability criteria for the priceComponent.
Cardinality0...*
Typesee (applicability)
Comments

The applicability conditions can be used to ascertain whether a billing item is allowed in a specific context. E.g. some billing codes may only be applicable in out-patient settings, only to male/female patients or only to children.

Mappings
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent
DefinitionThe price for a ChargeItem may be calculated as a base price with surcharges/deductions that apply in certain conditions. A ChargeItemDefinition resource that defines the prices, factors and conditions that apply to a billing code is currently under development. The priceComponent element can be used to offer transparency to the recipient of the Invoice of how the prices have been calculated.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent.id
DefinitionUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality0...1
Typestring
Mappings
  • rim: n/a
ChargeItemDefinition.propertyGroup.priceComponent.extension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Cardinality0...*
TypeExtension
Aliasextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

SlicingUnordered, Open, by url(Value)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent.modifierExtension
DefinitionMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Cardinality0...*
TypeExtension
ModifierTrue
SummaryTrue
Aliasextensions, user content, modifiers
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions.

Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • ext-1: Must have either extensions or value[x], not both
    extension.exists() != value.exists()
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent.type
DefinitionThis code identifies the type of the component.
Cardinality1...1
Typecode
Binding

Codes indicating the kind of the price component.

InvoicePriceComponentType (required)
Comments

Note that FHIR strings SHALL NOT exceed 1MB in size

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent.code
DefinitionA code that identifies the component. Codes may be used to differentiate between kinds of taxes, surcharges, discounts etc.
Cardinality0...1
TypeCodeableConcept
BindingValueSetRevenueCodeMyCore (example)
Comments

Not all terminology uses fit this general pattern. In some cases, models should not use CodeableConcept and use Coding directly and provide their own structure for managing text, codings, translations and the relationship between elements and pre- and post-coordination.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: CE/CNE/CWE
  • rim: CD
  • orim: fhir:CodeableConcept rdfs:subClassOf dt:CD
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent.factor
DefinitionThe factor that has been applied on the base price for calculating this component.
Cardinality0...1
Typedecimal
Comments

Do not use an IEEE type floating point type, instead use something that works like a true decimal, with inbuilt precision (e.g. Java BigInteger)

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: N/A
ChargeItemDefinition.propertyGroup.priceComponent.amount
DefinitionThe amount calculated for this component.
Cardinality0...1
TypeMoney
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: MO
  • rim: N/A

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ChargeItemDefinition-my-core" />
    <url value="http://fhir.hie.moh.gov.my/StructureDefinition/ChargeItemDefinition-my-core" />
    <name value="ChargeItemDefinitionMyCore" />
    <title value="ChargeItemDefinition (MY Core)" />
    <status value="active" />
    <date value="2024-02-12T04:04:09.5621857+00:00" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="ChargeItemDefinition" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition" />
    <derivation value="constraint" />
    <differential>
        <element id="ChargeItemDefinition.propertyGroup.priceComponent.code">
            <path value="ChargeItemDefinition.propertyGroup.priceComponent.code" />
            <binding>
                <strength value="example" />
                <valueSet value="http://fhir.hie.moh.gov.my/ValueSet/revenue-code-my-core" />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "ChargeItemDefinition-my-core",
    "url": "http://fhir.hie.moh.gov.my/StructureDefinition/ChargeItemDefinition-my-core",
    "name": "ChargeItemDefinitionMyCore",
    "title": "ChargeItemDefinition (MY Core)",
    "status": "active",
    "date": "2024-02-12T04:04:09.5621857+00:00",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "ChargeItemDefinition",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ChargeItemDefinition",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ChargeItemDefinition.propertyGroup.priceComponent.code",
                "path": "ChargeItemDefinition.propertyGroup.priceComponent.code",
                "binding": {
                    "strength": "example",
                    "valueSet": "http://fhir.hie.moh.gov.my/ValueSet/revenue-code-my-core"
                }
            }
        ]
    }
}

Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ1..1uri
identifierΣ0..*Identifier
versionΣ0..1string
titleΣ0..1string
derivedFromUriΣ0..*uri
partOfΣ0..*canonical(ChargeItemDefinition)
replacesΣ0..*canonical(ChargeItemDefinition)
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
descriptionΣ0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
copyright0..1markdown
approvalDate0..1date
lastReviewDate0..1date
effectivePeriodΣ I0..1Period
codeΣ0..1CodeableConcept
instanceI0..*Reference(Medication | Substance | Device)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
description0..1string
language0..1string
expression0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
applicability0..*see (applicability)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBinding
code0..1CodeableConcept
factor0..1decimal
amount0..1Money

Diff

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ1..1uri
identifierΣ0..*Identifier
versionΣ0..1string
titleΣ0..1string
derivedFromUriΣ0..*uri
partOfΣ0..*canonical(ChargeItemDefinition)
replacesΣ0..*canonical(ChargeItemDefinition)
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
descriptionΣ0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
copyright0..1markdown
approvalDate0..1date
lastReviewDate0..1date
effectivePeriodΣ I0..1Period
codeΣ0..1CodeableConcept
instanceI0..*Reference(Medication | Substance | Device)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
description0..1string
language0..1string
expression0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
applicability0..*see (applicability)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBinding
code0..1CodeableConcept
factor0..1decimal
amount0..1Money

Hybrid

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
extensionI0..*Extension
modifierExtension?! I0..*Extension
urlΣ1..1uri
identifierΣ0..*Identifier
versionΣ0..1string
titleΣ0..1string
derivedFromUriΣ0..*uri
partOfΣ0..*canonical(ChargeItemDefinition)
replacesΣ0..*canonical(ChargeItemDefinition)
statusΣ ?!1..1codeBinding
experimentalΣ0..1boolean
dateΣ0..1dateTime
publisherΣ0..1string
contactΣ0..*ContactDetail
descriptionΣ0..1markdown
useContextΣ0..*UsageContext
jurisdictionΣ0..*CodeableConceptBinding
copyright0..1markdown
approvalDate0..1date
lastReviewDate0..1date
effectivePeriodΣ I0..1Period
codeΣ0..1CodeableConcept
instanceI0..*Reference(Medication | Substance | Device)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
description0..1string
language0..1string
expression0..1string
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
applicability0..*see (applicability)
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
type1..1codeBinding
code0..1CodeableConcept
factor0..1decimal
amount0..1Money

This profile is derived from the base FHIR ChargeItemDefinition resource.

Requirements

This structure defines these element as mandatory requirement:

  1. A status status
  2. An intent intent
  3. A subject reference subject