With an onramp to Carequality, you can search for and push patient data to the Carequality Interopability Framework. This article outlines how to set up your onramp:
- You must qualify to be a Carequality participant.
- You and Redox set up the appropriate credentials and IDs to work with Carequality.
- You must complete tech validation to test your setup with Carequality before going live.
- Migrate to production.
Review the details for each step below.
Before using Network Onramps, 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 before going live. 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 might not receive responses from participants.
An organization must be a Principal (i.e., a participant or sub-participant acting as a covered entity) to use the Treatment Purpose of Use. If your organization doesn’t meet the criteria for Principal and is a Delegate instead, you’ll need to get a validated Delegate Attestation from a Principal to meet the Treatment Purpose of Use. Talk to your Redox sales rep if you have any questions about the attestation process.
You’ll work with Redox to set up the appropriate credentials and identifiers for working with Carequality. These are the things you’ll need:
- source and destination IDs
- data on demand destination ID
- OAuth API key ID and secret
- OIDs for organization, patients, and documents (learn about OID structures)
- Refer to our API specs and complete dev work for the relevant Redox data models or Redox FHIR® resources. You’ll use these to query or write back data to Carequality.
- Supported Redox data models
- Supported Redox FHIR® resources
- Sets up a destination for your data on demand repository. This is where you’ll push your patient data and documents.
- Configures your subscription(s) to Carequality. You must have already created an OAuth API key for a Redoxer to complete this step.
- Provides all destination IDs for you to test any Carequality requests:
| Request purpose | Development ID | Production ID |
|---|---|---|
| Perform a broad patient search | adf917b5-1496-4241-87e2-ed20434b1fdb | 97f2dc1d-c71b-43a7-a436-9b789d44c804 |
| Perform a patient search within a specific organization | 1ca254a8-8d42-4593-abb4-b21399d9de57 | 6391b961-55ae-430b-a789-cf575f03fca0 |
| Query for/create/update/delete an organization | a07afe3b-d247-4415-827f-6837707e1b8b | 5d0fd248-6c52-4ad9-b907-ae10bf2dcc39 |
| Search for a clinical summary/document | ec745338-8849-43ad-a7ce-4bc5bf1d8b89 | 628cbf79-1156-4923-b9d0-285906160ed6 |
| Save patient details and documents to your data on demand repository | This is specific to your organization. Redox provides the destination ID for data on demand. | This is specific to your organization. Redox provides the destination ID for data on demand. |
Before go-live, you must perform tech validation. Learn about submitting a tech validation request to the Redox Help Center.
For your own testing, download the Postman collection and environment from the Redox dashboard. Navigate to the Developer page > Test Tools tab > Dev Tool Downloads tab. Under the Network Onramps heading, click the Collection and Environment buttons to download each one.
There are notes within the Postman collection to the right of most of the directories. These comments help you decide between your options, explain the specific fields, and tell you what may change between production/development 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 | Definition |
|---|---|
[Static] | Keep this value the same except when switching from development to production. |
[Provided] | Copy these unique-to-you values (provided by Redox) and paste in the Current Value field. |
[Input] | Enter this value based on your specific organization (i.e., your organization’s name). |
[Auto] | 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:
- Create and maintain your organization record.Multiple organizations
After Redox has reviewed your tech validation request, submit a go-live readiness request 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 Redox to respond to incoming requests from other Carequality participants.