Mandatory and Must Support Data Elements

The following data elements must always be present or must be supported if the data is present in the sending system Must Support. They are presented below in a simple human-readable explanation. Profile specific guidance and examples are provided as well. The Formal Views below provides the formal summary, definitions, and terminology requirements.

Each Audit Event Must Have:

1. a type fixed to Dicom code 110106 "Export"
2. an action fixed to R "read"
3. a period
4. an entity

Each Audit Event Must Support:

1. all Must Have
2. a recorded
3. a purposeOfEvent
4. an agent, which Must Support:
5. a type
6. a role
7. a who
8. a requestor
9. a purposeOfUse
10. a source, which Must Support:
11. an observer
12. an entity what
13. an entity type

Referencing External Participants

Since a FHIR reference can contain a RESTful id to a patient, organization, practitioner, or related person, and those RESTful ids may not be useful once an Audit Event instance has propogated to other consent servers, this guide requires that an external identifier for those participants SHALL be populated. The RESTful id can also be sent but it is not necessary since the mandatory identifier conveys the identity of the participant. The FHIR additionalIdentifier extension is also included in the Reference to allow for multiple identifiers for participants to be conveyed.

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

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 110106
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
action	Σ	0..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. Required Pattern: R
period	S	1..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	Time when the event was recorded
purposeOfEvent	SΣ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
agent	S	1..*	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	Identifier of who
requestor	SΣ	1..1	boolean	Whether user is initiator
purposeOfUse	S	1..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
source	S	1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
observer	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	The identity of source detecting the event
type	S	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 Constraints: sev-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AuditEvent.type	extensible	Pattern Value: 110106 http://hl7.org/fhir/ValueSet/audit-event-type From the FHIR Standard
AuditEvent.action	required	Pattern Value: R http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 From the FHIR Standard
AuditEvent.purposeOfEvent	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0
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.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.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-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
type		1..1	Coding	Type/identifier of event Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 110106
action		0..1	code	Type of action performed during the event Required Pattern: R
period	S	1..1	Period	When the activity occurred
recorded	S	1..1	instant	Time when the event was recorded
purposeOfEvent	S	0..*	CodeableConcept	The purposeOfUse of the event
agent	S	1..*	BackboneElement	Actor involved in the event
type	S	0..1	CodeableConcept	How agent participated
role	S	0..*	CodeableConcept	Agent role in the event
who	S	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	Identifier of who
requestor	S	1..1	boolean	Whether user is initiator
purposeOfUse	S	1..*	CodeableConcept	Reason given for this user
source	S	1..1	BackboneElement	Audit Event Reporter
observer	S	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	The identity of source detecting the event
type	S	0..*	Coding	The type of source where event originated
entity	S	1..*	BackboneElement	Data or objects used
what	S	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 110106
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
subtype	Σ	0..*	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action	Σ	0..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. Required Pattern: R
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	SΣ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
agent	S	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	S	0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	SΣ	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	S	1..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
source	S	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	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	The identity of source detecting the event
type	S	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 Constraints: sev-1
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	SΣ	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
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 / Code	URI
AuditEvent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AuditEvent.type	extensible	Pattern Value: 110106 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	Pattern Value: R 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|3.1.0
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|3.1.0
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|5.2.0
AuditEvent.entity.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.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-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 110106
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
action	Σ	0..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. Required Pattern: R
period	S	1..1	Period	When the activity occurred
recorded	SΣ	1..1	instant	Time when the event was recorded
purposeOfEvent	SΣ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
agent	S	1..*	BackboneElement	Actor involved in the event
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
type	S	0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	Identifier of who
requestor	SΣ	1..1	boolean	Whether user is initiator
purposeOfUse	S	1..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
source	S	1..1	BackboneElement	Audit Event Reporter
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
observer	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	The identity of source detecting the event
type	S	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 Constraints: sev-1
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
what	SΣ	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet / Code	URI
AuditEvent.type	extensible	Pattern Value: 110106 http://hl7.org/fhir/ValueSet/audit-event-type From the FHIR Standard
AuditEvent.action	required	Pattern Value: R http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 From the FHIR Standard
AuditEvent.purposeOfEvent	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0
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.purposeOfUse	extensible	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse|3.1.0
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

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.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-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

