Contact Us

Patient Access API

Opala's Patient Access API

Opala’s Patient Access API and the Patient Access API Documentation Set assume that developers are familiar with FHIR and the CARIN for Blue Button® implementation guide.

The Patient Access API is required to be protected by the OpenID Connect flow of the OAuth 2.0 specification. Developers must include a valid JWT in the Authorization header of each HTTP GET request when testing or accessing the API. This requirement ensures Opala’s Patient Access API complies with OAuth 2.0 and OpenID Connect standards.

Before any development starts, you must have the following to help set up the project and begin accessing Opala’s Patient Access API:

  1. Client credentials — a client ID and secret generated when you register your application in the Opala Developer Portal.
  2. Authorization URL — the endpoint used to initiate the authorization workflow, which includes user authentication.
  3. Redirect URIs — a set of return URLs registered for your application. During the OIDC flow, the application specifies which redirect URI to use from this pre-approved list.

Developer Portal

Opala’s Developer Portal has information on registering your application with Opala and API Documentation.

Registering with Opala enables you to access Opala’s APIs from your application. Once you complete your registration and approval, you will receive the connection details that can be applied to access Opala’s Patient Access API.3rd party apps will be available on Opala’s App Gallery post approval.

App Registration

  • Download the app registration PDF form from the developer portal.
  • Complete and sign the form. Submit to Opala for app registration processing and approval.

More detailed information on registering your application is available at Getting Started.

Supported Standards

The Opala API supports HL7 FHIR Release 4 specification, Da Vinci Payer Data Exchange (PDex), and CARIN for Blue Button®.

Opala follows the SMART App Launch Framework.

Important! The documentation for this API assumes that you are familiar with the HL7 FHIR Release 4 specification. If you are not, each topic in the documentation contains links to the referenced sections of the FHIR specification.

Resources

Use the Introduction section to review the resources and interactions. See the Working with Opala’s APIs section in Getting Started to review API queries supported by the Opala API.

The API currently provides data for the following resources:

  • Coverage
  • ExplanationOfBenefit
  • Observation
  • Organization
  • Patient
  • AllergyIntolerance
  • CarePlan
  • CareTeam
  • Condition
  • DiagnosticReport
  • DocumentReference
  • Encounter
  • Goal
  • Immunization
  • MedicationRequest
  • Practitioner
  • Procedure
  • ServiceRequest
  • More coming soon!