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* | string | application/json|application/json+fhir | application/json |
log-cdata | string | ||
log-cdata-format | string | kv|json | kv |
Authorization | string | Bearer <token> |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a PaymentReconciliation resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | 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. | |
implicitRules | 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. | |
language | code | The base language in which the resource is written. | |
text | 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | A unique identifier assigned to this payment reconciliation. | |
status | code | 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 | dateTime | The date when the resource was created. | |
paymentIssuer | Reference | The party who generated the payment. | |
request | Reference | Original request resource reference. | |
requestor | Reference | The practitioner who is responsible for the services rendered to the patient. | |
outcome | queued|complete|error|partial | The outcome of a request for a reconciliation. | |
disposition | string | A human readable description of the status of the request for the reconciliation. | |
paymentDate | date | The date of payment as indicated on the financial instrument. | |
paymentAmount* | Money | Total payment amount as indicated on the financial instrument. | |
paymentIdentifier | Identifier | Issuer's unique identifier for the payment instrument. | |
detail | array(PaymentReconciliation_Detail) | Distribution of the payment amount for a previously acknowledged payable. | |
formCode | CodeableConcept | A code for the form to be used for printing the content. | |
processNote | array(PaymentReconciliation_ProcessNote) | A note that describes or explains the processing in a human readable form. |
Response
keyboard_arrow_down
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* | 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* | This is a PaymentReconciliation resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | 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. | |
implicitRules | 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. | |
language | code | The base language in which the resource is written. | |
text | 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | A unique identifier assigned to this payment reconciliation. | |
status | code | 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 | dateTime | The date when the resource was created. | |
paymentIssuer | Reference | The party who generated the payment. | |
request | Reference | Original request resource reference. | |
requestor | Reference | The practitioner who is responsible for the services rendered to the patient. | |
outcome | queued|complete|error|partial | The outcome of a request for a reconciliation. | |
disposition | string | A human readable description of the status of the request for the reconciliation. | |
paymentDate | date | The date of payment as indicated on the financial instrument. | |
paymentAmount* | Money | Total payment amount as indicated on the financial instrument. | |
paymentIdentifier | Identifier | Issuer's unique identifier for the payment instrument. | |
detail | array(PaymentReconciliation_Detail) | Distribution of the payment amount for a previously acknowledged payable. | |
formCode | CodeableConcept | A code for the form to be used for printing the content. | |
processNote | array(PaymentReconciliation_ProcessNote) | A note that describes or explains the processing in a human readable form. |
Response
keyboard_arrow_down
Read Payment Reconciliation
get
/organizations/{organizationId}/fhir/4/PaymentReconciliation/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/PaymentReconciliation/{resourceId}/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/PaymentReconciliation/{resourceId}/_history/{versionId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/PaymentReconciliation/{resourceId}
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/PaymentReconciliation
Request
Headers
content-type* | string | application/json|application/json+fhir | 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 | ||
outcome | string | ||
payment-issuer | string | ||
request | string | ||
requestor | string | ||
status | string |
Params
organizationId* | string|string | id|slug |
Response
keyboard_arrow_down
Search History Payment Reconciliation
get
/organizations/{organizationId}/fhir/4/PaymentReconciliation/_history
Request
Headers
content-type* | string | application/json|application/json+fhir | 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/4/PaymentReconciliation/_search
This resource provides the details including amount of a payment and allocates the payment items being paid.
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 | ||
outcome | string | ||
payment-issuer | string | ||
request | string | ||
requestor | string | ||
status | string |
Params
organizationId* | string|string | id|slug |
Body
resourceType* | This is a PaymentReconciliation resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | 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. | |
implicitRules | 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. | |
language | code | The base language in which the resource is written. | |
text | 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | A unique identifier assigned to this payment reconciliation. | |
status | code | 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 | dateTime | The date when the resource was created. | |
paymentIssuer | Reference | The party who generated the payment. | |
request | Reference | Original request resource reference. | |
requestor | Reference | The practitioner who is responsible for the services rendered to the patient. | |
outcome | queued|complete|error|partial | The outcome of a request for a reconciliation. | |
disposition | string | A human readable description of the status of the request for the reconciliation. | |
paymentDate | date | The date of payment as indicated on the financial instrument. | |
paymentAmount* | Money | Total payment amount as indicated on the financial instrument. | |
paymentIdentifier | Identifier | Issuer's unique identifier for the payment instrument. | |
detail | array(PaymentReconciliation_Detail) | Distribution of the payment amount for a previously acknowledged payable. | |
formCode | CodeableConcept | A code for the form to be used for printing the content. | |
processNote | array(PaymentReconciliation_ProcessNote) | A note that describes or explains the processing in a human readable form. |
Response
keyboard_arrow_down
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* | string | application/json|application/json+fhir | 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* | This is a PaymentReconciliation resource | ||
id | id | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | |
meta | 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. | |
implicitRules | 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. | |
language | code | The base language in which the resource is written. | |
text | 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. | |
contained | array(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. | |
extension | array(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. | |
modifierExtension | array(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). | |
identifier | array(Identifier) | A unique identifier assigned to this payment reconciliation. | |
status | code | 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 | dateTime | The date when the resource was created. | |
paymentIssuer | Reference | The party who generated the payment. | |
request | Reference | Original request resource reference. | |
requestor | Reference | The practitioner who is responsible for the services rendered to the patient. | |
outcome | queued|complete|error|partial | The outcome of a request for a reconciliation. | |
disposition | string | A human readable description of the status of the request for the reconciliation. | |
paymentDate | date | The date of payment as indicated on the financial instrument. | |
paymentAmount* | Money | Total payment amount as indicated on the financial instrument. | |
paymentIdentifier | Identifier | Issuer's unique identifier for the payment instrument. | |
detail | array(PaymentReconciliation_Detail) | Distribution of the payment amount for a previously acknowledged payable. | |
formCode | CodeableConcept | A code for the form to be used for printing the content. | |
processNote | array(PaymentReconciliation_ProcessNote) | A note that describes or explains the processing in a human readable form. |
Response
keyboard_arrow_down