Carequality Interoperability Framework FAQ

Refer to these questions for help with digital record retrieval and integrating with Carequality.

Get started with digital record retrieval or sign up for a Redox account and explore the digital record retrieval tab in the Redox dashboard. Explore our network and the Carequality participants.

Integrating with Carequality

Can I reuse my Redox configuration for other integrations?

One easy-to-use Redox configuration can connect you to Carequality, as well as healthcare organizations, EHR systems, and other integration partners you may have. You can use the same requests to search for patients and clinical documents, allowing you to send data either directly to an individual EHR system or nationwide over the DirectTrust network.

Talk to a Redoxer if you have questions about connecting to these types of organizations.

Reference: Data model docs

Learn more about data models we support, including fields, requirements, and details for each one.

What about Commonwell and the eHealth Exchange?

Commonwell and eHealth Exchange are two of the nation’s largest centralized health information exchanges. Both are certified Carequality implementers with thousands of live sites, meaning that many of their sites can be queried through the Framework.

Can I push data or receive notifications when new data is available?

Pulling data is powerful for various use cases (e.g., emergency care), but it doesn’t solve all problems. Pushing data can be useful for provider-to-provider messaging, event notification, diagnostic test ordering, and referrals. While Carequality and Commonwell don’t currently support push notifications, we have other options to help you accomplish your goals. We can help you push data through the DirectTrust network and other technical means. Talk to a Redoxer to learn more.

Finding patients

Why can't I find patients in the sandbox?

To improve the robustness of our test system, we currently isolate it from the data that you push to Redox as a responder. This ensures the integrity and consistency of our test system, but comes at the cost of you not being able to find your own patients that you add to the Framework.

If you truly need to find your own patients/documents, you can search your data on demand repository using PatientSearch.Query, Clinical Summary.DocumentQuery, or ClinicalSummary.DocumentGet. In your request, just switch the destination.ID of the Framework to the repository.ID instead.

In this case, your IDs match exactly what you sent. Just note that this isn't the ID that appears on the Framework.

Why don't the IDs I use for patients and documents match what's in the Framework?

To guarantee uniqueness on the Framework, Redox assigns new IDs to all patients and documents that you send. So if you send a patient with ID 1234 or a document with ID 5678, you won't be able to find your own data on the Framework with those IDs.

If you want to retrieve the Framework-assigned IDs, you must perform a search with demographics to Redox, then find the documents for that patient. This also allows you to find data from other Carequality participants (that are connected via Redox) that may be for the same patient.

What are the best practices for finding patients? What demographic information should I include?

To locate an exact match, you must include all of these fields:

  • first name
  • last name
  • date of birth
  • sex/gender

And at least one of the additional data points below:

  • address
  • Social Security number
  • phone number(s)
  • email

As a best practice, we recommend that you include as much information as possible. Most responding systems use advanced matching algorithms that have higher success rates when more information is included.

If you receive a successful response to your PatientSearch.Query without any results, it typically means that there were no matching patients found. You may want to search with a smaller set of demographics or verify that the patient’s information is correct.

Can I search for a patient with an identifier?

You can search for a patient with an identifier if you have the specific patient ID and the matching OID that the organization uses to represent a patient OID type. For example, if using an MRN, you must have the OID that the organization uses to represent MRN. However, these OIDs are not typically known. Organizations often have a specific identifier for Carequality responses, so we recommend starting with a demographics search, even if you do already have an identifier.

If my patient search is taking awhile, how do I check if the query is still running?

When you use the PatientSearch.LocationQuery, our record locator service runs the search for you. However, it may take awhile to return all the results because record locator service has to send the request to each connection individually. You can always check the status of your search by looking for the value of the Meta.Extensions.task-status.string field, which contains a status of either Active or Success.

The process is asynchronously collecting locations.
The Patients array populates with any partial results as they become available.
The process has completed and all possible locations were found.
Any available results have been returned.
If the Patients array is empty, it means no patients were found.

The response waits up to 10 seconds to reach a Success state. If unable to reach Success in that time, the response retains an Active status. You can retry the exact request repeatedly until it reaches a Success state.

Review your search results later

To review the results of your search again later, you can provide the value returned in Meta.Extensions.task-id.string on subsequent requests.

Same demographics, same results

If you run a new search with the same patient demographics within a 24-hour period, you see the same results. Record Locator Service doesn't trigger a new search to your connections unless you have new or modified patient demographics.

Clinical documents

I’m getting a lot of documents back on the response. What can I do?

ClinicalSummary.DocumentQuery has a number of useful parameters you can use to limit the number of documents returned or to find the documents that are relevant for you. However, not all parameters are supported by all vendors. When supported, you can use the Visit.StartDate parameter to help you pull documents after a given date of service. Learn more about which fields are supported for this request.

Why does DocumentGet return the raw XML document?

Some customers have pre-built capabilities to render XML C-CDA documents. Additionally, there are many available open source CDA renderers that can be useful in viewing the document. We offer the option to return the XML document for this reason.

Check out these options for an open source C-CDA renderer:

Responding to Carequality

Can I respond to Carequality myself rather than using Redox as my responder?

Yes, you can respond to requests from Carequality participants yourself, but you won't qualify for digital record retrieval. Learn how to be your own responder.

What information does Redox store?

We store all requests to and from the Framework per our standard data retention policy. Learn more about our data retention policy.

In order to respond on your behalf to incoming requests, we store all of the data you push to our database for the life of your contract. This way, we have complete information with which to respond to incoming requests.

When do I have to push information to Redox for responses?

We require that you push data (via ClinicalSummary.VisitPush) to our database for every instance in which you treat a patient—but don’t worry, you don’t have to push data immediately after every treatment. For example, you're welcome to push a daily batch to us instead.

We also require any and all patient demographic updates so that we can keep your patient demographics current. This enables us to provide accurate responses to other Carequality participants when they send a request to find out whether a patient has been seen at your location.

Do I need to send historical data when using the responder?

Carequality requires that you respond to requests for patients that are known to you, but they don’t specify a definite period for providing historical information. We recommend that you begin pushing data once you register your organization in production and build your historical data from that point forward.

If you want to send historical data, you may not qualify for digital record retrieval. Talk to a Redoxer to discuss your needs.