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 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 OKresponse unless an error occurs. - PDF and C-CDA export are supported for eligible resources using the
$export-ccdaoperation or downloadable PDF endpoints. - The
$everythingoperation 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.