Interface / 4.0.1 (R4) / Audit Event

Audit Event

Audit Events include a variety of informational messages about application security, such as failed login attempts and resource access.

Overview

See the FHIR documentation for more information about Audit Event resources.

Mapped Concepts in HIEBus

  • AuditLogEntry

Supported Interactions

Audit Event resources support the following interactions.

Search Parameters

When searching for Audit Event resources, the following search parameters are supported.

Name Type Prefixes
Modifiers
Can be Chained? Description
_count Special The maximum number of resources to return in a result page.
_elements Special Used to request a specific set of elements be returned as part of a resource.
_id Token Resource id.
_lastUpdated Date ne  lt  le  gt  ge  sa  eb  ap  When the resource last changed.
_summary Special Used to return only a portion of the resouces. Defaults to 'false', which returns the whole resource.
_total Special Use the value 'estimate' to populate the result bundle's 'total' element with an estimate of the matching number of resources.
agent Reference identifier  yes The agent associated with the AuditEvent. This is a special reference search parameter that only works with the :identifier modifier. The identifier value must correspond to an identifier supplied with the AuditEvent.agent reference to match.
agent-name String :contains  :exact  :missing  The name of an agent associated with the AuditEvent - path 'AuditEvent.agent.name'. Matches CareEvolution username or application names associated with the audit event.
date Date ne  lt  le  gt  ge  sa  eb  ap  Time when the event was recorded.
message String :contains  :exact  :missing  Searches for audit events by their message.
patient Reference :missing  yes The patient the AuditEvent is about.
subtype Token :missing  More specific type/id for the event.
type Token :missing  Type/identifier of event.

Sortable Parameters

When searching Audit Event resources, it is possible to sort the returned values by the following search parameters.

  • date
  • _id

Only one sort parameter may be specified.

Supported Includes

When searching Audit Event resources, it is possible to include the resources referenced by the following field names.

  • Agent
  • Patient

Back to Resources