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: Xealth ChargeItem

Official URL: https://fhir.xealth.io/StructureDefinition/xealth-chargeitem Version: v1.46.0
Active as of 2026-07-09 Computable Name: XealthChargeItem

Defines Xealth constraints on ChargeItem for posting partner charges to a health system's billing system.

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem C 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
Constraints: chargeitem-performer-with-ehr-order-id
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... identifier SΣ 0..* Identifier The EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
... status ?!SΣ 1..1 code billable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.
Binding: Xealth ChargeItem Valid Status Value Set (required)
... code SΣ 1..1 CodeableConcept The billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... subject SΣ 1..1 Reference(Patient) The patient this charge is for. Resolved via Xealth patient context.
... occurrence[x] SΣ 1..1 Service date, with an optional end when expressed as a Period.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... performer S 0..* BackboneElement Who performed charged service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 1..1 CodeableConcept The role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
Binding: Xealth ChargeItem Performer Function Value Set (required)
.... actor S 1..1 Reference(Practitioner | PractitionerRole | Organization) The ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
... performingOrganization S 0..1 Reference(Organization) The partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
... quantity SΣ 1..1 Quantity Units serviced. Required — sent explicitly rather than defaulted.
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
... supportingInformation S 1..1 Reference(ServiceRequest) The Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.status Base required Xealth ChargeItem Valid Status Value Set 📦v1.46.0 This IG
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.performer.​function Base required Xealth ChargeItem Performer Function Value Set 📦v1.46.0 This IG
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chargeitem-performer-with-ehr-order-id error ChargeItem 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')
dom-2 error ChargeItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItem 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 error ChargeItem 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 error ChargeItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChargeItem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem C 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
Constraints: chargeitem-performer-with-ehr-order-id
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... identifier S 0..* Identifier The EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
... code S 1..1 CodeableConcept The billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... subject S 1..1 Reference(Patient) The patient this charge is for. Resolved via Xealth patient context.
... occurrence[x] S 1..1 Service date, with an optional end when expressed as a Period.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... performer S 0..* BackboneElement Who performed charged service
.... function S 1..1 CodeableConcept The role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
Binding: Xealth ChargeItem Performer Function Value Set (required)
.... actor S 1..1 Reference(Practitioner | PractitionerRole | Organization) The ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
... performingOrganization S 0..1 Reference(Organization) The partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
... quantity S 1..1 Quantity Units serviced. Required — sent explicitly rather than defaulted.
.... value S 1..1 decimal Numerical value (with implicit precision)
... supportingInformation S 1..1 Reference(ServiceRequest) The Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ChargeItem.status Base required Xealth ChargeItem Valid Status Value Set 📦v1.46.0 This IG
ChargeItem.performer.​function Base required Xealth ChargeItem Performer Function Value Set 📦v1.46.0 This IG

Constraints

