This
page
is
part
of
the
FHIR
Specification
(v1.0.2:
DSTU
(v3.0.2:
STU
2).
3).
The
current
version
which
supercedes
this
version
is
5.0.0
.
For
a
full
list
of
available
versions,
see
the
Directory
of
published
versions
.
Page
versions:
R5
R4B
R4
R3
R2
R3
R2
Security
Work
Group
| Maturity Level : 3 | Trial Use | Compartments : Device , Patient , Practitioner |
Detailed Descriptions for the elements in the AuditEvent resource.
| AuditEvent | |
| Definition |
A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage. |
| Control | 1..1 |
| Comments |
Based on ATNA (RFC 3881). |
|
|
|
| Definition |
Identifier for a family of the event. For example, a menu item, program, rule, policy, function code, application name or URL. It identifies the performed function. |
| Control | 1..1 |
| Terminology Binding |
Audit
Event
|
| Type | Coding |
| Requirements |
This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed. |
| Summary | true |
|
|
|
| Definition |
Identifier for the category of event. |
| Control | 0..* |
| Terminology Binding |
Audit
Event
|
| Type | Coding |
| Requirements |
This field enables queries of messages by implementation-defined event categories. |
| Summary | true |
|
|
|
| Definition |
Indicator for type of action performed during the event that generated the audit. |
| Control | 0..1 |
| Terminology Binding |
|
| Type | code |
| Requirements |
This
broadly
indicates
what
kind
of
action
was
done
on
the
|
| Summary | true |
|
|
|
| Definition |
The time when the event occurred on the source. |
| Control | 1..1 |
| Type | instant |
| Requirements |
This ties an event to a specific date and time. Security audits typically require a consistent time base (e.g. UTC), to eliminate time-zone issues arising from geographical distribution. |
| Summary | true |
| Comments |
In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic. |
|
|
|
| Definition |
Indicates whether the event succeeded or failed. |
| Control | 0..1 |
| Terminology Binding |
|
| Type | code |
| Summary | true |
| Comments |
In some cases a "success" may be partial, for example, an incomplete or interrupted transfer of a radiological study. For the purpose of establishing accountability, these distinctions are not relevant. |
|
|
|
| Definition |
A free text description of the outcome of the event. |
| Control | 0..1 |
| Type | string |
| Summary | true |
|
|
|
| Definition |
The purposeOfUse (reason) that was used during the event being recorded. |
| Control | 0..* |
| Terminology Binding |
|
| Type |
|
| Summary | true |
| Comments |
Use
|
|
|
|
| Definition |
|
| Control | 1..* |
| Requirements |
|
| Alternate Names | ActiveParticipant |
| Comments |
For
example,
|
|
|
|
| Definition |
|
| Control | 0..* |
| Terminology Binding |
|
| Type | CodeableConcept |
| Requirements |
This value ties an audited event to a user's role(s). It is an optional value that might be used to group events for analysis by user functional role categories. |
| Comments | Should be roles relevant to the event. Should not be an exhaustive list of roles. |
|
|
|
| Definition |
Direct
reference
to
a
resource
that
identifies
the
|
| Control | 0..1 |
| Type | Reference ( Practitioner | Organization | Device | Patient | RelatedPerson ) |
| Requirements |
This field ties an audit event to a specific resource. |
| Summary | true |
|
|
|
| Definition |
Unique identifier for the user actively participating in the event. |
| Control | 0..1 |
| Type | Identifier |
| Requirements |
This field ties an audit event to a specific user. |
| Summary | true |
| Comments |
|
|
|
|
| Definition |
Alternative
|
| Control | 0..1 |
| Type | string |
| Requirements |
In
some
|
|
|
|
| Definition |
Human-meaningful
name
for
the
|
| Control | 0..1 |
| Type | string |
| Requirements |
The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user. |
|
|
|
| Definition |
Indicator that the user is or is not the requestor, or initiator, for the event being audited. |
| Control | 1..1 |
| Type | boolean |
| Requirements |
This value is used to distinguish between requestor-users and recipient-users. For example, one person may initiate a report-output to be sent to another user. |
| Comments |
There
can
only
be
one
initiator.
If
the
initiator
is
not
clear,
then
do
not
choose
any
one
|
|
|
|
| Definition |
Where the event occurred. |
| Control | 0..1 |
| Type | Reference ( Location ) |
|
|
|
| Definition |
The policy or plan that authorized the activity being recorded. Typically, a single activity may have multiple applicable policies, such as patient consent, guarantor funding, etc. The policy would also indicate the security token used. |
| Control | 0..* |
| Type | uri |
| Requirements |
This value is used retrospectively to determine the authorization policies. |
| Comments |
For example: Where an OAuth token authorizes, the unique identifier from the OAuth token is placed into the policy element Where a policy engine (e.g. XACML) holds policy logic, the unique policy identifier is placed into the policy element. |
|
|
|
| Definition |
Type of media involved. Used when the event is about exporting/importing onto media. |
| Control | 0..1 |
| Terminology Binding |
Media
Type
|
| Type | Coding |
| Requirements |
Usually, this is used instead of specifying a network address. This field is not used for Media Id (i.e. the serial number of a CD). |
|
|
|
| Definition |
Logical network location for application activity, if the activity has a network location. |
| Control | 0..1 |
|
|
|
| Definition |
An identifier for the network access point of the user device for the audit event. |
| Control | 0..1 |
| Type | string |
| Requirements |
This datum identifies the user's network access point, which may be distinct from the server that performed the action. It is an optional value that may be used to group events recorded on separate servers for analysis of a specific network access point's data access across all servers. |
| Comments |
This could be a device id, IP address or some other identifier associated with a device. |
|
|
|
| Definition |
An identifier for the type of network access point that originated the audit event. |
| Control | 0..1 |
| Terminology Binding |
|
| Type | code |
| Requirements |
This datum identifies the type of network access point identifier of the user device for the audit event. It is an optional value that may be used to group events recorded on separate servers for analysis of access according to a network access point's type. |
|
|
|
| Definition |
The
reason
(purpose
of
use),
specific
to
this
|
| Control | 0..* |
| Terminology Binding |
|
| Type |
|
| Comments |
Use
|
| AuditEvent.source | |
| Definition |
|
| Control | 1..1 |
| Requirements |
The event is reported by one source. |
| Comments |
Since multi-tier, distributed, or composite applications make source identification ambiguous, this collection of fields may repeat for each application or process actively involved in the event. For example, multiple value-sets can identify participating web servers, application processes, and database server threads in an n-tier distributed application. Passive event participants (e.g. low-level network transports) need not be identified. |
| AuditEvent.source.site | |
| Definition |
Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group. |
| Control | 0..1 |
| Type | string |
| Requirements |
This value differentiates among the sites in a multi-site enterprise health information system. |
| AuditEvent.source.identifier | |
| Definition |
Identifier of the source where the event was detected. |
| Note | This is a business identifer, not a resource identifier (see discussion ) |
| Control | 1..1 |
| Type | Identifier |
| Requirements |
This field ties the event to a specific source system. It may be used to group events for analysis according to where the event was detected. |
| Summary | true |
| AuditEvent.source.type | |
| Definition |
Code specifying the type of source where event originated. |
| Control | 0..* |
| Terminology Binding |
Audit
Event
Source
|
| Type | Coding |
| Requirements |
This field indicates which type of source is identified by the Audit Source ID. It is an optional value that may be used to group events for analysis according to the type of source where the event occurred. |
|
|
|
| Definition |
Specific instances of data or objects that have been accessed. |
| Control | 0..* |
| Requirements |
The
event
may
have
other
|
| Alternate Names | ParticipantObject |
| Comments |
Required
unless
the
values
for
|
| Invariants |
Defined
on
this
element
sev-1 : Either a name or a query (NOT both) :
name.empty()
or
query.empty(),
xpath:
not(exists(f:name))
or
not(exists(f:query)))
|
|
|
|
| Definition |
Identifies
a
specific
instance
of
the
|
| Note | This is a business identifer, not a resource identifier (see discussion ) |
| Control | 0..1 |
| Type | Identifier |
| Summary | true |
| Comments |
Identifier
detail
depends
on
|
|
|
|
| Definition |
Identifies
a
specific
instance
of
the
|
| Control | 0..1 |
| Type | Reference ( Any ) |
| Summary | true |
|
|
|
| Definition |
The type of the object that was involved in this audit event. |
| Control | 0..1 |
| Terminology Binding |
|
| Type | Coding |
| Requirements |
To describe the object being acted upon. In addition to queries on the subject of the action in an auditable event, it is also important to be able to query on the object type for the action. |
| Comments |
This
value
is
distinct
from
the
user's
role
or
any
user
relationship
to
the
|
|
|
|
| Definition |
Code
representing
the
|
| Control | 0..1 |
| Terminology Binding |
|
| Type | Coding |
| Requirements |
For
some
detailed
audit
analysis
it
may
be
necessary
to
indicate
a
more
granular
type
of
|
|
|
|
| Definition |
Identifier
for
the
data
life-cycle
stage
for
the
|
| Control | 0..1 |
| Terminology Binding |
|
| Type | Coding |
| Requirements |
Institutional policies for privacy and security may optionally fall under different accountability rules based on data life cycle. This provides a differentiating value for those cases. |
| Comments |
This can be used to provide an audit trail for data, over time, as it passes through the system. |
|
|
|
| Definition |
|
| Control | 0..* |
| Terminology Binding |
|
| Type | Coding |
| Requirements |
This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues. |
| Comments | Copied from entity meta security tags. |
|
|
|
| Definition |
|
| Control | 0..1 |
| Type | string |
| Requirements | Use only where entity can't be identified with an identifier. |
| Summary | true |
| Comments |
This
field
may
be
used
in
a
query/report
to
identify
audit
events
for
a
specific
person.
For
example,
where
multiple
synonymous
|
| Invariants |
Affect
this
element
sev-1 : Either a name or a query (NOT both) :
name.empty()
or
query.empty(),
xpath:
not(exists(f:name))
or
not(exists(f:query)))
|
|
|
|
| Definition |
Text
that
describes
the
|
| Control | 0..1 |
| Type | string |
| Requirements | Use only where entity can't be identified with an identifier. |
|
|
|
| Definition |
The
|
| Control | 0..1 |
| Type | base64Binary |
| Requirements |
For
query
|
| Summary | true |
| Invariants |
Affect
this
element
sev-1 : Either a name or a query (NOT both) :
name.empty()
or
query.empty(),
xpath:
not(exists(f:name))
or
not(exists(f:query)))
|
|
|
|
| Definition |
|
| Control | 0..* |
| Requirements | Implementation-defined data about specific details of the object accessed or used. |
|
|
|
| Definition |
|
| Control | 1..1 |
| Type | string |
|
|
|
| Definition |
|
| Control | 1..1 |
| Type | base64Binary |
| Requirements | Should not duplicate the entity value unless absolutely necessary. |
| Comments | The value is base64 encoded to enable various encodings or binary content. |