Skip to main content

Audit

Introduction​

The Helios FHIR Server supports the AuditEvent FHIR Resource and the accompanying set of auditing requirements described in the FHIR Specification for audit support.

Audit Settings​

There are three ways to configure these configuration settings.

  • Manually modify the $KARAF_HOME/etc/audit.properties.cfg file prior to, or after startup.
  • Use the Helios FHIR Server administrative user interface (Default - http://localhost:8181/ui), Settings menu to view or modify these values. Changes to these values in the administrative user interface will overwrite the values in audit.properties.cfg.
  • Use environment variables to override the audit.properties.cfg values. This approach is helpful when you need to pass configuration values to a Docker container or otherwise do not wish to modify the values in the audit.properties.cfg file.

Each setting section below lists two values.

  • The first is the audit.properties.cfg value, and
  • the second is the same value expressed as an environment variable.

Global​

This setting universally turns auditing on (true) or off (false). Set to true by default, the system will generate AuditEvent FHIR Resources. Turning this setting to false will prohibit any AuditEvent FHIR Resources records to be created independent of any of the other audit settings. i.e. Changing this setting to false is an easy way to turn all auditing off.

global = true
AUDIT_PROPERTIES_GLOBAL = true

System Startup/Shutdown​

This setting turns auditing on (true) or off (false) for system startup and shutdown events.

system = true
AUDIT_PROPERTIES_SYSTEM = true

Login and Logout​

This setting turns auditing on (true) or off (false) for login and logout events.

ui = true
AUDIT_PROPERTIES_UI = true

User Create, Update and Delete​

This setting turns auditing on (true) or off (false) for creation, update and deletion of user events.

users = true
AUDIT_PROPERTIES_USERS = true

Configuration Change​

This setting turns auditing on (true) or off (false) for configuration change events.

configuration = true
AUDIT_PROPERTIES_CONFIGURATION = true

Resource Create, Search, Read, Update and Delete​

This setting turns auditing on (true) or off (false) for FHIR Resource create, search, read, update, and delete events.

resources = true
AUDIT_PROPERTIES_RESOURCES = true

Log AuditEvents to the Karaf Log​

FHIR AuditEvents are sent to the AuditEvent database table based on the above settings. This setting sends the same log message optionally to the karaf.log file as an INFO message if set to true.

log = true
AUDIT_PROPERTIES_LOG = true