Overview of Clinical Payments Integration

Siebel Clinical provides the ability to integrate the processing of Siebel Clinical payments with third-party applications. The following integration processes facilitate this integration:

• Sending a payment request for processing. The payment request records in Siebel Clinical can be sent to a third-party application for processing and payment. The Status field for the payment request is updated to Waiting for Acknowledgement when the payment request is submitted.

• Capturing the delivery status of a payment request. The delivery status of the payment request is processed as follows:

  • Waiting for Acknowledgement. This Status field for the payment request is updated to Waiting for Acknowledgement when the Siebel workflow successfully writes the payment message to the JMS (Java Message Service) queue.

  • Request Failed. This Status field for the payment request is updated to Request Failed when writing to the JMS queue fails, and an error message appears.

  • Submitted. This Status field for the payment request is updated to Submitted when the payment request is successfully delivered to the third-party application from the JMS queue.

• Capturing feedback for a payment request. Feedback information from the third-party application is captured in the Feedback field for the payment request.

• Capturing final payment data. Final payment information, such as check number, and check amount, is captured from the third-party application, and the Status field for the payment request is updated to Paid.

The Status field for the payment request triggers the integration processes. Table 17-1 describes the status values for the integration.

Table 17-1 Payment Request Statuses for Clinical Payments Integration

Status	Description
To Be Processed	The payment request is created, but processing is not yet started. This status is the default value for all new payment requests. The payment request is not yet submitted to the third-party application.
In Progress	Processing of the payment request is in progress. The payment request is not yet submitted to the third-party application.
To Be Submitted	The payment request is ready to be submitted to the third-party application for processing. This status value triggers the LS Clinical Payments Outbound workflow to send the payment request to the third-party application.
Waiting for Acknowledgement	The Status field for the payment request is automatically updated to Waiting for Acknowledgement when the payment request is submitted
Submitted	This value is automatically populated when the payment request is successfully delivered to the third-party application from the JMS queue.
Request Failed	This value is automatically populated when writing to the JMS queue fails.
Withdraw	You manually populate this status. You can set a Withdraw status for a payment request that has a status of Waiting for Acknowledgement or Submitted.
Rejected	This value is automatically populated when the third-party application rejects the payment request. You cannot manually change this value.
Paid	This value is automatically populated by the third-party application when a payment is made. The Status field for the payment request becomes read-only after it is set to Paid.
Processed	This value is not applicable to Siebel Clinical payments integration.
Update Failed	This value is not applicable to Siebel Clinical payments integration.