AuditEvent

Property	Value
Publisher
Name	AuditEvent
URL	http://hl7.org/fhir/StructureDefinition/AuditEvent
Status	draft
Description
Abstract	false

Structure

Path	Cardinality	Type	Description
AuditEvent	0..*	AuditEvent	A record of an event made for purposes of maintaining a security log. Typical uses include detection of intrusion attempts and monitoring for inappropriate usage.
AuditEvent.id	0..1	http://hl7.org/fhirpath/System.String	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
AuditEvent.meta	0..1	Meta	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.
AuditEvent.implicitRules	0..1	uri	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.
AuditEvent.language	0..1	code	The base language in which the resource is written.
AuditEvent.text	0..1	Narrative	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.
AuditEvent.contained	0..*	Resource	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.
AuditEvent.extension	0..*	Extension	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.
AuditEvent.modifierExtension	0..*	Extension	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).
AuditEvent.type	1..1	Coding	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.
AuditEvent.subtype	0..*	Coding	Identifier for the category of event.
AuditEvent.action	0..1	code	Indicator for type of action performed during the event that generated the audit.
AuditEvent.period	0..1	Period	The period during which the activity occurred.
AuditEvent.recorded	1..1	instant	The time when the event was recorded.
AuditEvent.outcome	0..1	code	Indicates whether the event succeeded or failed.
AuditEvent.outcomeDesc	0..1	string	A free text description of the outcome of the event.
AuditEvent.purposeOfEvent	0..*	CodeableConcept	The purposeOfUse (reason) that was used during the event being recorded.
AuditEvent.agent	1..*	BackboneElement	An actor taking an active role in the event or activity that is logged.
AuditEvent.agent.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AuditEvent.agent.extension	0..*	Extension	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.
AuditEvent.agent.modifierExtension	0..*	Extension	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).
AuditEvent.agent.type	0..1	CodeableConcept	Specification of the participation type the user plays when performing the event.
AuditEvent.agent.role	0..*	CodeableConcept	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.
AuditEvent.agent.who	0..1	Reference	Reference to who this agent is that was involved in the event.
AuditEvent.agent.altId	0..1	string	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.
AuditEvent.agent.name	0..1	string	Human-meaningful name for the agent.
AuditEvent.agent.requestor	1..1	boolean	Indicator that the user is or is not the requestor, or initiator, for the event being audited.
AuditEvent.agent.location	0..1	Reference	Where the event occurred.
AuditEvent.agent.policy	0..*	uri	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.
AuditEvent.agent.media	0..1	Coding	Type of media involved. Used when the event is about exporting/importing onto media.
AuditEvent.agent.network	0..1	BackboneElement	Logical network location for application activity, if the activity has a network location.
AuditEvent.agent.network.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AuditEvent.agent.network.extension	0..*	Extension	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.
AuditEvent.agent.network.modifierExtension	0..*	Extension	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).
AuditEvent.agent.network.address	0..1	string	An identifier for the network access point of the user device for the audit event.
AuditEvent.agent.network.type	0..1	code	An identifier for the type of network access point that originated the audit event.
AuditEvent.agent.purposeOfUse	0..*	CodeableConcept	The reason (purpose of use), specific to this agent, that was used during the event being recorded.
AuditEvent.source	1..1	BackboneElement	The system that is reporting the event.
AuditEvent.source.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AuditEvent.source.extension	0..*	Extension	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.
AuditEvent.source.modifierExtension	0..*	Extension	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).
AuditEvent.source.site	0..1	string	Logical source location within the healthcare enterprise network. For example, a hospital or other provider location within a multi-entity provider group.
AuditEvent.source.observer	1..1	Reference	Identifier of the source where the event was detected.
AuditEvent.source.type	0..*	Coding	Code specifying the type of source where event originated.
AuditEvent.entity	0..*	BackboneElement	Specific instances of data or objects that have been accessed.
AuditEvent.entity.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AuditEvent.entity.extension	0..*	Extension	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.
AuditEvent.entity.modifierExtension	0..*	Extension	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).
AuditEvent.entity.what	0..1	Reference	Identifies a specific instance of the entity. The reference should be version specific.
AuditEvent.entity.type	0..1	Coding	The type of the object that was involved in this audit event.
AuditEvent.entity.role	0..1	Coding	Code representing the role the entity played in the event being audited.
AuditEvent.entity.lifecycle	0..1	Coding	Identifier for the data life-cycle stage for the entity.
AuditEvent.entity.securityLabel	0..*	Coding	Security labels for the identified entity.
AuditEvent.entity.name	0..1	string	A name of the entity in the audit event.
AuditEvent.entity.description	0..1	string	Text that describes the entity in more detail.
AuditEvent.entity.query	0..1	base64Binary	The query parameters for a query-type entities.
AuditEvent.entity.detail	0..*	BackboneElement	Tagged value pairs for conveying additional information about the entity.
AuditEvent.entity.detail.id	0..1	http://hl7.org/fhirpath/System.String	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
AuditEvent.entity.detail.extension	0..*	Extension	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.
AuditEvent.entity.detail.modifierExtension	0..*	Extension	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).
AuditEvent.entity.detail.type	1..1	string	The type of extra detail provided in the value.
AuditEvent.entity.detail.value[x]	1..1	string	The value of the extra detail.

