Search
K
< Back

Prerequisites

Health Gorilla provides a FHIR-compliant RESTful API that enables secure access to healthcare data. The platform supports interoperability through standardized FHIR resources, OAuth 2.0 authentication, and mechanisms for data retrieval, writeback, and event-based notifications. Before beginning development, make sure your environment is provisioned, your credentials are issued, and your access model is fully defined.

Use the Correct Base URL

Health Gorilla provides separate base URLs for each environment and FHIR version. Match the appropriate URL to your environment and version to ensure correct API behavior.

EnvironmentFHIR R4 Base URLFHIR STU3 Base URL
Sandboxhttps://sandbox.healthgorilla.com/fhir/R4/https://sandbox.healthgorilla.com/fhir/3.0.1/
Productionhttps://api.healthgorilla.com/fhir/R4/https://api.healthgorilla.com/fhir/3.0.1/

Obtain OAuth Credentials

All API access requires OAuth 2.0 client credentials. Health Gorilla Support will provision the following for you:

  • Client ID
  • Client Secret
  • User Key (if required for your implementation)

These credentials are used to request access tokens for authenticating API calls. Store them securely and request separate credentials for each environment.

Confirm Feature Provisioning

Before testing your integration, verify that your tenant is licensed and provisioned for the features you plan to use. Health Gorilla Support handles this configuration.

Common features include:

  • Patient360 queries
  • Clinical Alerts and webhook delivery
  • HL7 ADT notifications
  • Diagnostic ordering and results retrieval

Prepare Required Scopes

Scopes determine which FHIR resources your application can access. These are assigned during implementation and control read, write, and subscription access.

Examples include:

  • patient.read
  • documentreference.read
  • observation.write
  • patient360

Validate Integration Requirements

Before continuing, confirm that:

  • Your environment (sandbox or production) is selected and configured
  • Your OAuth credentials have been issued by Health Gorilla
  • Required product licenses are enabled on your tenant
  • Your scopes match your intended use case

Once confirmed, you are ready to authenticate and make your first API call.