Release 5 Preview #2
Electronic Health Records Work Group Maturity Level: 1Trial Use Use Context: Any

Definitions for the ehrsrle-auditevent Profile.

AuditEvent
Element IdAuditEvent
Definition

A record of an event relevant for purposes such as operations, privacy, security, maintenance, and performance analysis.

Cardinality0..*
Comments

Based on IHE-ATNA.

Invariants
Inherited by this element
dom-2RuleIf the resource is contained in another resource, it SHALL NOT contain nested Resourcescontained.contained.empty()
dom-3RuleIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resourcecontained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4RuleIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdatedcontained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5RuleIf a resource is contained in another resource, it SHALL NOT have a security labelcontained.meta.security.empty()
dom-6GuidelineA resource should have narrative for robust managementtext.`div`.exists()
This is (only) a best practice guideline because:

When a resource has no narrative, only systems that fully understand the data can display the resource to a human safely. Including a human readable representation in the resource makes for a much more robust eco-system and cheaper handling of resources by intermediary systems. Some ecosystems restrict distribution of resources to only those systems that do fully understand the resources, and as a consequence implementers may believe that the narrative is superfluous. However experience shows that such eco-systems often open up to new participants over time.

AuditEvent.id
Element IdAuditEvent.id
Definition

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

Cardinality0..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
Element IdAuditEvent.meta
Definition

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

Cardinality0..1
TypeMeta
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.implicitRules
Element IdAuditEvent.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. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Cardinality0..1
Typeuri
Is Modifiertrue (Reason: This element is labeled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation)
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. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.language
Element IdAuditEvent.language
Definition

The base language in which the resource is written.

Cardinality0..1
Terminology BindingA human language.
The codes SHOULD be taken from Common Languages
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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.text
Element IdAuditEvent.text
Definition

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Cardinality0..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 information is added later.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.contained
Element IdAuditEvent.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.

Cardinality0..*
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. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

AuditEvent.extension
Element IdAuditEvent.extension
Definition

May be used to represent additional information that is not part of the basic definition of the resource. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.modifierExtension
Element IdAuditEvent.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 and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the resource that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.type
Element IdAuditEvent.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.

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

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.subtype
Element IdAuditEvent.subtype
Definition

Identifier for the category of event.

Cardinality0..*
Terminology 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
Must Supporttrue
Requirements

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.action
Element IdAuditEvent.action
Definition

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

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

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.severity
Element IdAuditEvent.severity
Definition

Indicates and enables segmentation of various severity including debugging from critical.

Cardinality0..1
Terminology BindingThe severity of the audit entry.
The codes SHALL be taken from AuditEventSeverity
Typecode
Comments

ATNA will map this to the SYSLOG PRI element.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.period
Element IdAuditEvent.period
Definition

The period during which the activity occurred.

Cardinality0..1
TypePeriod
Comments

The period can be a little arbitrary; where possible, the time should correspond to human assessment of the activity time.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.recorded
Element IdAuditEvent.recorded
Definition

The time when the event was recorded.

Cardinality1..1
Typeinstant
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.outcome
Element IdAuditEvent.outcome
Definition

Indicates whether the event succeeded or failed. A free text descripiton can be given in outcome.text.

Cardinality0..1
Terminology BindingIndicates whether the event succeeded or failed.
The codes SHALL be taken from AuditEventOutcome; other codes may be used where these codes are not suitable
TypeCodeableConcept
Requirements

when a code is given there must be one code from the given codeSystem, and may be other equivilant codes from other codeSystems (for example http response codes such as 2xx, 4xx, or 5xx).

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.purposeOfEvent
Element IdAuditEvent.purposeOfEvent
Definition

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

Cardinality0..*
Terminology BindingThe reason the activity took place.
The codes SHALL be taken from V3 Value SetPurposeOfUse; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

record of any relevant security context not restricted to purposeOfUse valueSet, may include security compartments or other security tags.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent
Element IdAuditEvent.agent
Definition

An actor taking an active role in the event or activity that is logged.

Cardinality1..*
TypeBackboneElement
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.id
Element IdAuditEvent.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.

Cardinality0..1
Typeid
AuditEvent.agent.extension
Element IdAuditEvent.agent.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.agent.modifierExtension
Element IdAuditEvent.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.agent.type
Element IdAuditEvent.agent.type
Definition

Specification of the participation type the user plays when performing the event.

Cardinality0..1
Terminology BindingThe Participation type of the agent to the event.
The codes SHALL be taken from ParticipationRoleType; other codes may be used where these codes are not suitable
TypeCodeableConcept
Comments

The most relevant role code for how the agent participated in the activity.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.role
Element IdAuditEvent.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.

Cardinality0..*
Terminology BindingWhat security role enabled the agent to participate in the event.
For example codes, see SecurityRoleType
TypeCodeableConcept
Must Supporttrue
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 all the relevant roles (Functional and Structural) inclusive of the value in .agent.type.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.who
Element IdAuditEvent.agent.who
Definition

Reference to who this agent is that was involved in the event.

Cardinality0..1
TypeReference(PractitionerRole)
Must Supporttrue
Requirements

This field ties an audit event to a specific resource or identifier.

Alternate NamesuserId
Comments

Where a User ID is available it will go into who.identifier.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.altId
Element IdAuditEvent.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.

Cardinality0..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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.name
Element IdAuditEvent.agent.name
Definition

Human-meaningful name for the agent.

Cardinality0..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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.requestor
Element IdAuditEvent.agent.requestor
Definition

