ChargeItem (MY Core)

Defining URL http://fhir.hie.moh.gov.my/StructureDefinition/ChargeItem-my-core
Version 1.0.0
Name ChargeItemMyCore
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 ChargeItem (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

ChargeItem
DefinitionThe resource ChargeItem describes the provision of healthcare provider products for a certain patient, therefore referring not only to the product, but containing in addition details of the provision, like date, time, amounts and participating organizations and persons. Main Usage of the ChargeItem is to enable the billing process and internal cost allocation.
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()
Mappings
  • rim: Entity. Role, or Act
  • workflow: Event
  • v2: FT1
  • rim: Act[moodCode=EVN]
ChargeItem.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.

ChargeItem.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
ChargeItem.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
ChargeItem.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
ChargeItem.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?
ChargeItem.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
ChargeItem.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
ChargeItem.extension:chargeItemDefinitionReference
DefinitionExtension for a ChargeItem to reference a ChargeItemDefinition
Cardinality0...*
TypeExtension(Reference(ChargeItemDefinition))
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.

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
ChargeItem.extension:priceComponentMyCore
Definitionextension about the details of a line item in ChargeItem
Cardinality0...*
TypeExtension(Complex)
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.

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
ChargeItem.extension:useContextMyCore
DefinitionExtension to determine the use context
Cardinality0...*
TypeExtension(UsageContext)
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.

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
ChargeItem.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
ChargeItem.identifier
DefinitionIdentifiers assigned to this event performer or other systems.
Cardinality0...*
TypeIdentifier
SummaryTrue
Requirements

Allows identification of the charge Item as it is known by various participating systems and in a way that remains consistent across servers.

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: Event.identifier
  • w5: FiveWs.identifier
  • v2: FT1.2
  • rim: .identifier
ChargeItem.definitionUri
DefinitionReferences the (external) source of pricing information, rules of application for the code this ChargeItem uses.
Cardinality0...*
Typeuri
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
  • workflow: Event.instantiates
  • v2: Varies by domain
  • rim: .outboundRelationship[typeCode=DEFN].target
ChargeItem.definitionCanonical
DefinitionReferences the source of pricing information, rules of application for the code this ChargeItem uses.
Cardinality0...*
Typecanonical(ChargeItemDefinition)
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
  • workflow: Event.instantiates
  • v2: Varies by domain
  • rim: .outboundRelationship[typeCode=DEFN].target
ChargeItem.status
DefinitionThe current state of the ChargeItem.
Cardinality1...1
Typecode
Binding

Codes identifying the lifecycle stage of a ChargeItem.

ChargeItemStatus (required)
ModifierTrue
SummaryTrue
Comments

Unknown does not represent "other" - one of the defined statuses must apply. Unknown is used when the authoring system is not sure what the current status is.

This element is labeled as a modifier because the status contains the code entered-in-error that marks the charge item as not currently valid.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.status
  • w5: FiveWs.status
  • v2: Varies by domain
  • rim: .status
ChargeItem.partOf
DefinitionChargeItems can be grouped to larger ChargeItems covering the whole set.
Cardinality0...*
TypeReference(ChargeItem)
Aliascontainer
Requirements

E.g. Drug administration as part of a procedure, procedure as part of observation, etc.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

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)
  • workflow: Event.partOf
  • v2: Varies by domain
  • rim: .inboundRelationship[typeCode=COMP].source[moodCode=EVN]
ChargeItem.code
DefinitionA code that identifies the charge, like a billing code.
Cardinality1...1
TypeCodeableConcept
Binding

Set of codes that can be used for billing purposes.

ChargeItemCode (example)
SummaryTrue
Aliastype
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
  • workflow: Event.code
  • w5: FiveWs.what[x]
  • v2: FT1.7
  • rim: .code
ChargeItem.subject
DefinitionThe individual or set of individuals the action is being or was performed on.
Cardinality1...1
TypeReference(Patient | Group)
SummaryTrue
Aliaspatient
Requirements

Links the event to the Patient context.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

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)
  • workflow: Event.subject
  • w5: FiveWs.subject[x]
  • v2: PAT in proximity to FT1 segment
  • rim: .participation[typeCode=SBJ].role
  • w5: FiveWs.subject
