StructureDefinition: PolicyAuditEvent - Detailed Descriptions

Definitions for the PolicyAuditEvent Profile.

AuditEvent
Definition

Policy Audit Trail Content Profil

Control0..*
Comments

Based on ATNA (RFC 3881).

InvariantsDefined on this element
ch-atc-pae-1: subtype needs to be fixed to ValueSet PolicyAuditEventType (: subtype.exists() and subtype.count()=1 and subtype[0].code.startsWith('ATC_POL'))
dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (: contained.text.empty())
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (: contained.contained.empty())
dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (: contained.where(('#'+id in %resource.descendants().reference).not()).empty())
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())
AuditEvent.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control1..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

AuditEvent.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
AuditEvent.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element.

This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation.

AuditEvent.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from Common Languages; other codes may be used where these codes are not suitable
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

AuditEvent.text
Definition

A human-readable narrative that contains the summary of the Audit Event.

Control1..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later.

AuditEvent.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

AuditEvent.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.

Control1..1
BindingType of event.
The codes SHALL be taken from Audit Event ID; other codes may be used where these codes are not suitable
TypeCoding
Requirements

This identifies the performed function. For "Execute" Event Action Code audit records, this identifies the application function performed.

AuditEvent.subtype
Definition

Identifier for the category of event.

Control1..*
BindingSub-type of event.
The codes SHALL be taken from Audit Event Sub-Type; other codes may be used where these codes are not suitable
TypeCoding
Requirements

This field enables queries of messages by implementation-defined event categories.

AuditEvent.subtype(PolicyAuditEventType)
Definition

Identifier for the category of event.

Control1..1
BindingPolicy Audit Event Type
The codes SHALL be taken from PolicyAuditEventType
TypeCoding
Requirements

This field enables queries of messages by implementation-defined event categories.

AuditEvent.subtype.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.subtype.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.subtype.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control1..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

Fixed Valueurn:oid:2.16.756.5.30.1.127.3.10.7
AuditEvent.subtype.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

AuditEvent.subtype.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control0..1
Typecode
Requirements

Need to refer to a particular code in the system.

AuditEvent.subtype.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

AuditEvent.subtype.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

AuditEvent.action
Definition

Indicator for type of action performed during the event that generated the audit.

Control0..1
BindingIndicator for type of action performed during the event that generated the event
The codes SHALL be taken from AuditEventAction
Typecode
Requirements

This broadly indicates what kind of action was done on the AuditEvent.entity by the AuditEvent.agent.

AuditEvent.recorded
Definition

The time when the event was recorded.

Control1..1
Typeinstant
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.

Comments

In a distributed system, some sort of common time base (e.g. an NTP [RFC1305] server) is a good implementation tactic.

AuditEvent.outcome
Definition

Indicates whether the event succeeded or failed.

Control0..1
BindingIndicates whether the event succeeded or failed
The codes SHALL be taken from AuditEventOutcome
Typecode
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.

AuditEvent.outcomeDesc
Definition

A free text description of the outcome of the event.

Control0..1
Typestring
AuditEvent.purposeOfEvent
Definition

The purposeOfUse (reason) that was used during the event being recorded.

Control0..*
BindingThe reason the activity took place.
The codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

Use AuditEvent.agent.purposeOfUse when you know that it 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.agent
Definition

Participants

Control1..*
TypeBackboneElement
Requirements

An agent can be a person, an organization, software, device, or other actors that may be ascribed responsibility.

Alternate NamesActiveParticipant
Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.agent.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.agent.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.agent.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.agent.role
Definition

The security role that the user was acting under, that come from local codes defined by the access control security system (e.g. RBAC, ABAC) used in the local context.

Control1..1
BindingEprParticipant
The codes SHALL be taken from EprParticipant
TypeCodeableConcept
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.

AuditEvent.agent.reference
Definition

Direct reference to a resource that identifies the agent.

Control0..1
TypeReference(Practitioner | Organization | Device | Patient | RelatedPerson)
Requirements

This field ties an audit event to a specific resource.

AuditEvent.agent.userId
Definition

Unique identifier for the user

Control0..1
TypeIdentifier
Requirements

