API Protocols
Health Gorilla’s platform provides a secure, standards-based foundation for nationwide clinical data exchange. It retrieves patient records on demand, normalizes and deduplicates them, and stores the results as structured FHIR resources for immediate use across all Health Gorilla products. The platform’s cloud-native architecture supports multiple delivery methods, diverse use cases, and strict compliance requirements.
FHIR R4
FHIR R4 is used for nearly all current workflows, including asynchronous clinical data retrieval, shareback operations, and message delivery through FHIR Subscription.
On-Demand Retrieval
FHIR R4 supports the full range of RESTful interactions.
- Send GET, POST, PUT, or DELETE requests to FHIR endpoints.
- Receive synchronous responses by default for smaller or targeted queries.
Event Notifications with FHIR Subscription
FHIR Subscription delivers event-based notifications when new or updated data becomes available.
- Create a Subscription for resources such as Encounter, Condition, or DocumentReference.
- Receive POST notifications to a secure HTTPS endpoint when matching resources are created or updated.
- Filter by resource type and query criteria.
- Each notification includes a full FHIR resource payload.
- If direct push delivery is not feasible, polling can be used to retrieve new data.
FHIR R4 resources conform to United States Core Data for Interoperability (USCDI) data classes and US Core profiles, and are required for all shareback operations.
HL7 v2
HL7 v2 is used to exchange event-driven data with hospitals, laboratories, and other systems.
- Health Gorilla accepts HL7 v2 ADT messages for admission, discharge, and transfer events.
- Lab orders and results are exchanged using standard HL7 segments.
- Connections are established over TCP/IP or Secure File Transfer Protocol (SFTP).
- HL7 v2 messages can be converted into FHIR resources for downstream use.
FHIR STU3 (Legacy)
FHIR STU3 is supported only for existing integrations. It enables historical $p360-retrieve operations with asynchronous polling.
Note: All new implementations must use FHIR R4.
Protocol Summary
| Protocol | Primary Use Case | Delivery Model | FHIR Version |
|---|---|---|---|
| FHIR R4 | On-demand retrieval and shareback | Asynchronous response or FHIR Subscription push | R4 |
| HL7 v2 | ADT and diagnostic messages | Event-driven messaging | N/A |
| FHIR STU3 | Legacy $p360-retrieve bulk aggregation | Asynchronous polling | STU3 |