Set up Redox Access

Last updated: Apr 30, 2024

With Redox Access™, you can perform these API actions while integrating with the Carequality Interoperability Framework:

  • Search for a patient with demographics: Find organizations that have a record for your patient and obtain demographics and identifiers.
  • Retrieve patient documents: Retrieve patient summaries and other clinical documents.

Before you can use these API actions, though, you must complete some "pre-work."

Qualify for Carequality

Before you can use Redox Access, you must qualify to be a Carequality participant. The qualifying process should begin before signing a contract with Redox. If you haven't qualified yet, reach out to your Redox sales rep to begin the qualifying process.

Carequality requires that you fill out a form prior to going live on the Carequality Framework. Organizations that meet the Treatment Purpose of Use will find the most value in joining since all participants must respond to your queries. Organizations with other Purposes of Use may join but may not receive responses from participants.

Set up credentials and OIDs

You'll work with Redox to set up the appropriate credentials and OIDs for working with Carequality. These are the things you'll need:

  • source identifier
  • API key
  • API secret
  • patient OID
  • organization OID
  • document OID
  • data on demand destination ID

What you'll do

  1. Refer to the API reference and complete dev work for using the relevant data models or FHIR® resources. You'll need these to query and write data to the Carequality Framework.
  2. Submit a tech validation ticket to being the testing process described in the next section. Learn about submitting pre-production tickets to the Redox Help Desk.

What Redox will do

  1. Set up your data on demand destination that you can push data to.
  2. Configure subscriptions to the Carequality Framework. You must have already created an OAuth API key for a Redoxer to complete this step.
  3. Provide all identifiers, or OIDs, for testing. This includes these OIDs. You can use these to test your integration with Carequality.
Request purposeStaging IDProduction ID
Search for a patient with Redox Accessadf917b5-1496-4241-87e2-ed20434b1fdb97f2dc1d-c71b-43a7-a436-9b789d44c804
Search for a patient within a specific organization1ca254a8-8d42-4593-abb4-b21399d9de576391b961-55ae-430b-a789-cf575f03fca0
Query for/create/update/delete an organizationa07afe3b-d247-4415-827f-6837707e1b8b5d0fd248-6c52-4ad9-b907-ae10bf2dcc39
Search for a clinical summary/documentec745338-8849-43ad-a7ce-4bc5bf1d8b89628cbf79-1156-4923-b9d0-285906160ed6
Save patient details and documents to your repositoryThis is specific to your org. Redox provides the correct ID.This is specific to your org. Redox provides the correct ID.

Technical validation

During the setup process for Redox Access, you'll want to perform technical validation. We provide a Postman collection and environment to use for testing, which you can get from the Redox technical account manager.

There are notes within the Postman collection to the right of most of the directories. These comments can help you decide between your options, explain the specific fields, and tell you what may change between production/staging environments or individual queries. The comments also indicate which environment variables change regularly. 

The values are found within the environment and include comments with the following prefixes:

Value prefix
Keep this value the same except when switching from staging to production.
Copy these unique-to-you values (provided by Redox) and paste in the Current Value field.
Enter this value based on your specific organization (i.e., your organization’s name).
Populates automatically, typically for ID or ID type fields. We do this by automatically saving any ID or ID type fields that you received from previous calls, then automatically populating for future calls.

To complete technical validation, you must send test messages to validate your system. We divide each of these tests into their own how-to:

Migrate to production

When you're done with tech validation, submit a go-live readiness ticket so that we can help you migrate to production.

After migrating to production, make sure to push patient demographics and visit details to your data on demand repository. This allows us to respond to incoming requests from other Carequality participants.