work-with-audit

Configure FHIR AuditEvent logging with IHE BALP profiles and pluggable sinks.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Developers working on the Helios FHIR Server need to emit compliant audit trails for FHIR interactions, but configuring the helios-audit crate involves understanding IHE BALP profiles, multiple sink backends, and HFS_AUDIT_* environment variables. This Skill provides the operational knowledge to implement and configure audit logging correctly. ## Core Features & Use Cases - BALP AuditEvent Emission: Generate FHIR R4-family AuditEvent records following IHE BALP profiles for request/response activity, with R5/R6 builds aliasing to the R4B baseline. - Pluggable Sink Backends: Route audit events to file (NDJSON), SQL/MongoDB databases, or AWS CloudWatch Logs via the HFS_AUDIT_BACKEND setting. - Path Exclusion & Source Configuration: Skip noisy endpoints like /health and /metadata, and customize AuditEvent.source.observer references. - Use Case: You need HIPAA-style audit trails for a production FHIR server. Enable the database sink with HFS_AUDIT_DATABASE_URL, exclude health-check paths, and every FHIR interaction is recorded as a BALP-compliant AuditEvent. ## Quick Start Ask the AI to enable audit logging in helios-audit with the file sink and exclude the /health and /metadata paths.

Frequently Asked Questions about work-with-audit

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

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

Set the HFS_AUDIT_BACKEND environment variable to a sink such as file, database, or cloudwatch. Auditing is off by default (HFS_AUDIT_BACKEND=none), and each backend requires its own connection variables like HFS_AUDIT_FILE_PATH or HFS_AUDIT_DATABASE_URL.

What audit event format does the Helios FHIR Server use?▼

The helios-audit crate emits FHIR AuditEvent resources following the IHE BALP profile. It uses the R4-family AuditEvent model, and R5/R6 builds alias to the R4B baseline because those versions restructured AuditEvent.

How do I exclude health check endpoints from FHIR audit logs?▼

Set HFS_AUDIT_EXCLUDE_PATHS to a comma-separated list of paths to skip, such as /health and /metadata. The ExclusionFilter in the middleware then bypasses audit recording for those requests.

Does helios-audit support AWS CloudWatch Logs?▼

Yes, CloudWatch Logs is supported as a sink by setting HFS_AUDIT_BACKEND to cloudwatch and building with the cloudwatch feature flag. Configure the target with HFS_AUDIT_CLOUDWATCH_LOG_GROUP, _LOG_STREAM, and _REGION variables.

Can I write FHIR audit events to MongoDB?▼

Yes, the database sink supports MongoDB in addition to SQL databases. Set HFS_AUDIT_BACKEND to database and provide the MongoDB database name via HFS_AUDIT_MONGODB_DATABASE.