ChargeItem.context
DefinitionThe encounter or episode of care that establishes the context for this event.
Cardinality0...1
TypeReference(Encounter | EpisodeOfCare)
SummaryTrue
Aliasencounter
Requirements

Links the request to the Encounter context.

Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

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)
  • workflow: Event.context
  • w5: FiveWs.context
  • v2: PV1 in proximity to FT1 segment
  • rim: .inboundRelationship(typeCode=COMP].source[classCode<=PCPR, moodCode=EVN]
ChargeItem.occurrence[x]
DefinitionDate/time(s) or duration when the charged service was applied.
Cardinality0...1
TypedateTime
SummaryTrue
Aliastiming
Comments

The list of types may be constrained as appropriate for the type of charge item.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.occurrence[x]
  • w5: FiveWs.done[x]
  • v2: Varies by domain
  • rim: .effectiveTime
ChargeItem.performer
DefinitionIndicates who or what performed or participated in the charged service.
Cardinality0...*
TypeBackboneElement
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • workflow: Event.performer
  • v2: EVN.5 or by domain
  • rim: .participation[typeCode=PRF].role[scoper.determinerCode=INSTANCE]
ChargeItem.performer.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
ChargeItem.performer.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
ChargeItem.performer.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
ChargeItem.performer.function
DefinitionDescribes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).
Cardinality0...1
TypeCodeableConcept
Binding

Codes describing the types of functional roles performers can take on when performing events.

ProcedurePerformerRoleCodes (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
  • workflow: Event.performer.function
  • v2: Varies by domain
  • rim: .participation.functionCode
ChargeItem.performer.actor
DefinitionThe device, practitioner, etc. who performed or participated in the service.
Cardinality1...1
TypeReference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

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)
  • workflow: Event.performer.actor
  • w5: FiveWs.actor
  • v2: EVN.5 or by domain
  • rim: .player
ChargeItem.performingOrganization
DefinitionThe organization requesting the service.
Cardinality0...1
TypeReference(Organization)
Comments

Practitioners and Devices can be associated with multiple organizations. It has to be made clear, on behalf of which Organization the services have been rendered.

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)
  • workflow: Event.performer.actor
  • v2: N/A
  • rim: .scoper
ChargeItem.requestingOrganization
DefinitionThe organization performing the service.
Cardinality0...1
TypeReference(Organization)
Comments

The rendered Service might not be associated with a Request. This property indicates which Organization requested the services to be rendered. (In many cases, this may just be the Department associated with the Encounter.location).

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)
  • v2: N/A
  • rim: .scoper
ChargeItem.costCenter
DefinitionThe financial cost center permits the tracking of charge attribution.
Cardinality0...1
TypeReference(Organization)
Comments

The costCenter could either be given as a reference to an Organization(Role) resource or as the identifier of the cost center determined by Reference.identifier.value and Reference.identifier.system, depending on use case requirements.

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)
  • v2: FT1.13
ChargeItem.quantity
DefinitionQuantity of which the charge item has been serviced.
Cardinality0...1
TypeQuantity
SummaryTrue
Comments

In many cases this may just be a value, if the underlying units are implicit in the definition of the charge item code.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
  • qty-3: If a code for the unit is present, the system SHALL also be present
    code.empty() or system.exists()
Mappings
  • rim: n/a
  • v2: SN (see also Range) or CQ
  • rim: PQ, IVL<PQ>, MO, CO, depending on the values
  • v2: FT1.10
ChargeItem.bodysite
DefinitionThe anatomical location where the related service has been applied.
Cardinality0...*
TypeCodeableConcept
Binding

Codes describing anatomical locations. May include laterality.

SNOMEDCTBodyStructures (example)
SummaryTrue
Comments

Only used if not implicit in code found in Condition.code. If the use case requires attributes from the BodySite resource (e.g. to identify and track separately) then use the standard extension bodySite. May be a summary code, or a reference to a very precise definition of the location, or both.

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: .targetBodySiteCode
ChargeItem.factorOverride
DefinitionFactor overriding the factor determined by the rules associated with the code.
Cardinality0...1
Typedecimal
Comments