This field ties an audit event to a specific user.

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.

AuditEvent.agent.altId
Definition

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.

Control0..1
Typestring
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.

AuditEvent.agent.name
Definition

AttributeStatement/Attribute[@Name='urn:oasis:names:tc:xspa:1.0:subject:subject- id']/AttributeValue

Control1..1
Typestring
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.

AuditEvent.agent.requestor
Definition

Indicator that the participant is the initiator for the event being audited.

Control1..1
Typeboolean
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 agent as the initiator.

AuditEvent.agent.location
Definition

Where the event occurred.

Control0..1
TypeReference(Location)
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.

Control0..*
Typeuri
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.

AuditEvent.agent.media
Definition

Type of media involved. Used when the event is about exporting/importing onto media.

Control0..1
BindingUsed when the event is about exporting/importing onto media.
The codes SHALL be taken from Media Type Code; other codes may be used where these codes are not suitable
TypeCoding
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).

AuditEvent.agent.network
Definition

Logical network location for application activity, if the activity has a network location.

Control0..1
TypeBackboneElement
InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.agent.network.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.agent.network.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.agent.network.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.agent.network.address
Definition

An identifier for the network access point of the user device for the audit event.

Control0..1
Typestring
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.

AuditEvent.agent.network.type
Definition

An identifier for the type of network access point that originated the audit event.

Control0..1
BindingThe type of network access point of this agent in the audit event
The codes SHALL be taken from AuditEventAgentNetworkType
Typecode
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.

AuditEvent.agent.purposeOfUse
Definition

The reason (purpose of use), specific to this agent, that was used during the event being recorded.

Control0..*
BindingThe reason the activity took place.
The codes SHALL be taken from PurposeOfUse; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

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

The system that is reporting the event.

Control1..1
TypeBackboneElement
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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.source.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.source.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.source.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

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.

Control0..1
Typestring
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.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
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.

AuditEvent.source.type
Definition

Code specifying the type of source where event originated.

Control0..*
BindingCode specifying the type of system that detected and recorded the event.
The codes SHALL be taken from Audit Event Source Type; other codes may be used where these codes are not suitable
TypeCoding
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.

AuditEvent.entity
Definition

Specific instances of data or objects that have been accessed.

Control0..*
TypeBackboneElement
Requirements

The event may have other entities involved.

Alternate NamesParticipantObject
Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
sev-1: Either a name or a query (NOT both) (: name.empty() or query.empty())
sev-1: Either a name or a query (NOT both) (: name.empty() or query.empty())
AuditEvent.entity.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.identifier
Definition

Identifies a specific instance of the entity. The reference should always be version specific.

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Comments

Identifier detail depends on entity type.

AuditEvent.entity.reference
Definition

Identifies a specific instance of the entity. The reference should be version specific.

Control0..1
TypeReference(Resource)
AuditEvent.entity.type
Definition

The type of the object that was involved in this audit event.

Control0..1
BindingCode for the entity type involved in the audit event
The codes SHALL be taken from AuditEventEntityType; other codes may be used where these codes are not suitable
TypeCoding
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 entity.

AuditEvent.entity.role
Definition

Code representing the role the entity played in the event being audited.

Control0..1
BindingCode representing the role the entity played in the audit event
The codes SHALL be taken from AuditEventEntityRole; other codes may be used where these codes are not suitable
TypeCoding
Requirements

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.entity.lifecycle
Definition

Identifier for the data life-cycle stage for the entity.

Control0..1
TypeCoding
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.

AuditEvent.entity.securityLabel
Definition

Security labels for the identified entity.

Control0..*
BindingSecurity Labels from the Healthcare Privacy and Security Classification System.
The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable
TypeCoding
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.

AuditEvent.entity.name
Definition

A name of the entity in the audit event.

Control0..1 This element is affected by the following invariants: sev-1
Typestring
Requirements

Use only where entity can't be identified with an identifier.

Comments

This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.

AuditEvent.entity.description
Definition

Text that describes the entity in more detail.

Control0..1
Typestring
Requirements

Use only where entity can't be identified with an identifier.

AuditEvent.entity.query
Definition

The query parameters for a query-type entities.

