Generated Narrative: StructureDefinition DebtPortalPaymentReconciliation Name Flags Card. Type Description & Constraints PaymentReconciliation 0..* PaymentReconciliation(4.0.1) PaymentReconciliation resource #xD; Slices for extension 0..* Extension Extension Slice: Unordered, Open by value:url #xD; extension:extension-PaymentReconciliation-paymentIssuer S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer]] Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.paymentIssuer #xD; value[x] S 1..1 Reference(Debt Portal Patient) Value of extension #xD; extension:extension-PaymentReconciliation-allocation-identifier S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier]] Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.identifier #xD; value[x] #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Bill Number #xD; value S 0..1 string The value that is unique #xD; extension:extension-PaymentReconciliation-allocation-target S 0..1 ?gen-e1? [CanonicalType[http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target]] Optional Extensions Element URL: http://hl7.org/fhir/5.0/StructureDefinition/extension-PaymentReconciliation.allocation.target #xD; value[x] S 1..1 Reference(Debt Portal Invoice) Value of extension #xD; identifier #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Transaction Number #xD; value S 0..1 string The value that is unique #xD; status S 1..1 code active | cancelled | draft | entered-in-error Required Pattern: active #xD; created S 1..1 dateTime Creation date #xD; disposition SC 0..1 string Disposition message Constraints: 430.3-.01)" class="constraint">dppr-31-1982 #xD; paymentDate S 1..1 date When payment issued #xD; paymentAmount #xD; value S 0..1 decimal Numerical value (with implicit precision) #xD; currency S 0..1 code ISO 4217 Currency Code Required Pattern: USD #xD; paymentIdentifier S 0..1 Identifier Business identifier for the payment #xD; Slices for detail 0..* BackboneElement Settlement particulars Slice: Unordered, Open by value:$this #xD; detail:va-principal-collected S 0..1 BackboneElement Settlement particulars #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Principal Collected #xD; amount S 0..1 Money Amount allocated to this payable #xD; detail:va-interest-collected S 0..1 BackboneElement Settlement particulars #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Interest Collected #xD; amount S 0..1 Money Amount allocated to this payable #xD; detail:va-admin-collected S 0..1 BackboneElement Settlement particulars #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Administrative Charge Collected #xD; amount S 0..1 Money Amount allocated to this payable #xD; detail:va-marshal-collected S 0..1 BackboneElement Settlement particulars #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Marshal Fee Collected #xD; amount S 0..1 Money Amount allocated to this payable #xD; detail:va-courtcost-collected S 0..1 BackboneElement Settlement particulars #xD; type #xD; text S 0..1 string Plain text representation of the concept Required Pattern: Court Cost Collected #xD; amount S 0..1 Money Amount allocated to this payable #xD; Documentation for this format
This StructureDefinition contains the maps for VistA file AR TRANSACTION (433) to PaymentReconciliation.
Veterans Health Information Systems Technology and Architecture (VistA)
Canadian Dental Association eclaims standard
This resource provides the details including amount of a payment and allocates the payment items being paid.
If the resource is contained in another resource, it SHALL NOT contain nested Resources
not(parent::f:contained and f:contained)
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()
not(exists(for $id in f:contained/*/f:id/@value return $contained[not(parent::*/descendant::f:reference/@value=concat('#', $contained/*/id/@value) or descendant::f:reference[@value='#'])]))
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()
not(exists(f:contained/*/f:meta/f:versionId)) and not(exists(f:contained/*/f:meta/f:lastUpdated))
If a resource is contained in another resource, it SHALL NOT have a security label
When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.
A resource should have narrative for robust management
The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
The only time that a resource does not have an id is when it is being submitted to the server using a create operation.
The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
All FHIR elements must have a @value or children
hasValue() or (children().count() > id.count())
A set of rules under which this content was created
A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.
This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation
The base language in which the resource is written.
Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).
Text summary of the resource, for human interpretation
A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.
These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.
Must have either extensions or value[x], not both
exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")])
Optional Extension Element - found in all resources.
exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')])
Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Extensions are always sliced by (at least) url
Source of the definition for the extension code - a logical name or a URL.
The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Value of extension - must be one of a constrained set of the data types (see [Extensibility](http://hl7.org/fhir/R4/extensibility.html) for a list).
2032: reference based on AR TRANSACTION - BILL NUMBER > ACCOUNTS RECEIVABLE - DEBTOR (433-.03 > 430-9)
2/20/25 validated Bill Number from AR Transaction is the correct map as this field points to Accounts Receivable and the patient (debtor) link is in Accounts Receivable
IB.ARTransaction.AccountsReceivableIEN IB.ARTransaction.PatientIEN IB.ARTransactionComment.PatientIEN IB.ARTransactionDescription.PatientIEN IB.ARTransactionFiscalYear.PatientIEN IB.AccountsReceivable.ARDebtorIEN
Additional content defined by implementations
May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
usual | official | temp | secondary | old (If known)
Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.
Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.
This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one.
Identifies the purpose for this identifier, if known .
A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.
This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage. Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.
Allows users to make use of identifiers when the identifier system is not known.
A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
A reference to a code defined by a terminology system.
Codes may be defined very casually in enumerations, or code lists, up to very formal definitions such as SNOMED CT - see the HL7 v3 Core Principles for more information. Ordering of codings is undefined and SHALL NOT be used to infer meaning. Generally, at most only one of the coding values will be labeled as UserSelected = true.
Allows for alternative encodings within a code system, and translations to other code systems.
fhir:CodeableConcept.coding rdfs:subPropertyOf dt:CD.coding
Plain text representation of the concept
A human language representation of the concept as seen/selected/uttered by the user who entered the data and/or which represents the intended meaning of the user.
Very often the text is the same as a displayName of one of the codings.
The codes from the terminologies do not always capture the correct meaning with all the nuances of the human using them, or sometimes there is no appropriate code at all. In these cases, the text is used to capture the full meaning of the source.
IB.ARTransaction.AccountsReceivableIEN IB.ARTransaction.PatientIEN IB.ARTransactionComment.PatientIEN IB.ARTransactionDescription.PatientIEN IB.ARTransactionFiscalYear.PatientIEN
C*E.9. But note many systems use C*E.2 for this
fhir:CodeableConcept.text rdfs:subPropertyOf dt:CD.originalText
Establishes the namespace for the value - that is, a URL that describes a set values that are unique.
Identifier.system is always case sensitive.
There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.
The portion of the identifier typically relevant to the user and which is unique within the context of the system.
If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the [Rendered Value extension](http://hl7.org/fhir/R4/extension-rendered-value.html). Identifier.value is to be treated as case sensitive unless knowledge of the Identifier.system allows the processer to be confident that non-case-sensitive processing is safe.
1979: source value based on AR TRANSACTION - BILL NUMBER (433-.03)
II.extension or II.root if system indicates OID or GUID (Or Role.id.extension or root)
Time period when id is/was valid for use
Time period during which identifier is/was valid for use.
Role.effectiveTime or implied by context
Organization that issued id (may be just text)
Organization that issued/manages the identifier.
The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.
II.assigningAuthorityName but note that this is an improper use by the definition of the field. Also Role.scoper
May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions allow for extensions that *cannot* be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the [definition of modifier extensions](http://hl7.org/fhir/R4/extensibility.html#modifierExtension).
Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them
Business Identifier for a payment reconciliation
A unique identifier assigned to this payment reconciliation.
Allows payment reconciliations to be distinguished and referenced.
1978: source value based on AR TRANSACTION - TRANSACTION NUMBER (433-.01)
active | cancelled | draft | entered-in-error
This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
Need to track the status of the resource as 'draft' resources may undergo further edits while 'active' resources are immutable and may only have their status changed to 'cancelled'.
This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
A code specifying the state of the resource instance.
The period of time for which payments have been gathered into this bulk payment for settlement.
Needed to allow receivers to monitor and reconcile payment issuer schedules.
Need to record a timestamp for use by both the recipient and the issuer.
1984: source value based on AR TRANSACTION - DATE ENTERED (433-19)
This party is also responsible for the reconciliation.
Need to identify the party resonsible for the payment and this resource.
Needed to allow the response to be linked to the request.
The practitioner who is responsible for the services rendered to the patient.
Need to identify the party responsible for the request.
The outcome of a request for a reconciliation.
The resource may be used to indicate that: the request has been held (queued) for processing; that it has been processed and errors found (error); that no errors were found and that some of the adjudication has been undertaken (partial) or that all of the adjudication has been undertaken (complete).
To advise the requestor of an overall processing outcome.
A human readable description of the status of the request for the reconciliation.
If IEN = 34 OR 2 then source value from (433-12 > 430.3-.01)
1982: source value based on AR TRANSACTION - TRANSACTION TYPE > ACCOUNTS RECEIVABLE TRANS.TYPE - NAME (433-12 > 430.3-.01) is IEN = 34 OR 2
Transaction type name = PAYMENT (IN FULL) when IEN = 34 Transaction type name = PAYMENT (IN PART) when IEN = 2
IB.ARTransaction.ARTransactionTypeIEN Dim.ARTransactionType.ARTransactionType
The date of payment as indicated on the financial instrument.
To advise the payee when payment can be expected.
1981: source value based on AR TRANSACTION - TRANSACTION DATE (433-11)
IB.ARTransaction.TransactionDateTime IB.ARTransactionComment.TransactionDateTime IB.ARTransactionDescription.TransactionDateTime IB.ARTransactionFiscalYear.TransactionDateTime
Total payment amount as indicated on the financial instrument.
Needed to provide the actual payment amount.
Numerical value (with implicit precision)
Numerical value (with implicit precision).
Monetary values have their own rules for handling precision (refer to standard accounting text books).
The amount of the currency. The value includes an implicit precision in the presentation of the value.
1983: source value based on AR TRANSACTION - TRANS. AMOUNT (433-15)
A code indicating the currency, taken from ISO 4217.
Issuer's unique identifier for the payment instrument.
For example: EFT number or check number.
Enable the receiver to reconcile when payment is received.
1985: source value based on AR TRANSACTION - RECEIPT # (433-13)
Distribution of the payment amount for a previously acknowledged payable.
Needed to show how the payment amount is distributed across the payables.
Extensions that cannot be ignored even if unrecognized
May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
Modifier extensions are expected to modify the meaning or interpretation of the element that contains them
Business identifier of the payment detail
Unique identifier for the current payment item for the referenced payable.
Business identifier of the prior payment detail
Unique identifier for the prior payment item for the referenced payable.
Code to indicate the nature of the payment.
For example: payment, adjustment, funds advance, etc.
Needed to provide context for the amount.
The reason for the amount: payment, adjustment, advance.
A resource, such as a Claim, the evaluation of which could lead to payment.
Needed to provide a linkage to the original request.
The party which submitted the claim or financial transaction.
A resource, such as a ClaimResponse, which contains a commitment to payment.
Needed to provide a linkage to the payment commitment.
The date from the response resource containing a commitment to pay.
A reference to the individual who is responsible for inquiries regarding the response and its payment.
The party which is receiving the payment.
The monetary amount allocated from the total payment to the payable.
Needed to explain the distribution of the payment to the payables.
1986a: fixed value = Principal Collected
1986: source value based on AR TRANSACTION - PRIN.COLLECTED (433-31)
1987: source value based on AR TRANSACTION - INTEREST COLLECTED (433-32)
1988a: fixed value = Administrative Charge Collected
1988: source value based on AR TRANSACTION - ADMIN.COLLECTED (433-33)
1989a: fixed value = Marshal Fee Collected
1989: source value based on AR TRANSACTION - MARSHAL FEE COLLECTED (433-34)
1990a: fixed value = Court Cost Collected
1990: source value based on AR TRANSACTION - COURT COST COLLECTED (433-35)
A code for the form to be used for printing the content.
May be needed to identify specific jurisdictional forms.
Needed to specify the specific form used for producing output for this response.
A note that describes or explains the processing in a human readable form.
Provides the specific textual explanations associated with the processing.
To convey the expectation for when the text is used.
The explanation or description associated with the processing.
Required to provide human readable explanation.