Generated Narrative: CapabilityStatement huli-server-r5

Huli FHIR R5 Server Capabilities

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 5.0.0
  • Supported Formats: json
  • Published on: 2026-01-01
  • Published by: Huli

Note 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.

FHIR RESTful Capabilities

Mode: server

Security
Enable CORS: no
Security services supported: SMART-on-FHIR

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
Patient yyyy_id, identifier, name, gender, birthdate, active, _count, _cursor$everything
Appointment yyyy_id, patient, practitioner, date, status, appointment-type, _count, _cursor
Encounter yyyy_id, patient, practitioner, date, status, class, _count, _cursor
Observation yyyy_id, patient, encounter, code, date, status, category, _count, _cursor
MedicationRequest yyyypatient, encounter, _count, _cursor
ServiceRequest yyyypatient, encounter, _count, _cursor
Composition yyyy_id, patient, type, date, _count, _cursor
DocumentReference yyyypatient, type, category, date, _count, _offset$upload
Practitioner yyname, _count, _offset
Organization yy_id
HealthcareService yy_id, _count, _offset
PractitionerRole yy_id, practitioner, location, _count, _offset
Schedule yy_id, actor, service-type, _count, _offset
Slot yschedule, actor, start, end, _count, _offset

Resource Conformance: unspecified Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLidentifiertoken
SHALLnamestring
SHALLgendertoken
SHALLbirthdatedate
SHALLactivetoken
SHALL_countnumber
SHALL_cursorstring
 
Extended Operations
ConformanceOperationDocumentation
SHALL$everything

Resource Conformance: unspecified Appointment

Core FHIR Resource
Appointment
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Documentation

Supports recurring appointments via the R5 recurrenceTemplate element: POST with a recurrenceTemplate creates a series. Series edits select scope with the _recurrenceScope query 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 a recurrence-pattern-id extension for occurrences that belong to a series.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLpatientreference
SHALLpractitionerreference
SHALLdatedate
SHALLstatustoken
SHALLappointment-typetoken
SHALL_countnumber
SHALL_cursorstring
 

Resource Conformance: unspecified Encounter

Core FHIR Resource
Encounter
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLpatientreference
SHALLpractitionerreference
SHALLdatedate
SHALLstatustoken
SHALLclasstoken
SHALL_countnumber
SHALL_cursorstring
 

Resource Conformance: unspecified Observation

Core FHIR Resource
Observation
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLpatientreference
SHALLencounterreference
SHALLcodetoken
SHALLdatedate
SHALLstatustoken
SHALLcategorytoken
SHALL_countnumber
SHALL_cursorstring
 

Resource Conformance: unspecified MedicationRequest

Core FHIR Resource
MedicationRequest
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLencounterreference
SHALL_countnumber
SHALL_cursorstring
 

Resource Conformance: unspecified ServiceRequest

Core FHIR Resource
ServiceRequest
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLencounterreference
SHALL_countnumber
SHALL_cursorstring
 

Resource Conformance: unspecified Composition

Core FHIR Resource
Composition
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLpatientreference
SHALLtypetoken
SHALLdatedate
SHALL_countnumber
SHALL_cursorstring
 

Resource Conformance: unspecified DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • Supports read, search-type, create, update.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference
SHALLtypetoken
SHALLcategorytoken
SHALLdatedate
SHALL_countnumber
SHALL_offsetnumber
 
Extended Operations
ConformanceOperationDocumentation
SHALL$upload

Resource Conformance: unspecified Practitioner

Core FHIR Resource
Practitioner
Reference Policy
Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLnamestring
SHALL_countnumber
SHALL_offsetnumber
 

Resource Conformance: unspecified Organization

Core FHIR Resource
Organization
Reference Policy
Interaction summary
  • Supports read, search-type.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
 

Resource Conformance: unspecified HealthcareService

Core FHIR Resource
HealthcareService
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Authorized by the SMART scope system/Appointment.rs. This resource inherits an existing scope — no per-resource system/HealthcareService.* scope is minted; requesting one is rejected.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALL_countnumber
SHALL_offsetnumber
 

Resource Conformance: unspecified PractitionerRole

Core FHIR Resource
PractitionerRole
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Authorized by the SMART scope system/Practitioner.rs. This resource inherits an existing scope — no per-resource system/PractitionerRole.* scope is minted; requesting one is rejected.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLpractitionerreference
SHALLlocationreference
SHALL_countnumber
SHALL_offsetnumber
 

Resource Conformance: unspecified Schedule

Core FHIR Resource
Schedule
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

Authorized by the SMART scope system/Appointment.rs. This resource inherits an existing scope — no per-resource system/Schedule.* scope is minted; requesting one is rejected.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken
SHALLactorreference
SHALLservice-typetoken
SHALL_countnumber
SHALL_offsetnumber
 

Resource Conformance: unspecified Slot

Core FHIR Resource
Slot
Reference Policy
Interaction summary
  • Supports search-type.

Documentation

