EHR and PHR System Functional Models - Record Lifecycle Events Implementation Guide, published by HL7 International / Electronic Health Records. This guide is not an authorized publication; it is the continuous build for version 1.2.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/ehrs-rle-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: EHRS Functional Model - Record Lifecycle Events - AuditEvent

Defines the elements to be supported within the AuditEvent resource in order to conform with the Electronic Health Record System Functional Model Record Lifecycle Event standard

Usage:

• This Resource Profile is not used by any profiles in this Implementation Guide

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	Record of an event
type	S	1..1	CodeableConcept	High level categorization of audit event
subtype	S	0..*	CodeableConcept	Specific type of event Binding: ValueSet record-lifecycle-events (preferred)
action	S	0..1	code	Type of action performed during the event
recorded	S	1..1	instant	Time when the event was recorded
authorization	S	0..*	CodeableConcept	Authorization related to the event
agent	S	1..*	BackboneElement	Actor involved in the event
who	S	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Identifier of who
requestor	S	0..1	boolean	Whether user is initiator
location	S	0..1	Reference(Location)	The agent location when the event occurred
network[x]	S	0..1	Reference(Endpoint), uri, string	This agent network location for the activity
authorization	S	0..*	CodeableConcept	Allowable authorization for this agent
source	S	1..1	BackboneElement	Audit Event Reporter
entity	S	0..*	BackboneElement	Data or objects used
what	S	0..1	Reference(Resource)	Specific instance of resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.subtype	preferred	RecordLifecycleEvents http://hl7.org/fhir/uv/ehrs-rle/ValueSet/record-lifecycle-events from this IG

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Record of an event dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	CodeableConcept	High level categorization of audit event Binding: AuditEventID (example): Type of event. ele-1: All FHIR elements must have a @value or children
subtype	SΣ	0..*	CodeableConcept	Specific type of event Binding: ValueSet record-lifecycle-events (preferred) ele-1: All FHIR elements must have a @value or children
action	SΣ	0..1	code	Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action ele-1: All FHIR elements must have a @value or children
recorded	SΣ	1..1	instant	Time when the event was recorded ele-1: All FHIR elements must have a @value or children
authorization	SΣ	0..*	CodeableConcept	Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. ele-1: All FHIR elements must have a @value or children
agent	SΣ	1..*	BackboneElement	Actor involved in the event ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children
who	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Identifier of who ele-1: All FHIR elements must have a @value or children
requestor	SΣ	0..1	boolean	Whether user is initiator ele-1: All FHIR elements must have a @value or children
location	S	0..1	Reference(Location)	The agent location when the event occurred ele-1: All FHIR elements must have a @value or children
network[x]	S	0..1		This agent network location for the activity ele-1: All FHIR elements must have a @value or children
networkReference			Reference(Endpoint)
networkUri			uri
networkString			string
authorization	S	0..*	CodeableConcept	Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. ele-1: All FHIR elements must have a @value or children
source	SΣ	1..1	BackboneElement	Audit Event Reporter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children
observer	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	The identity of source detecting the event ele-1: All FHIR elements must have a @value or children
entity	SΣ	0..*	BackboneElement	Data or objects used ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children
what	SΣ	0..1	Reference(Resource)	Specific instance of resource ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.type	example	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	preferred	RecordLifecycleEvents http://hl7.org/fhir/uv/ehrs-rle/ValueSet/record-lifecycle-events from this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|6.0.0-ballot2 from the FHIR Standard
AuditEvent.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Record of an event
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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	SΣ	1..1	CodeableConcept	High level categorization of audit event Binding: AuditEventID (example): Type of event.
subtype	SΣ	0..*	CodeableConcept	Specific type of event Binding: ValueSet record-lifecycle-events (preferred)
action	SΣ	0..1	code	Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action
severity	Σ	0..1	code	emergency | alert | critical | error | warning | notice | informational | debug Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
occurred[x]		0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	SΣ	1..1	instant	Time when the event was recorded
outcome	Σ	0..1	BackboneElement	Whether the event succeeded or failed
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
code	Σ	1..1	Coding	Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
detail	Σ	0..*	CodeableConcept	Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.
authorization	SΣ	0..*	CodeableConcept	Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.
basedOn		0..*	Reference(Resource)	Workflow authorization within which this event occurred
patient	Σ	0..1	Reference(Patient)	The patient is the subject of the data used/created/updated/deleted during the activity
encounter		0..1	Reference(Encounter)	Encounter within which this event occurred or which the event is tightly associated
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		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (preferred): 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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Identifier of who
requestor	SΣ	0..1	boolean	Whether user is initiator
location	S	0..1	Reference(Location)	The agent location when the event occurred
policy		0..*	uri	Policy that authorized the agent participation in the event
network[x]	S	0..1		This agent network location for the activity
networkReference			Reference(Endpoint)
networkUri			uri
networkString			string
authorization	S	0..*	CodeableConcept	Allowable authorization for this agent Binding: PurposeOfUse (example): 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	Reference(Location)	Logical source location within the enterprise
observer	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	The identity of source detecting the event
type		0..*	CodeableConcept	The type of source where event originated Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.
entity	SΣ	0..*	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	SΣ	0..1	Reference(Resource)	Specific instance of resource
role		0..1	CodeableConcept	What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
securityLabel		0..*	CodeableConcept	Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
query	Σ	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	CodeableConcept	The name of the extra detail property Binding: AuditEventEntityDetailType (example): Additional detail about an entity used in an event.
value[x]		1..1		Property value
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
valueBase64Binary			base64Binary
agent		0..*	See agent (AuditEvent)	Entity is attributed to this agent
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2 from the FHIR Standard
AuditEvent.type	example	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	preferred	RecordLifecycleEvents http://hl7.org/fhir/uv/ehrs-rle/ValueSet/record-lifecycle-events from this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|6.0.0-ballot2 from the FHIR Standard
AuditEvent.severity	required	AuditEventSeverity http://hl7.org/fhir/ValueSet/audit-event-severity|6.0.0-ballot2 from the FHIR Standard
AuditEvent.outcome.code	preferred	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome from the FHIR Standard
AuditEvent.outcome.detail	example	AuditEventOutcomeDetail http://hl7.org/fhir/ValueSet/audit-event-outcome-detail from the FHIR Standard
AuditEvent.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.type	preferred	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.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.type	preferred	AuditEventSourceType http://hl7.org/fhir/ValueSet/security-source-type from the FHIR Standard
AuditEvent.entity.role	example	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard
AuditEvent.entity.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard
AuditEvent.entity.detail.type	example	AuditEventEntityDetailType http://hl7.org/fhir/ValueSet/audit-entity-detail-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())

