Patient Access API

Opala’s Patient Access API enables third-party app developers to create applications that can be used by patients and healthcare organizations to access meaningful medical data. After a developer registers an application, it can be downloaded from Opala's App Gallery.

  • The Opala API follows the SMART App Launch Framework for the HL7 FHIR Release 4 specification.
  • The Opala API supports HL7 FHIR, DaVinci (PDex), and CARIN for Blue Button®.

Opala’s API provides a robust Master Patient Index, OAuth 2.0 security, a cloud-based data repository, and access to FHIR-based resources.

Patient Access API Overview

Payer-to-Payer Data Exchange

For members, this feature enables them to initiate the transfer of healthcare information from a previous payer to their current payer. The member enters their information on Opala's white-labeled Health Data Transfer page, then logs into their account with the previous payer. For a payer's data to be available for members to transfer, the payer must be registered with Opala. If a payer is not registered, the member can request registration from this page.

For payers, this feature enables them to register as a payer administrator with Opala. Once Opala approves the registration, the payer’s connection details can be applied in our Payer-to-Payer Exchange or incorporated into your payer application for member access to our API.

Developer Portal

Please note that the Developer Portal is accessed by both the developer and the payer administrator. Both developers and administrators can use the Developer Portal to access their Sandbox settings. Developers can also use the portal to register their applications with Opala, while payer administrators can register as a client to get access to Opala’s payer-to-payer exchange.

Provider Directory

The Provider Directory is a publicly accessible API that does not require any registration or authorization to access. It conforms to the HL7 FHIR Da Vinci PDex Plan Net IG.


Access the API Documentation

If you have any questions, contact us at (206) 902-3380 or

Getting Started

Opala assumes that any developer working with the Patient Access API is familiar with the HL7 FHIR Release 4 specification. If a developer is not familiar with FHIR Release 4, or needs to look up something pertaining to a resource, each topic in the documentation set for the Opala APIs contains links to the relevant sections of the FHIR specification.

If you are ready to begin working with Opala's APIs, you must first:

1. Create an account with Opala. Information Popup

2. Register one or more applications. Information Popup

Create Opala Account & Register Application