Set up your onramp to TEFCA-CommonWell

With Network Onramps, you can integrate with TEFCA via CommonWell. Learn about TEFCA.

Before you get started, your organization has to go through a vetting process with TEFCA before being entered into their directory.

The aim of this vetting process is to ensure that your organization qualifies for the appropriate treatment (i.e., Purpose of Use) type. You can start this process during your onboarding to Redox or the beginning of your new implementation project with TEFCA.

The time for this process can vary, but you should plan for around 3 weeks for the full vetting process.

1. Your Technical Account Manager provides an organization submission form.
2. Fill out the submission form and include any documentation to demonstrate your right to be part of the Purpose of Use treatment type.
3. Return the form and any documentation to your Technical Account Manager.
4. We send your documentation to CommonWell for review.
   1. If requirements are met, you receive an approval email for your organization entry. Proceed to step #5.
   2. If requirements aren’t met, you receive a denial email. We will follow up within 3 business days to discuss why the organization entry wasn’t approved. You may be able to resubmit.
5. CommonWell submits all received entries to the Recognized Coordinating Entity (RCE). The entries are available for other QHINs to review. Any QHIN can file objections during the 10-day objection period. Either of these outcomes can occur:
   1. If an objection is raised, you receive a notification within 3 business days. CommonWell works directly with you to move you to a new process for further evaluation.
   2. If no objection is raised, your organization is allowed to be added to TEFCA. Proceed to step #6.
6. We provide a delegation notice to you, which would Redox as your delegate organization. Sign the notice to complete the vetting process.

You’ll work with Redox to set up the appropriate credentials and OIDs for working with TEFCA-CommonWell. These are the things you’ll need:

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

1. Create and authenticate an OAuth API key.
2. Refer to the API reference and complete dev work for using the relevant data models. You’ll need these to query and write data to TEFCA-CommonWell.
   • Organization.New
   • Organization.Update
   • PatientSearch.LocationQuery
   • ClinicalSummary.DocumentQuery
   • ClinicalSummary.DocumentGet
   • PatientAdmin.NewPatient
   • PatientAdmin.PatientUpdate
   • PatientAdmin.PatientMerge
   • ClinicalSummary.VisitQuery
   • ClinicalSummary.VisitPush
3. Submit a tech validation request to begin the testing process described in the next section (learn about submitting a tech validation request to Redox Help Center).

1. Set up your data on demand destination that you can push data to.
2. Configure subscriptions to TEFCA-CommonWell. 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. Learn about testing with the Network Onramps sandbox.

While setting up Network Onramps, you must perform tech validation. We provide a Postman collection and environment to use for testing, which you can get from your 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:

To complete tech validation, you must send test messages to validate your system. You'll want to test that you can perform the steps outlined in these how-tos, but to the sandbox environment:

1. Create and maintain your organization record.
2. Search for patient records.
3. Request patient documents.
4. Maintain your Redox repository.

When you’re done with tech validation, 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 us to respond to incoming requests from other TEFCA-CommonWell participants.