There is no reason to carry the factor in the instance of a ChargeItem unless special circumstances require a manual override. The factors are usually defined by a set of rules in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: FT1.26
ChargeItem.priceOverride
DefinitionTotal price of the charge overriding the list price associated with the code.
Cardinality0...1
TypeMoney
Comments

There is no reason to carry the price in the instance of a ChargeItem unless circumstances require a manual override. The list prices or are usually defined in a back catalogue of the billing codes (see ChargeItem.definition). Derived profiles may require a ChargeItem.overrideReason to be provided if either factor or price are manually overridden.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: MO
  • v2: FT1.22
ChargeItem.overrideReason
DefinitionIf the list price or the rule-based factor associated with the code is overridden, this attribute can capture a text to indicate the reason for this action.
Cardinality0...1
Typestring
Comments

Derived Profiles may choose to add invariants requiring this field to be populated if either priceOverride or factorOverride have been filled.

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ChargeItem.enterer
DefinitionThe device, practitioner, etc. who entered the charge item.
Cardinality0...1
TypeReference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
SummaryTrue
Comments

The enterer is also the person considered responsible for factor/price overrides if applicable.

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)
  • w5: FiveWs.actor
  • v2: EVN.5 or by domain
  • rim: .player
ChargeItem.enteredDate
DefinitionDate the charge item was entered.
Cardinality0...1
TypedateTime
SummaryTrue
Comments

The actual date when the service associated with the charge has been rendered is captured in occurrence[x].

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
ChargeItem.reason
DefinitionDescribes why the event occurred in coded or textual form.
Cardinality0...*
TypeCodeableConcept
Binding

Example binding for reason.

ICD-10Codes (example)
Comments

If the application of the charge item requires a reason to be given, it can be captured here. Textual reasons can be captured using reasonCode.text.

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: Event.reasonCode
  • w5: FiveWs.why[x]
  • v2: EVN.4 or by domain
  • rim: .reasonCode
ChargeItem.service
DefinitionIndicated the rendered service that caused this charge.
Cardinality0...*
TypeReference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

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)
  • workflow: Event.reasonReference
  • w5: FiveWs.why[x]
  • v2: EVN.4 or by domain
  • rim: .outboundRelationship[typeCode=RSON].target
ChargeItem.product[x]
DefinitionIdentifies the device, food, drug or other product being charged either by type code or reference to an instance.
Cardinality0...1
TypeReference(Device | Medication | Substance)
Binding

Example binding for product type.

FHIRDeviceTypes (example)
Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • rim: .participation[typeCode=CSM].role
ChargeItem.account
DefinitionAccount into which this ChargeItems belongs.
Cardinality0...*
TypeReference(Account)
SummaryTrue
Comments

Systems posting the ChargeItems might not always be able to determine, which accounts the Items need to be places into. It is up to the postprocessing Financial System to apply internal rules to decide based on the Encounter/EpisodeOfCare/Patient/Coverage context and the type of ChargeItem, which Account is appropriate.

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)
ChargeItem.note
DefinitionComments made about the event by the performer, subject or other participants.
Cardinality0...*
TypeAnnotation
Comments

For systems that do not have structured annotations, they can simply communicate a single annotation with no author or time. This element may need to be included in narrative because of the potential for modifying information. Annotations SHOULD NOT be used to communicate "modifying" information that could be computable. (This is a SHOULD because enforcing user behavior is nearly impossible).

Invariants
  • ele-1: All FHIR elements must have a @value or children
    hasValue() or (children().count() > id.count())
Mappings
  • rim: n/a
  • v2: N/A
  • rim: Act
  • workflow: Event.note
  • v2: NTE
  • rim: .inboundRelationship(typeCode=SUBJ].source[classCode=ANNGEN, moodCode=EVN].value[xsi:type=ST]
ChargeItem.supportingInformation
DefinitionFurther information supporting this charge.
Cardinality0...*
TypeReference(Resource)
Comments

References SHALL be a reference to an actual FHIR resource, and SHALL be resolveable (allowing for access control, temporary unavailability, etc.). Resolution can be either by retrieval from the URL, or, where applicable by resource type, by treating an absolute reference as a canonical URL and looking it up in a local registry/repository.

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)
  • workflow: Event.supportingInfo

