Situational Awareness for Novel Epidemic Response, published by HL7 International / Public Health. This guide is not an authorized publication; it is the continuous build for version 1.0.1 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-saner/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• Examples
• XML
• JSON
• TTL

Resource Profile: General Audit Event Requirements

Defines general constraints on the AuditEvent Resource.

Usage:

• Examples for this Resource Profile: AuditEvent/ExAuditEventBase

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

• Differential Table
• Key Elements Table
• Snapshot Table
• Statistics/References
• All

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
subtype	S	1..1	Coding	More specific type/id for the event
system		0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction
action	S	1..1	code	Type of action performed during the event
period	S	1..1	Period	When the activity occurred
recorded	S	1..1	instant	Time when the event was recorded
Slices for agent		2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor
agent:Source	S	1..1	BackboneElement	Actor involved in the event
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Roles (required)
who	S	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor		1..1	boolean	Whether user is initiator Required Pattern: false
agent:HumanRequestor	S	0..*	BackboneElement	Actor involved in the event
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Or Destination Roles (required)
who	S	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor		1..1	boolean	Whether user is initiator Required Pattern: true
agent:Destination	S	1..1	BackboneElement	Actor involved in the event
role	S	1..1	CodeableConcept	Agent role in the event Binding: Destination Roles (required)
who	S	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor		1..1	boolean	Whether user is initiator Required Pattern: false
entity	S	1..*	BackboneElement	Data or objects used
role	S	1..1	Coding	What role the entity played
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.agent:Source.role	required	SourceRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceRoles from this IG
AuditEvent.agent:HumanRequestor.role	required	SourceOrDestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceOrDestinationRoles from this IG
AuditEvent.agent:Destination.role	required	DestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/DestinationRoles from this IG

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Type/identifier of event Binding: AuditEventID (extensible): Type of event.
subtype	SΣ	1..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction
action	SΣ	1..1	code	Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period	S	1..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	Time when the event was recorded
Slices for agent		2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
requestor	Σ	1..1	boolean	Whether user is initiator
agent:Source	S	1..1	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
agent:HumanRequestor	S	0..*	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Or Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
agent:Destination	S	1..1	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	Agent role in the event Binding: Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
source		1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identity of source detecting the event
entity	SC	1..*	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.type	extensible	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	extensible	AuditEventSub-Type http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard
AuditEvent.agent:Source.role	required	SourceRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceRoles from this IG
AuditEvent.agent:HumanRequestor.role	required	SourceOrDestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceOrDestinationRoles from this IG
AuditEvent.agent:Destination.role	required	DestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/DestinationRoles from this IG
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Type/identifier of event Binding: AuditEventID (extensible): Type of event.
subtype	SΣ	1..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
action	SΣ	1..1	code	Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period	S	1..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	Time when the event was recorded
outcome	Σ	0..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	Σ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent		2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor
agent:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:Source	S	1..1	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:HumanRequestor	S	0..*	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Or Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:Destination	S	1..1	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	1..1	CodeableConcept	Agent role in the event Binding: Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
source		1..1	BackboneElement	Audit Event Reporter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site		0..1	string	Logical source location within the enterprise
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identity of source detecting the event
type		0..*	Coding	The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
entity	SC	1..*	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	0..1	Reference(Resource)	Specific instance of resource
type		0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role	S	1..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AuditEvent.type	extensible	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	extensible	AuditEventSub-Type http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard
AuditEvent.outcome	required	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard
AuditEvent.purposeOfEvent	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
AuditEvent.agent.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:Source.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent:Source.role	required	SourceRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceRoles from this IG
AuditEvent.agent:Source.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent:Source.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent:Source.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:HumanRequestor.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent:HumanRequestor.role	required	SourceOrDestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceOrDestinationRoles from this IG
AuditEvent.agent:HumanRequestor.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent:HumanRequestor.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent:HumanRequestor.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:Destination.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent:Destination.role	required	DestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/DestinationRoles from this IG
AuditEvent.agent:Destination.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent:Destination.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent:Destination.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.type	extensible	AuditEventSourceType http://hl7.org/fhir/ValueSet/audit-source-type from the FHIR Standard
AuditEvent.entity.type	extensible	AuditEventEntityType http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents http://hl7.org/fhir/ValueSet/object-lifecycle-events from the FHIR Standard
AuditEvent.entity.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard

