US Veterans Health Administration FHIR Map Set Implementation Guide
1.3.1 - 250401 United States of America flag

Publication Build: This will be filled in by the publication tooling

Resource Profile: Debt Portal ChargeItem[interest]

Official URL: http://va.gov/fhir/StructureDefinition/DebtPortalChargeIteminterest Version: 1.3.1
Active as of 2025-03-31 Computable Name: DebtPortalChargeIteminterest

This StructureDefinition contains the maps for VistA file AR TRANSACTION (433) to ChargeItem.

See also the FHIR Shorthand.

Use Case Overview

Use Case: Debt Portal«FHIR Account»DebtPortalAccountsubject«FHIR Invoice»DebtPortalInvoicerecipientsubjectissueraccountlineItem[va-charges].chargeItemReferencelineItem[va-interest].chargeItemReference«FHIR Patient»DebtPortalPatient«FHIR ChargeItem»DebtPortalChargeItemchargessubjectcontextservice[va-rxorig]service[va-rxrefill]service[va-rxpartial]«FHIR ChargeItem»DebtPortalChargeItemremovedpartOf«FHIR ChargeItem»DebtPortalChargeIteminterest«FHIR PaymentReconciliation»DebtPortalPaymentReconciliationextension[PaymentReconciliation.paymentIssuer].valueReferenceextension[PaymentReconciliation.allocation.target].valueReferencePatientPatientOrganizationPatientEncounterOutpatientEncounterInpatientEncounterMedicationDispenseOriginalMedicationDispenseRefillMedicationDispensePartial

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 0..* Identifier Business Identifier for item
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:va-tn Σ 0..1 Identifier Business Identifier for item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Transaction Number
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:va-bn Σ 0..1 Identifier Business Identifier for item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Bill Number
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... code Σ 1..1 CodeableConcept A code that identifies the charge, like a billing code
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.


ele-1: All FHIR elements must have a @value or children
.... text SΣC 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
dpci-28-1993: If IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
... subject Σ 1..1 Reference(Patient | Group) Individual service was done for/to
ele-1: All FHIR elements must have a @value or children
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was applied
ele-1: All FHIR elements must have a @value or children
... enteredDate SΣ 0..1 dateTime Date the charge item was entered
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ChargeItem.identifier:va-tn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-tn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.identifier:va-bn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-bn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.statusrequiredPattern: billed
http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1
from the FHIR Standard
ChargeItem.codeexampleChargeItemCode
http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorChargeItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemIf 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-4errorChargeItemIf 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-5errorChargeItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemA resource should have narrative for robust management
: text.`div`.exists()
dpci-28-1993warningChargeItem.code.textIf IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItem

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... Slices for identifier 0..* Identifier Business Identifier for item
Slice: Unordered, Open by value:$this
.... identifier:va-tn 0..1 Identifier Business Identifier for item
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Transaction Number
..... value S 0..1 string The value that is unique
.... identifier:va-bn 0..1 Identifier Business Identifier for item
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Bill Number
..... value S 0..1 string The value that is unique
... status S 1..1 code planned | billable | not-billable | aborted | billed | entered-in-error | unknown
Required Pattern: billed
... code
.... text SC 0..1 string Plain text representation of the concept
dpci-28-1993: If IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime When the charged service was applied
... enteredDate S 0..1 dateTime Date the charge item was entered

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dpci-28-1993warningChargeItem.code.textIf IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
: true
NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Business Identifier for item
Slice: Unordered, Open by value:$this
.... identifier:va-tn Σ 0..1 Identifier Business Identifier for item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... 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 Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Transaction Number
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-bn Σ 0..1 Identifier Business Identifier for item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... 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 Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Bill Number
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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 planned | billable | not-billable | aborted | billed | entered-in-error | unknown
Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.


Required Pattern: billed
... partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
... code Σ 1..1 CodeableConcept A code that identifies the charge, like a billing code
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 Σ 0..* Coding Code defined by a terminology system
.... text SΣC 0..1 string Plain text representation of the concept
dpci-28-1993: If IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
... subject Σ 1..1 Reference(Patient | Group) Individual service was done for/to
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was applied
... performer 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 0..1 CodeableConcept What type of performance was done
Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events.