<StructureDefinition xmlns="http://hl7.org/fhir">
    <id value="ChargeItem-my-core" />
    <url value="http://fhir.hie.moh.gov.my/StructureDefinition/ChargeItem-my-core" />
    <name value="ChargeItemMyCore" />
    <title value="ChargeItem (MY Core)" />
    <status value="active" />
    <date value="2024-03-13T01:41:41.3395961+00:00" />
    <fhirVersion value="4.0.1" />
    <kind value="resource" />
    <abstract value="false" />
    <type value="ChargeItem" />
    <baseDefinition value="http://hl7.org/fhir/StructureDefinition/ChargeItem" />
    <derivation value="constraint" />
    <differential>
        <element id="ChargeItem.extension:chargeItemDefinitionReference">
            <path value="ChargeItem.extension" />
            <sliceName value="chargeItemDefinitionReference" />
            <short value="Extension for a ChargeItem to reference a ChargeItemDefinition" />
            <definition value="Extension for a ChargeItem to reference a ChargeItemDefinition" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/chargeitem-cid-reference-my-core" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="ChargeItem.extension:priceComponentMyCore">
            <path value="ChargeItem.extension" />
            <sliceName value="priceComponentMyCore" />
            <short value="extension about the details of a line item in ChargeItem" />
            <definition value="extension about the details of a line item in ChargeItem" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/price-component-my-core" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="ChargeItem.extension:useContextMyCore">
            <path value="ChargeItem.extension" />
            <sliceName value="useContextMyCore" />
            <short value="Extension to determine the use context" />
            <definition value="Extension to determine the use context" />
            <type>
                <code value="Extension" />
                <profile value="http://fhir.hie.moh.gov.my/StructureDefinition/use-context-my-core" />
            </type>
            <isModifier value="false" />
        </element>
        <element id="ChargeItem.code">
            <path value="ChargeItem.code" />
            <binding>
                <strength value="example" />
                <description value="Set of codes that can be used for billing purposes." />
            </binding>
        </element>
    </differential>
</StructureDefinition>

{
    "resourceType": "StructureDefinition",
    "id": "ChargeItem-my-core",
    "url": "http://fhir.hie.moh.gov.my/StructureDefinition/ChargeItem-my-core",
    "name": "ChargeItemMyCore",
    "title": "ChargeItem (MY Core)",
    "status": "active",
    "date": "2024-03-13T01:41:41.3395961+00:00",
    "fhirVersion": "4.0.1",
    "kind": "resource",
    "abstract": false,
    "type": "ChargeItem",
    "baseDefinition": "http://hl7.org/fhir/StructureDefinition/ChargeItem",
    "derivation": "constraint",
    "differential": {
        "element":  [
            {
                "id": "ChargeItem.extension:chargeItemDefinitionReference",
                "path": "ChargeItem.extension",
                "sliceName": "chargeItemDefinitionReference",
                "short": "Extension for a ChargeItem to reference a ChargeItemDefinition",
                "definition": "Extension for a ChargeItem to reference a ChargeItemDefinition",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.hie.moh.gov.my/StructureDefinition/chargeitem-cid-reference-my-core"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "ChargeItem.extension:priceComponentMyCore",
                "path": "ChargeItem.extension",
                "sliceName": "priceComponentMyCore",
                "short": "extension about the details of a line item in ChargeItem",
                "definition": "extension about the details of a line item in ChargeItem",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.hie.moh.gov.my/StructureDefinition/price-component-my-core"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "ChargeItem.extension:useContextMyCore",
                "path": "ChargeItem.extension",
                "sliceName": "useContextMyCore",
                "short": "Extension to determine the use context",
                "definition": "Extension to determine the use context",
                "type":  [
                    {
                        "code": "Extension",
                        "profile":  [
                            "http://fhir.hie.moh.gov.my/StructureDefinition/use-context-my-core"
                        ]
                    }
                ],
                "isModifier": false
            },
            {
                "id": "ChargeItem.code",
                "path": "ChargeItem.code",
                "binding": {
                    "strength": "example",
                    "description": "Set of codes that can be used for billing purposes."
                }
            }
        ]
    }
}

