Huli FHIR Core Implementation Guide (R4)
0.1.0 - Release
Huli FHIR Core Implementation Guide (R4) - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
Location exposes the clinics, sites, and rooms a Huli organization operates,
sourced from the organization's locations. It is read-only on the Public
API: partners cannot create or update sites through the FHIR surface;
provisioning happens through the operator-facing platform.
Location is a discovery resource — its purpose is to let booking
clients resolve where an appointment can take place. Access is gated by
the booking scope system/Appointment.rs (see Terminology
for the scope-aliasing rule).
A room-type Location (physicalType = ro) is the bookable room an
Appointment references: the Appointment.participant room actor is a
Reference(Location) keyed on this same Location.id, so the reference an
integrator reads off an appointment resolves here via GET /Location/{id} and
the room appears in Location search — the discover → book loop closes entirely
through the API. (See Appointment mapping §Participants.)
| Interaction | Supported |
|---|---|
read |
Yes |
search-type |
Yes |
vread |
No |
update |
No |
patch |
No |
delete |
No |
history |
No |
create |
No |
Read by id via GET /fhir/R4/Location/{id}; list via
GET /fhir/R4/Location (offset pagination: _count, _offset).
| Huli concept | FHIR path | Cardinality | Notes |
|---|---|---|---|
| Location id (UUID) | Location.id |
1..1 | UUID of the clinic / site / room within Huli |
| Last update | Location.meta.lastUpdated |
0..1 | Set by the platform |
| Active status | Location.status |
0..1 | active for in-service sites; inactive for retired ones |
| Site / room name | Location.name |
1..1 | Display name |
| Site vs room | Location.physicalType |
0..1 | http://terminology.hl7.org/CodeSystem/location-physical-type (si/ro) |
| Postal address | Location.address |
0..1 | Emitted for clinics/sites that carry one |
| Parent site | Location.partOf |
0..1 | A room references its parent site; a site references the organization |
| Parameter | Type | Notes |
|---|---|---|
_id |
token | Exact id match |
_count |
number | Page size |
_offset |
number | Offset pagination |