Control0..1 This element is affected by the following invariants: sev-1
Typebase64Binary
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.

AuditEvent.entity.detail
Definition

Tagged value pairs for conveying additional information about the entity.

Control0..*
TypeBackboneElement
Requirements

Implementation-defined data about specific details of the object accessed or used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.entity.detail.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Control1..1
Typestring
AuditEvent.entity.detail.value
Definition

The details, base64 encoded. Used to carry bulk information.

Control1..1
Typebase64Binary
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value is base64 encoded to enable various encodings or binary content.

AuditEvent.entity(Patient)
Definition

Specific instances of data or objects that have been accessed.

Control1..1
TypeBackboneElement
Requirements

The event may have other entities involved.

Alternate NamesParticipantObject
Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
sev-1: Either a name or a query (NOT both) (: name.empty() or query.empty())
AuditEvent.entity.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.identifier
Definition

Patient Id (EPR-SPID)

NoteThis is a business identifier, not a resource identifier (see discussion)
Control1..1
TypeIdentifier
Comments

.

AuditEvent.entity.identifier.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.identifier.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.identifier.use
Definition

The purpose of this identifier.

Control0..1
BindingIdentifies the purpose for this identifier, if known .
The codes SHALL be taken from IdentifierUse
Typecode
Is Modifiertrue
Requirements

Allows the appropriate identifier for a particular context of use to be selected from among a set of identifiers.

Comments

This is labeled as "Is Modifier" because applications should not mistake a temporary id for a permanent one. Applications can assume that an identifier is permanent unless it explicitly says that it is temporary.

AuditEvent.entity.identifier.type
Definition

A coded type for the identifier that can be used to determine which identifier to use for a specific purpose.

Control0..1
BindingA coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
The codes SHALL be taken from Identifier Type Codes; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

Allows users to make use of identifiers when the identifier system is not known.

Comments

This element deals only with general categories of identifiers. It SHOULD not be used for codes that correspond 1..1 with the Identifier.system. Some identifiers may fall into multiple categories due to common usage.

Where the system is known, a type is unnecessary because the type is always part of the system definition. However systems often need to handle identifiers where the system is not known. There is not a 1:1 relationship between type and system, since many different systems have the same type.

AuditEvent.entity.identifier.system
Definition

Establishes the namespace for the value - that is, a URL that describes a set values that are unique.

Control1..1
Typeuri
Requirements

There are many sets of identifiers. To perform matching of two identifiers, we need to know what set we're dealing with. The system identifies a particular set of unique identifiers.

Fixed Valueurn:oid:2.16.756.5.30.1.127.3.10.3
Example
General:http://www.acme.com/identifiers/patient or urn:ietf:rfc:3986 if the Identifier.value itself is a full uri
AuditEvent.entity.identifier.value
Definition

The portion of the identifier typically relevant to the user and which is unique within the context of the system.

Control0..1
Typestring
Comments

If the value is a full URI, then the system SHALL be urn:ietf:rfc:3986. The value's primary purpose is computational mapping. As a result, it may be normalized for comparison purposes (e.g. removing non-significant whitespace, dashes, etc.) A value formatted for human display can be conveyed using the Rendered Value extension.

Example
General:123456
AuditEvent.entity.identifier.period
Definition

Time period during which identifier is/was valid for use.

Control0..1
TypePeriod
AuditEvent.entity.identifier.assigner
Definition

Organization that issued/manages the identifier.

Control0..1
TypeReference(Organization)
Comments

The Identifier.assigner may omit the .reference element and only contain a .display element reflecting the name or other textual information about the assigning organization.

AuditEvent.entity.reference
Definition

Identifies a specific instance of the entity. The reference should be version specific.

Control0..1
TypeReference(Resource)
AuditEvent.entity.type
Definition

The type of the object that was involved in this audit event.

Control1..1
BindingCode for the entity type involved in the audit event
The codes SHALL be taken from AuditEventEntityType; other codes may be used where these codes are not suitable
TypeCoding
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 entity.

AuditEvent.entity.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.type.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

AuditEvent.entity.type.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

AuditEvent.entity.type.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Value1
AuditEvent.entity.type.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

