XealthIG
v1.46.0 - release

XealthIG - Local Development build (vv1.46.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: XealthChargeItem - Detailed Descriptions

Active as of 2026-07-09

Definitions for the xealth-chargeitem resource profile.

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

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())
chargeitem-performer-with-ehr-order-id: If an ordering provider (performer.function = OP) is present, then the ehr-order-id extension must be present. (performer.function.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0912' and code = 'OP').exists() implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id'))
2. 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
Control10..1
TypeMeta
Is Modifierfalse
Must Supporttrue
Summarytrue
Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
4. ChargeItem.meta.profile
Definition

A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.


A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

ShortProfiles this resource claims to conform to
Comments

It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

Control10..1*
Typecanonical(StructureDefinition)
Is Modifierfalse
Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
Must Supporttrue
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.extension
Definition

An Extension


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

ShortExtensionAdditional 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())
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
  • 10. ChargeItem.extension:ehrOrderId
    Slice NameehrOrderId
    Definition

    The EHR's identifier for the order.

    ShortThe EHR's identifier for the order.
    Control0..1
    This element is affected by the following invariants: ele-1
    TypeExtension(Ehr Order Id) (Extension Type: string)
    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())
    ext-1: Must have either extensions or value[x], not both (extension.exists() != value.exists())
    12. 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())
    14. ChargeItem.identifier
    Definition

    Identifiers assigned to this event performer or other systems.

    ShortThe EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.Business Identifier for item
    NoteThis is a business identifier, not a resource identifier (see discussion)
    Control0..*
    TypeIdentifier
    Is Modifierfalse
    Must Supporttrue
    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()))
    16. ChargeItem.status
    Definition

    The current state of the ChargeItem.

    Shortbillable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.planned | 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 Xealth ChargeItem Valid Status Value Sethttp://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1
    (required to https://fhir.xealth.io/ValueSet/xealth-chargeitem-valid-status-vs)
    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
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    18. ChargeItem.code
    Definition

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

    ShortThe billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).A code that identifies the charge, like a billing code
    Comments

    Recognized by Xealth and mapped to the health system's standard code systems by default: CPT (system http://www.ama-assn.org/go/cpt), HCPCS (system http://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets), Cerner CDM_SCHED (system https://fhir.xealth.io/CodeSystem/cerner-cdm-sched), and Cerner PROCCODE (system https://fhir.xealth.io/CodeSystem/cerner-proccode). Any other code system requires Xealth mapping configuration before it can be recognized and mapped.

    Control1..1
    BindingFor example codes, see ChargeItemCodehttp://hl7.org/fhir/ValueSet/chargeitem-billingcodes|4.0.1
    (example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes|4.0.1)

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

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

    A reference to a code defined by a terminology system.

    ShortCode defined by a terminology system
    Comments

    Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

    Control10..*
    TypeCoding
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Requirements

    Allows for alternative encodings within a code system, and translations to other code systems.

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

    The identification of the code system that defines the meaning of the symbol in the code.

    ShortIdentity of the terminology system
    Comments

    The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

    Control10..1
    Typeuri
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be unambiguous about the source of the definition of the symbol.

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

    A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

    ShortSymbol in syntax defined by the system
    Control10..1
    Typecode
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to refer to a particular code in the system.

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

    A representation of the meaning of the code in the system, following the rules of the system.

    ShortRepresentation defined by the system
    Control10..1
    Typestring
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

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

    ShortThe patient this charge is for. Resolved via Xealth patient context.Individual service was done for/to
    Control1..1
    TypeReference(Patient, Patient, Group)
    Is Modifierfalse
    Must Supporttrue
    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()))
    30. ChargeItem.occurrence[x]
    Definition

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

    ShortService date, with an optional end when expressed as a Period.When the charged service was applied
    Comments

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

    Control10..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
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summarytrue
    Alternate Namestiming
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    32. ChargeItem.performer
    Definition

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

    ShortWho performed charged service
    Control0..*
    TypeBackboneElement
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    34. 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())
    36. ChargeItem.performer.function
    Definition

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

    ShortThe role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).What type of performance was done
    Control10..1
    BindingThe codes SHALL be taken from For example codes, see Xealth ChargeItem Performer Function Value Sethttp://hl7.org/fhir/ValueSet/performer-role|4.0.1
    (required to https://fhir.xealth.io/ValueSet/xealth-chargeitem-performer-function-vs)
    TypeCodeableConcept
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    38. ChargeItem.performer.actor
    Definition

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

    ShortThe ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.Individual who was performing
    Control1..1
    TypeReference(Practitioner, PractitionerRole, Organization, Practitioner, PractitionerRole, Organization, CareTeam, Patient, Device, RelatedPerson)
    Is Modifierfalse
    Must Supporttrue
    Must Support TypesNo must-support rules about the choice of types/profiles
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    40. ChargeItem.performingOrganization
    Definition

    The organization requesting the service.

    ShortThe partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.Organization 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
    Must Supporttrue
    Summaryfalse
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    42. ChargeItem.quantity
    Definition

    Quantity of which the charge item has been serviced.

    ShortUnits serviced. Required — sent explicitly rather than defaulted.Quantity 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.

    Control10..1
    TypeQuantity
    Is Modifierfalse
    Must Supporttrue
    Summarytrue
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    44. ChargeItem.quantity.value
    Definition

    The value of the measured amount. The value includes an implicit precision in the presentation of the value.

    ShortNumerical value (with implicit precision)
    Comments

    The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

    Control10..1
    Typedecimal
    Is Modifierfalse
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Must Supporttrue
    Summarytrue
    Requirements

    Precision is handled implicitly in almost all cases of measurement.

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

    How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

    Short< | <= | >= | > - how to understand the value
    Control0..1
    BindingThe codes SHALL be taken from QuantityComparatorhttp://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1
    (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

    How the Quantity should be understood and represented.

    Typecode
    Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
    Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
    Summarytrue
    Requirements

    Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

    Meaning if MissingIf there is no comparator, then there is no modification of the value
    Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
    48. ChargeItem.supportingInformation
    Definition

    Further information supporting this charge.

    ShortThe Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.Further information supporting this charge
    Control10..1*
    TypeReference(ServiceRequest, Resource)
    Is Modifierfalse
    Must Supporttrue
    Summaryfalse
    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 foundhere

    0. ChargeItem
    Invariantschargeitem-performer-with-ehr-order-id: If an ordering provider (performer.function = OP) is present, then the ehr-order-id extension must be present. (performer.function.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0912' and code = 'OP').exists() implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id'))
    2. ChargeItem.meta
    Control1..?
    Must Supporttrue
    4. ChargeItem.meta.profile
    Control1..1
    Must Supporttrue
    6. ChargeItem.extension
    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
    • 8. ChargeItem.extension:ehrOrderId
      Slice NameehrOrderId
      ShortThe EHR's identifier for the order.
      Control0..1
      TypeExtension(Ehr Order Id) (Extension Type: string)
      10. ChargeItem.identifier
      ShortThe EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
      NoteThis is a business identifier, not a resource identifier (see discussion)
      Must Supporttrue
      12. ChargeItem.status
      Shortbillable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.
      BindingThe codes SHALL be taken from Xealth ChargeItem Valid Status Value Set
      (required to https://fhir.xealth.io/ValueSet/xealth-chargeitem-valid-status-vs)
      Must Supporttrue
      14. ChargeItem.code
      ShortThe billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
      Comments

      Recognized by Xealth and mapped to the health system's standard code systems by default: CPT (system http://www.ama-assn.org/go/cpt), HCPCS (system http://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets), Cerner CDM_SCHED (system https://fhir.xealth.io/CodeSystem/cerner-cdm-sched), and Cerner PROCCODE (system https://fhir.xealth.io/CodeSystem/cerner-proccode). Any other code system requires Xealth mapping configuration before it can be recognized and mapped.

      Must Supporttrue
      16. ChargeItem.code.coding
      Control1..?
      Must Supporttrue
      18. ChargeItem.code.coding.system
      Control1..?
      Must Supporttrue
      20. ChargeItem.code.coding.code
      Control1..?
      Must Supporttrue
      22. ChargeItem.code.coding.display
      Control1..?
      Must Supporttrue
      24. ChargeItem.subject
      ShortThe patient this charge is for. Resolved via Xealth patient context.
      TypeReference(Patient)
      Must Supporttrue
      26. ChargeItem.occurrence[x]
      ShortService date, with an optional end when expressed as a Period.
      Control1..?
      TypeChoice of: dateTime, Period, Timing
      [x] NoteSeeChoice of Data Typesfor further information about how to use [x]
      Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      28. ChargeItem.performer
      Must Supporttrue
      30. ChargeItem.performer.function
      ShortThe role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
      Control1..?
      BindingThe codes SHALL be taken from Xealth ChargeItem Performer Function Value Set
      (required to https://fhir.xealth.io/ValueSet/xealth-chargeitem-performer-function-vs)
      Must Supporttrue
      32. ChargeItem.performer.actor
      ShortThe ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
      TypeReference(Practitioner, PractitionerRole, Organization)
      Must Supporttrue
      Must Support TypesNo must-support rules about the choice of types/profiles
      34. ChargeItem.performingOrganization
      ShortThe partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
      Must Supporttrue
      36. ChargeItem.quantity
      ShortUnits serviced. Required — sent explicitly rather than defaulted.
      Control1..?
      Must Supporttrue
      38. ChargeItem.quantity.value
      Control1..?
      Must Supporttrue
      40. ChargeItem.supportingInformation
      ShortThe Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.
      Control1..1
      TypeReference(ServiceRequest)
      Must Supporttrue

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

      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())
      chargeitem-performer-with-ehr-order-id: If an ordering provider (performer.function = OP) is present, then the ehr-order-id extension must be present. (performer.function.coding.where(system = 'http://terminology.hl7.org/CodeSystem/v2-0912' and code = 'OP').exists() implies extension.exists(url = 'https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id'))
      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
      Control1..1
      TypeMeta
      Is Modifierfalse
      Must Supporttrue
      Summarytrue
      Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
      6. ChargeItem.meta.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
      8. ChargeItem.meta.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())
      SlicingThis element introduces a set of slices on ChargeItem.meta.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
      • value @ url
      • 10. ChargeItem.meta.versionId
        Definition

        The version specific identifier, as it appears in the version portion of the URL. This value changes when the resource is created, updated, or deleted.

        ShortVersion specific identifier
        Comments

        The server assigns this value, and ignores what the client specifies, except in the case that the server is imposing version integrity on updates/deletes.

        Control0..1
        Typeid
        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()))
        12. ChargeItem.meta.lastUpdated
        Definition

        When the resource last changed - e.g. when the version changed.

        ShortWhen the resource version last changed
        Comments

        This value is always populated except when the resource is first being created. The server / resource manager sets this value; what a client provides is irrelevant. This is equivalent to the HTTP Last-Modified and SHOULD have the same value on a read interaction.

        Control0..1
        Typeinstant
        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()))
        14. ChargeItem.meta.source
        Definition

        A uri that identifies the source system of the resource. This provides a minimal amount of Provenance information that can be used to track or differentiate the source of information in the resource. The source may identify another FHIR server, document, message, database, etc.

        ShortIdentifies where the resource comes from
        Comments

        In the provenance resource, this corresponds to Provenance.entity.what[x]. The exact use of the source (and the implied Provenance.entity.role) is left to implementer discretion. Only one nominated source is allowed; for additional provenance details, a full Provenance resource should be used.

        This element can be used to indicate where the current master source of a resource that has a canonical URL if the resource is no longer hosted at the canonical URL.

        Control0..1
        Typeuri
        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()))
        16. ChargeItem.meta.profile
        Definition

        A list of profiles (references to StructureDefinition resources) that this resource claims to conform to. The URL is a reference to StructureDefinition.url.

        ShortProfiles this resource claims to conform to
        Comments

        It is up to the server and/or other infrastructure of policy to determine whether/how these claims are verified and/or updated over time. The list of profile URLs is a set.

        Control1..1
        Typecanonical(StructureDefinition)
        Is Modifierfalse
        Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
        Must Supporttrue
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        18. ChargeItem.meta.security
        Definition

        Security labels applied to this resource. These tags connect specific resources to the overall security policy and infrastructure.

        ShortSecurity Labels applied to this resource
        Comments

        The security labels can be updated without changing the stated version of the resource. The list of security labels is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingUnless not suitable, these codes SHALL be taken from All Security Labels
        (extensible to http://hl7.org/fhir/ValueSet/security-labels|4.0.1)

        Security Labels from the Healthcare Privacy and Security Classification System.

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        20. ChargeItem.meta.tag
        Definition

        Tags applied to this resource. Tags are intended to be used to identify and relate resources to process and workflow, and applications are not required to consider the tags when interpreting the meaning of a resource.

        ShortTags applied to this resource
        Comments

        The tags can be updated without changing the stated version of the resource. The list of tags is a set. Uniqueness is based the system/code, and version and display are ignored.

        Control0..*
        BindingFor example codes, see CommonTags
        (example to http://hl7.org/fhir/ValueSet/common-tags|4.0.1)

        Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".

        TypeCoding
        Is Modifierfalse
        Summarytrue
        Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
        22. 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()))
        24. 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|4.0.1)

        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()))
        26. 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()))
        28. 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
        30. 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
        • 32. ChargeItem.extension:ehrOrderId
          Slice NameehrOrderId
          Definition

          The EHR's identifier for the order.

          ShortThe EHR's identifier for the order.
          Control0..1
          This element is affected by the following invariants: ele-1
          TypeExtension(Ehr Order Id) (Extension Type: string)
          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())
          34. 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())
          36. ChargeItem.identifier
          Definition

          Identifiers assigned to this event performer or other systems.

          ShortThe EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
          NoteThis is a business identifier, not a resource identifier (see discussion)
          Control0..*
          TypeIdentifier
          Is Modifierfalse
          Must Supporttrue
          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()))
          38. 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()))
          40. 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()))
          42. ChargeItem.status
          Definition

          The current state of the ChargeItem.

          Shortbillable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.
          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 Xealth ChargeItem Valid Status Value Set
          (required to https://fhir.xealth.io/ValueSet/xealth-chargeitem-valid-status-vs)
          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
          Must Supporttrue
          Summarytrue
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          44. 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()))
          46. ChargeItem.code
          Definition

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

          ShortThe billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
          Comments

          Recognized by Xealth and mapped to the health system's standard code systems by default: CPT (system http://www.ama-assn.org/go/cpt), HCPCS (system http://www.cms.gov/Medicare/Coding/HCPCSReleaseCodeSets), Cerner CDM_SCHED (system https://fhir.xealth.io/CodeSystem/cerner-cdm-sched), and Cerner PROCCODE (system https://fhir.xealth.io/CodeSystem/cerner-proccode). Any other code system requires Xealth mapping configuration before it can be recognized and mapped.

          Control1..1
          BindingFor example codes, see ChargeItemCode
          (example to http://hl7.org/fhir/ValueSet/chargeitem-billingcodes|4.0.1)

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

          TypeCodeableConcept
          Is Modifierfalse
          Must Supporttrue
          Summarytrue
          Alternate Namestype
          Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
          48. ChargeItem.code.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
          50. ChargeItem.code.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())
          SlicingThis element introduces a set of slices on ChargeItem.code.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
          • value @ url
          • 52. ChargeItem.code.coding
            Definition

            A reference to a code defined by a terminology system.

            ShortCode defined by a terminology system
            Comments

            Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.

            Control1..*
            TypeCoding
            Is Modifierfalse
            Must Supporttrue
            Summarytrue
            Requirements

            Allows for alternative encodings within a code system, and translations to other code systems.

            Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
            54. ChargeItem.code.coding.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
            56. ChargeItem.code.coding.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())
            SlicingThis element introduces a set of slices on ChargeItem.code.coding.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
            • value @ url
            • 58. ChargeItem.code.coding.system
              Definition

              The identification of the code system that defines the meaning of the symbol in the code.

              ShortIdentity of the terminology system
              Comments

              The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should reference to some definition that establishes the system clearly and unambiguously.

              Control1..1
              Typeuri
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              Need to be unambiguous about the source of the definition of the symbol.

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

              The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured, and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

              ShortVersion of the system - if relevant
              Comments

              Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

              NoteThis is a business version Id, not a resource version Id (see discussion)
              Control0..1
              Typestring
              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()))
              62. ChargeItem.code.coding.code
              Definition

              A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

              ShortSymbol in syntax defined by the system
              Control1..1
              Typecode
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              Need to refer to a particular code in the system.

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

              A representation of the meaning of the code in the system, following the rules of the system.

              ShortRepresentation defined by the system
              Control1..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Must Supporttrue
              Summarytrue
              Requirements

              Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

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

              Indicates that this coding was chosen by a user directly - e.g. off a pick list of available items (codes or displays).

              ShortIf this coding was chosen directly by the user
              Comments

              Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

              Control0..1
              Typeboolean
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

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

              A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.

              ShortPlain text representation of the concept
              Comments

              Very often the text is the same as a displayName of one of the codings.

              Control0..1
              Typestring
              Is Modifierfalse
              Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
              Summarytrue
              Requirements

              The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.

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

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

              ShortThe patient this charge is for. Resolved via Xealth patient context.
              Control1..1
              TypeReference(Patient)
              Is Modifierfalse
              Must Supporttrue
              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()))
              72. 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()))
              74. ChargeItem.occurrence[x]
              Definition

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

              ShortService date, with an optional end when expressed as a Period.
              Comments

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

              Control1..1
              TypeChoice of: dateTime, Period
              [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
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              Summarytrue
              Alternate Namestiming
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              76. ChargeItem.performer
              Definition

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

              ShortWho performed charged service
              Control0..*
              TypeBackboneElement
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              78. 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
              80. 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())
              82. 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())
              84. ChargeItem.performer.function
              Definition

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

              ShortThe role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
              Control1..1
              BindingThe codes SHALL be taken from Xealth ChargeItem Performer Function Value Set
              (required to https://fhir.xealth.io/ValueSet/xealth-chargeitem-performer-function-vs)
              TypeCodeableConcept
              Is Modifierfalse
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              86. ChargeItem.performer.actor
              Definition

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

              ShortThe ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
              Control1..1
              TypeReference(Practitioner, PractitionerRole, Organization)
              Is Modifierfalse
              Must Supporttrue
              Must Support TypesNo must-support rules about the choice of types/profiles
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              88. ChargeItem.performingOrganization
              Definition

              The organization requesting the service.

              ShortThe partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
              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
              Must Supporttrue
              Summaryfalse
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              90. 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()))
              92. 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()))
              94. ChargeItem.quantity
              Definition

              Quantity of which the charge item has been serviced.

              ShortUnits serviced. Required — sent explicitly rather than defaulted.
              Comments

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

              Control1..1
              TypeQuantity
              Is Modifierfalse
              Must Supporttrue
              Summarytrue
              Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
              96. ChargeItem.quantity.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
              98. ChargeItem.quantity.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())
              SlicingThis element introduces a set of slices on ChargeItem.quantity.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators:
              • value @ url
              • 100. ChargeItem.quantity.value
                Definition

                The value of the measured amount. The value includes an implicit precision in the presentation of the value.

                ShortNumerical value (with implicit precision)
                Comments

                The implicit precision in the value should always be honored. Monetary values have their own rules for handling precision (refer to standard accounting text books).

                Control1..1
                Typedecimal
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Must Supporttrue
                Summarytrue
                Requirements

                Precision is handled implicitly in almost all cases of measurement.

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

                How the value should be understood and represented - whether the actual value is greater or less than the stated value due to measurement issues; e.g. if the comparator is "<" , then the real value is < stated value.

                Short< | <= | >= | > - how to understand the value
                Control0..1
                BindingThe codes SHALL be taken from QuantityComparator
                (required to http://hl7.org/fhir/ValueSet/quantity-comparator|4.0.1)

                How the Quantity should be understood and represented.

                Typecode
                Is Modifiertrue because This is labeled as "Is Modifier" because the comparator modifies the interpretation of the value significantly. If there is no comparator, then there is no modification of the value
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need a framework for handling measures where the value is <5ug/L or >400mg/L due to the limitations of measuring methodology.

                Meaning if MissingIf there is no comparator, then there is no modification of the value
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                104. ChargeItem.quantity.unit
                Definition

                A human-readable form of the unit.

                ShortUnit representation
                Control0..1
                Typestring
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                There are many representations for units of measure and in many contexts, particular representations are fixed and required. I.e. mcg for micrograms.

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

                The identification of the system that provides the coded form of the unit.

                ShortSystem that defines coded unit form
                Control0..1
                This element is affected by the following invariants: qty-3
                Typeuri
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need to know the system that defines the coded form of the unit.

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

                A computer processable form of the unit in some unit representation system.

                ShortCoded form of the unit
                Comments

                The preferred system is UCUM, but SNOMED CT can also be used (for customary units) or ISO 4217 for currency. The context of use may additionally require a code from a particular system.

                Control0..1
                Typecode
                Is Modifierfalse
                Primitive ValueThis primitive element may be present, or absent, or replaced by an extension
                Summarytrue
                Requirements

                Need a computable form of the unit that is fixed across all forms. UCUM provides this for quantities, but SNOMED CT provides many units of interest.

                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))
                110. 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|4.0.1)

                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()))
                112. 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()))
                114. 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()))
                116. 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()))
                118. 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()))
                120. 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()))
                122. 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|4.0.1)

                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()))
                124. 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()))
                126. 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|4.0.1)

                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()))
                128. 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()))
                130. 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()))
                132. ChargeItem.supportingInformation
                Definition

                Further information supporting this charge.

                ShortThe Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.
                Control1..1
                TypeReference(ServiceRequest)
                Is Modifierfalse
                Must Supporttrue
                Summaryfalse
                Invariantsele-1: All FHIR elements must have a @value or children (hasValue() or (children().count() > id.count()))