Search Parameters

Name	Type	Description	Expression
_text	string	Search on the narrative of the resource
_content	string	Search on the entire content of the resource
_filter	token	Filter search parameter which supports a more sophisticated grammar for searching. See documentation for further details
_has	string	Provides limited support for reverse chaining - that is, selecting resources based on the properties of resources that refer to them (instead of chaining where resources can be selected based on the properties of resources that they refer to). See the FHIR search page for further documentation
_id	token	Logical id of this artifact	Resource.id
_lastUpdated	date	When the resource version last changed	Resource.meta.lastUpdated
_list	string	All resources in nominated list (by id, Type/id, url or one of the magic List types)
_profile	uri	Profiles this resource claims to conform to	Resource.meta.profile
_query	token	A custom search profile that describes a specific defined query operation
_security	token	Security Labels applied to this resource	Resource.meta.security
_source	uri	Identifies where the resource comes from	Resource.meta.source
_tag	token	Tags applied to this resource	Resource.meta.tag
_text	string	Search on the narrative text (html) of the resource
_type	token	Used when a search is performed in a context which doesn't limit the search to indicate which types are being searched. See the FHIR search page for further discussion
action	token	Type of action performed during the event	AuditEvent.action
address	string	Identifier for the network access point of the user device	AuditEvent.agent.network.address
agent	reference	Identifier of who	AuditEvent.agent.who
agent-name	string	Human friendly name for the agent	AuditEvent.agent.name
agent-role	token	Agent role in the event	AuditEvent.agent.role
altid	token	Alternative User identity	AuditEvent.agent.altId
date	date	Time when the event was recorded	AuditEvent.recorded
entity	reference	Specific instance of resource	AuditEvent.entity.what
entity-name	string	Descriptor for entity	AuditEvent.entity.name
entity-role	token	What role the entity played	AuditEvent.entity.role
entity-type	token	Type of entity involved	AuditEvent.entity.type
outcome	token	Whether the event succeeded or failed	AuditEvent.outcome
patient	reference	Identifier of who	AuditEvent.agent.who.where(resolve() is Patient) / AuditEvent.entity.what.where(resolve() is Patient)
policy	uri	Policy that authorized event	AuditEvent.agent.policy
site	token	Logical source location within the enterprise	AuditEvent.source.site
source	reference	The identity of source detecting the event	AuditEvent.source.observer
subtype	token	More specific type/id for the event	AuditEvent.subtype
type	token	Type/identifier of event	AuditEvent.type