This structure is derived from AuditEvent

Summary

Mandatory: 13 elements (3 nested mandatory elements)
Must-Support: 18 elements

Slices

This structure defines the following Slices:

• The element AuditEvent.agent is sliced based on the values of value:role, value:requestor (Open at End)

Differential View

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
subtype	S	1..1	Coding	More specific type/id for the event
system		0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction
action	S	1..1	code	Type of action performed during the event
period	S	1..1	Period	When the activity occurred
recorded	S	1..1	instant	Time when the event was recorded
Slices for agent		2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor
agent:Source	S	1..1	BackboneElement	Actor involved in the event
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Roles (required)
who	S	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor		1..1	boolean	Whether user is initiator Required Pattern: false
agent:HumanRequestor	S	0..*	BackboneElement	Actor involved in the event
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Or Destination Roles (required)
who	S	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor		1..1	boolean	Whether user is initiator Required Pattern: true
agent:Destination	S	1..1	BackboneElement	Actor involved in the event
role	S	1..1	CodeableConcept	Agent role in the event Binding: Destination Roles (required)
who	S	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor		1..1	boolean	Whether user is initiator Required Pattern: false
entity	S	1..*	BackboneElement	Data or objects used
role	S	1..1	Coding	What role the entity played
system		0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.agent:Source.role	required	SourceRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceRoles from this IG
AuditEvent.agent:HumanRequestor.role	required	SourceOrDestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceOrDestinationRoles from this IG
AuditEvent.agent:Destination.role	required	DestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/DestinationRoles from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Type/identifier of event Binding: AuditEventID (extensible): Type of event.
subtype	SΣ	1..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction
action	SΣ	1..1	code	Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period	S	1..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	Time when the event was recorded
Slices for agent		2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor
agent:All Slices				Content/Rules for all slices
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
requestor	Σ	1..1	boolean	Whether user is initiator
agent:Source	S	1..1	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
agent:HumanRequestor	S	0..*	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Or Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
agent:Destination	S	1..1	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	CodeableConcept	Agent role in the event Binding: Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
source		1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identity of source detecting the event
entity	SC	1..*	BackboneElement	Data or objects used
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
role	S	1..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.type	extensible	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	extensible	AuditEventSub-Type http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard
AuditEvent.agent:Source.role	required	SourceRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceRoles from this IG
AuditEvent.agent:HumanRequestor.role	required	SourceOrDestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceOrDestinationRoles from this IG
AuditEvent.agent:Destination.role	required	DestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/DestinationRoles from this IG
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
id	Σ	0..1	id	Logical id of this artifact
meta	Σ	0..1	Meta	Metadata about the resource
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: CommonLanguages (preferred): A human language. Additional Bindings Purpose AllLanguages Max Binding
text		0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
type	Σ	1..1	Coding	Type/identifier of event Binding: AuditEventID (extensible): Type of event.
subtype	SΣ	1..1	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://hl7.org/fhir/restful-interaction
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
action	SΣ	1..1	code	Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period	S	1..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	Time when the event was recorded
outcome	Σ	0..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
outcomeDesc	Σ	0..1	string	Description of the event outcome
purposeOfEvent	Σ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent		2..*	BackboneElement	Actor involved in the event Slice: Unordered, Open At End by value:role, value:requestor
agent:All Slices				Content/Rules for all slices
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role		0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	Σ	0..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:Source	S	1..1	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:HumanRequestor	S	0..*	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	1..1	CodeableConcept	Agent role in the event Binding: Source Or Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: true
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:Destination	S	1..1	BackboneElement	Actor involved in the event
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	1..1	CodeableConcept	Agent role in the event Binding: Destination Roles (required)
who	SΣ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	Identifier of who
altId		0..1	string	Alternative User identity
name	S	1..1	string	Human friendly name for the agent
requestor	Σ	1..1	boolean	Whether user is initiator Required Pattern: false
location		0..1	Reference(Location)	Where
policy		0..*	uri	Policy that authorized event
media		0..1	Coding	Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.
network		0..1	BackboneElement	Logical network location for application activity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address		0..1	string	Identifier for the network access point of the user device
type		0..1	code	The type of network access point Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.
purposeOfUse		0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
source		1..1	BackboneElement	Audit Event Reporter
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
site		0..1	string	Logical source location within the enterprise
observer	Σ	1..1	Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson)	The identity of source detecting the event
type		0..*	Coding	The type of source where event originated Binding: AuditEventSourceType (extensible): Code specifying the type of system that detected and recorded the event.
entity	SC	1..*	BackboneElement	Data or objects used
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	Σ	0..1	Reference(Resource)	Specific instance of resource
type		0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role	S	1..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
system	Σ	0..1	uri	Identity of the terminology system Required Pattern: http://terminology.hl7.org/CodeSystem/object-role
version	Σ	0..1	string	Version of the system - if relevant
code	Σ	0..1	code	Symbol in syntax defined by the system
display	Σ	0..1	string	Representation defined by the system
userSelected	Σ	0..1	boolean	If this coding was chosen directly by the user
lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
name	ΣC	0..1	string	Descriptor for entity
description		0..1	string	Descriptive text
query	ΣC	0..1	base64Binary	Query parameters
detail		0..*	BackboneElement	Additional Information about the entity
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type		1..1	string	Name of the property
value[x]		1..1		Property value
valueString			string
valueBase64Binary			base64Binary
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.language	preferred	CommonLanguages Additional Bindings Purpose AllLanguages Max Binding http://hl7.org/fhir/ValueSet/languages from the FHIR Standard
AuditEvent.type	extensible	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	extensible	AuditEventSub-Type http://hl7.org/fhir/ValueSet/audit-event-sub-type from the FHIR Standard
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard
AuditEvent.outcome	required	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard
AuditEvent.purposeOfEvent	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent.role	example	SecurityRoleType http://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard
AuditEvent.agent.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:Source.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent:Source.role	required	SourceRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceRoles from this IG
AuditEvent.agent:Source.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent:Source.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent:Source.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:HumanRequestor.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent:HumanRequestor.role	required	SourceOrDestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/SourceOrDestinationRoles from this IG
AuditEvent.agent:HumanRequestor.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent:HumanRequestor.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent:HumanRequestor.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:Destination.type	extensible	ParticipationRoleType http://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard
AuditEvent.agent:Destination.role	required	DestinationRoles http://hl7.org/fhir/uv/saner/ValueSet/DestinationRoles from this IG
AuditEvent.agent:Destination.media	extensible	MediaTypeCode http://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard
AuditEvent.agent:Destination.network.type	required	AuditEventAgentNetworkType http://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard
AuditEvent.agent:Destination.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.type	extensible	AuditEventSourceType http://hl7.org/fhir/ValueSet/audit-source-type from the FHIR Standard
AuditEvent.entity.type	extensible	AuditEventEntityType http://hl7.org/fhir/ValueSet/audit-entity-type from the FHIR Standard
AuditEvent.entity.role	extensible	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents http://hl7.org/fhir/ValueSet/object-lifecycle-events from the FHIR Standard
AuditEvent.entity.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels from the FHIR Standard

This structure is derived from AuditEvent

Summary

Mandatory: 13 elements (3 nested mandatory elements)
Must-Support: 18 elements

Slices

This structure defines the following Slices:

• The element AuditEvent.agent is sliced based on the values of value:role, value:requestor (Open at End)

Other representations of profile: CSV, Excel, Schematron