US Veterans Health Administration FHIR Map Set Implementation Guide
1.10.0 - 251101 United States of America flag

US Veterans Health Administration FHIR Map Set Implementation Guide - Downloaded Version 1.10.0 See the Directory of published versions

Resource Profile: Debt Portal PaymentReconciliation

Official URL: http://va.gov/fhir/StructureDefinition/DebtPortalPaymentReconciliation Version: 1.10.0
Active as of 2025-11-04 Computable Name: DebtPortalPaymentReconciliation

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

​See also the FHIR Shorthand.

Use Case Overview

Use Case: Debt Portal«FHIR Account»DebtPortalAccountsubject«FHIR Invoice»DebtPortalInvoicerecipientsubjectissueraccountlineItem[va-charges].chargeItemReferencelineItem[va-interest].chargeItemReference«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].valueReferencePatientPatientOrganizationPatientEncounterVisitEncounterPTFEncounterMedicationDispenseOriginalMedicationDispenseRefillMedicationDispensePartial

Usages:

  • CapabilityStatements using this Profile: Lung Cancer Screening
  • This Profile is not used by any profiles in this Implementation Guide

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
.. PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource
... 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:extension-PaymentReconciliation-paymentIssuer S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
..... value[x] S 1..1 Reference(Debt Portal Patient) Value of extension
.... extension:extension-PaymentReconciliation-allocation-identifier S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
..... value[x] 1..1 Identifier Value of extension
...... 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.
....... 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
Example General: 123456
.... extension:extension-PaymentReconciliation-allocation-target S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
..... value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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.
..... 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
Example General: 123456
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... created SΣ 1..1 dateTime Creation date
... disposition SC 0..1 string Disposition message
Constraints: dppr-31-1982
... paymentDate SΣ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
.... value SΣ 0..1 decimal Numerical value (with implicit precision)
.... currency SΣ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Required Pattern: USD
... paymentIdentifier S 0..1 Identifier Business identifier for the payment
... Slices for detail 0..* BackboneElement Settlement particulars
Slice: Unordered, Open by value:$this
.... detail:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
.... detail:va-principal-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Principal Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-interest-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-admin-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charge Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Collected
..... amount S 0..1 Money Amount allocated to this payable

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-principal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-interest-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-admin-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-marshal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-courtcost-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentReconciliation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentReconciliation A resource should have narrative for robust management text.`div`.exists()
dppr-31-1982 best practice PaymentReconciliation.disposition If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) true
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 PaymentReconciliation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extension-PaymentReconciliation-paymentIssuer S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
..... value[x] S 1..1 Reference(Debt Portal Patient) Value of extension
.... extension:extension-PaymentReconciliation-allocation-identifier S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
..... value[x]
...... 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
.... extension:extension-PaymentReconciliation-allocation-target S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
..... value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension
... identifier
.... 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
... status S 1..1 code active | cancelled | draft | entered-in-error
Required Pattern: active
... disposition SC 0..1 string Disposition message
Constraints: dppr-31-1982
... paymentDate S 1..1 date When payment issued
... paymentAmount
.... value S 0..1 decimal Numerical value (with implicit precision)
.... currency S 0..1 code ISO 4217 Currency Code
Required Pattern: USD
... paymentIdentifier S 0..1 Identifier Business identifier for the payment
... Slices for detail 0..* BackboneElement Settlement particulars
Slice: Unordered, Open by value:$this
.... detail:va-principal-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Principal Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-interest-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-admin-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charge Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Collected
..... amount S 0..1 Money Amount allocated to this payable

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dppr-31-1982 best practice PaymentReconciliation.disposition If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) true
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource
... 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
... 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:extension-PaymentReconciliation-paymentIssuer S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
..... value[x] S 1..1 Reference(Debt Portal Patient) Value of extension
.... extension:extension-PaymentReconciliation-allocation-identifier S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
..... value[x] 1..1 Identifier Value of extension
...... 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)
.... extension:extension-PaymentReconciliation-allocation-target S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
..... value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business Identifier for a payment reconciliation
.... 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)
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... period Σ 0..1 Period Period covered
... created SΣ 1..1 dateTime Creation date
... paymentIssuer Σ 0..1 Reference(Organization) Party generating payment
... request 0..1 Reference(Task) Reference to requesting resource
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... outcome 0..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The outcome of the processing.
... disposition SC 0..1 string Disposition message
Constraints: dppr-31-1982
... paymentDate SΣ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
.... 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Σ 0..1 decimal Numerical value (with implicit precision)
.... currency SΣ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Required Pattern: USD
... paymentIdentifier S 0..1 Identifier Business identifier for the payment
... Slices for detail 0..* BackboneElement Settlement particulars
Slice: Unordered, Open by value:$this
.... detail:All Slices Content/Rules for all slices
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount 0..1 Money Amount allocated to this payable
.... detail:va-principal-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Principal Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-interest-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Interest Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-admin-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Administrative Charge Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Marshal Fee Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Court Cost Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... processNote 0..* BackboneElement Note concerning processing
.... 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
.... type 0..1 code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 0..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-principal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-interest-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-admin-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-marshal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-courtcost-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​formCode Base example Forms 📍4.0.1 FHIR Std.
PaymentReconciliation.​processNote.type Base required NoteType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentReconciliation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentReconciliation A resource should have narrative for robust management text.`div`.exists()
dppr-31-1982 best practice PaymentReconciliation.disposition If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) true
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()

