In order to manage a referral with an API error, follow these steps:
From the Referral Inbox, within the yellow details banner, select View Referrals with integration errors. This will filter your Referral Inbox to only show referrals with API errors.
Under the Workflow column, click on the red error button on the referral. This will show you the error details for that specific referral.
Under the Response column, click the “view” link to review the error details and identify the cause. This will open a new tab with more information.
The new tab will show some code identifying the nature of the error. At the top of the text block you'll see an error http_code, usually in the 200s, 400s, or 500s.
400 error codes
Near the bottom of the text block there will be a section called
"text"
, telling you the error specifics, such as"'Primary Contact's Postal Code (Patient.contact[0].address.postCode)' is missing."
Return to your inbox and edit the referral to fix the issue as per the error message, such as correcting the patient’s address, and re-save the referral.
Once the referral is updated, Caredove will automatically trigger the updated message. There is no need to use the “Resend” button.
If the red error button still appears beside the referral, but the Response has been updated with a green checkmark, click the "Close and clear error" button at the bottom of the Integration Triggers window. This will clear the error from your inbox.
500 error codes
Click the blue “Resend” button only for errors with a 500-series status code, for example., 500, 502, 504, etc. Wait a few minutes for an update to appear on the same screen.
If a red x appears again, try one more time. Do not click the "Resend" button multiple times in a row.
If a green check mark appears, click the "Close and clear error" button at the bottom of the Integration Triggers window. This will clear the error from your inbox.
When to contact Caredove
If you have a 200-series error code
If you have a 400-series error code that does not have a clear error message
If you have a 500-series error code that does not clear after clicking "Resend"
Contact the Caredove support team by typing “Talk to a person” in the chatbox.