PaymentReconciliation

This resource provides the details including amount of a payment and allocates the payment items being paid.

Properties

Name	Required	Type	Description
identifier		Identifier[]	Business Identifier for a payment reconciliation Details A unique identifier assigned to this payment reconciliation.
status	✓	code	active | cancelled | draft | entered-in-error Details The status of the resource instance. This element is labeled as a modifier because the status contains codes that mark the resource as not currently valid.
period		Period	Period covered Details The period of time for which payments have been gathered into this bulk payment for settlement.
created	✓	dateTime	Creation date Details The date when the resource was created.
paymentIssuer		Reference<Organization>	Party generating payment Details The party who generated the payment. This party is also responsible for the reconciliation.
request		Reference<Task>	Reference to requesting resource Details Original request resource reference.
requestor		Reference< Practitioner | PractitionerRole | Organization >	Responsible practitioner Details The practitioner who is responsible for the services rendered to the patient.
outcome		code	queued | complete | error | partial Details 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).
disposition		string	Disposition message Details A human readable description of the status of the request for the reconciliation.
paymentDate	✓	date	When payment issued Details The date of payment as indicated on the financial instrument.
paymentAmount	✓	Money	Total amount of Payment Details Total payment amount as indicated on the financial instrument.
paymentIdentifier		Identifier	Business identifier for the payment Details Issuer's unique identifier for the payment instrument. For example: EFT number or check number.
detail		PaymentReconciliationDetail[]	Settlement particulars Details Distribution of the payment amount for a previously acknowledged payable.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details 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.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details 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). 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.
identifier		Identifier	Business identifier of the payment detail Details Unique identifier for the current payment item for the referenced payable.
predecessor		Identifier	Business identifier of the prior payment detail Details Unique identifier for the prior payment item for the referenced payable.
type	✓	CodeableConcept	Category of payment Details Code to indicate the nature of the payment. For example: payment, adjustment, funds advance, etc.
request		Reference<Resource>	Request giving rise to the payment Details A resource, such as a Claim, the evaluation of which could lead to payment.
submitter		Reference< Practitioner | PractitionerRole | Organization >	Submitter of the request Details The party which submitted the claim or financial transaction.
response		Reference<Resource>	Response committing to a payment Details A resource, such as a ClaimResponse, which contains a commitment to payment.
date		date	Date of commitment to pay Details The date from the response resource containing a commitment to pay.
responsible		Reference<PractitionerRole>	Contact for the response Details A reference to the individual who is responsible for inquiries regarding the response and its payment.
payee		Reference< Practitioner | PractitionerRole | Organization >	Recipient of the payment Details The party which is receiving the payment.
amount		Money	Amount allocated to this payable Details The monetary amount allocated from the total payment to the payable.
formCode		CodeableConcept	Printed form identifier Details A code for the form to be used for printing the content. May be needed to identify specific jurisdictional forms.
processNote		PaymentReconciliationProcessNote[]	Note concerning processing Details A note that describes or explains the processing in a human readable form.
id		string	Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
extension		Extension[]	Additional content defined by implementations Details 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.
modifierExtension		Extension[]	Extensions that cannot be ignored even if unrecognized Details 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). 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.
type		code	display | print | printoper Details The business purpose of the note text.
text		string	Note explanatory text Details The explanation or description associated with the processing.

Search Parameters

Name	Type	Description	Expression
created	date	The creation date	PaymentReconciliation.created
disposition	string	The contents of the disposition message	PaymentReconciliation.disposition
identifier	token	The business identifier of the ExplanationOfBenefit	PaymentReconciliation.identifier
outcome	token	The processing outcome	PaymentReconciliation.outcome
payment-issuer	reference	The organization which generated this resource	PaymentReconciliation.paymentIssuer
request	reference	The reference to the claim	PaymentReconciliation.request
requestor	reference	The reference to the provider who submitted the claim	PaymentReconciliation.requestor
status	token	The status of the payment reconciliation	PaymentReconciliation.status

Inherited Properties

Name	Required	Type	Description
id		string	Logical id of this artifact Details 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.
meta		Meta	Metadata about the resource Details 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.
implicitRules		uri	A set of rules under which this content was created Details 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.
language		code	Language of the resource content Details 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		Narrative	Text summary of the resource, for human interpretation Details 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.
contained		Resource[]	Contained, inline Resources Details 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.
extension		Extension[]	Additional content defined by implementations Details May 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. 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.
modifierExtension		Extension[]	Extensions that cannot be ignored Details 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). 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.