Key Elements View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource
... 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:extension-PaymentReconciliation-paymentIssuer S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
..... value[x] S 1..1 Reference(Debt Portal Patient) Value of extension
.... extension:extension-PaymentReconciliation-allocation-identifier S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
..... value[x] 1..1 Identifier Value of extension
...... 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.
....... 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
Example General: 123456
.... extension:extension-PaymentReconciliation-allocation-target S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
..... value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
.... 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.
..... 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
Example General: 123456
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... created SΣ 1..1 dateTime Creation date
... disposition SC 0..1 string Disposition message
Constraints: dppr-31-1982
... paymentDate SΣ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
.... value SΣ 0..1 decimal Numerical value (with implicit precision)
.... currency SΣ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Required Pattern: USD
... paymentIdentifier S 0..1 Identifier Business identifier for the payment
... Slices for detail 0..* BackboneElement Settlement particulars
Slice: Unordered, Open by value:$this
.... detail:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
.... detail:va-principal-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Principal Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-interest-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Interest Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-admin-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charge Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... text SΣ 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Collected
..... amount S 0..1 Money Amount allocated to this payable

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-principal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-interest-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-admin-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-marshal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-courtcost-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentReconciliation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentReconciliation A resource should have narrative for robust management text.`div`.exists()
dppr-31-1982 best practice PaymentReconciliation.disposition If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) true
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 PaymentReconciliation

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource
... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:extension-PaymentReconciliation-paymentIssuer S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
..... value[x] S 1..1 Reference(Debt Portal Patient) Value of extension
.... extension:extension-PaymentReconciliation-allocation-identifier S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
..... value[x]
...... 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
.... extension:extension-PaymentReconciliation-allocation-target S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
..... value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension
... identifier
.... 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
... status S 1..1 code active | cancelled | draft | entered-in-error
Required Pattern: active
... disposition SC 0..1 string Disposition message
Constraints: dppr-31-1982
... paymentDate S 1..1 date When payment issued
... paymentAmount
.... value S 0..1 decimal Numerical value (with implicit precision)
.... currency S 0..1 code ISO 4217 Currency Code
Required Pattern: USD
... paymentIdentifier S 0..1 Identifier Business identifier for the payment
... Slices for detail 0..* BackboneElement Settlement particulars
Slice: Unordered, Open by value:$this
.... detail:va-principal-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Principal Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-interest-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Interest Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-admin-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Administrative Charge Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Marshal Fee Collected
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars
..... type
...... text S 0..1 string Plain text representation of the concept
Required Pattern: Court Cost Collected
..... amount S 0..1 Money Amount allocated to this payable

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
dppr-31-1982 best practice PaymentReconciliation.disposition If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) true

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource
... 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
... 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:extension-PaymentReconciliation-paymentIssuer S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer"
..... value[x] S 1..1 Reference(Debt Portal Patient) Value of extension
.... extension:extension-PaymentReconciliation-allocation-identifier S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier"
..... value[x] 1..1 Identifier Value of extension
...... 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)
.... extension:extension-PaymentReconciliation-allocation-target S 0..1 (Complex) Optional Extensions Element
URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0 Extension
Slice: Unordered, Open by value:url
..... url 1..1 uri "http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target"
..... value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... identifier 0..* Identifier Business Identifier for a payment reconciliation
.... 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)
... status ?!SΣ 1..1 code active | cancelled | draft | entered-in-error
Binding: FinancialResourceStatusCodes (required): A code specifying the state of the resource instance.
Required Pattern: active
... period Σ 0..1 Period Period covered
... created SΣ 1..1 dateTime Creation date
... paymentIssuer Σ 0..1 Reference(Organization) Party generating payment
... request 0..1 Reference(Task) Reference to requesting resource
... requestor 0..1 Reference(Practitioner | PractitionerRole | Organization) Responsible practitioner
... outcome 0..1 code queued | complete | error | partial
Binding: ClaimProcessingCodes (required): The outcome of the processing.
... disposition SC 0..1 string Disposition message
Constraints: dppr-31-1982
... paymentDate SΣ 1..1 date When payment issued
... paymentAmount Σ 1..1 Money Total amount of Payment
.... 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Σ 0..1 decimal Numerical value (with implicit precision)
.... currency SΣ 0..1 code ISO 4217 Currency Code
Binding: Currencies (required): A code indicating the currency, taken from ISO 4217.
Required Pattern: USD
... paymentIdentifier S 0..1 Identifier Business identifier for the payment
... Slices for detail 0..* BackboneElement Settlement particulars
Slice: Unordered, Open by value:$this
.... detail:All Slices Content/Rules for all slices
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount 0..1 Money Amount allocated to this payable
.... detail:va-principal-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Principal Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-interest-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Interest Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-admin-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Administrative Charge Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Marshal Fee Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
.... detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars
..... 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
..... identifier 0..1 Identifier Business identifier of the payment detail
..... predecessor 0..1 Identifier Business identifier of the prior payment detail
..... type 1..1 CodeableConcept Category of payment
Binding: PaymentTypeCodes (example): The reason for the amount: payment, adjustment, advance.
...... 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: Court Cost Collected
..... request 0..1 Reference(Resource) Request giving rise to the payment
..... submitter 0..1 Reference(Practitioner | PractitionerRole | Organization) Submitter of the request
..... response 0..1 Reference(Resource) Response committing to a payment
..... date 0..1 date Date of commitment to pay
..... responsible 0..1 Reference(PractitionerRole) Contact for the response
..... payee 0..1 Reference(Practitioner | PractitionerRole | Organization) Recipient of the payment
..... amount S 0..1 Money Amount allocated to this payable
... formCode 0..1 CodeableConcept Printed form identifier
Binding: Form Codes (example): The forms codes.
... processNote 0..* BackboneElement Note concerning processing
.... 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
.... type 0..1 code display | print | printoper
Binding: NoteType (required): The presentation types of notes.
.... text 0..1 string Note explanatory text