Id Grade Path(s) Description Expression
chargeitem-performer-with-ehr-order-id error ChargeItem 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')
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem C 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
Constraints: chargeitem-performer-with-ehr-order-id
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier The EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
... definitionUri 0..* uri Defining information about the code of this charge item
... definitionCanonical 0..* canonical(ChargeItemDefinition) Resource defining the code of this ChargeItem
... status ?!SΣ 1..1 code billable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.
Binding: Xealth ChargeItem Valid Status Value Set (required)
... partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
... code SΣ 1..1 CodeableConcept The billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient) The patient this charge is for. Resolved via Xealth patient context.
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... occurrence[x] SΣ 1..1 Service date, with an optional end when expressed as a Period.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... performer S 0..* BackboneElement Who performed charged service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 1..1 CodeableConcept The role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
Binding: Xealth ChargeItem Performer Function Value Set (required)
.... actor S 1..1 Reference(Practitioner | PractitionerRole | Organization) The ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
... performingOrganization S 0..1 Reference(Organization) The partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
... requestingOrganization 0..1 Reference(Organization) Organization requesting the charged service
... costCenter 0..1 Reference(Organization) Organization that has ownership of the (potential, future) revenue
... quantity SΣ 1..1 Quantity Units serviced. Required — sent explicitly rather than defaulted.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit
... bodysite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... factorOverride 0..1 decimal Factor overriding the associated rules
... priceOverride 0..1 Money Price overriding the associated rules
... overrideReason 0..1 string Reason for overriding the list price/factor
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was entering
... enteredDate Σ 0..1 dateTime Date the charge item was entered
... reason 0..* CodeableConcept Why was the charged service rendered?
Binding: ICD-10Codes (example): Example binding for reason.
... service 0..* Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) Which rendered service is being charged?
... product[x] 0..1 Product charged
Binding: FHIRDeviceTypes (example): Example binding for product type.
.... productReference Reference(Device | Medication | Substance)
.... productCodeableConcept CodeableConcept
... account Σ 0..* Reference(Account) Account to place this charge
... note 0..* Annotation Comments made about the ChargeItem
... supportingInformation S 1..1 Reference(ServiceRequest) The Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ChargeItem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ChargeItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ChargeItem.status Base required Xealth ChargeItem Valid Status Value Set 📦v1.46.0 This IG
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.performer.​function Base required Xealth ChargeItem Performer Function Value Set 📦v1.46.0 This IG
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ChargeItem.bodysite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ChargeItem.reason Base example ICD-10 Codes 📍4.0.1 FHIR Std.
ChargeItem.product[x] Base example FHIR Device Types 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chargeitem-performer-with-ehr-order-id error ChargeItem 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')
dom-2 error ChargeItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItem 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 error ChargeItem 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 error ChargeItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChargeItem

Summary

Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem C 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
Constraints: chargeitem-performer-with-ehr-order-id
... meta SΣ 1..1 Meta Metadata about the resource
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... identifier SΣ 0..* Identifier The EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
... status ?!SΣ 1..1 code billable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.
Binding: Xealth ChargeItem Valid Status Value Set (required)
... code SΣ 1..1 CodeableConcept The billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
.... coding SΣ 1..* Coding Code defined by a terminology system
..... system SΣ 1..1 uri Identity of the terminology system
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
... subject SΣ 1..1 Reference(Patient) The patient this charge is for. Resolved via Xealth patient context.
... occurrence[x] SΣ 1..1 Service date, with an optional end when expressed as a Period.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... performer S 0..* BackboneElement Who performed charged service
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 1..1 CodeableConcept The role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
Binding: Xealth ChargeItem Performer Function Value Set (required)
.... actor S 1..1 Reference(Practitioner | PractitionerRole | Organization) The ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
... performingOrganization S 0..1 Reference(Organization) The partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
... quantity SΣ 1..1 Quantity Units serviced. Required — sent explicitly rather than defaulted.
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
... supportingInformation S 1..1 Reference(ServiceRequest) The Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.status Base required Xealth ChargeItem Valid Status Value Set 📦v1.46.0 This IG
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.performer.​function Base required Xealth ChargeItem Performer Function Value Set 📦v1.46.0 This IG
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chargeitem-performer-with-ehr-order-id error ChargeItem 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')
dom-2 error ChargeItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItem 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 error ChargeItem 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 error ChargeItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

Differential View

