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
| Official URL: https://fhir.huli.ai/r4/CapabilityStatement/huli-server | Version: 0.1.0 | |||
| Active as of 2026-01-01 | Computable Name: | |||
Declared capabilities of the Huli Public FHIR R4 API at https://api.huli.io/fhir/R4.
Raw OpenAPI-Swagger Definition file | Download
jsonNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
serverSMART-on-FHIRThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | D | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|
| Patient | y | y | y | y | _id, identifier, name, gender, birthdate, active, _count, _cursor | $everything, $match | ||||
| Appointment | y | y | y | y | _id, patient, practitioner, date, status, appointment-type, _count, _cursor | |||||
| Encounter | y | y | y | y | _id, patient, practitioner, date, status, class, _count, _cursor | |||||
| Observation | y | y | y | y | _id, patient, encounter, code, date, status, category, _count, _cursor | |||||
| MedicationRequest | y | y | y | y | patient, encounter, _count, _cursor | |||||
| ServiceRequest | y | y | y | patient, encounter, _count, _cursor | ||||||
| Composition | y | y | y | y | _id, patient, type, date, _count, _cursor | |||||
| DocumentReference | y | y | y | y | patient, type, category, date, _count, _cursor | $upload | ||||
| Practitioner | y | y | name, _count, _offset | |||||||
| Organization | y | y | _id | |||||||
| Subscription | y | y | y | y | y | _id, status, _count, _offset | $replay, $stats, $deliveries | |||
| Location | y | y | _id, _count, _offset | |||||||
| HealthcareService | y | y | _id, _count, _offset | |||||||
| PractitionerRole | y | y | _id, practitioner, location, _count, _offset | |||||||
| Schedule | y | y | _id, actor, service-type, _count, _offset | |||||||
| Slot | y | schedule, actor, start, end, _count, _offset | ||||||||
| Device | y | y | _id, _count, _offset | |||||||
| CodeSystem | y | |||||||||
| ValueSet | $expand |
read, search-type, create, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | identifier | token | |
| SHALL | name | string | |
| SHALL | gender | token | |
| SHALL | birthdate | date | |
| SHALL | active | token | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $everything | |
| SHALL | $match |
read, search-type, create, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | patient | reference | |
| SHALL | practitioner | reference | |
| SHALL | date | date | |
| SHALL | status | token | |
| SHALL | appointment-type | token | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create, update.Every encounter records its location: send location[0].location as a Location/[id] reference to one of the practitioner's locations (PractitionerRole.location). It may be omitted when the practitioner works at exactly one location, or when the encounter is bound to an appointment that has a location; sent with such an appointment, it must be the appointment's location. Otherwise the create is refused with 422 HPB-00150, or with 422 HPB-00151 when the practitioner has no location assigned. Under la normativa (the Mexican regulation) what counts is the practitioner's normativa configuration: a location configured for them is accepted, one that is not is refused with 403 HPB-00141. Create-only: an update cannot change it or add one.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | patient | reference | |
| SHALL | practitioner | reference | |
| SHALL | date | date | |
| SHALL | status | token | |
| SHALL | class | token | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | patient | reference | |
| SHALL | encounter | reference | |
| SHALL | code | token | |
| SHALL | date | date | |
| SHALL | status | token | |
| SHALL | category | token | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | encounter | reference | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | encounter | reference | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create, update.Creating a Composition creates its encounter, which records a location but carries none on this resource: for a practitioner working at more than one location, a POST is refused with 422 HPB-00150 (or 403 HPB-00141 under la normativa when none of their locations is configured for them). Create the Encounter with its location first, then write the note with PUT Composition/[id] using the encounter's id; a POST always creates a new encounter.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | patient | reference | |
| SHALL | type | token | |
| SHALL | date | date | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | type | token | |
| SHALL | category | token | |
| SHALL | date | date | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $upload |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | name | string | |
| SHALL | _count | number | |
| SHALL | _offset | number |
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token |
read, search-type, create, update, delete.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | status | token | |
| SHALL | _count | number | |
| SHALL | _offset | number |
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $replay | Re-enqueue past events in a [from,to] window for outage recovery / backfill (POST; requires system/Subscription.crud). |
| SHALL | $stats | Per-subscription delivery metrics: delivered/failed/pending/dead, DLQ depth, success rate, latency p50/p95 (GET; requires system/Subscription.rs). |
| SHALL | $deliveries | Recent delivery-attempt trail, sanitized — never the payload/endpoint/secret (GET; requires system/Subscription.rs). |
Authorized by the SMART scope
system/Appointment.rs. This resource inherits an existing scope — no per-resourcesystem/Location.*scope is minted; requesting one is rejected.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | _count | number | |
| SHALL | _offset | number |
Authorized by the SMART scope
system/Appointment.rs. This resource inherits an existing scope — no per-resourcesystem/HealthcareService.*scope is minted; requesting one is rejected.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | _count | number | |
| SHALL | _offset | number |
Authorized by the SMART scope
system/Practitioner.rs. This resource inherits an existing scope — no per-resourcesystem/PractitionerRole.*scope is minted; requesting one is rejected.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | practitioner | reference | |
| SHALL | location | reference | |
| SHALL | _count | number | |
| SHALL | _offset | number |
Authorized by the SMART scope
system/Appointment.rs. This resource inherits an existing scope — no per-resourcesystem/Schedule.*scope is minted; requesting one is rejected.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | actor | reference | |
| SHALL | service-type | token | |
| SHALL | _count | number | |
| SHALL | _offset | number |
Authorized by the SMART scope
system/Appointment.rs. This resource inherits an existing scope — no per-resourcesystem/Slot.*scope is minted; requesting one is rejected.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | schedule | reference | |
| SHALL | actor | reference | |
| SHALL | start | date | |
| SHALL | end | date | |
| SHALL | _count | number | |
| SHALL | _offset | number |
Authorized by the SMART scope
system/Appointment.rs. This resource inherits an existing scope — no per-resourcesystem/Device.*scope is minted; requesting one is rejected.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | |
| SHALL | _count | number | |
| SHALL | _offset | number |
Terminology resource. Scope is enforced per CodeSystem id by the handler (e.g.
address-source→system/Patient.rs,org-service→system/Appointment.rs).
Terminology operation. Scope is enforced per ValueSet
urlby the handler (cancellation-reason →system/Appointment.rs, observation-loinc →system/Observation.rs, mx-* →system/Patient.rs).
| Conformance | Operation | Documentation |
|---|---|---|
| SHALL | $expand |