doco Documentation for this format

Terminology Bindings

Path Status Usage ValueSet Version Source
PaymentReconciliation.​language Base preferred Common Languages 📍4.0.1 FHIR Std.
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​extension:extension-PaymentReconciliation-allocation-identifier.​value[x].type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.use Base required IdentifierUse 📍4.0.1 FHIR Std.
PaymentReconciliation.​identifier.type Base extensible IdentifierType 📍4.0.1 FHIR Std.
PaymentReconciliation.​status Base required Financial Resource Status Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​outcome Base required Claim Processing Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​paymentAmount.currency Base required CurrencyCode 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail.type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-principal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-interest-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-admin-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-marshal-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​detail:va-courtcost-collected.​type Base example Payment Type Codes 📍4.0.1 FHIR Std.
PaymentReconciliation.​formCode Base example Forms 📍4.0.1 FHIR Std.
PaymentReconciliation.​processNote.type Base required NoteType 📍4.0.1 FHIR Std.

Constraints

Id Grade Path(s) Description Expression
dom-2 error PaymentReconciliation If the resource is contained in another resource, it SHALL NOT contain nested Resources contained.contained.empty()
dom-3 error PaymentReconciliation 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 PaymentReconciliation 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 PaymentReconciliation If a resource is contained in another resource, it SHALL NOT have a security label contained.meta.security.empty()
dom-6 best practice PaymentReconciliation A resource should have narrative for robust management text.`div`.exists()
dppr-31-1982 best practice PaymentReconciliation.disposition If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01) true
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()

 

Other representations of profile: CSV, Excel, Schematron