run-hfs-server

Configure and run the HFS FHIR server with storage backends, multi-tenancy, and REST endpoints.

51|19|Updated Jan 4, 2025
One-click install
npx skills add https://github.com/HeliosSoftware/hfs --skill run-hfs-server-heliossoftware
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: run-hfs-server
Source: https://github.com/HeliosSoftware/hfs/tree/main/.agents/skills/run-hfs-server
Command: npx skills add https://github.com/HeliosSoftware/hfs --skill run-hfs-server-heliossoftware

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Running the Helios FHIR Server requires navigating dozens of environment variables, storage backend modes, and behavior flags, and misconfiguration leads to startup failures or incorrect tenant routing. ## Core Features & Use Cases - Server Startup & Configuration: Launch the hfs binary with SQLite, PostgreSQL, Elasticsearch, or S3 storage backends using HFS environment variables. - Multi-Tenancy & Routing: Configure tenant routing via headers or URL paths, with strict validation options and JWT claim support. - Operational Tuning: Control compression, CORS, request limits, pagination, versioning, and dashboard refresh intervals. - Use Case: A developer needs to run HFS against PostgreSQL with Elasticsearch search and debug why search results lag behind writes; the skill provides the exact backend mode, connection variables, and the HFS_COMPOSITE_SYNC_MODE=synchronous setting for read-your-write semantics. ## Quick Start Start the HFS FHIR server locally with the default SQLite backend and show me how to switch it to PostgreSQL using environment variables.

Frequently Asked Questions about run-hfs-server

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I run the HFS FHIR server with PostgreSQL?▼

Set HFS_STORAGE_BACKEND=postgres and HFS_DATABASE_URL to your connection string, then run cargo run --bin hfs. PostgreSQL plus Elasticsearch is available via the postgres-elasticsearch or pg-es backend values.

How do I configure multi-tenancy in the HFS FHIR server?▼

Tenancy is controlled by HFS_TENANT_ROUTING_MODE with values header_only, url_path, or both. Clients pass X-Tenant-ID headers by default, or use URL path prefixes like /clinic-a/Patient when url_path routing is enabled.

Does the HFS server support S3 storage backends?▼

Yes, S3 storage requires building with the s3 feature flag and setting HFS_STORAGE_BACKEND=s3 plus HFS_S3_BUCKET. S3-compatible endpoints like MinIO need HFS_S3_ENDPOINT and HFS_S3_FORCE_PATH_STYLE=true.

Why are my HFS search results not reflecting recent writes?▼

Elasticsearch-backed composite writes default to asynchronous sync mode. Set HFS_COMPOSITE_SYNC_MODE=synchronous when callers need read-your-write search semantics, such as integration tests or bulk loads that search immediately.

What request compression does the HFS server support?▼

The hfs, sof-server, and hts servers accept gzip, deflate, br, and zstd request bodies via Content-Encoding, returning 415 for unsupported encodings. Responses are compressed when clients send Accept-Encoding, and body limits apply after decompression.