FHIR R4 Overview

Health Gorilla supports the HL7® FHIR® R4 standard to enable on-demand access to structured clinical data.

FHIR R4 is recommended for workflows that require:

Point-of-care data retrieval
Interactive patient queries
Integration with FHIR-native systems

FHIR R4 is used in synchronous APIs, including resource-specific operations (for example, GET /fhir/R4/AllergyIntolerance) and system-level queries. All resources follow the FHIR R4 specification and may include Health Gorilla–specific extensions where applicable.

FHIR API

The Health Gorilla FHIR API provides secure, standards-based access to clinical data using the FHIR R4 specification. It uses RESTful endpoints, JSON-encoded responses, standard HTTP verbs, and OAuth 2.0 bearer-token authentication.

You can work in sandbox or production mode. Sandbox mode lets you test integrations without accessing live clinical data; the credentials you use determine the environment.

Each endpoint corresponds to a FHIR resource such as Patient, Observation, or DocumentReference, and follows the FHIR R4 specification.

The API supports asynchronous operations for long-running tasks, including bulk data exports and event-driven alerts delivered through FHIR Subscriptions. Asynchronous methods are recommended for scalability and performance.

The API evolves continuously to align with TEFCA and USCDI requirements, and supported capabilities may vary by tenant or environment.

FHIR STU3 vs. FHIR R4

FHIR R4 is the current standard used across Health Gorilla APIs. It replaces earlier STU3 implementations by formalizing resource definitions, improving consistency, and reducing the need for custom extensions. While overall workflows remain the same, R4 introduces standardized resources such as RequestGroup and ServiceRequest for orders, and provides stronger support for versioning, terminology alignment, and event notifications through FHIR Subscription.

Note: All new integrations are configured using FHIR R4. STU3 endpoints are maintained for backward compatibility only.

Base URLs

Production: https://api.healthgorilla.com/fhir/R4
Sandbox: https://sandbox.healthgorilla.com/fhir/R4

Supported Resources and Operations

Resource	Read	Search	Create	Update	Delete	Export (PDF/CCDA)
`AllergyIntolerance`	✅	✅	✅	✅	✅
`Bundle`	✅
`CarePlan`	✅	✅	✅	✅	✅
`Composition`	✅
`Condition`	✅	✅	✅	✅	✅
`Consent`	✅	✅	✅	✅	✅
`Coverage`	✅	✅	✅	✅	✅
`DeviceUseStatement`	✅	✅	✅	✅	✅
`DiagnosticReport`	✅	✅	✅	✅	✅	✅
`DocumentReference`	✅	✅	✅	✅	✅	✅
`ElectronicFax`	✅	✅	✅	✅	✅	✅
`Encounter`	✅	✅	✅	✅	✅
`FamilyMemberHistory`	✅	✅	✅	✅	✅
`Goal`	✅	✅	✅	✅	✅
`Immunization`	✅	✅	✅	✅	✅
`InstantMessage`	✅	✅
`Location`	✅	✅
`MedicationDispense`	✅	✅	✅	✅	✅
`MedicationRequest`	✅	✅	✅	✅	✅	✅
`MedicationStatement`	✅	✅	✅	✅	✅
`NutritionOrder`	✅	✅	✅	✅	✅
`Observation`	✅	✅	✅	✅	✅
`Organization`	✅	✅
`Patient`	✅	✅	✅	✅		✅
`Practitioner`	✅	✅
`PractitionerRole`	✅	✅	✅	✅	✅
`Procedure`	✅	✅	✅	✅	✅
`Provenance`	✅
`RequestGroup`	✅	✅	✅	✅		✅
`ServiceRequest`	✅	✅	✅	✅		✅

Notes:

All R4 API operations are synchronous. Clients typically receive a 200 OK response unless an error occurs.
PDF and C-CDA export are supported for eligible resources using the $export-ccda operation or downloadable PDF endpoints.
The $everything operation retrieves a patient’s complete record.
Resource availability may vary based on your licensed capabilities and permitted use cases. Contact your Health Gorilla for details.
For the full HL7 FHIR R4 specification, visit fhir.org.