.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Individual who was performing
... performingOrganization 0..1 Reference(Organization) Organization providing the charged service
... 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 Σ 0..1 Quantity Quantity of which the charge item has been serviced
... 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 SΣ 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 0..* Reference(Resource) Further information supporting this charge

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ChargeItem.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItem.identifier:va-tn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-tn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.identifier:va-bn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-bn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.statusrequiredPattern: billed
http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1
from the FHIR Standard
ChargeItem.codeexampleChargeItemCode
http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
from the FHIR Standard
ChargeItem.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
ChargeItem.bodysiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
ChargeItem.reasonexampleICD-10Codes
http://hl7.org/fhir/ValueSet/icd-10
from the FHIR Standard
ChargeItem.product[x]exampleFHIRDeviceTypes
http://hl7.org/fhir/ValueSet/device-kind
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorChargeItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemIf 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-4errorChargeItemIf 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-5errorChargeItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemA resource should have narrative for robust management
: text.`div`.exists()
dpci-28-1993warningChargeItem.code.textIf IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItem

Summary

Must-Support: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ChargeItem.identifier
  • The element 1 is sliced based on the value of ChargeItem.occurrence[x]

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... Slices for identifier Σ 0..* Identifier Business Identifier for item
Slice: Unordered, Open by value:$this
ele-1: All FHIR elements must have a @value or children
.... identifier:va-tn Σ 0..1 Identifier Business Identifier for item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Transaction Number
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
.... identifier:va-bn Σ 0..1 Identifier Business Identifier for item
ele-1: All FHIR elements must have a @value or children
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .


ele-1: All FHIR elements must have a @value or children
..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.


ele-1: All FHIR elements must have a @value or children
...... text SΣ 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
Required Pattern: Bill Number
..... value SΣ 0..1 string The value that is unique
ele-1: All FHIR elements must have a @value or children
Example General: 123456
... code Σ 1..1 CodeableConcept A code that identifies the charge, like a billing code
Binding: ChargeItemCode (example): Example set of codes that can be used for billing purposes.


ele-1: All FHIR elements must have a @value or children
.... text SΣC 0..1 string Plain text representation of the concept
ele-1: All FHIR elements must have a @value or children
dpci-28-1993: If IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
... subject Σ 1..1 Reference(Patient | Group) Individual service was done for/to
ele-1: All FHIR elements must have a @value or children
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
ele-1: All FHIR elements must have a @value or children
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was applied
ele-1: All FHIR elements must have a @value or children
... enteredDate SΣ 0..1 dateTime Date the charge item was entered
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ChargeItem.identifier:va-tn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-tn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.identifier:va-bn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-bn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.statusrequiredPattern: billed
http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1
from the FHIR Standard
ChargeItem.codeexampleChargeItemCode
http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorChargeItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemIf 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-4errorChargeItemIf 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-5errorChargeItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemA resource should have narrative for robust management
: text.`div`.exists()
dpci-28-1993warningChargeItem.code.textIf IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from ChargeItem

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... Slices for identifier 0..* Identifier Business Identifier for item
Slice: Unordered, Open by value:$this
.... identifier:va-tn 0..1 Identifier Business Identifier for item
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Transaction Number
..... value S 0..1 string The value that is unique
.... identifier:va-bn 0..1 Identifier Business Identifier for item
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Bill Number
..... value S 0..1 string The value that is unique
... status S 1..1 code planned | billable | not-billable | aborted | billed | entered-in-error | unknown
Required Pattern: billed
... code
.... text SC 0..1 string Plain text representation of the concept
dpci-28-1993: If IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
.... occurrence[x]:occurrenceDateTime S 0..1 dateTime When the charged service was applied
... enteredDate S 0..1 dateTime Date the charge item was entered

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
dpci-28-1993warningChargeItem.code.textIf IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
: true

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. ChargeItem 0..* ChargeItem Item containing charge code(s) associated with the provision of healthcare provider products
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... 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
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... Slices for identifier Σ 0..* Identifier Business Identifier for item
Slice: Unordered, Open by value:$this
.... identifier:va-tn Σ 0..1 Identifier Business Identifier for item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... 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 Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Transaction Number
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
.... identifier:va-bn Σ 0..1 Identifier Business Identifier for item
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
..... use ?!Σ 0..1 code usual | official | temp | secondary | old (If known)
Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .

