|
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.
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).
AuditEvent.event
Definition
Identifies
the
name,
action
type,
time,
and
disposition
of
the
audited
event.
Control
1..1
Requirements
The
event
must
be
identified.
Based on ATNA (RFC 3881).
|
AuditEvent.event.type
AuditEvent.type
|
|
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.
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
|
|
Binding
|
Audit
Event
ID:
Type
of
event.
(
Audit Event ID:
Type of event.
(
Extensible
)
|
|
Type
|
Coding
|
|
Requirements
|
This
identifies
the
performed
function.
For
"Execute"
Event
Action
Code
audit
records,
this
identifies
the
application
function
performed.
This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed.
|
|
Summary
|
true
|
AuditEvent.event.subtype
AuditEvent.subtype
|
|
Definition
|
Identifier
for
the
category
of
event.
Identifier for the category of event.
|
|
Control
|
0..*
|
|
Binding
|
Audit
Event
Sub-Type:
Sub-type
of
event.
(
Audit Event Sub-Type:
Sub-type of event.
(
Extensible
)
|
|
Type
|
Coding
|
|
Requirements
|
This
field
enables
queries
of
messages
by
implementation-defined
event
categories.
This field enables queries of messages by implementation-defined event categories.
|
|
Summary
|
true
|
AuditEvent.event.action
AuditEvent.action
|
|
Definition
|
Indicator
for
type
of
action
performed
during
the
event
that
generated
the
audit.
Indicator for type of action performed during the event that generated the audit.
|
|
Control
|
0..1
|
|
Binding
|
AuditEventAction:
Indicator
for
type
of
action
performed
during
the
event
that
generated
the
audit.
(
AuditEventAction:
Indicator for type of action performed during the event that generated the audit.
(
Required
)
|
|
Type
|
code
|
|
Requirements
|
This
broadly
indicates
what
kind
of
action
was
done
on
the
Participant
Object.
This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.
|
|
Summary
|
true
|
AuditEvent.event.dateTime
AuditEvent.recorded
|
|
Definition
|
The
time
when
the
event
occurred
on
the
source.
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.
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.
In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.
|
AuditEvent.event.outcome
AuditEvent.outcome
|
|
Definition
|
Indicates
whether
the
event
succeeded
or
failed.
Indicates whether the event succeeded or failed.
|
|
Control
|
0..1
|
|
Binding
|
AuditEventOutcome:
Indicates
whether
the
event
succeeded
or
failed
(
AuditEventOutcome:
Indicates whether the event succeeded or failed
(
Required
)
|
|
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.
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.
|
AuditEvent.event.outcomeDesc
AuditEvent.outcomeDesc
|
|
Definition
|
A
free
text
description
of
the
outcome
of
the
event.
A free text description of the outcome of the event.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Summary
|
true
|
AuditEvent.event.purposeOfEvent
AuditEvent.purposeOfEvent
|
|
Definition
|
The
purposeOfUse
(reason)
that
was
used
during
the
event
being
recorded.
The purposeOfUse (reason) that was used during the event being recorded.
|
|
Control
|
0..*
|
|
Binding
|
PurposeOfUse:
The
reason
the
activity
took
place.
(
PurposeOfUse:
The reason the activity took place.
(
Extensible
)
|
|
Type
|
Coding
|
|
Summary
|
true
|
|
Comments
|
Use
participant.purposeOfUse
when
you
know
that
is
specific
to
the
participant,
otherwise
use
event.purposeOfEvent.
For
example,
during
a
machine-to-machine
transfer
it
might
not
be
obvious
to
the
audit
system
who
caused
the
event,
but
it
does
know
why.
Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
|
AuditEvent.participant
AuditEvent.agent
|
|
Definition
|
A
person,
a
hardware
device
or
software
process.
An actor taking an active role in the event or activity that is logged.
|
|
Control
|
1..*
|
|
Requirements
|
The
event
has
one
or
more
active
participants.
An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.
|
|
Alternate Names
|
ActiveParticipant
|
|
Comments
|
There
may
be
more
than
one
user
per
event,
for
example,
in
cases
of
actions
initiated
by
one
user
for
other
users,
or
in
events
that
involve
more
than
one
user,
hardware
device,
or
system
process.
However,
only
one
user
may
be
the
initiator/requestor
for
the
event.
Several agents may be associated (i.e. have some responsibility for an activity) with an event or activity.
For example, an activity may be initiated by one user for other users or involve more than one user. However, only one user may be the initiator/requestor for the activity.
|
AuditEvent.participant.role
AuditEvent.agent.role
|
|
Definition
|
Specification
of
the
role(s)
the
user
plays
when
performing
the
event.
Usually
the
codes
used
in
this
element
are
local
codes
defined
by
the
role-based
access
control
security
system
used
in
the
local
context.
Specification of the role(s) the user plays when performing the event. Usually the codes used in this element are local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.
|
|
Control
|
0..*
|
|
Binding
|
Audit
Active
Participant
Role
ID
Code:
Role(s)
the
user
plays
(from
RBAC).
(
Audit Active Participant Role ID Code:
Role(s) the user plays (from RBAC).
(
Extensible
)
|
|
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.
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.
|
AuditEvent.participant.reference
AuditEvent.agent.reference
|
|
Definition
|
Direct
reference
to
a
resource
that
identifies
the
participant.
Direct reference to a resource that identifies the agent.
|
|
Control
|
0..1
|
|
Type
|
Reference
(
Practitioner
|
|
Organization
|
|
Device
|
|
Patient
|
|
RelatedPerson
)
|
|
Requirements
|
This
field
ties
an
audit
event
to
a
specific
resource.
This field ties an audit event to a specific resource.
|
|
Summary
|
true
|
AuditEvent.participant.userId
AuditEvent.agent.userId
|
|
Definition
|
Unique
identifier
for
the
user
actively
participating
in
the
event.
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.
This field ties an audit event to a specific user.
|
|
Summary
|
true
|
|
Comments
|
a
unique
value
within
the
Audit
Source
ID.
For
node-based
authentication
--
where
only
the
system
hardware
or
process,
but
not
a
human
user,
is
identified
--
User
ID
would
be
the
node
name.
a unique value within the Audit Source ID. For node-based authentication -- where only the system hardware or process, but not a human user, is identified -- User ID would be the node name.
|
AuditEvent.participant.altId
AuditEvent.agent.altId
|
|
Definition
|
Alternative
Participant
Identifier.
For
a
human,
this
should
be
a
user
identifier
text
string
from
authentication
system.
This
identifier
would
be
one
known
to
a
common
authentication
system
(e.g.
single
sign-on),
if
available.
Alternative agent Identifier. For a human, this should be a user identifier text string from authentication system. This identifier would be one known to a common authentication system (e.g. single sign-on), if available.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Requirements
|
In
some
situations
a
human
user
may
authenticate
with
one
identity
but,
to
access
a
specific
application
system,
may
use
a
synonymous
identify.
For
example,
some
"single
sign
on"
implementations
will
do
this.
The
alternative
identifier
would
then
be
the
original
identify
used
for
authentication,
and
the
User
ID
is
the
one
known
to
and
used
by
the
application.
In some situations a human user may authenticate with one identity but, to access a specific application system, may use a synonymous identify. For example, some "single sign on" implementations will do this. The alternative identifier would then be the original identify used for authentication, and the User ID is the one known to and used by the application.
|
AuditEvent.participant.name
AuditEvent.agent.name
|
|
Definition
|
Human-meaningful
name
for
the
user.
Human-meaningful name for the agent.
|
|
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.
The User ID and Authorization User ID may be internal or otherwise obscure values. This field assists the auditor in identifying the actual user.
|
AuditEvent.participant.requestor
AuditEvent.agent.requestor
|
|
Definition
|
Indicator
that
the
user
is
or
is
not
the
requestor,
or
initiator,
for
the
event
being
audited.
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.
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
participant
as
the
initiator.
There can only be one initiator. If the initiator is not clear, then do not choose any one agent as the initiator.
|
AuditEvent.participant.location
AuditEvent.agent.location
|
|
Definition
|
Where
the
event
occurred.
Where the event occurred.
|
|
Control
|
0..1
|
|
Type
|
Reference
(
Location
)
|
AuditEvent.participant.policy
AuditEvent.agent.policy
|
|
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.
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.
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.
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.
|
AuditEvent.participant.media
AuditEvent.agent.media
|
|
Definition
|
Type
of
media
involved.
Used
when
the
event
is
about
exporting/importing
onto
media.
Type of media involved. Used when the event is about exporting/importing onto media.
|
|
Control
|
0..1
|
|
Binding
|
Media
Type
Code:
Used
when
the
event
is
about
exporting/importing
onto
media.
(
Media Type Code:
Used when the event is about exporting/importing onto media.
(
Extensible
)
|
|
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).
To
Do
Do
we
need
an
element
for
Media
Id
(as
opposed
to
type).
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).
|
AuditEvent.participant.network
AuditEvent.agent.network
|
|
Definition
|
Logical
network
location
for
application
activity,
if
the
activity
has
a
network
location.
Logical network location for application activity, if the activity has a network location.
|
|
Control
|
0..1
|
AuditEvent.participant.network.address
AuditEvent.agent.network.address
|
|
Definition
|
An
identifier
for
the
network
access
point
of
the
user
device
for
the
audit
event.
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.
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.
This could be a device id, IP address or some other identifier associated with a device.
|
AuditEvent.participant.network.type
AuditEvent.agent.network.type
|
|
Definition
|
An
identifier
for
the
type
of
network
access
point
that
originated
the
audit
event.
An identifier for the type of network access point that originated the audit event.
|
|
Control
|
0..1
|
|
Binding
|
AuditEventParticipantNetworkType:
The
type
of
network
access
point
of
this
participant
in
the
audit
event
(
AuditEventParticipantNetworkType:
The type of network access point of this participant in the audit event
(
Required
)
|
|
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.
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.
|
AuditEvent.participant.purposeOfUse
AuditEvent.agent.purposeOfUse
|
|
Definition
|
The
reason
(purpose
of
use),
specific
to
this
participant,
that
was
used
during
the
event
being
recorded.
The reason (purpose of use), specific to this agent, that was used during the event being recorded.
|
|
Control
|
0..*
|
|
Binding
|
PurposeOfUse:
The
reason
the
activity
took
place.
(
PurposeOfUse:
The reason the activity took place.
(
Extensible
)
|
|
Type
|
Coding
|
|
Comments
|
Use
participant.purposeOfUse
when
you
know
that
is
specific
to
the
participant,
otherwise
use
event.purposeOfEvent.
For
example,
during
a
machine-to-machine
transfer
it
might
not
be
obvious
to
the
audit
system
who
caused
the
event,
but
it
does
know
why.
Use AuditEvent.agent.purposeOfUse when you know that is specific to the agent, otherwise use AuditEvent.purposeOfEvent. For example, during a machine-to-machine transfer it might not be obvious to the audit system who caused the event, but it does know why.
|
|
AuditEvent.source
|
|
Definition
|
Application
systems
and
processes.
Application systems and processes.
|
|
Control
|
1..1
|
|
Requirements
|
The
event
is
reported
by
one
source.
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.
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.
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.
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.
Identifier of the source where the event was detected.
|
|
Note
|
This
is
a
business
identifer,
not
a
resource
identifier
(see
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.
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.
Code specifying the type of source where event originated.
|
|
Control
|
0..*
|
|
Binding
|
Audit
Event
Source
Type:
Code
specifying
the
type
of
system
that
detected
and
recorded
the
event.
(
Audit Event Source Type:
Code specifying the type of system that detected and recorded the event.
(
Extensible
)
|
|
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.
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.
|
AuditEvent.object
AuditEvent.entity
|
|
Definition
|
Specific
instances
of
data
or
objects
that
have
been
accessed.
Specific instances of data or objects that have been accessed.
|
|
Control
|
0..*
|
|
Requirements
|
The
event
may
have
other
objects
involved.
The event may have other entities involved.
|
|
Alternate Names
|
ParticipantObject
|
|
Comments
|
Required
unless
the
values
for
Event
Identification,
Active
Participant
Identification,
and
Audit
Source
Identification
are
sufficient
to
document
the
entire
auditable
event.
Because
events
may
have
more
than
one
participant
object,
this
group
can
be
a
repeating
set
of
values.
Required unless the values for event identification, agent identification, and audit source identification are sufficient to document the entire auditable event. Because events may have more than one entity, this group can be a repeating set of values.
|
|
Invariants
|
Defined
on
this
element
Defined on this element
sev-1
:
Either
a
name
or
a
query
(NOT
both)
(xpath:
not(exists(f:name))
or
not(exists(f:query)))
: Either a name or a query (NOT both) (
expression
: name.empty() or query.empty(), xpath: not(exists(f:name)) or not(exists(f:query)))
|
AuditEvent.object.identifier
AuditEvent.entity.identifier
|
|
Definition
|
Identifies
a
specific
instance
of
the
participant
object.
The
reference
should
always
be
version
specific.
Identifies a specific instance of the entity. The reference should always be version specific.
|
|
Note
|
This
is
a
business
identifer,
not
a
resource
identifier
(see
This is a business identifer, not a resource identifier (see
discussion
)
|
|
Control
|
0..1
|
|
Type
|
Identifier
|
|
Summary
|
true
|
|
Comments
|
Identifier
detail
depends
on
object
type.
Identifier detail depends on entity type.
|
AuditEvent.object.reference
AuditEvent.entity.reference
|
|
Definition
|
Identifies
a
specific
instance
of
the
participant
object.
The
reference
should
always
be
version
specific.
Identifies a specific instance of the entity. The reference should always be version specific.
|
|
Control
|
0..1
|
|
Type
|
Reference
(
Any
)
|
|
Summary
|
true
|
AuditEvent.object.type
AuditEvent.entity.type
|
|
Definition
|
The
type
of
the
object
that
was
involved
in
this
audit
event.
The type of the object that was involved in this audit event.
|
|
Control
|
0..1
|
|
Binding
|
AuditEventObjectType:
Code
for
the
object
type
involved
audited.
(
AuditEventObjectType:
Code for the object type involved audited.
(
Extensible
)
|
|
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.
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
participant
object.
This value is distinct from the user's role or any user relationship to the entity.
|
AuditEvent.object.role
AuditEvent.entity.role
|
|
Definition
|
Code
representing
the
functional
application
role
of
Participant
Object
being
audited.
Code representing the role the entity played in the event being audited.
|
|
Control
|
0..1
|
|
Binding
|
AuditEventObjectRole:
Code
representing
the
role
the
Object
played
in
the
event.
(
AuditEventObjectRole:
Code representing the role the Object played in the event.
(
Extensible
)
|
|
Type
|
Coding
|
|
Requirements
|
For
some
detailed
audit
analysis
it
may
be
necessary
to
indicate
a
more
granular
type
of
participant,
based
on
the
application
role
it
serves.
Comments
See
RFC
3881
for
rules
concerning
matches
between
role
and
type.
For some detailed audit analysis it may be necessary to indicate a more granular type of entity, based on the application role it serves.
|
AuditEvent.object.lifecycle
AuditEvent.entity.lifecycle
|
|
Definition
|
Identifier
for
the
data
life-cycle
stage
for
the
participant
object.
Identifier for the data life-cycle stage for the entity.
|
|
Control
|
0..1
|
|
Binding
|
AuditEventObjectLifecycle:
Identifier
for
the
data
life-cycle
stage
for
the
object.
(
AuditEventObjectLifecycle:
Identifier for the data life-cycle stage for the object.
(
Extensible
)
|
|
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.
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.
This can be used to provide an audit trail for data, over time, as it passes through the system.
|
AuditEvent.object.securityLabel
AuditEvent.entity.securityLabel
|
|
Definition
|
Denotes
security
labels
for
the
identified
object.
Denotes security labels for the identified entity.
|
|
Control
|
0..*
|
|
Binding
|
All
Security
Labels:
Security
Labels
from
the
Healthcare
Privacy
and
Security
Classification
System.
(
All Security Labels:
Security Labels from the Healthcare Privacy and Security Classification System.
(
Extensible
)
|
|
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.
This field identifies the security labels for a specific instance of an object, such as a patient, to detect/track privacy and security issues.
|
AuditEvent.object.name
AuditEvent.entity.name
|
|
Definition
|
An
instance-specific
descriptor
of
the
Participant
Object
ID
audited,
such
as
a
person's
name.
A name of the entity in the audit event.
|
|
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
Participant
Object
IDs
(patient
number,
medical
record
number,
encounter
number,
etc.)
have
been
used.
This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifers (patient number, medical record number, encounter number, etc.) have been used.
|
|
Invariants
|
Affect
this
element
Affect this element
sev-1
:
Either
a
name
or
a
query
(NOT
both)
(xpath:
not(exists(f:name))
or
not(exists(f:query)))
: Either a name or a query (NOT both) (
expression
: name.empty() or query.empty(), xpath: not(exists(f:name)) or not(exists(f:query)))
|
AuditEvent.object.description
AuditEvent.entity.description
|
|
Definition
|
Text
that
describes
the
object
in
more
detail.
Text that describes the entity in more detail.
|
|
Control
|
0..1
|
|
Type
|
string
|
|
Requirements
|
Use only where entity can't be identified with an identifier.
|
AuditEvent.object.query
AuditEvent.entity.query
|
|
Definition
|
The
actual
query
for
a
query-type
participant
object.
The query parameters for a query-type entities.
|
|
Control
|
0..1
|
|
Type
|
base64Binary
|
|
Requirements
|
For
query
events
it
may
be
necessary
to
capture
the
actual
query
input
to
the
query
process
in
order
to
identify
the
specific
event.
Because
of
differences
among
query
implementations
and
data
encoding
for
them,
this
is
a
base
64
encoded
data
blob.
It
may
be
subsequently
decoded
or
interpreted
by
downstream
audit
analysis
processing.
For query events it may be necessary to capture the actual query input to the query process in order to identify the specific event. Because of differences among query implementations and data encoding for them, this is a base 64 encoded data blob. It may be subsequently decoded or interpreted by downstream audit analysis processing.
|
|
Summary
|
true
|
|
Invariants
|
Affect
this
element
Affect this element
sev-1
:
Either
a
name
or
a
query
(NOT
both)
(xpath:
not(exists(f:name))
or
not(exists(f:query)))
: Either a name or a query (NOT both) (
expression
: name.empty() or query.empty(), xpath: not(exists(f:name)) or not(exists(f:query)))
|
AuditEvent.object.detail
AuditEvent.entity.detail
|
|
Definition
|
Additional
Information
about
the
Object.
Additional Information about the entity.
|
|
Control
|
0..*
|
AuditEvent.object.detail.type
AuditEvent.entity.detail.type
|
|
Definition
|
Name
of
the
property.
Name of the property.
|
|
Control
|
1..1
|
|
Type
|
string
|
AuditEvent.object.detail.value
AuditEvent.entity.detail.value
|
|
Definition
|
Property
value.
Property value.
|
|
Control
|
1..1
|
|
Type
|
base64Binary
|
©
HL7.org
2011+.
FHIR
DSTU2
(v1.0.2-7202)
generated
on
Sat,
Oct
24,
2015
07:43+1100.
Links:
Search