Integration Options

Use OneRecord API

There are multiple ways to integrate with OneRecord API, depending on your solution's requirements and desired level of customization. Each integration method requires securely configured back-end to back-end communication to ensure the proper handling of sensitive healthcare data. This guide will outline two primary integration options:

1. From your Backend services
2. Through OneRecord Workflows

Integrating from your Backend services is the traditional way to securely connect two systems via an API. On the other hand, OneRecord Workflows expands upon this concept, making development easier while still keeping the connection through the API hidden and secure via a lightweight backend. Workflows provide custom-built UI flows that execute API transactions for you.

Option 1: From Your Back End Services

When accessing OneRecord API through your backend services, your development team has full freedom to customize your solution to your own needs, interfacing with OneRecord API only when necessary to interact with healthcare data. To use this option, build your full stack solution's app or website around your own requirements and securely store the API Access Tokens for your solution's OneRecord API Device(s) in an encrypted secrets vault within your secure backend. Device keys should never be stored within code or uploaded to version control repositories. When working with healthcare data, your solution should use these Device keys to authenticate with OneRecord API and gain access to the areas in the network configured for your account.

The solution's team is responsible for architecting and maintaining the system around your OneRecord API integration. It is essential to consider your solution's strategies for authenticating patients, retrieving data, de-duplicating data you may have already retrieved, refreshing granted patient access tokens, and other items outlined in "Planning Your Integration". OneRecord can provide tools and code examples, but it is primarily up to the solution provider to fully architect and understand their system and its relationship with healthcare interoperability networks.

Option 2: Through OneRecord Workflows

One benefit of using OneRecord Workflows is that they provide an easy and flexible plug-and-play solution, speeding up development time by leveraging pre-built UI and API connections. Additionally, using OneRecord Workflows can help ensure consistency in user experience and data quality, as all OneRecord Workflows are built using the same standards and guidelines. These standards and guidelines are the result of rigorous user experience feedback loops, perfecting the use of OneRecord API through other OneRecord apps. However, Workflows have limits to customization and may not fit the specific needs of all custom solutions. By leveraging Workflows, development teams can focus on other critical aspects of their project, such as analyzing and utilizing the healthcare data retrieved from OneRecord API.

It's important to note that OneRecord Workflows still require a secure backend connection to OneRecord API. This connection ensures that no API Access Tokens need to be stored on the client, mitigating the risk of exposure. When using OneRecord Workflows, this connection to OneRecord API must be set up for the OneRecord Workflows to make API calls on your behalf. Your solution's backend securely manages this connection, providing an additional layer of security. For more information on setting this up, see the Workflows Documentation.

Choosing an Integration Option

It is possible (and advisable) to use both integration options in your solution. When deciding between using backend services or OneRecord Workflows for integrating with OneRecord API, there are several key factors to consider:

• Security: Backend integration is generally considered the most secure option, as sensitive information can be stored securely on the server side. OneRecord Workflows are also secure but provide less control over security features compared to backend integration.
• Data Processing: Backend integration provides more control over data processing and analysis, leveraging more powerful server-side computing resources. OneRecord Workflows, although providing a more seamless experience, have limited options for data processing. However, OneRecord is working on new OneRecord Workflows and tools to improve data processing capabilities as things move forward.
• Ease of Implementation: Backend integration may require more technical expertise and setup, which can make it more challenging to implement. OneRecord Workflows, on the other hand, offer a simpler plug-and-play solution.
• Use Case: Depending on the specific use case and requirements of the integration, one option may be more suitable than the other. For example, if data needs to be processed and analyzed offline, backend integration may be a better fit. OneRecord Workflows offer the most seamless solution for simpler use cases.

Overall, each integration option has its own unique benefits and drawbacks. It is important to evaluate the specific needs and requirements of your project to determine the best integration approach.