Retrieve a patient's transition of care document

If you want to access general clinical data for a patient, you can retrieve a transition of care document (CCD). Typically, you can use this for: 

  • getting a current snapshot of a patient as clinical background for determining treatment; or
  • learning details about a patient’s visit at another organization.

Patient identifier required

To use this API action, you must know the patient identifier. If you don’t, you must locate the appropriate identifier first. Learn how to search for a patient with demographics.

We recommend only using this API action for the two use cases above. For example, if you frequently work with another organization–by receiving transfers or seeing patients from that organization–this is a great option to get a summary of care. 

If you find that you only need pieces of data from the transition of care document, we recommend requesting only those pieces with more specific queries instead of retrieving a transition of care document.

Supported systems

You can use this API action with the Redox FHIR® API.

Talk to a Redoxer

It’s also possible to use the Redox Data Model API for this API action. Talk to a Redoxer to learn about your options if you want to use alternative integration methods.

Your connection's system can return results with their own FHIR®, SOAP-based CCD exchange, or query-based API. Or, they can use a push-based method, such as CCD push or Direct Trust messaging.

Using data on demand

It's possible that your connection's system can't support a query-based data exchange, but they may still be willing to provide results with a push-based method.

However, we understand that you may not want to store all that data—maybe you don't need all possible results and just want to query for what you want when you need it. If so, you can use this API action via our data on demand service, which stores the connection's data so that you can query from Redox "on demand." Learn more about data on demand.

Things you need to know

What's next?

Does this API action seem like a good fit for your unique workflow? If so, let your Redox rep know! You can begin development by downloading the relevant resource schema (which is noted in the relevant action step below), and deciding which data elements you need. Then head over to our Quickstart guide to dive right in.

If you're not engaged with our sales team yet, talk to a Redoxer to get started.

Action steps

Prerequisites

The following actions must be completed before attempting the steps below.

Steps

Retrieve a patient's document list

This table has notes about how to use parameters for this API action specifically, but it's not exhaustive. Refer to the resource schema for more details.

Query parameter
Required
Notes
patient
Y
You must include at least one identifier for the patient that's used by the EHR system you're querying. If you don't have a patient identifier, you can find one by searching for a patient with demographics.

Your search returns a list of related documents for one patient.

Query Response
Open dropdown
Open dropdown

Retrieve a patient's transition of care document

This table has notes about how to use parameters for this API action specifically, but it's not exhaustive. Refer to the resource schema for more details.

Parameter
Required
Notes
_id
Y
The document ID for the document you want to retrieve. This is located in the response that you received to the document list request.

When you search for a particular document, you receive the specified summary of care document for that patient.  

Canada URL

If you're operating in Canada, you must tweak the Redox hostname slightly. All you need to do is add a ca in that URL like this: https://api.ca.redoxengine.com.

Query Response
Open dropdown
Open dropdown