..... type Σ 0..1 CodeableConcept Description of identifier
Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.

...... 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 Σ 0..* Coding Code defined by a terminology system
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Bill Number
..... system Σ 0..1 uri The namespace for the identifier value
Example General: http://www.acme.com/identifiers/patient
..... value SΣ 0..1 string The value that is unique
Example General: 123456
..... period Σ 0..1 Period Time period when id is/was valid for use
..... assigner Σ 0..1 Reference(Organization) Organization that issued id (may be just text)
... 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 planned | billable | not-billable | aborted | billed | entered-in-error | unknown
Binding: ChargeItemStatus (required): Codes identifying the lifecycle stage of a ChargeItem.


Required Pattern: billed
... partOf 0..* Reference(ChargeItem) Part of referenced ChargeItem
... code Σ 1..1 CodeableConcept A code that identifies the charge, like a billing code
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 Σ 0..* Coding Code defined by a terminology system
.... text SΣC 0..1 string Plain text representation of the concept
dpci-28-1993: If IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
... subject Σ 1..1 Reference(Patient | Group) Individual service was done for/to
... context Σ 0..1 Reference(Encounter | EpisodeOfCare) Encounter / Episode associated with event
... Slices for occurrence[x] Σ 0..1 When the charged service was applied
Slice: Unordered, Open by type:$this
.... occurrenceDateTime dateTime
.... occurrencePeriod Period
.... occurrenceTiming Timing
.... occurrence[x]:occurrenceDateTime SΣ 0..1 dateTime When the charged service was applied
... performer 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 0..1 CodeableConcept What type of performance was done
Binding: ProcedurePerformerRoleCodes (example): Codes describing the types of functional roles performers can take on when performing events.

.... actor 1..1 Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson) Individual who was performing
... performingOrganization 0..1 Reference(Organization) Organization providing the charged service
... 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 Σ 0..1 Quantity Quantity of which the charge item has been serviced
... 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 SΣ 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 0..* Reference(Resource) Further information supporting this charge

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
ChargeItem.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
ChargeItem.identifier:va-tn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-tn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.identifier:va-bn.userequiredIdentifierUse
http://hl7.org/fhir/ValueSet/identifier-use|4.0.1
from the FHIR Standard
ChargeItem.identifier:va-bn.typeextensibleIdentifier Type Codes
http://hl7.org/fhir/ValueSet/identifier-type
from the FHIR Standard
ChargeItem.statusrequiredPattern: billed
http://hl7.org/fhir/ValueSet/chargeitem-status|4.0.1
from the FHIR Standard
ChargeItem.codeexampleChargeItemCode
http://hl7.org/fhir/ValueSet/chargeitem-billingcodes
from the FHIR Standard
ChargeItem.performer.functionexampleProcedurePerformerRoleCodes
http://hl7.org/fhir/ValueSet/performer-role
from the FHIR Standard
ChargeItem.bodysiteexampleSNOMEDCTBodyStructures
http://hl7.org/fhir/ValueSet/body-site
from the FHIR Standard
ChargeItem.reasonexampleICD-10Codes
http://hl7.org/fhir/ValueSet/icd-10
from the FHIR Standard
ChargeItem.product[x]exampleFHIRDeviceTypes
http://hl7.org/fhir/ValueSet/device-kind
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorChargeItemIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorChargeItemIf 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-4errorChargeItemIf 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-5errorChargeItemIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceChargeItemA resource should have narrative for robust management
: text.`div`.exists()
dpci-28-1993warningChargeItem.code.textIf IEN = 12 OR 13 then source value from (433-12 > 430.3-.01)
: true
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

This structure is derived from ChargeItem

Summary

Must-Support: 8 elements

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of ChargeItem.identifier
  • The element 1 is sliced based on the value of ChargeItem.occurrence[x]

 

Other representations of profile: CSV, Excel, Schematron