API Reference

About FHIR STU3

Health Gorilla’s FHIR STU3 implementation supports asynchronous, document-centric workflows for retrieving clinical data from multiple sources. This version is ideal for use cases involving:

  • Longitudinal health record aggregation
  • Discharge summaries and CCD documents
  • Patient360 queries and bulk record packaging

FHIR STU3 is used in our asynchronous APIs, including Patient360 (POST /fhir/STU3/DocumentReference/$p360-retrieve) and $everything exports. All resources follow the HL7® FHIR® STU3 specification with Health Gorilla–specific behavior and extensions where applicable.

Tip: If your calls begin with /fhir/STU3/..., you're using the STU3 version of the API.

Base URLs

  • Production: https://api.healthgorilla.com/fhir/STU3
  • Sandbox: https://sandbox.healthgorilla.com/fhir/STU3

FHIR STU3 Resource Capabilities

The table below summarizes method support for the FHIR STU3 resources in the Health Gorilla API.

ResourceReadSearchPDF Export$everything$p360-retrieve$merge
AllergyIntolerance✅✅✅
Bundle✅
CarePlan✅✅✅
ClinicalNote✅✅✅✅
Composition✅✅
Condition✅✅✅
Consent✅✅✅
Coverage✅✅✅
DeviceUseStatement✅✅✅
DiagnosticReport✅✅✅✅
DocumentReference✅✅✅✅✅✅
ElectronicFax✅✅✅✅
Encounter✅✅✅
FamilyMemberHistory✅✅✅
Goal✅✅✅
Immunization✅✅✅
InstantMessage✅✅
MedicationDispense✅✅✅
MedicationRequest✅✅✅
MedicationStatement✅✅✅
NutritionOrder✅✅✅
Observation✅✅✅
Organization✅✅
Patient✅✅✅✅
Practitioner✅✅
PractitionerRole✅✅
ProcedureRequest✅✅
Procedure✅✅✅
ProcedureRequest✅✅✅
RecordLocatorService✅
ReferralRequest✅✅
RequestGroup✅✅✅✅
Subscription✅✅
TelephonicEncounter✅✅

Notes:

  • All operations in the FHIR STU3 API are processed asynchronously. Responses may return 202 Accepted with a polling location or webhook notification.
  • PDF Export: Available via Binary resource, typically linked from a DocumentReference
  • $everything is included in Patient Everything queries
  • $p360-retrieve and $merge are included in Patient360 document workflows