The Carequality Interoperability Framework has disparate, varied errors. Below, we describe common errors and the steps you can take below.
If you need extra support to resolve any Carequality issues, contact our Help Desk.
Code | Message | Notes |
---|---|---|
403 Forbidden | [OID] already exists. | |
403 Forbidden | Failed to parse request body as XML resource. | This error occurs because your request body has to contain: (a) at least one identifier element; (b) a valid type element; (c) at least one contact element (for implementer only); and (d) valid display names for any defined endpoints. |
403 Forbidden | id:[ID] is not valid. | For update or delete messages only. |
404 Not found. | The file you're looking for isn't found. | |
500 Internal Server Error | Parsing XML request error! | |
500 Internal Server Error | Your Organization Source contains a duplicate business! |
You may receive an error that states:
No subscriptions. Meta.Destinations needs to contain a destination from existing subscription.
This means that the endpoint you specified to receive the request is invalid. The ID for the receiving endpoint should be in the Meta.Destinations
array of your request. The ID differs based on the environment and the type of request.
If you receive this error, refer to the table below to make sure that you entered the correct ID.
Request purpose | Staging ID | Production ID |
---|---|---|
Query for/create/update/delete an organization | a07afe3b-d247-4415-827f-6837707e1b8b | 5d0fd248-6c52-4ad9-b907-ae10bf2dcc39 |
Search for a patient within the entire Framework | adf917b5-1496-4241-87e2-ed20434b1fdb | 97f2dc1d-c71b-43a7-a436-9b789d44c804 |
Search for a patient within a specific organization | 1ca254a8-8d42-4593-abb4-b21399d9de57 | 6391b961-55ae-430b-a789-cf575f03fca0 |
Search for a clinical summary/document | ec745338-8849-43ad-a7ce-4bc5bf1d8b89 | 628cbf79-1156-4923-b9d0-285906160ed6 |
Save patient details and documents to your repository | This is specific to your org—you can find the correct ID in the digital record retrieval wizard. | This is specific to your org—you can find the correct ID in the digital record retrieval wizard. |
You may receive an error that states:
Repository URL and certificate are required. Review destination configuration.
This means that we we couldn't find the organization specified in your request. This can happen if:
The last possibility may be the case for organizations like EMS vendors or specialty pharmacies.
If you find a match via PatientSearch then try the ClinicalSummary.PatientQuery, you may receive an error that states:
Something Went Wrong Retrieving The Document List. Error: Could Not Find Any Documents.
This occurs when the organization doesn't have any documents available for the patient. In these cases, it's possible that patient consent is missing or that the patient is registered but hasn't had a visit yet, so there isn't any clinical data available.
If you expect documents but aren't getting any, contact our Help Desk so that we can reach out to the relevant implementers and Carequality participants.
You may receive an error that states:
Request received a response with status code 504
.
Socket hang up
Client network socket disconnected before secure TLS connection was established.
This may occur as different systems undergo maintenance or small outages.
Given that these connectivity errors are typically temporary, we recommend retrying the request. If you see persistent problems with an organization, contact our Help Desk.
You may see any of these certificate errors:
Unable to verify the first certificate
or
Unable to get local issuer certificate
This means that the organization you're requesting data from incorrectly installed its certificate and security is compromised.
You may also see:
Self signed certificate in certificate chain
This means that the organization you're requesting data from installed the wrong certificate.
Connectivity with the Carequality Interoperability Framework depends on mutual TLS authentication to ensure security. The certificates issued by Carequality need to be refreshed and reinstalled periodically.
If you see any certificate errors, contact our Help Desk so that we can reach out to the relevant implementers and Carequality participants.
If you're responding to incoming requests, you can return granular errors by responding with the following format:
{"body": {"XDSErrors": [{"code": "XDSUnknownPatientId","message": "Patient Not Found."}]}}
In the body.XDSErrors.code
field, you can return any of the following errors :
XDSRepositoryOutOfResources
XDSRepositoryBusy
XDSRepositoryError
XDSUnknownPatientId
In the body.XDSErrors.message
field, you can include any additional information you want to relay back to the sender about the error.