PaymentReconciliation

Property	Value
Publisher
Name	PaymentReconciliation
URL	http://hl7.org/fhir/StructureDefinition/PaymentReconciliation
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
PaymentReconciliation	0..*	PaymentReconciliation	This resource provides the details including amount of a payment and allocates the payment items being paid.
PaymentReconciliation.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
PaymentReconciliation.meta	0..1	Meta	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.
PaymentReconciliation.implicitRules	0..1	uri	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.
PaymentReconciliation.language	0..1	code	The base language in which the resource is written.
PaymentReconciliation.text	0..1	Narrative	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.
PaymentReconciliation.contained	0..*	Resource	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.
PaymentReconciliation.extension	0..*	Extension	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.
PaymentReconciliation.modifierExtension	0..*	Extension	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).
PaymentReconciliation.identifier	0..*	Identifier	A unique identifier assigned to this payment reconciliation.
PaymentReconciliation.status	1..1	code	The status of the resource instance.
PaymentReconciliation.period	0..1	Period	The period of time for which payments have been gathered into this bulk payment for settlement.
PaymentReconciliation.created	1..1	dateTime	The date when the resource was created.
PaymentReconciliation.paymentIssuer	0..1	Reference	The party who generated the payment.
PaymentReconciliation.request	0..1	Reference	Original request resource reference.
PaymentReconciliation.requestor	0..1	Reference	The practitioner who is responsible for the services rendered to the patient.
PaymentReconciliation.outcome	0..1	code	The outcome of a request for a reconciliation.
PaymentReconciliation.disposition	0..1	string	A human readable description of the status of the request for the reconciliation.
PaymentReconciliation.paymentDate	1..1	date	The date of payment as indicated on the financial instrument.
PaymentReconciliation.paymentAmount	1..1	Money	Total payment amount as indicated on the financial instrument.
PaymentReconciliation.paymentIdentifier	0..1	Identifier	Issuer's unique identifier for the payment instrument.
PaymentReconciliation.detail	0..*	BackboneElement	Distribution of the payment amount for a previously acknowledged payable.
PaymentReconciliation.detail.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PaymentReconciliation.detail.extension	0..*	Extension	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.
PaymentReconciliation.detail.modifierExtension	0..*	Extension	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).
PaymentReconciliation.detail.identifier	0..1	Identifier	Unique identifier for the current payment item for the referenced payable.
PaymentReconciliation.detail.predecessor	0..1	Identifier	Unique identifier for the prior payment item for the referenced payable.
PaymentReconciliation.detail.type	1..1	CodeableConcept	Code to indicate the nature of the payment.
PaymentReconciliation.detail.request	0..1	Reference	A resource, such as a Claim, the evaluation of which could lead to payment.
PaymentReconciliation.detail.submitter	0..1	Reference	The party which submitted the claim or financial transaction.
PaymentReconciliation.detail.response	0..1	Reference	A resource, such as a ClaimResponse, which contains a commitment to payment.
PaymentReconciliation.detail.date	0..1	date	The date from the response resource containing a commitment to pay.
PaymentReconciliation.detail.responsible	0..1	Reference	A reference to the individual who is responsible for inquiries regarding the response and its payment.
PaymentReconciliation.detail.payee	0..1	Reference	The party which is receiving the payment.
PaymentReconciliation.detail.amount	0..1	Money	The monetary amount allocated from the total payment to the payable.
PaymentReconciliation.formCode	0..1	CodeableConcept	A code for the form to be used for printing the content.
PaymentReconciliation.processNote	0..*	BackboneElement	A note that describes or explains the processing in a human readable form.
PaymentReconciliation.processNote.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
PaymentReconciliation.processNote.extension	0..*	Extension	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.
PaymentReconciliation.processNote.modifierExtension	0..*	Extension	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).
PaymentReconciliation.processNote.type	0..1	code	The business purpose of the note text.
PaymentReconciliation.processNote.text	0..1	string	The explanation or description associated with the processing.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides 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
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used 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
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