Snapshot

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
chargeItemDefinitionReferenceI0..*Extension(Reference(ChargeItemDefinition))
priceComponentMyCoreI0..*Extension(Complex)
useContextMyCoreI0..*Extension(UsageContext)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
definitionUri0..*uri
definitionCanonical0..*canonical(ChargeItemDefinition)
statusΣ ?!1..1codeBinding
partOfI0..*Reference(ChargeItem)
codeΣ1..1CodeableConcept
subjectΣ I1..1Reference(Patient | Group)
contextΣ I0..1Reference(Encounter | EpisodeOfCare)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
function0..1CodeableConcept
actorI1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)
performingOrganizationI0..1Reference(Organization)
requestingOrganizationI0..1Reference(Organization)
costCenterI0..1Reference(Organization)
quantityΣ I0..1Quantity
bodysiteΣ0..*CodeableConcept
factorOverride0..1decimal
priceOverride0..1Money
overrideReason0..1string
entererΣ I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
enteredDateΣ0..1dateTime
reason0..*CodeableConcept
serviceI0..*Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery)
productCodeableConceptCodeableConcept
productReferenceReference(Device | Medication | Substance)
accountΣ I0..*Reference(Account)
note0..*Annotation
supportingInformationI0..*Reference(Resource)

Diff

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
chargeItemDefinitionReferenceI0..*Extension(Reference(ChargeItemDefinition))
priceComponentMyCoreI0..*Extension(Complex)
useContextMyCoreI0..*Extension(UsageContext)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
definitionUri0..*uri
definitionCanonical0..*canonical(ChargeItemDefinition)
statusΣ ?!1..1codeBinding
partOfI0..*Reference(ChargeItem)
codeΣ1..1CodeableConcept
subjectΣ I1..1Reference(Patient | Group)
contextΣ I0..1Reference(Encounter | EpisodeOfCare)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
function0..1CodeableConcept
actorI1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)
performingOrganizationI0..1Reference(Organization)
requestingOrganizationI0..1Reference(Organization)
costCenterI0..1Reference(Organization)
quantityΣ I0..1Quantity
bodysiteΣ0..*CodeableConcept
factorOverride0..1decimal
priceOverride0..1Money
overrideReason0..1string
entererΣ I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
enteredDateΣ0..1dateTime
reason0..*CodeableConcept
serviceI0..*Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery)
productCodeableConceptCodeableConcept
productReferenceReference(Device | Medication | Substance)
accountΣ I0..*Reference(Account)
note0..*Annotation
supportingInformationI0..*Reference(Resource)

Hybrid

idΣ0..1string
metaΣ0..1Meta
implicitRulesΣ ?!0..1uri
language0..1codeBinding
text0..1Narrative
contained0..*Resource
chargeItemDefinitionReferenceI0..*Extension(Reference(ChargeItemDefinition))
priceComponentMyCoreI0..*Extension(Complex)
useContextMyCoreI0..*Extension(UsageContext)
modifierExtension?! I0..*Extension
identifierΣ0..*Identifier
definitionUri0..*uri
definitionCanonical0..*canonical(ChargeItemDefinition)
statusΣ ?!1..1codeBinding
partOfI0..*Reference(ChargeItem)
codeΣ1..1CodeableConcept
subjectΣ I1..1Reference(Patient | Group)
contextΣ I0..1Reference(Encounter | EpisodeOfCare)
occurrenceDateTimedateTime
occurrencePeriodPeriod
occurrenceTimingTiming
id0..1string
extensionI0..*Extension
modifierExtensionΣ ?! I0..*Extension
function0..1CodeableConcept
actorI1..1Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)
performingOrganizationI0..1Reference(Organization)
requestingOrganizationI0..1Reference(Organization)
costCenterI0..1Reference(Organization)
quantityΣ I0..1Quantity
bodysiteΣ0..*CodeableConcept
factorOverride0..1decimal
priceOverride0..1Money
overrideReason0..1string
entererΣ I0..1Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson)
enteredDateΣ0..1dateTime
reason0..*CodeableConcept
serviceI0..*Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery)
productCodeableConceptCodeableConcept
productReferenceReference(Device | Medication | Substance)
accountΣ I0..*Reference(Account)
note0..*Annotation
supportingInformationI0..*Reference(Resource)

This profile is derived from the base FHIR ChargeItem resource.

Requirements

This structure defines these element as mandatory requirement:

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