Huli FHIR Core Implementation Guide (R5)
0.1.0 - Release
Latin America and the Caribbean
Huli FHIR Core Implementation Guide (R5) - 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/r5/CapabilityStatement/huli-server-r5 | Version: 0.1.0 | |||
| Active as of 2026-01-01 | Computable Name: | |||
Declared capabilities of the Huli Public FHIR R5 API at https://api.huli.io/fhir/R5.
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 | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | y | y | y | y | _id, identifier, name, gender, birthdate, active, _count, _cursor | $everything | |||
| 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 | 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, _offset | $upload | |||
| Practitioner | y | y | name, _count, _offset | ||||||
| Organization | y | y | _id | ||||||
| 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 |
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 |
read, search-type, create, update.Supports recurring appointments via the R5
recurrenceTemplateelement: POST with a recurrenceTemplate creates a series. Series edits select scope with the_recurrenceScopequery parameter (this|this-and-following|all) on the PUT; cancelling a series is a PUT with status=cancelled plus_recurrenceScope. GET/search echo the recurrenceTemplate and arecurrence-pattern-idextension for occurrences that belong to a series.
| 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.| 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, update.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | |
| SHALL | encounter | reference | |
| SHALL | _count | number | |
| SHALL | _cursor | string |
read, search-type, create, update.| 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 | _offset | number |
| 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 |
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 |