work-with-subscriptions

Implements FHIR topic-based Subscriptions with multi-channel notification delivery and retry logic.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Developers working on the Helios FHIR Server need to build, debug, and configure the topic-based Subscriptions engine that evaluates resource events against SubscriptionTopic criteria and delivers notifications across multiple channels. ## Core Features & Use Cases - Multi-Channel Delivery: Supports rest-hook (HTTP callback), websocket, email, and messaging channels, with the messaging channel gated by its own environment flag. - Topic-Based Matching: Evaluates resource events against SubscriptionTopic criteria using the evaluator and filter matching logic in the engine. - Reliable Delivery: Retries failed notification deliveries with backoff and blocks rest-hook delivery to private or loopback endpoints unless explicitly allowed. - Use Case: When adding a new notification channel or debugging why a Subscription is not firing, use this Skill to navigate the engine, evaluator, manager, and channels modules plus their CI workflows and tests. ## Quick Start Ask the assistant to explain how the subscriptions engine matches a resource event to a SubscriptionTopic and delivers a rest-hook notification, including which environment variables control the behavior.

Frequently Asked Questions about work-with-subscriptions

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

FAQPage Schema
How do I enable FHIR Subscriptions in the Helios FHIR Server?▼

Set HFS_SUBSCRIPTIONS_ENABLED=true to activate the subscriptions engine. The messaging channel additionally requires HFS_SUBSCRIPTION_MESSAGING_ENABLED=true, and HFS_BASE_URL controls the base URL used in notification links.

What notification channels does the FHIR Subscriptions engine support?▼

The engine supports rest-hook HTTP callbacks, websocket, email, and messaging channels. WebSocket subscriptions use binding tokens managed per connection, and the messaging channel is gated by a separate environment flag.

Why is my rest-hook subscription not delivering to a localhost endpoint?▼

Rest-hook delivery to private or loopback endpoints is blocked by default for endpoint safety. Set HFS_SUBSCRIPTION_ALLOW_PRIVATE_ENDPOINTS=true to opt in to delivery to private or loopback URLs.

How does the subscriptions engine handle failed notification deliveries?▼

Failed deliveries are retried with backoff, implemented in the engine retry module. Notification bundles follow the FHIR topic-based subscription specification.

Where are the subscription tests and CI workflows located?▼

Unit tests live inline in the subscriptions crate source, with integration tests under crates/subscriptions/tests. CI workflows include inferno-subscription.yml, subscriptions-channels.yml, and subscriptions-smoke.yml.