AuditEvent.entity.type.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

AuditEvent.entity.role
Definition

Code representing the role the entity played in the event being audited.

Control1..1
BindingCode representing the role the entity played in the audit event
The codes SHALL be taken from AuditEventEntityRole; other codes may be used where these codes are not suitable
TypeCoding
Requirements

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.entity.role.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.role.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.role.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

AuditEvent.entity.role.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

AuditEvent.entity.role.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Value1
AuditEvent.entity.role.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

AuditEvent.entity.role.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

AuditEvent.entity.lifecycle
Definition

Identifier for the data life-cycle stage for the entity.

Control0..1
TypeCoding
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.

AuditEvent.entity.securityLabel
Definition

Security labels for the identified entity.

Control0..*
BindingSecurity Labels from the Healthcare Privacy and Security Classification System.
The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable
TypeCoding
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.

AuditEvent.entity.name
Definition

A name of the entity in the audit event.

Control0..1 This element is affected by the following invariants: sev-1
Typestring
Requirements

Use only where entity can't be identified with an identifier.

Comments

This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.

AuditEvent.entity.description
Definition

Text that describes the entity in more detail.

Control0..1
Typestring
Requirements

Use only where entity can't be identified with an identifier.

AuditEvent.entity.query
Definition

The query parameters for a query-type entities.

Control0..1 This element is affected by the following invariants: sev-1
Typebase64Binary
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.

AuditEvent.entity.detail
Definition

Tagged value pairs for conveying additional information about the entity.

Control0..*
TypeBackboneElement
Requirements

Implementation-defined data about specific details of the object accessed or used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.entity.detail.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Control1..1
Typestring
AuditEvent.entity.detail.value
Definition

The details, base64 encoded. Used to carry bulk information.

Control1..1
Typebase64Binary
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value is base64 encoded to enable various encodings or binary content.

AuditEvent.entity(Resource)
Definition

Specific instances of data or objects that have been accessed.

Control0..1
TypeBackboneElement
Requirements

The event may have other entities involved.

Alternate NamesParticipantObject
Comments

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.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
sev-1: Either a name or a query (NOT both) (: name.empty() or query.empty())
AuditEvent.entity.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.identifier
Definition

Identifier. HCP (GLN), Group (OID)

NoteThis is a business identifier, not a resource identifier (see discussion)
Control0..1
TypeIdentifier
Comments

Identifier detail depends on entity type.

AuditEvent.entity.reference
Definition

Identifies a specific instance of the entity. The reference should be version specific.

Control0..1
TypeReference(Resource)
AuditEvent.entity.type
Definition

The type of the object that was involved in this audit event.

Control1..1
BindingCode for the entity type involved in the audit event
The codes SHALL be taken from AuditEventEntityType; other codes may be used where these codes are not suitable
TypeCoding
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 entity.

AuditEvent.entity.type.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.type.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.type.system
Definition

The identification of the code system that defines the meaning of the symbol in the code.

Control0..1
Typeuri
Requirements

Need to be unambiguous about the source of the definition of the symbol.

Comments

The URI may be an OID (urn:oid:...) or a UUID (urn:uuid:...). OIDs and UUIDs SHALL be references to the HL7 OID registry. Otherwise, the URI should come from HL7's list of FHIR defined special URIs or it should de-reference to some definition that establish the system clearly and unambiguously.

AuditEvent.entity.type.version
Definition

The version of the code system which was used when choosing this code. Note that a well-maintained code system does not need the version reported, because the meaning of codes is consistent across versions. However this cannot consistently be assured. and when the meaning is not guaranteed to be consistent, the version SHOULD be exchanged.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Comments

Where the terminology does not clearly define what string should be used to identify code system versions, the recommendation is to use the date (expressed in FHIR date format) on which that version was officially published as the version date.

AuditEvent.entity.type.code
Definition

A symbol in syntax defined by the system. The symbol may be a predefined code or an expression in a syntax defined by the coding system (e.g. post-coordination).

Control1..1
Typecode
Requirements

Need to refer to a particular code in the system.

Fixed Value2
AuditEvent.entity.type.display
Definition

A representation of the meaning of the code in the system, following the rules of the system.

