Welcome to the OneRecord API User Guide. In this guide you will find all sorts of useful information to help you on your way to successful connectivity with many data sources through our API.

What You'll Find Here

We have documentation describing various components of the system and how you interact with each. We have samples, best practices, information about demo data, data access flows, and references to relevant industry standards. Please read on to learn more about what is involved and how you can get started.

Familiarize yourself with our documentation and layout. In this guide you should find the information you need in a familiar and intuitive format. We strive to provide just the right amount of content in an easily digestible format.

We have a lot of information available, but our main goal is successful connectivity for your application. Below is a quick overview of our simple 3-step process. Let's get started!

3 Simple Steps to Successful Integration


Before you start building, you will need a key that is specific to your organization. Getting a key is easy. You must get your API key to initiate the process by filling out a simple form. Once completed, someone should contact you within 1-2 business days. If you need immediate assistance, drop us a note.


Before you have your key...

Test out the API and get familiar with it by using the Try It Now feature with the shared key that is automatically supplied there.

2. Build and Test

Try it now on our servers, then yours. First navigate to our API Guide and use the "Try it now" in the browser to get a feel for what API calls are available and what is returned. Following that, complete the same exercise, but this time from your local developer machine. You can use a tools such as Curl or Postman to do this. Third, download our SDK and UI test tool and build and test more from your local developer machine or your own application servers using a test organization setup configured for you in our servers.

We believe and understand the importance of having proper test data for you to use both during your initial exploration and, especially so, in your move to production. We provide sample patients and documents for you to work with to help resolve any issues you may find in your system before it becomes an issue in production.

3. Go Live!

After all of the above is complete you may be ready to consider moving to production. We take this move very seriously as you are now exchanging protected health information (PHI). Any mishandling of PHI has, potentially, severe consequences. To ensure you are adequately prepared for production, we have a certification process that you will need to go through. We describe this in further detail later in this guide.