This structure is derived from AuditEvent

Summary

Must-Support: 14 elements

Maturity: 1

Differential View

This structure is derived from AuditEvent

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Record of an event
type	S	1..1	CodeableConcept	High level categorization of audit event
subtype	S	0..*	CodeableConcept	Specific type of event Binding: ValueSet record-lifecycle-events (preferred)
action	S	0..1	code	Type of action performed during the event
recorded	S	1..1	instant	Time when the event was recorded
authorization	S	0..*	CodeableConcept	Authorization related to the event
agent	S	1..*	BackboneElement	Actor involved in the event
who	S	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Identifier of who
requestor	S	0..1	boolean	Whether user is initiator
location	S	0..1	Reference(Location)	The agent location when the event occurred
network[x]	S	0..1	Reference(Endpoint), uri, string	This agent network location for the activity
authorization	S	0..*	CodeableConcept	Allowable authorization for this agent
source	S	1..1	BackboneElement	Audit Event Reporter
entity	S	0..*	BackboneElement	Data or objects used
what	S	0..1	Reference(Resource)	Specific instance of resource
Documentation for this format

Terminology Bindings (Differential)

Path	Conformance	ValueSet	URI
AuditEvent.subtype	preferred	RecordLifecycleEvents http://hl7.org/fhir/uv/ehrs-rle/ValueSet/record-lifecycle-events from this IG