Authorized by the SMART scope system/Appointment.rs. This resource inherits an existing scope — no per-resource system/Slot.* scope is minted; requesting one is rejected.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLschedulereference
SHALLactorreference
SHALLstartdate
SHALLenddate
SHALL_countnumber
SHALL_offsetnumber
 
 <status value="active"/> <date value="2026-01-01"/> <publisher value="Huli"/> <contact> <name value="Huli"/> <telecom> <system value="url"/> <value value="https://huli.ai"/> </telecom> </contact> <description value="Declared capabilities of the Huli Public FHIR R5 API at https://api.huli.io/fhir/R5."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="419"/> <display value="Latin America and the Caribbean"/> </coding> </jurisdiction> <kind value="instance"/> <software> <name value="Huli FHIR API"/> <version value="dev"/> </software> <implementation> <description value="Huli FHIR R5 API"/> <url value="https://api.huli.io/fhir/R5"/> </implementation> <fhirVersion value="5.0.0"/> <format value="json"/> <rest> <mode value="server"/> <security> <extension url="http://fhir-registry.smarthealthit.org/StructureDefinition/oauth-uris"> <extension url="token"> <valueUri value="https://api.huli.io/auth/token"/> </extension> </extension> <service> <coding> <system value="http://terminology.hl7.org/CodeSystem/restful-security-service"/> <code value="SMART-on-FHIR"/> </coding> <text value="OAuth2 using SMART-on-FHIR profile (see http://docs.smarthealthit.org)"/> </service> </security> <resource> <type value="Patient"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="identifier"/> <type value="token"/> </searchParam> <searchParam> <name value="name"/> <type value="string"/> </searchParam> <searchParam> <name value="gender"/> <type value="token"/> </searchParam> <searchParam> <name value="birthdate"/> <type value="date"/> </searchParam> <searchParam> <name value="active"/> <type value="token"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> <operation> <name value="everything"/> <definition value="http://hl7.org/fhir/OperationDefinition/Patient-everything"/> </operation> </resource> <resource> <type value="Appointment"/> <documentation value="Supports recurring appointments via the R5 `recurrenceTemplate` element: POST with a recurrenceTemplate creates a series. Series edits select scope with the `_recurrenceScope` query 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 a `recurrence-pattern-id` extension for occurrences that belong to a series."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="practitioner"/> <type value="reference"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> </searchParam> <searchParam> <name value="appointment-type"/> <type value="token"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> </resource> <resource> <type value="Encounter"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="practitioner"/> <type value="reference"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> </searchParam> <searchParam> <name value="class"/> <type value="token"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> </resource> <resource> <type value="Observation"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> </searchParam> <searchParam> <name value="code"/> <type value="token"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> </searchParam> <searchParam> <name value="status"/> <type value="token"/> </searchParam> <searchParam> <name value="category"/> <type value="token"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> </resource> <resource> <type value="MedicationRequest"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> </resource> <resource> <type value="ServiceRequest"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="encounter"/> <type value="reference"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> </resource> <resource> <type value="Composition"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_cursor"/> <type value="string"/> </searchParam> </resource> <resource> <type value="DocumentReference"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <interaction> <code value="create"/> </interaction> <interaction> <code value="update"/> </interaction> <searchParam> <name value="patient"/> <type value="reference"/> </searchParam> <searchParam> <name value="type"/> <type value="token"/> </searchParam> <searchParam> <name value="category"/> <type value="token"/> </searchParam> <searchParam> <name value="date"/> <type value="date"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_offset"/> <type value="number"/> </searchParam> <operation> <name value="upload"/> <definition value="https://fhir.huli.ai/r5/OperationDefinition/DocumentReference-upload"/> </operation> </resource> <resource> <type value="Practitioner"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="name"/> <type value="string"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_offset"/> <type value="number"/> </searchParam> </resource> <resource> <type value="Organization"/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> </resource> <resource> <type value="HealthcareService"/> <documentation value="Authorized by the SMART scope `system/Appointment.rs`. This resource inherits an existing scope — no per-resource `system/HealthcareService.*` scope is minted; requesting one is rejected."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_offset"/> <type value="number"/> </searchParam> </resource> <resource> <type value="PractitionerRole"/> <documentation value="Authorized by the SMART scope `system/Practitioner.rs`. This resource inherits an existing scope — no per-resource `system/PractitionerRole.*` scope is minted; requesting one is rejected."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="practitioner"/> <type value="reference"/> </searchParam> <searchParam> <name value="location"/> <type value="reference"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_offset"/> <type value="number"/> </searchParam> </resource> <resource> <type value="Schedule"/> <documentation value="Authorized by the SMART scope `system/Appointment.rs`. This resource inherits an existing scope — no per-resource `system/Schedule.*` scope is minted; requesting one is rejected."/> <interaction> <code value="read"/> </interaction> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="_id"/> <type value="token"/> </searchParam> <searchParam> <name value="actor"/> <type value="reference"/> </searchParam> <searchParam> <name value="service-type"/> <type value="token"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_offset"/> <type value="number"/> </searchParam> </resource> <resource> <type value="Slot"/> <documentation value="Authorized by the SMART scope `system/Appointment.rs`. This resource inherits an existing scope — no per-resource `system/Slot.*` scope is minted; requesting one is rejected."/> <interaction> <code value="search-type"/> </interaction> <searchParam> <name value="schedule"/> <type value="reference"/> </searchParam> <searchParam> <name value="actor"/> <type value="reference"/> </searchParam> <searchParam> <name value="start"/> <type value="date"/> </searchParam> <searchParam> <name value="end"/> <type value="date"/> </searchParam> <searchParam> <name value="_count"/> <type value="number"/> </searchParam> <searchParam> <name value="_offset"/> <type value="number"/> </searchParam> </resource> </rest> </CapabilityStatement>