Differential View

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
type		1..1	Coding	Type/identifier of event Required Pattern: At least the following
system		1..1	uri	Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 110106
action		0..1	code	Type of action performed during the event Required Pattern: R
period	S	1..1	Period	When the activity occurred
recorded	S	1..1	instant	Time when the event was recorded
purposeOfEvent	S	0..*	CodeableConcept	The purposeOfUse of the event
agent	S	1..*	BackboneElement	Actor involved in the event
type	S	0..1	CodeableConcept	How agent participated
role	S	0..*	CodeableConcept	Agent role in the event
who	S	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	Identifier of who
requestor	S	1..1	boolean	Whether user is initiator
purposeOfUse	S	1..*	CodeableConcept	Reason given for this user
source	S	1..1	BackboneElement	Audit Event Reporter
observer	S	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	The identity of source detecting the event
type	S	0..*	Coding	The type of source where event originated
entity	S	1..*	BackboneElement	Data or objects used
what	S	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
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 This profile does not constrain the narrative in regard to content, language, or traceability to data elements
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. Required Pattern: At least the following
id		0..1	string	Unique id for inter-element referencing
extension		0..*	Extension	Additional content defined by implementations
system		1..1	uri	Identity of the terminology system Fixed Value: http://dicom.nema.org/resources/ontology/DCM
version		0..1	string	Version of the system - if relevant
code		1..1	code	Symbol in syntax defined by the system Fixed Value: 110106
display		0..1	string	Representation defined by the system
userSelected		0..1	boolean	If this coding was chosen directly by the user
subtype	Σ	0..*	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action	Σ	0..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. Required Pattern: R
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	SΣ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
agent	S	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	S	0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
role	S	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	Identifier of who
altId		0..1	string	Alternative User identity
name		0..1	string	Human friendly name for the agent
requestor	SΣ	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	S	1..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (3.1.0) (extensible): The reason the activity took place.
source	S	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	SΣ	1..1	FASTReference(US Core Organization Profile | US Core Patient Profile | US Core Practitioner Profile | US Core RelatedPerson Profile | US Core PractitionerRole Profile)	The identity of source detecting the event
type	S	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 Constraints: sev-1
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	SΣ	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.
role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
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 / Code	URI
AuditEvent.language	preferred	CommonLanguages http://hl7.org/fhir/ValueSet/languages From the FHIR Standard Additional Bindings Purpose AllLanguages Max Binding
AuditEvent.type	extensible	Pattern Value: 110106 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	Pattern Value: R 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|3.1.0
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|3.1.0
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|5.2.0
AuditEvent.entity.securityLabel	extensible	All Security Labels http://hl7.org/fhir/ValueSet/security-labels From the FHIR Standard

Constraints

Id	Grade	Path(s)	Details	Requirements
dom-2	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain nested Resources : contained.contained.empty()
dom-3	error	AuditEvent	If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource : contained.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-4	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated : contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5	error	AuditEvent	If a resource is contained in another resource, it SHALL NOT have a security label : contained.meta.security.empty()
dom-6	best practice	AuditEvent	A resource should have narrative for robust management : text.`div`.exists()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count())
ext-1	error	**ALL** extensions	Must have either extensions or value[x], not both : extension.exists() != value.exists()
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both) : name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 4 elements
Must-Support: 15 elements

Structures

This structure refers to these other structures:

• FASTReference (http://hl7.org/fhir/us/consent-management/StructureDefinition/FASTReference)
• US Core Organization Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-organization)
• US Core Patient Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-patient)
• US Core Practitioner Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitioner)
• US Core RelatedPerson Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-relatedperson)
• US Core PractitionerRole Profile (http://hl7.org/fhir/us/core/StructureDefinition/us-core-practitionerrole)

Maturity: 1