Key Elements View

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Record of an event dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources dom-3: 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 dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated dom-5: If a resource is contained in another resource, it SHALL NOT have a security label dom-6: A resource should have narrative for robust management
implicitRules	?!Σ	0..1	uri	A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children
contained		0..*	Resource	Contained, inline Resources
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored ele-1: All FHIR elements must have a @value or children
type	SΣ	1..1	CodeableConcept	High level categorization of audit event Binding: AuditEventID (example): Type of event. ele-1: All FHIR elements must have a @value or children
subtype	SΣ	0..*	CodeableConcept	Specific type of event Binding: ValueSet record-lifecycle-events (preferred) ele-1: All FHIR elements must have a @value or children
action	SΣ	0..1	code	Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action ele-1: All FHIR elements must have a @value or children
recorded	SΣ	1..1	instant	Time when the event was recorded ele-1: All FHIR elements must have a @value or children
authorization	SΣ	0..*	CodeableConcept	Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity. ele-1: All FHIR elements must have a @value or children
agent	SΣ	1..*	BackboneElement	Actor involved in the event ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children
who	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Identifier of who ele-1: All FHIR elements must have a @value or children
requestor	SΣ	0..1	boolean	Whether user is initiator ele-1: All FHIR elements must have a @value or children
location	S	0..1	Reference(Location)	The agent location when the event occurred ele-1: All FHIR elements must have a @value or children
network[x]	S	0..1		This agent network location for the activity ele-1: All FHIR elements must have a @value or children
networkReference			Reference(Endpoint)
networkUri			uri
networkString			string
authorization	S	0..*	CodeableConcept	Allowable authorization for this agent Binding: PurposeOfUse (example): The reason the activity took place. ele-1: All FHIR elements must have a @value or children
source	SΣ	1..1	BackboneElement	Audit Event Reporter ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children
observer	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	The identity of source detecting the event ele-1: All FHIR elements must have a @value or children
entity	SΣ	0..*	BackboneElement	Data or objects used ele-1: All FHIR elements must have a @value or children
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized ele-1: All FHIR elements must have a @value or children
what	SΣ	0..1	Reference(Resource)	Specific instance of resource ele-1: All FHIR elements must have a @value or children
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.type	example	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	preferred	RecordLifecycleEvents http://hl7.org/fhir/uv/ehrs-rle/ValueSet/record-lifecycle-events from this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|6.0.0-ballot2 from the FHIR Standard
AuditEvent.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse

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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
AuditEvent		0..*	AuditEvent	Record of an event
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: AllLanguages (required): IETF language tag for a human language Additional Bindings Purpose CommonLanguages Starter Set
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	SΣ	1..1	CodeableConcept	High level categorization of audit event Binding: AuditEventID (example): Type of event.
subtype	SΣ	0..*	CodeableConcept	Specific type of event Binding: ValueSet record-lifecycle-events (preferred)
action	SΣ	0..1	code	Type of action performed during the event Binding: AuditEventAction (required): DICOM Audit Event Action
severity	Σ	0..1	code	emergency | alert | critical | error | warning | notice | informational | debug Binding: AuditEventSeverity (required): This is in the SysLog header, PRI. http://tools.ietf.org/html/rfc5424#appendix-A.3
occurred[x]		0..1		When the activity occurred
occurredPeriod			Period
occurredDateTime			dateTime
recorded	SΣ	1..1	instant	Time when the event was recorded
outcome	Σ	0..1	BackboneElement	Whether the event succeeded or failed
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
code	Σ	1..1	Coding	Whether the event succeeded or failed Binding: AuditEventOutcome (preferred): DICOM Audit Event Outcome
detail	Σ	0..*	CodeableConcept	Additional outcome detail Binding: AuditEventOutcomeDetail (example): A code that provides details as the exact issue.
authorization	SΣ	0..*	CodeableConcept	Authorization related to the event Binding: PurposeOfUse (example): The authorized purposeOfUse for the activity.
basedOn		0..*	Reference(Resource)	Workflow authorization within which this event occurred
patient	Σ	0..1	Reference(Patient)	The patient is the subject of the data used/created/updated/deleted during the activity
encounter		0..1	Reference(Encounter)	Encounter within which this event occurred or which the event is tightly associated
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		0..1	CodeableConcept	How agent participated Binding: ParticipationRoleType (preferred): 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	SΣ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	Identifier of who
requestor	SΣ	0..1	boolean	Whether user is initiator
location	S	0..1	Reference(Location)	The agent location when the event occurred
policy		0..*	uri	Policy that authorized the agent participation in the event
network[x]	S	0..1		This agent network location for the activity
networkReference			Reference(Endpoint)
networkUri			uri
networkString			string
authorization	S	0..*	CodeableConcept	Allowable authorization for this agent Binding: PurposeOfUse (example): 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	Reference(Location)	Logical source location within the enterprise
observer	Σ	1..1	Reference(Practitioner | PractitionerRole | Organization | CareTeam | Patient | Device | RelatedPerson)	The identity of source detecting the event
type		0..*	CodeableConcept	The type of source where event originated Binding: AuditEventSourceType (preferred): Code specifying the type of system that detected and recorded the event. Use of these codes is not required but is encouraged to maintain translation with DICOM AuditMessage schema.
entity	SΣ	0..*	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	SΣ	0..1	Reference(Resource)	Specific instance of resource
role		0..1	CodeableConcept	What role the entity played Binding: AuditEventEntityRole (example): DICOM Audit Event Entity Role
securityLabel		0..*	CodeableConcept	Security labels on the entity Binding: SecurityLabelExamples (example): Example Security Labels from the Healthcare Privacy and Security Classification System.
query	Σ	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	CodeableConcept	The name of the extra detail property Binding: AuditEventEntityDetailType (example): Additional detail about an entity used in an event.
value[x]		1..1		Property value
valueQuantity			Quantity
valueCodeableConcept			CodeableConcept
valueString			string
valueBoolean			boolean
valueInteger			integer
valueRange			Range
valueRatio			Ratio
valueTime			time
valueDateTime			dateTime
valuePeriod			Period
valueBase64Binary			base64Binary
agent		0..*	See agent (AuditEvent)	Entity is attributed to this agent
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet	URI
AuditEvent.language	required	AllLanguages http://hl7.org/fhir/ValueSet/all-languages|6.0.0-ballot2 from the FHIR Standard
AuditEvent.type	example	AuditEventID http://hl7.org/fhir/ValueSet/audit-event-type from the FHIR Standard
AuditEvent.subtype	preferred	RecordLifecycleEvents http://hl7.org/fhir/uv/ehrs-rle/ValueSet/record-lifecycle-events from this IG
AuditEvent.action	required	AuditEventAction http://hl7.org/fhir/ValueSet/audit-event-action|6.0.0-ballot2 from the FHIR Standard
AuditEvent.severity	required	AuditEventSeverity http://hl7.org/fhir/ValueSet/audit-event-severity|6.0.0-ballot2 from the FHIR Standard
AuditEvent.outcome.code	preferred	AuditEventOutcome http://hl7.org/fhir/ValueSet/audit-event-outcome from the FHIR Standard
AuditEvent.outcome.detail	example	AuditEventOutcomeDetail http://hl7.org/fhir/ValueSet/audit-event-outcome-detail from the FHIR Standard
AuditEvent.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent.type	preferred	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.authorization	example	PurposeOfUse http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.type	preferred	AuditEventSourceType http://hl7.org/fhir/ValueSet/security-source-type from the FHIR Standard
AuditEvent.entity.role	example	AuditEventEntityRole http://hl7.org/fhir/ValueSet/object-role from the FHIR Standard
AuditEvent.entity.securityLabel	example	SecurityLabelExamples http://hl7.org/fhir/ValueSet/security-label-examples from the FHIR Standard
AuditEvent.entity.detail.type	example	AuditEventEntityDetailType http://hl7.org/fhir/ValueSet/audit-entity-detail-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().ofType(canonical) | %resource.descendants().ofType(uri) | %resource.descendants().ofType(url))) or descendants().where(reference = '#').exists() or descendants().where(ofType(canonical) = '#').exists() or descendants().where(ofType(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())

This structure is derived from AuditEvent

Summary

Must-Support: 14 elements

Maturity: 1

Other representations of profile: CSV, Excel, Schematron