Skip to main content

PaymentReconciliation

PropertyValue
Publisher
NamePaymentReconciliation
URLhttp://hl7.org/fhir/StructureDefinition/PaymentReconciliation
Statusdraft
Description
Abstractfalse

Structure

PathCardinalityTypeDescription
PaymentReconciliation0..*PaymentReconciliationThis resource provides the details including amount of a payment and allocates the payment items being paid.
PaymentReconciliation.id0..1http://hl7.org/fhirpath/System.StringThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
PaymentReconciliation.meta0..1MetaThe 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.
PaymentReconciliation.implicitRules0..1uriA 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.
PaymentReconciliation.language0..1codeThe base language in which the resource is written.
PaymentReconciliation.text0..1NarrativeA 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.
PaymentReconciliation.contained0..*ResourceThese 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.
PaymentReconciliation.extension0..*ExtensionMay be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
PaymentReconciliation.modifierExtension0..*ExtensionMay 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).
PaymentReconciliation.identifier0..*IdentifierA unique identifier assigned to this payment reconciliation.
PaymentReconciliation.status1..1codeThe status of the resource instance.
PaymentReconciliation.period0..1PeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
PaymentReconciliation.created1..1dateTimeThe date when the resource was created.
PaymentReconciliation.paymentIssuer0..1ReferenceThe party who generated the payment.
PaymentReconciliation.request0..1ReferenceOriginal request resource reference.
PaymentReconciliation.requestor0..1ReferenceThe practitioner who is responsible for the services rendered to the patient.
PaymentReconciliation.outcome0..1codeThe outcome of a request for a reconciliation.
PaymentReconciliation.disposition0..1stringA human readable description of the status of the request for the reconciliation.
PaymentReconciliation.paymentDate1..1dateThe date of payment as indicated on the financial instrument.
PaymentReconciliation.paymentAmount1..1MoneyTotal payment amount as indicated on the financial instrument.
PaymentReconciliation.paymentIdentifier0..1IdentifierIssuer's unique identifier for the payment instrument.
PaymentReconciliation.detail0..*BackboneElementDistribution of the payment amount for a previously acknowledged payable.
PaymentReconciliation.detail.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PaymentReconciliation.detail.extension0..*ExtensionMay 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.
PaymentReconciliation.detail.modifierExtension0..*ExtensionMay 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).
PaymentReconciliation.detail.identifier0..1IdentifierUnique identifier for the current payment item for the referenced payable.
PaymentReconciliation.detail.predecessor0..1IdentifierUnique identifier for the prior payment item for the referenced payable.
PaymentReconciliation.detail.type1..1CodeableConceptCode to indicate the nature of the payment.
PaymentReconciliation.detail.request0..1ReferenceA resource, such as a Claim, the evaluation of which could lead to payment.
PaymentReconciliation.detail.submitter0..1ReferenceThe party which submitted the claim or financial transaction.
PaymentReconciliation.detail.response0..1ReferenceA resource, such as a ClaimResponse, which contains a commitment to payment.
PaymentReconciliation.detail.date0..1dateThe date from the response resource containing a commitment to pay.
PaymentReconciliation.detail.responsible0..1ReferenceA reference to the individual who is responsible for inquiries regarding the response and its payment.
PaymentReconciliation.detail.payee0..1ReferenceThe party which is receiving the payment.
PaymentReconciliation.detail.amount0..1MoneyThe monetary amount allocated from the total payment to the payable.
PaymentReconciliation.formCode0..1CodeableConceptA code for the form to be used for printing the content.
PaymentReconciliation.processNote0..*BackboneElementA note that describes or explains the processing in a human readable form.
PaymentReconciliation.processNote.id0..1http://hl7.org/fhirpath/System.StringUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PaymentReconciliation.processNote.extension0..*ExtensionMay 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.
PaymentReconciliation.processNote.modifierExtension0..*ExtensionMay 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).
PaymentReconciliation.processNote.type0..1codeThe business purpose of the note text.
PaymentReconciliation.processNote.text0..1stringThe explanation or description associated with the processing.

Search Parameters

NameTypeDescriptionExpression
_textstringSearch on the narrative of the resource
_contentstringSearch on the entire content of the resource
_filtertokenFilter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_hasstringProvides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_idtokenLogical id of this artifactResource.id
_lastUpdateddateWhen the resource version last changedResource.meta.lastUpdated
_liststringAll resources in nominated list (by id, Type/id, url or one of the magic List types)
_profileuriProfiles this resource claims to conform toResource.meta.profile
_querytokenA custom search profile that describes a specific defined query operation
_securitytokenSecurity Labels applied to this resourceResource.meta.security
_sourceuriIdentifies where the resource comes fromResource.meta.source
_tagtokenTags applied to this resourceResource.meta.tag
_textstringSearch on the narrative text (html) of the resource
_typetokenUsed when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
createddateThe creation datePaymentReconciliation.created
dispositionstringThe contents of the disposition messagePaymentReconciliation.disposition
identifiertokenThe business identifier of the ExplanationOfBenefitPaymentReconciliation.identifier
outcometokenThe processing outcomePaymentReconciliation.outcome
payment-issuerreferenceThe organization which generated this resourcePaymentReconciliation.paymentIssuer
requestreferenceThe reference to the claimPaymentReconciliation.request
requestorreferenceThe reference to the provider who submitted the claimPaymentReconciliation.requestor
statustokenThe status of the payment reconciliationPaymentReconciliation.status