Overview

Health Gorilla provides secure, standards-based APIs for clinical data exchange, patient identity management, diagnostics, and real-time notifications. The APIs support RESTful FHIR, HL7 v2 messaging, and webhook-based delivery, with built-in access to national networks including Carequality, CommonWell, and TEFCA.

Core API behaviors include consistent authentication, environment selection, FHIR versioning, metadata tagging, and request safety mechanisms. Applying these patterns ensures reliable, standards-compliant workflows across all supported protocols.

Supported Protocols

Health Gorilla APIs support multiple protocol standards, enabling flexible integration across diverse health IT environments.

FHIR (Fast Healthcare Interoperability Resources) is the primary API standard for clinical data exchange, supporting both R4 (recommended) and STU3 versions to enable access to structured resources such as Patient, Observation, Encounter, and DocumentReference.
HL7 v2 is a traditional messaging protocol used primarily for ADT (Admission, Discharge, Transfer) notifications and lab result delivery, often integrated via MirthConnect.
SMART on FHIR is a secure application launch protocol that uses OAuth 2.0 to support contextual, consent-aware access for embedded user-facing applications.

API Interaction Models

Model	Description
RESTful Query	Standard request/response operations for FHIR resources.
Asynchronous Job Handling	Long-running tasks such as Patient360 retrieval or CCDA export.
Event Notification	Subscriptions or webhook notifications for new data.
SMART on FHIR Launch	Delegated authorization flow for launching apps from portals or EHRs.

Typical Use Cases

Retrieve comprehensive longitudinal records using $p360-retrieve
Generate structured document exports using $export-ccda
Subscribe to real-time alerts when patients have new encounters or results
Query clinical data such as medications, vitals, problems, and notes
Launch patient- or provider-facing applications with SMART on FHIR protocols