payment reconciliations

Create Payment Reconciliation

post
/organizations/{organizationId}/fhir/4/PaymentReconciliation

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*This is a PaymentReconciliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)A unique identifier assigned to this payment reconciliation.
statuscodeThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createddateTimeThe date when the resource was created.
paymentIssuerReferenceThe party who generated the payment.
requestReferenceOriginal request resource reference.
requestorReferenceThe practitioner who is responsible for the services rendered to the patient.
outcomequeued|complete|error|partialThe outcome of a request for a reconciliation.
dispositionstringA human readable description of the status of the request for the reconciliation.
paymentDatedateThe date of payment as indicated on the financial instrument.
paymentAmount*MoneyTotal payment amount as indicated on the financial instrument.
paymentIdentifierIdentifierIssuer's unique identifier for the payment instrument.
detailarray(PaymentReconciliation_Detail)Distribution of the payment amount for a previously acknowledged payable.
formCodeCodeableConceptA code for the form to be used for printing the content.
processNotearray(PaymentReconciliation_ProcessNote)A note that describes or explains the processing in a human readable form.

Response

Patch Payment Reconciliation

patch
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}

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

Request

Headers

content-type*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a PaymentReconciliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)A unique identifier assigned to this payment reconciliation.
statuscodeThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createddateTimeThe date when the resource was created.
paymentIssuerReferenceThe party who generated the payment.
requestReferenceOriginal request resource reference.
requestorReferenceThe practitioner who is responsible for the services rendered to the patient.
outcomequeued|complete|error|partialThe outcome of a request for a reconciliation.
dispositionstringA human readable description of the status of the request for the reconciliation.
paymentDatedateThe date of payment as indicated on the financial instrument.
paymentAmount*MoneyTotal payment amount as indicated on the financial instrument.
paymentIdentifierIdentifierIssuer's unique identifier for the payment instrument.
detailarray(PaymentReconciliation_Detail)Distribution of the payment amount for a previously acknowledged payable.
formCodeCodeableConceptA code for the form to be used for printing the content.
processNotearray(PaymentReconciliation_ProcessNote)A note that describes or explains the processing in a human readable form.

Response

Read Payment Reconciliation

get
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Payment Reconciliation

get
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug
resourceId*

Response

Read Version Payment Reconciliation

get
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}/_history/{versionId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Payment Reconciliation

delete
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Payment Reconciliation

get
/organizations/{organizationId}/fhir/4/PaymentReconciliation

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
createdstring
dispositionstring
identifierstring
outcomestring
payment-issuerstring
requeststring
requestorstring
statusstring

Params

organizationId*string|stringid|slug

Response

Search History Payment Reconciliation

get
/organizations/{organizationId}/fhir/4/PaymentReconciliation/_history

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_countstring
_sincestring

Params

organizationId*string|stringid|slug

Response

Search Post Payment Reconciliation

post
/organizations/{organizationId}/fhir/4/PaymentReconciliation/_search

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

Request

Headers

content-type*stringapplication/json|application/x-www-form-urlencodedapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Query params

_idstring
_languagestring
createdstring
dispositionstring
identifierstring
outcomestring
payment-issuerstring
requeststring
requestorstring
statusstring

Params

organizationId*string|stringid|slug

Body

resourceType*This is a PaymentReconciliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)A unique identifier assigned to this payment reconciliation.
statuscodeThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createddateTimeThe date when the resource was created.
paymentIssuerReferenceThe party who generated the payment.
requestReferenceOriginal request resource reference.
requestorReferenceThe practitioner who is responsible for the services rendered to the patient.
outcomequeued|complete|error|partialThe outcome of a request for a reconciliation.
dispositionstringA human readable description of the status of the request for the reconciliation.
paymentDatedateThe date of payment as indicated on the financial instrument.
paymentAmount*MoneyTotal payment amount as indicated on the financial instrument.
paymentIdentifierIdentifierIssuer's unique identifier for the payment instrument.
detailarray(PaymentReconciliation_Detail)Distribution of the payment amount for a previously acknowledged payable.
formCodeCodeableConceptA code for the form to be used for printing the content.
processNotearray(PaymentReconciliation_ProcessNote)A note that describes or explains the processing in a human readable form.

Response

Update Payment Reconciliation

put
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}

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

Request

Headers

content-type*stringapplication/json|application/json+fhirapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*This is a PaymentReconciliation resource
ididThe logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
metaMetaThe 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.
implicitRulesuriA 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.
languagecodeThe base language in which the resource is written.
textNarrativeA 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.
containedarray(ResourceList)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.
extensionarray(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.
modifierExtensionarray(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).
identifierarray(Identifier)A unique identifier assigned to this payment reconciliation.
statuscodeThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createddateTimeThe date when the resource was created.
paymentIssuerReferenceThe party who generated the payment.
requestReferenceOriginal request resource reference.
requestorReferenceThe practitioner who is responsible for the services rendered to the patient.
outcomequeued|complete|error|partialThe outcome of a request for a reconciliation.
dispositionstringA human readable description of the status of the request for the reconciliation.
paymentDatedateThe date of payment as indicated on the financial instrument.
paymentAmount*MoneyTotal payment amount as indicated on the financial instrument.
paymentIdentifierIdentifierIssuer's unique identifier for the payment instrument.
detailarray(PaymentReconciliation_Detail)Distribution of the payment amount for a previously acknowledged payable.
formCodeCodeableConceptA code for the form to be used for printing the content.
processNotearray(PaymentReconciliation_ProcessNote)A note that describes or explains the processing in a human readable form.

Response