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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug

Body

resourceType*stringPaymentReconciliationThis is a PaymentReconciliation resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe Insurer who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
detailarray(PaymentReconciliation_Detail)List of individual settlement amounts and the corresponding transaction.
formCodeableConceptThe form to be used for printing the content.
totalMoneyTotal payment amount.
processNotearray(PaymentReconciliation_ProcessNote)Suite of notes.

Response

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*stringapplication/json-patch+jsonapplication/json-patch+json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPaymentReconciliationThis is a PaymentReconciliation resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe Insurer who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
detailarray(PaymentReconciliation_Detail)List of individual settlement amounts and the corresponding transaction.
formCodeableConceptThe form to be used for printing the content.
totalMoneyTotal payment amount.
processNotearray(PaymentReconciliation_ProcessNote)Suite of notes.

Response

Read Payment Reconciliation

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Read History Payment Reconciliation

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/PaymentReconciliation/{resourceId}/_history/{versionId}

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*
versionId*

Response

Remove Payment Reconciliation

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

Request

Headers

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

Params

organizationId*string|stringid|slug
resourceId*

Response

Search Get Payment Reconciliation

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

Request

Headers

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

Query params

_idstring
_languagestring
createdstring
dispositionstring
identifierstring
organizationstring
outcomestring
requeststring
request-organizationstring
request-providerstring

Params

organizationId*string|stringid|slug

Response

Search History Payment Reconciliation

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

Request

Headers

content-type*stringapplication/jsonapplication/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/3/PaymentReconciliation/_search

This resource provides payment details and claim references supporting a bulk payment.

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
organizationstring
outcomestring
requeststring
request-organizationstring
request-providerstring

Params

organizationId*string|stringid|slug

Body

resourceType*stringPaymentReconciliationThis is a PaymentReconciliation resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe Insurer who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
detailarray(PaymentReconciliation_Detail)List of individual settlement amounts and the corresponding transaction.
formCodeableConceptThe form to be used for printing the content.
totalMoneyTotal payment amount.
processNotearray(PaymentReconciliation_ProcessNote)Suite of notes.

Response

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*stringapplication/jsonapplication/json
log-cdatastring
log-cdata-formatstringkv|jsonkv
AuthorizationstringBearer <token>

Params

organizationId*string|stringid|slug
resourceId*

Body

resourceType*stringPaymentReconciliationThis is a PaymentReconciliation resource
identifierarray(Identifier)The Response business identifier.
statusstringThe status of the resource instance.
periodPeriodThe period of time for which payments have been gathered into this bulk payment for settlement.
createdstringThe date when the enclosed suite of services were performed or completed.
organizationReferenceThe Insurer who produced this adjudicated response.
requestReferenceOriginal request resource reference.
outcomeCodeableConceptTransaction status: error, complete.
dispositionstringA description of the status of the adjudication.
requestProviderReferenceThe practitioner who is responsible for the services rendered to the patient.
requestOrganizationReferenceThe organization which is responsible for the services rendered to the patient.
detailarray(PaymentReconciliation_Detail)List of individual settlement amounts and the corresponding transaction.
formCodeableConceptThe form to be used for printing the content.
totalMoneyTotal payment amount.
processNotearray(PaymentReconciliation_ProcessNote)Suite of notes.

Response