Control0..1
Typestring
Requirements

Need to be able to carry a human-readable meaning of the code for readers that do not know the system.

AuditEvent.entity.type.userSelected
Definition

Indicates that this coding was chosen by a user directly - i.e. off a pick list of available items (codes or displays).

Control0..1
Typeboolean
Requirements

This has been identified as a clinical safety criterium - that this exact system/code pair was chosen explicitly, rather than inferred by the system based on some rules or language processing.

Comments

Amongst a set of alternatives, a directly chosen code is the most appropriate starting point for new translations. There is some ambiguity about what exactly 'directly chosen' implies, and trading partner agreement may be needed to clarify the use of this element and its consequences more completely.

AuditEvent.entity.role
Definition

Code representing the role the entity played in the event being audited.

Control1..1
BindingEprParticipant
The codes SHALL be taken from EprParticipant
TypeCoding
Requirements

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.entity.lifecycle
Definition

Identifier for the data life-cycle stage for the entity.

Control0..1
TypeCoding
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.

AuditEvent.entity.securityLabel
Definition

Security labels for the identified entity.

Control0..*
BindingSecurity Labels from the Healthcare Privacy and Security Classification System.
The codes SHALL be taken from All Security Labels; other codes may be used where these codes are not suitable
TypeCoding
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.

AuditEvent.entity.name
Definition

A name of the entity in the audit event.

Control1..1 This element is affected by the following invariants: sev-1
Typestring
Requirements

Use only where entity can't be identified with an identifier.

Comments

This field may be used in a query/report to identify audit events for a specific person. For example, where multiple synonymous entity identifiers (patient number, medical record number, encounter number, etc.) have been used.

AuditEvent.entity.description
Definition

Text that describes the entity in more detail.

Control0..1
Typestring
Requirements

Use only where entity can't be identified with an identifier.

AuditEvent.entity.query
Definition

The query parameters for a query-type entities.

Control0..1 This element is affected by the following invariants: sev-1
Typebase64Binary
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.

AuditEvent.entity.detail
Definition

Tagged value pairs for conveying additional information about the entity.

Control0..*
TypeBackboneElement
Requirements

Implementation-defined data about specific details of the object accessed or used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.entity.detail.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Control1..1
Typestring
AuditEvent.entity.detail.value
Definition

The details, base64 encoded. Used to carry bulk information.

Control1..1
Typebase64Binary
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value is base64 encoded to enable various encodings or binary content.

AuditEvent.entity.detail(AccessLevel)
Definition

The type of extra detail provided in the value.

Control0..1
TypeBackboneElement
Requirements

Implementation-defined data about specific details of the object accessed or used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.entity.detail.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Control1..1
Typestring
Fixed ValueAccessLevel
AuditEvent.entity.detail.value
Definition

The details, base64 encoded. Used to carry bulk information.

Control1..1
Typebase64Binary
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value is base64 encoded to enable various encodings or binary content.

AuditEvent.entity.detail(AccessLimitedToDate)
Definition

Tagged value pairs for conveying additional information about the entity.

Control0..1
TypeBackboneElement
Requirements

Implementation-defined data about specific details of the object accessed or used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.entity.detail.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Control1..1
Typestring
Fixed ValueAccessLimitedToDate
AuditEvent.entity.detail.value
Definition

The details, base64 encoded. Used to carry bulk information.

Control1..1
Typebase64Binary
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value is base64 encoded to enable various encodings or binary content.

AuditEvent.entity.detail(ProvideLevel)
Definition

Tagged value pairs for conveying additional information about the entity.

Control0..1
TypeBackboneElement
Requirements

Implementation-defined data about specific details of the object accessed or used.

InvariantsDefined on this element
ele-1: All FHIR elements must have a @value or children (: hasValue() | (children().count() > id.count()))
AuditEvent.entity.detail.id
Definition

unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

Control0..1
Typestring
AuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

AuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Control1..1
Typestring
Fixed ValueProvideLevel
AuditEvent.entity.detail.value
Definition

The details, base64 encoded. Used to carry bulk information.

Control1..1
Typebase64Binary
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value is base64 encoded to enable various encodings or binary content.