This structure is derived from ChargeItem

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem C 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
Constraints: chargeitem-performer-with-ehr-order-id
... meta S 1..1 Meta Metadata about the resource
.... profile S 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... identifier S 0..* Identifier The EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
... code S 1..1 CodeableConcept The billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
.... coding S 1..* Coding Code defined by a terminology system
..... system S 1..1 uri Identity of the terminology system
..... code S 1..1 code Symbol in syntax defined by the system
..... display S 1..1 string Representation defined by the system
... subject S 1..1 Reference(Patient) The patient this charge is for. Resolved via Xealth patient context.
... occurrence[x] S 1..1 Service date, with an optional end when expressed as a Period.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... performer S 0..* BackboneElement Who performed charged service
.... function S 1..1 CodeableConcept The role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
Binding: Xealth ChargeItem Performer Function Value Set (required)
.... actor S 1..1 Reference(Practitioner | PractitionerRole | Organization) The ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
... performingOrganization S 0..1 Reference(Organization) The partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
... quantity S 1..1 Quantity Units serviced. Required — sent explicitly rather than defaulted.
.... value S 1..1 decimal Numerical value (with implicit precision)
... supportingInformation S 1..1 Reference(ServiceRequest) The Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.

doco Documentation for this format

Terminology Bindings (Differential)

Path Status Usage ValueSet Version Source
ChargeItem.status Base required Xealth ChargeItem Valid Status Value Set 📦v1.46.0 This IG
ChargeItem.performer.​function Base required Xealth ChargeItem Performer Function Value Set 📦v1.46.0 This IG

Constraints