Indicator that the user is or is not the requestor, or initiator, for the event being audited.

Cardinality1..1
Typeboolean
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.location
Element IdAuditEvent.agent.location
Definition

Where the event occurred.

Cardinality0..1
TypeReference(Location)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.policy
Element IdAuditEvent.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.

Cardinality0..*
Typeuri
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.media
Element IdAuditEvent.agent.media
Definition

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

Cardinality0..1
Terminology 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).

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.network
Element IdAuditEvent.agent.network
Definition

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

Cardinality0..1
TypeBackboneElement
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.network.id
Element IdAuditEvent.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.

Cardinality0..1
Typeid
AuditEvent.agent.network.extension
Element IdAuditEvent.agent.network.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.agent.network.modifierExtension
Element IdAuditEvent.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.agent.network.address
Element IdAuditEvent.agent.network.address
Definition

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

Cardinality0..1
Typestring
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.network.type
Element IdAuditEvent.agent.network.type
Definition

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

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.agent.purposeOfUse
Element IdAuditEvent.agent.purposeOfUse
Definition

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

Cardinality0..*
Terminology BindingThe reason the activity took place.
The codes SHALL be taken from V3 Value SetPurposeOfUse; other codes may be used where these codes are not suitable
TypeCodeableConcept
Must Supporttrue
Requirements

record of any relevant security context not restricted to purposeOfUse valueSet, may include security compartments or other security tags.

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.source
Element IdAuditEvent.source
Definition

The system that is reporting the event.

Cardinality1..1
TypeBackboneElement
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.source.id
Element IdAuditEvent.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.

Cardinality0..1
Typeid
AuditEvent.source.extension
Element IdAuditEvent.source.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.source.modifierExtension
Element IdAuditEvent.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.source.site
Element IdAuditEvent.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.

Cardinality0..1
Typestring
Must Supporttrue
Requirements

This value differentiates among the sites in a multi-site enterprise health information system.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.source.observer
Element IdAuditEvent.source.observer
Definition

Identifier of the source where the event was detected.

Cardinality1..1
TypeReference(PractitionerRole)
Must Supporttrue
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.

Alternate NamesSourceId
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.source.type
Element IdAuditEvent.source.type
Definition

Code specifying the type of source where event originated.

Cardinality0..*
Terminology 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
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity
Element IdAuditEvent.entity
Definition

Specific instances of data or objects that have been accessed.

Cardinality0..*
TypeBackboneElement
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
sev-1RuleEither a name or a query (NOT both)name.empty() or query.empty()
AuditEvent.entity.id
Element IdAuditEvent.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.

Cardinality0..1
Typeid
AuditEvent.entity.extension
Element IdAuditEvent.entity.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.entity.modifierExtension
Element IdAuditEvent.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.entity.what
Element IdAuditEvent.entity.what
Definition

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

Cardinality0..1
TypeReference(Resource)
Must Supporttrue
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.type
Element IdAuditEvent.entity.type
Definition

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

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.role
Element IdAuditEvent.entity.role
Definition

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

Cardinality0..1
Terminology 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
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.lifecycle
Element IdAuditEvent.entity.lifecycle
Definition

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

Cardinality0..1
Terminology BindingIdentifier for the data life-cycle stage for the entity.
The codes SHALL be taken from ObjectLifecycleEvents; other codes may be used where these codes are not suitable
TypeCoding
Must Supporttrue
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.securityLabel
Element IdAuditEvent.entity.securityLabel
Definition

Security labels for the identified entity.

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.name
Element IdAuditEvent.entity.name
Definition

A name of the entity in the audit event.

Cardinality0..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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.query
Element IdAuditEvent.entity.query
Definition

The query parameters for a query-type entities.

Cardinality0..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.

Comments

The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example, if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.detail
Element IdAuditEvent.entity.detail
Definition

Tagged value pairs for conveying additional information about the entity.

Cardinality0..*
TypeBackboneElement
Requirements

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

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.detail.id
Element IdAuditEvent.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.

Cardinality0..1
Typeid
AuditEvent.entity.detail.extension
Element IdAuditEvent.entity.detail.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. 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 can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Cardinality0..*
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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.entity.detail.modifierExtension
Element IdAuditEvent.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 in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. 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 can 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.

Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).

Cardinality0..*
TypeExtension
Is Modifiertrue (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them)
Requirements

Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions .

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.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
ext-1RuleMust have either extensions or value[x], not bothextension.exists() != value.exists()
AuditEvent.entity.detail.type
Element IdAuditEvent.entity.detail.type
Definition

The type of extra detail provided in the value.

Cardinality1..1
Typestring
Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
AuditEvent.entity.detail.value[x]
Element IdAuditEvent.entity.detail.value[x]
Definition

The value of the extra detail.

Cardinality1..1
TypeChoice of: string, base64Binary
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

Should not duplicate the entity value unless absolutely necessary.

Comments

The value can be string when known to be a string, else base64 encoding should be used to protect binary or undefined content. The meaning and secondary-encoding of the content of base64 encoded blob is specific to the AuditEvent.type, AuditEvent.subtype, AuditEvent.entity.type, and AuditEvent.entity.role. The base64 is a general-use and safe container for event specific data blobs regardless of the encoding used by the transaction being recorded. An AuditEvent consuming application must understand the event it is consuming and the formats used by the event. For example if auditing an Oracle network database access, the Oracle formats must be understood as they will be simply encoded in the base64binary blob.

Invariants
Inherited by this element
ele-1RuleAll FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())