ImplementationGuide for Malaysia Core (MY Core)
0.0.1 - CI Build

ImplementationGuide for Malaysia Core (MY Core), published by Malaysia Healthcare Nexus (MHN). This guide is not an authorized publication; it is the continuous build for version 0.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/nhphong245/my-core-ig-r4/ and changes regularly. See the Directory of published versions

Resource Profile: ChargeItemMyCore - Detailed Descriptions

Active as of 2024-03-13

Definitions for the ChargeItem-my-core resource profile.

Guidance on how to interpret the contents of this table can be found here

0. ChargeItem
2. ChargeItem.extension:chargeItemDefinitionReference
Slice NamechargeItemDefinitionReference
Definition

Extension for a ChargeItem to reference a ChargeItemDefinition

ShortExtension for a ChargeItem to reference a ChargeItemDefinition
TypeExtension(ExtensionChargeItemCIDReference (MY Core)) (Extension Type: Reference(ChargeItemDefinition))
Is Modifierfalse
4. ChargeItem.extension:priceComponentMyCore
Slice NamepriceComponentMyCore
Definition

extension about the details of a line item in ChargeItem

Shortextension about the details of a line item in ChargeItem
TypeExtension(PriceComponent (MY Core)) (Complex Extension)
Is Modifierfalse
6. ChargeItem.extension:useContextMyCore
Slice NameuseContextMyCore
Definition

Extension to determine the use context

ShortExtension to determine the use context
TypeExtension(UseContect (MY Core)) (Extension Type: UsageContext)
Is Modifierfalse
8. ChargeItem.code
Binding

Set of codes that can be used for billing purposes.

Guidance on how to interpret the contents of this table can be found here

0. ChargeItem
Definition

The 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.

ShortItem containing charge code(s) associated with the provision of healthcare provider products
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ChargeItem.implicitRules
Definition

A 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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ChargeItem.extension:chargeItemDefinitionReference
Slice NamechargeItemDefinitionReference
Definition

Extension for a ChargeItem to reference a ChargeItemDefinition

ShortExtension for a ChargeItem to reference a ChargeItemDefinition
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(ExtensionChargeItemCIDReference (MY Core)) (Extension Type: Reference(ChargeItemDefinition))
Is Modifierfalse
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
6. ChargeItem.extension:priceComponentMyCore
Slice NamepriceComponentMyCore
Definition

extension about the details of a line item in ChargeItem

Shortextension about the details of a line item in ChargeItem
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(PriceComponent (MY Core)) (Complex Extension)
Is Modifierfalse
Invariantsele-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())
8. ChargeItem.extension:useContextMyCore
Slice NameuseContextMyCore
Definition

Extension to determine the use context

ShortExtension to determine the use context
Control0..*
This element is affected by the following invariants: ele-1
TypeExtension(UseContect (MY Core)) (Extension Type: UsageContext)
Is Modifierfalse
Invariantsele-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())
ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
10. ChargeItem.modifierExtension
Definition

May 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).

ShortExtensions that cannot be ignored
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.

Control0..*
TypeExtension
Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Summaryfalse
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.

Alternate Namesextensions, user content
Invariantsele-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())
12. ChargeItem.status
Definition

The current state of the ChargeItem.

Shortplanned | billable | not-billable | aborted | billed | entered-in-error | unknown
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.

Control1..1
BindingThe codes SHALL be taken from ChargeItemStatushttp://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1
(required to http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1)

Codes identifying the lifecycle stage of a ChargeItem.

Typecode
Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
14. ChargeItem.code
Definition

A code that identifies the charge, like a billing code.

ShortA code that identifies the charge, like a billing code
Control1..1
BindingFor example codes, see ChargeItemCodehttp://hl7.org/fhir/ValueSet/chargeitem-billingcodes
(example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes)

Set of codes that can be used for billing purposes.


Example set of codes that can be used for billing purposes.

TypeCodeableConcept
Is Modifierfalse
Summarytrue
Alternate Namestype
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
16. ChargeItem.subject
Definition

The individual or set of individuals the action is being or was performed on.

ShortIndividual service was done for/to
Control1..1
TypeReference(Patient, Group)
Is Modifierfalse
Summarytrue
Requirements

Links the event to the Patient context.

Alternate Namespatient
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))

Guidance on how to interpret the contents of this table can be found here

0. ChargeItem
Definition

The 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.

ShortItem containing charge code(s) associated with the provision of healthcare provider products
Control0..*
Is Modifierfalse
Summaryfalse
Invariantsdom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.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-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-5: If a resource is contained in another resource, it SHALL NOT have a security label (contained.meta.security.empty())
dom-6: A resource should have narrative for robust management (text.`div`.exists())
2. ChargeItem.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

ShortLogical id of this artifact
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.

Control0..1
Typeid
Is Modifierfalse
Summarytrue
4. ChargeItem.meta
Definition

The 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.

ShortMetadata about the resource
Control0..1
TypeMeta
Is Modifierfalse
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
6. ChargeItem.implicitRules
Definition

A 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.

ShortA set of rules under which this content was created
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.

Control0..1
Typeuri
Is Modifiertrue because This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
8. ChargeItem.language
Definition

