Health Gorilla APIs provide access to patient clinical data, documents, diagnostic results, and ordering workflows using the HL7® FHIR® standard, extended with Health Gorilla resources where FHIR defines no equivalent. Use the navigation to explore available resources, operations, and platform capabilities.
API Versions
Health Gorilla supports two FHIR-based API versions:
- FHIR R4 (Recommended): Primary API for new integrations
- FHIR STU3 (Legacy): Maintained for legacy workflows
If you are starting a new integration, use FHIR R4.
How to Use This Reference
The API Reference is organized by domain and resource. Most resources are FHIR resources, but some are Health Gorilla extensions that the FHIR specification does not define.
- Platform Foundations: Authentication, errors, async processing, and shared behaviors
- Patient Clinical Data: Patient records and structured clinical data (e.g., Patient, Observation, Condition)
- Documents & Results: Clinical documents and reports (e.g., DocumentReference, Binary, DiagnosticReport)
- Orders & Fulfillment: Ordering workflows and diagnostic services (e.g., ServiceRequest)
Each resource page includes:
- Overview and common use cases
- Available endpoints (GET, POST, PUT, DELETE)
- Supported search parameters
- Resource-specific behavior and notes
Some resources may include additional operations for extended functionality.
Common Workflows
Developers typically use the API in the following patterns:
- Retrieve patient data: Patient Clinical Data
- Work with documents: Documents & Results → DocumentReference → Binary
- Discover data sources: Documents & Results → Record Locator Service (List)
- Place and manage orders: Orders & Fulfillment