payment reconciliations
Create Payment Reconciliation
post
/organizations/{organizationId}/fhir/3/PaymentReconciliation
This resource provides payment details and claim references supporting a bulk payment.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | PaymentReconciliation | This is a PaymentReconciliation resource |
| identifier | array(Identifier) | The Response business identifier. | |
| status | string | The status of the resource instance. | |
| period | Period | The period of time for which payments have been gathered into this bulk payment for settlement. | |
| created | string | The date when the enclosed suite of services were performed or completed. | |
| organization | Reference | The Insurer who produced this adjudicated response. | |
| request | Reference | Original request resource reference. | |
| outcome | CodeableConcept | Transaction status: error, complete. | |
| disposition | string | A description of the status of the adjudication. | |
| requestProvider | Reference | The practitioner who is responsible for the services rendered to the patient. | |
| requestOrganization | Reference | The organization which is responsible for the services rendered to the patient. | |
| detail | array(PaymentReconciliation_Detail) | List of individual settlement amounts and the corresponding transaction. | |
| form | CodeableConcept | The form to be used for printing the content. | |
| total | Money | Total payment amount. | |
| processNote | array(PaymentReconciliation_ProcessNote) | Suite of notes. |
Response
keyboard_arrow_down
Patch Payment Reconciliation
patch
/organizations/{organizationId}/fhir/3/PaymentReconciliation/{resourceId}
This resource provides payment details and claim references supporting a bulk payment.
Request
Headers
| content-type* | string | application/json-patch+json | application/json-patch+json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | PaymentReconciliation | This is a PaymentReconciliation resource |
| identifier | array(Identifier) | The Response business identifier. | |
| status | string | The status of the resource instance. | |
| period | Period | The period of time for which payments have been gathered into this bulk payment for settlement. | |
| created | string | The date when the enclosed suite of services were performed or completed. | |
| organization | Reference | The Insurer who produced this adjudicated response. | |
| request | Reference | Original request resource reference. | |
| outcome | CodeableConcept | Transaction status: error, complete. | |
| disposition | string | A description of the status of the adjudication. | |
| requestProvider | Reference | The practitioner who is responsible for the services rendered to the patient. | |
| requestOrganization | Reference | The organization which is responsible for the services rendered to the patient. | |
| detail | array(PaymentReconciliation_Detail) | List of individual settlement amounts and the corresponding transaction. | |
| form | CodeableConcept | The form to be used for printing the content. | |
| total | Money | Total payment amount. | |
| processNote | array(PaymentReconciliation_ProcessNote) | Suite of notes. |
Response
keyboard_arrow_down
Read Payment Reconciliation
get
/organizations/{organizationId}/fhir/3/PaymentReconciliation/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read History Payment Reconciliation
get
/organizations/{organizationId}/fhir/3/PaymentReconciliation/{resourceId}/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Read Version Payment Reconciliation
get
/organizations/{organizationId}/fhir/3/PaymentReconciliation/{resourceId}/_history/{versionId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* | |||
| versionId* |
Response
keyboard_arrow_down
Remove Payment Reconciliation
delete
/organizations/{organizationId}/fhir/3/PaymentReconciliation/{resourceId}
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Response
keyboard_arrow_down
Search Get Payment Reconciliation
get
/organizations/{organizationId}/fhir/3/PaymentReconciliation
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| created | string | ||
| disposition | string | ||
| identifier | string | ||
| organization | string | ||
| outcome | string | ||
| request | string | ||
| request-organization | string | ||
| request-provider | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Payment Reconciliation
get
/organizations/{organizationId}/fhir/3/PaymentReconciliation/_history
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _count | string | ||
| _since | string |
Params
| organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search Post Payment Reconciliation
post
/organizations/{organizationId}/fhir/3/PaymentReconciliation/_search
This resource provides payment details and claim references supporting a bulk payment.
Request
Headers
| content-type* | string | application/json|application/x-www-form-urlencoded | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Query params
| _id | string | ||
| _language | string | ||
| created | string | ||
| disposition | string | ||
| identifier | string | ||
| organization | string | ||
| outcome | string | ||
| request | string | ||
| request-organization | string | ||
| request-provider | string |
Params
| organizationId* | string|string | id|slug |
Body
| resourceType* | string | PaymentReconciliation | This is a PaymentReconciliation resource |
| identifier | array(Identifier) | The Response business identifier. | |
| status | string | The status of the resource instance. | |
| period | Period | The period of time for which payments have been gathered into this bulk payment for settlement. | |
| created | string | The date when the enclosed suite of services were performed or completed. | |
| organization | Reference | The Insurer who produced this adjudicated response. | |
| request | Reference | Original request resource reference. | |
| outcome | CodeableConcept | Transaction status: error, complete. | |
| disposition | string | A description of the status of the adjudication. | |
| requestProvider | Reference | The practitioner who is responsible for the services rendered to the patient. | |
| requestOrganization | Reference | The organization which is responsible for the services rendered to the patient. | |
| detail | array(PaymentReconciliation_Detail) | List of individual settlement amounts and the corresponding transaction. | |
| form | CodeableConcept | The form to be used for printing the content. | |
| total | Money | Total payment amount. | |
| processNote | array(PaymentReconciliation_ProcessNote) | Suite of notes. |
Response
keyboard_arrow_down
Update Payment Reconciliation
put
/organizations/{organizationId}/fhir/3/PaymentReconciliation/{resourceId}
This resource provides payment details and claim references supporting a bulk payment.
Request
Headers
| content-type* | string | application/json | application/json |
| log-cdata | string | ||
| log-cdata-format | string | kv|json | kv |
| Authorization | string | Bearer <token> |
Params
| organizationId* | string|string | id|slug | |
| resourceId* |
Body
| resourceType* | string | PaymentReconciliation | This is a PaymentReconciliation resource |
| identifier | array(Identifier) | The Response business identifier. | |
| status | string | The status of the resource instance. | |
| period | Period | The period of time for which payments have been gathered into this bulk payment for settlement. | |
| created | string | The date when the enclosed suite of services were performed or completed. | |
| organization | Reference | The Insurer who produced this adjudicated response. | |
| request | Reference | Original request resource reference. | |
| outcome | CodeableConcept | Transaction status: error, complete. | |
| disposition | string | A description of the status of the adjudication. | |
| requestProvider | Reference | The practitioner who is responsible for the services rendered to the patient. | |
| requestOrganization | Reference | The organization which is responsible for the services rendered to the patient. | |
| detail | array(PaymentReconciliation_Detail) | List of individual settlement amounts and the corresponding transaction. | |
| form | CodeableConcept | The form to be used for printing the content. | |
| total | Money | Total payment amount. | |
| processNote | array(PaymentReconciliation_ProcessNote) | Suite of notes. |
Response
keyboard_arrow_down