The FHIR R4 Location resource describes the physical or virtual place where healthcare services are provided. This includes clinics, hospitals, departments, and telehealth service locations. It is commonly referenced by other resources like Encounter, PractitionerRole, and Organization.
Use Cases
- Identify the facility where a patient was seen or treated
- Associate a provider with a specific service location
- Filter encounters or appointments by location
Base URLs
- Production: https://api.healthgorilla.com/fhir/R4/Location
- Sandbox: https://sandbox.healthgorilla.com/fhir/R4/Location
Authentication
All requests require OAuth 2.0 authentication using a Bearer Token. Unauthorized requests return 401 Unauthorized responses.
Required Scope: location.read for GET
For more information, go to: OAuth 2.0 Authentication.
Supported Methods
| Method | Operation | Description |
|---|---|---|
GET | Read Location | Retrieves a specific Location record by its FHIR ID. |
GET | Search Location | Searches for Location records based on supported parameters. |
Frequently Used Search Parameters
| Parameter | Description | FHIR Value Set / Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
name | Filters by location name | "Downtown Clinic" | string | No |
address | Matches any part of the address (street, city, zip, etc.) | "Sunnyvale" | string | No |
identifier | Filters by facility identifier | 1234567 | token | No |
organization | Filters by the managing organization | Organization/{id} | Reference | No |
_id | Filters by the Location resource ID | Location/{id} | token | No |
Commonly Returned Resource Attributes
| Attribute | Description | Example Values | FHIR Data Type | Required |
|---|---|---|---|---|
id | Unique FHIR ID for the location | 6b2a8a16-2131-49fb-b5f7-ef8cfe2a9a6c | id | Yes |
name | Name of the location | "Health Gorilla Main Clinic" | string | No |
status | Whether the location record is currently active | active, suspended, inactive | code | No |
mode | Indicates instance vs kind | instance, kind | code | No |
type | Type of facility or location | outpatient clinic, lab, pharmacy | CodeableConcept[] | No |
address | Physical or mailing address | City, state, postal code, etc. | Address | No |
telecom | Contact information | Phone, fax | ContactPoint[] | No |
managingOrganization | Organization responsible for the location | Organization/{id} | Reference(Organization) | No |
partOf | Larger location that this is a part of | Location/{id} | Reference(Location) | No |
position | Latitude and longitude | latitude: 37.37, longitude: -122.03 | Location.position | No |
Webhooks
Location resources are not directly monitored via webhook. However, they may appear in webhook payloads for Encounter, PractitionerRole, or Appointment resources.
For more information, go to: Webhooks & Polling.
Error Handling
All Location operations follow standard Health Gorilla error handling, including use of FHIR OperationOutcome for structured responses.
For more information, go to: Error Handling.