Id Grade Path(s) Description Expression
chargeitem-performer-with-ehr-order-id error ChargeItem 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')

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. ChargeItem C 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
Constraints: chargeitem-performer-with-ehr-order-id
... id Σ 0..1 id Logical id of this artifact
... meta SΣ 1..1 Meta Metadata about the resource
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... versionId Σ 0..1 id Version specific identifier
.... lastUpdated Σ 0..1 instant When the resource version last changed
.... source Σ 0..1 uri Identifies where the resource comes from
.... profile SΣ 1..1 canonical(StructureDefinition) Profiles this resource claims to conform to
.... security Σ 0..* Coding Security Labels applied to this resource
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
.... tag Σ 0..* Coding Tags applied to this resource
Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... language 0..1 code Language of the resource content
Binding: CommonLanguages (preferred): A human language.
Additional BindingsPurpose
AllLanguages Max Binding
... text 0..1 Narrative Text summary of the resource, for human interpretation
This profile does not constrain the narrative in regard to content, language, or traceability to data elements
... contained 0..* Resource Contained, inline Resources
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:ehrOrderId 0..1 string The EHR's identifier for the order.
URL: https://fhir.xealth.io/StructureDefinition/extension-ehr-order-id
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier SΣ 0..* Identifier The EHR's identifier for the charge, assigned by Xealth. Not usable with GET/PATCH — use ChargeItem.id (a UUID) for those.
... definitionUri 0..* uri Defining information about the code of this charge item
... definitionCanonical 0..* canonical(ChargeItemDefinition) Resource defining the code of this ChargeItem
... status ?!SΣ 1..1 code billable = charge (POST); entered-in-error = total reversal / correction (PATCH). Drives the transaction intent together with the HTTP verb.
Binding: Xealth ChargeItem Valid Status Value Set (required)
... partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
... code SΣ 1..1 CodeableConcept The billable charge code (CPT/HCPCS, or Cerner CDM_SCHED/PROCCODE).
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... coding SΣ 1..* Coding Code defined by a terminology system
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... system SΣ 1..1 uri Identity of the terminology system
..... version Σ 0..1 string Version of the system - if relevant
..... code SΣ 1..1 code Symbol in syntax defined by the system
..... display SΣ 1..1 string Representation defined by the system
..... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
.... text Σ 0..1 string Plain text representation of the concept
... subject SΣ 1..1 Reference(Patient) The patient this charge is for. Resolved via Xealth patient context.
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... occurrence[x] SΣ 1..1 Service date, with an optional end when expressed as a Period.
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
... performer S 0..* BackboneElement Who performed charged service
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... function S 1..1 CodeableConcept The role this performer played: OP (ordering provider), PRF (performer), or VRF (verifier).
Binding: Xealth ChargeItem Performer Function Value Set (required)
.... actor S 1..1 Reference(Practitioner | PractitionerRole | Organization) The ordering provider. Use actor.identifier (e.g. NPI) + actor.display when no Practitioner resource is referenced.
... performingOrganization S 0..1 Reference(Organization) The partner organization that submitted this charge. Set by Xealth; used for partner attribution and ownership.
... requestingOrganization 0..1 Reference(Organization) Organization requesting the charged service
... costCenter 0..1 Reference(Organization) Organization that has ownership of the (potential, future) revenue
... quantity SΣ 1..1 Quantity Units serviced. Required — sent explicitly rather than defaulted.
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... value SΣ 1..1 decimal Numerical value (with implicit precision)
.... comparator ?!Σ 0..1 code < | <= | >= | > - how to understand the value
Binding: QuantityComparator (required): How the Quantity should be understood and represented.
.... unit Σ 0..1 string Unit representation
.... system ΣC 0..1 uri System that defines coded unit form
.... code Σ 0..1 code Coded form of the unit
... bodysite Σ 0..* CodeableConcept Anatomical location, if relevant
Binding: SNOMEDCTBodyStructures (example): Codes describing anatomical locations. May include laterality.
... factorOverride 0..1 decimal Factor overriding the associated rules
... priceOverride 0..1 Money Price overriding the associated rules
... overrideReason 0..1 string Reason for overriding the list price/factor
... enterer Σ 0..1 Reference(Practitioner | PractitionerRole | Organization | Patient | Device | RelatedPerson) Individual who was entering
... enteredDate Σ 0..1 dateTime Date the charge item was entered
... reason 0..* CodeableConcept Why was the charged service rendered?
Binding: ICD-10Codes (example): Example binding for reason.
... service 0..* Reference(DiagnosticReport | ImagingStudy | Immunization | MedicationAdministration | MedicationDispense | Observation | Procedure | SupplyDelivery) Which rendered service is being charged?
... product[x] 0..1 Product charged
Binding: FHIRDeviceTypes (example): Example binding for product type.
.... productReference Reference(Device | Medication | Substance)
.... productCodeableConcept CodeableConcept
... account Σ 0..* Reference(Account) Account to place this charge
... note 0..* Annotation Comments made about the ChargeItem
... supportingInformation S 1..1 Reference(ServiceRequest) The Xealth order this ChargeItem is based on. Consumed server-side to resolve the order.

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
ChargeItem.meta.security Base extensible SecurityLabels 📍4.0.1 FHIR Std.
ChargeItem.meta.tag Base example Common Tags 📍4.0.1 FHIR Std.
ChargeItem.language Base preferred Common Languages 📍4.0.1 FHIR Std.
ChargeItem.status Base required Xealth ChargeItem Valid Status Value Set 📦v1.46.0 This IG
ChargeItem.code Base example ChargeItemCode 📍4.0.1 FHIR Std.
ChargeItem.performer.​function Base required Xealth ChargeItem Performer Function Value Set 📦v1.46.0 This IG
ChargeItem.quantity.​comparator Base required QuantityComparator 📍4.0.1 FHIR Std.
ChargeItem.bodysite Base example SNOMED CT Body Structures 📍4.0.1 FHIR Std.
ChargeItem.reason Base example ICD-10 Codes 📍4.0.1 FHIR Std.
ChargeItem.product[x] Base example FHIR Device Types 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
chargeitem-performer-with-ehr-order-id error ChargeItem 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')
dom-2 error ChargeItem If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error ChargeItem 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 error ChargeItem 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 error ChargeItem If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice ChargeItem A resource should have narrative for robust management text.`div`.exists()
ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
ext-1 error **ALL** extensions Must have either extensions or value[x], not both extension.exists() != value.exists()

This structure is derived from ChargeItem

Summary

Mandatory: 10 elements(1 nested mandatory element)
Must-Support: 18 elements

Extensions

This structure refers to these extensions:

 

Other representations of profile: CSV, Excel, Schematron