The base language in which the resource is written.

ShortLanguage of the resource content
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).

Control0..1
BindingThe codes SHOULD be taken from CommonLanguages
(preferred to http://hl7.org/fhir/ValueSet/languages)

A human language.

Additional BindingsPurpose
AllLanguagesMax Binding
Typecode
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Summaryfalse
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
10. ChargeItem.text
Definition

A 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.

ShortText summary of the resource, for human interpretation
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.

Control0..1
TypeNarrative
Is Modifierfalse
Summaryfalse
Alternate Namesnarrative, html, xhtml, display
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
12. ChargeItem.contained
Definition

These 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.

ShortContained, inline 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.

Control0..*
TypeResource
Is Modifierfalse
Summaryfalse
Alternate Namesinline resources, anonymous resources, contained resources
14. ChargeItem.extension
Definition

An Extension

ShortExtension
Control0..*
TypeExtension
Is Modifierfalse
Summaryfalse
Invariantsele-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())
SlicingThis element introduces a set of slices on ChargeItem.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
  • value @ url
  • 16. ChargeItem.extension:chargeItemDefinitionReference
    Slice NamechargeItemDefinitionReference
    Definition

    Extension for a ChargeItem to reference a ChargeItemDefinition

    ShortExtension for a ChargeItem to reference a ChargeItemDefinition
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(ExtensionChargeItemCIDReference (MY Core)) (Extension Type: Reference(ChargeItemDefinition))
    Is Modifierfalse
    Invariantsele-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())
    18. ChargeItem.extension:priceComponentMyCore
    Slice NamepriceComponentMyCore
    Definition

    extension about the details of a line item in ChargeItem

    Shortextension about the details of a line item in ChargeItem
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(PriceComponent (MY Core)) (Complex Extension)
    Is Modifierfalse
    Invariantsele-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())
    20. ChargeItem.extension:useContextMyCore
    Slice NameuseContextMyCore
    Definition

    Extension to determine the use context

    ShortExtension to determine the use context
    Control0..*
    This element is affected by the following invariants: ele-1
    TypeExtension(UseContect (MY Core)) (Extension Type: UsageContext)
    Is Modifierfalse
    Invariantsele-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())
    22. ChargeItem.modifierExtension
    Definition

    May 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).

    ShortExtensions that cannot be ignored
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
    Summaryfalse
    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.

    Alternate Namesextensions, user content
    Invariantsele-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())
    24. ChargeItem.identifier
    Definition

    Identifiers assigned to this event performer or other systems.

    ShortBusiness Identifier for item
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    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.

    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    26. ChargeItem.definitionUri
    Definition

    References the (external) source of pricing information, rules of application for the code this ChargeItem uses.

    ShortDefining information about the code of this charge item
    Control0..*
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    28. ChargeItem.definitionCanonical
    Definition

    References the source of pricing information, rules of application for the code this ChargeItem uses.

    ShortResource defining the code of this ChargeItem
    Control0..*
    Typecanonical(ChargeItemDefinition)
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    30. ChargeItem.status
    Definition

    The current state of the ChargeItem.

    Shortplanned | billable | not-billable | aborted | billed | entered-in-error | unknown
    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.

    Control1..1
    BindingThe codes SHALL be taken from ChargeItemStatus
    (required to http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1)

    Codes identifying the lifecycle stage of a ChargeItem.

    Typecode
    Is Modifiertrue because This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. ChargeItem.partOf
    Definition

    ChargeItems can be grouped to larger ChargeItems covering the whole set.

    ShortPart of referenced ChargeItem
    Control0..*
    TypeReference(ChargeItem)
    Is Modifierfalse
    Summaryfalse
    Requirements

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

    Alternate Namescontainer
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. ChargeItem.code
    Definition

    A code that identifies the charge, like a billing code.

    ShortA code that identifies the charge, like a billing code
    Control1..1
    BindingFor example codes, see ChargeItemCode
    (example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes)

    Set of codes that can be used for billing purposes.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Alternate Namestype
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    36. ChargeItem.subject
    Definition

    The individual or set of individuals the action is being or was performed on.

    ShortIndividual service was done for/to
    Control1..1
    TypeReference(Patient, Group)
    Is Modifierfalse
    Summarytrue
    Requirements

    Links the event to the Patient context.

    Alternate Namespatient
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. ChargeItem.context
    Definition

    The encounter or episode of care that establishes the context for this event.

    ShortEncounter / Episode associated with event
    Control0..1
    TypeReference(Encounter, EpisodeOfCare)
    Is Modifierfalse
    Summarytrue
    Requirements

    Links the request to the Encounter context.

    Alternate Namesencounter
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. ChargeItem.occurrence[x]
    Definition

    Date/time(s) or duration when the charged service was applied.

    ShortWhen the charged service was applied
    Comments

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

    Control0..1
    TypeChoice of: dateTime, Period, Timing
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Alternate Namestiming
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. ChargeItem.performer
    Definition

    Indicates who or what performed or participated in the charged service.

    ShortWho performed charged service
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. ChargeItem.performer.id
    Definition

    Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

    ShortUnique id for inter-element referencing
    Control0..1
    Typestring
    Is Modifierfalse
    XML FormatIn the XML format, this property is represented as an attribute.
    Summaryfalse
    46. ChargeItem.performer.extension
    Definition

    May 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.

    ShortAdditional content defined by implementations
    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.

    Control0..*
    TypeExtension
    Is Modifierfalse
    Summaryfalse
    Alternate Namesextensions, user content
    Invariantsele-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())
    48. ChargeItem.performer.modifierExtension
    Definition

    May 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).

    ShortExtensions that cannot be ignored even if unrecognized
    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.

    Control0..*
    TypeExtension
    Is Modifiertrue because Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
    Summarytrue
    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.

    Alternate Namesextensions, user content, modifiers
    Invariantsele-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())
    50. ChargeItem.performer.function
    Definition

    Describes the type of performance or participation(e.g. primary surgeon, anesthesiologiest, etc.).

    ShortWhat type of performance was done
    Control0..1
    BindingFor example codes, see ProcedurePerformerRoleCodes
    (example to http://hl7.org/fhir/ValueSet/performer-role)

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

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    52. ChargeItem.performer.actor
    Definition

    The device, practitioner, etc. who performed or participated in the service.

    ShortIndividual who was performing
    Control1..1
    TypeReference(Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    54. ChargeItem.performingOrganization
    Definition

    The organization requesting the service.

    ShortOrganization providing the charged service
    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.

    Control0..1
    TypeReference(Organization)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    56. ChargeItem.requestingOrganization
    Definition

    The organization performing the service.

    ShortOrganization requesting the charged service
    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).

    Control0..1
    TypeReference(Organization)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    58. ChargeItem.costCenter
    Definition

    The financial cost center permits the tracking of charge attribution.

    ShortOrganization that has ownership of the (potential, future) revenue
    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.

    Control0..1
    TypeReference(Organization)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    60. ChargeItem.quantity
    Definition

    Quantity of which the charge item has been serviced.

    ShortQuantity of which the charge item has been serviced
    Comments

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

    Control0..1
    TypeQuantity
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    62. ChargeItem.bodysite
    Definition

    The anatomical location where the related service has been applied.

    ShortAnatomical location, if relevant
    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.

    Control0..*
    BindingFor example codes, see SNOMEDCTBodyStructures
    (example to http://hl7.org/fhir/ValueSet/body-site)

    Codes describing anatomical locations. May include laterality.

    TypeCodeableConcept
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    64. ChargeItem.factorOverride
    Definition

    Factor overriding the factor determined by the rules associated with the code.

    ShortFactor overriding the associated rules
    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.

    Control0..1
    Typedecimal
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    66. ChargeItem.priceOverride
    Definition

    Total price of the charge overriding the list price associated with the code.

    ShortPrice overriding the associated rules
    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.

    Control0..1
    TypeMoney
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    68. ChargeItem.overrideReason
    Definition

    If 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.

    ShortReason for overriding the list price/factor
    Comments

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

    Control0..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    70. ChargeItem.enterer
    Definition

    The device, practitioner, etc. who entered the charge item.

    ShortIndividual who was entering
    Comments

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

    Control0..1
    TypeReference(Practitioner, PractitionerRole, Organization, Patient, Device, RelatedPerson)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    72. ChargeItem.enteredDate
    Definition

    Date the charge item was entered.

    ShortDate the charge item was entered
    Comments

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

    Control0..1
    TypedateTime
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    74. ChargeItem.reason
    Definition

    Describes why the event occurred in coded or textual form.

    ShortWhy was the charged service rendered?
    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.

    Control0..*
    BindingFor example codes, see ICD-10Codes
    (example to http://hl7.org/fhir/ValueSet/icd-10)

    Example binding for reason.

    TypeCodeableConcept
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    76. ChargeItem.service
    Definition

    Indicated the rendered service that caused this charge.

    ShortWhich rendered service is being charged?
    Control0..*
    TypeReference(DiagnosticReport, ImagingStudy, Immunization, MedicationAdministration, MedicationDispense, Observation, Procedure, SupplyDelivery)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    78. ChargeItem.product[x]
    Definition

    Identifies the device, food, drug or other product being charged either by type code or reference to an instance.

    ShortProduct charged
    Control0..1
    BindingFor example codes, see FHIRDeviceTypes
    (example to http://hl7.org/fhir/ValueSet/device-kind)

    Example binding for product type.

    TypeChoice of: Reference(Device, Medication, Substance), CodeableConcept
    [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    80. ChargeItem.account
    Definition

    Account into which this ChargeItems belongs.

    ShortAccount to place this charge
    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.

    Control0..*
    TypeReference(Account)
    Is Modifierfalse
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    82. ChargeItem.note
    Definition

    Comments made about the event by the performer, subject or other participants.

    ShortComments made about the ChargeItem
    Control0..*
    TypeAnnotation
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    84. ChargeItem.supportingInformation
    Definition

    Further information supporting this charge.

    ShortFurther information supporting this charge
    Control0..*
    TypeReference(Resource)
    Is Modifierfalse
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))