Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.have-foresight.app/llms.txt

Use this file to discover all available pages before exploring further.

Foresight emits an audit log entry for every:
  • PHI read or write (patient, encounter, claim, prior auth, denial, insurance policy, etc.).
  • Administrative action (key creation, scope change, webhook subscription change).
  • Authentication event (key used, session created, MFA event).

What’s captured

FieldDescription
actorAPI key id (or user id for dashboard sessions).
actorTypeapi_key | user_session.
actionOne of READ, CREATE, UPDATE, DELETE.
entityTypeResource kind (e.g. patient, claim).
entityIdResource ID.
changedFields(UPDATE) keys that changed.
requestIdPer-request correlation ID.
ipAddressCaller IP (X-Forwarded-For honored).
userAgentCaller User-Agent.
containsPhiWhether PHI was accessed.
accessReasonOptional caller-supplied reason for break-glass.
timestampUTC ISO 8601.

Retrieving logs

Logs are surfaced via the dashboard (Settings → Audit logs) and exported on-demand. Programmatic retrieval is available for enterprise customers through the Audit Log API (contact support to enable).

Tamper resistance

Audit log entries are append-only. The store rejects updates and deletes at the database level. Backups are retained for the life of the BAA + 7 years.