HL7.FHIR.UV.EHRS-RLE\EHRSFunctionalModelRecordLifecycleEventsAuditEvent

EHRS Functional Model - Record Lifecycle Events Implementation Guide
1.0.0-ballot - Informative Release 1 International flag

This page is part of the EHRS Functional Model - Record Lifecycle Events Implementation Guide (v1.0.0-ballot: Informative Release 1 Ballot 1) based on FHIR R4. . For a full list of available versions, see the Directory of published versions

Resource Profile: EHRSFunctionalModelRecordLifecycleEventsAuditEvent

Official URL: http://hl7.org/fhir/uv/ehrs-rle/StructureDefinition/ehrsrle-auditevent				Version: 1.0.0-ballot
Standards status: Informative			Maturity Level: 1	Computable Name: EHRSFunctionalModelRecordLifecycleEventsAuditEvent

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	Event record kept for security purposes
type	S	1..1	Coding	Type/identifier of event
subtype	S	0..*	Coding	More specific type/id for the event
action	S	0..1	code	Type of action performed during the event
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
role	S	0..*	CodeableConcept	Agent role in the event
who	S	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Identifier of who
requestor	S	1..1	boolean	Whether user is initiator
location	S	0..1	Reference(Location)	Where
policy	S	0..*	uri	Policy that authorized event
network	S	0..1	BackboneElement	Logical network location for application activity
address	S	0..1	string	Identifier for the network access point of the user device
type	S	0..1	code	The type of network access point
purposeOfUse	S	0..*	CodeableConcept	Reason given for this user
source	S	1..1	BackboneElement	Audit Event Reporter
site	S	0..1	string	Logical source location within the enterprise
observer	S	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	The identity of source detecting the event
type	S	0..*	Coding	The type of source where event originated
entity	S	0..*	BackboneElement	Data or objects used
what	S	0..1	Reference(Resource)	Specific instance of resource
type	S	0..1	Coding	Type of entity involved
role	S	0..1	Coding	What role the entity played
lifecycle	S	0..1	Coding	Life-cycle stage for the entity
securityLabel	S	0..*	Coding	Security labels on the entity
Documentation for this format

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	SΣ	1..1	Coding	Type/identifier of event Binding: AuditEventID (extensible): Type of event.
subtype	SΣ	0..*	Coding	More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action	SΣ	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.
recorded	SΣ	1..1	instant	Time when the event was recorded
purposeOfEvent	SΣ	0..*	CodeableConcept	The purposeOfUse of the event Binding: PurposeOfUse (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
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Σ	0..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	Identifier of who
requestor	SΣ	1..1	boolean	Whether user is initiator
location	S	0..1	Reference(Location)	Where
policy	S	0..*	uri	Policy that authorized event
network	S	0..1	BackboneElement	Logical network location for application activity
modifierExtension	?!Σ	0..*	Extension	Extensions that cannot be ignored even if unrecognized
address	S	0..1	string	Identifier for the network access point of the user device
type	S	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	0..*	CodeableConcept	Reason given for this user Binding: PurposeOfUse (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
site	S	0..1	string	Logical source location within the enterprise
observer	SΣ	1..1	Reference(PractitionerRole \| Practitioner \| Organization \| Device \| Patient \| RelatedPerson)	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	0..*	BackboneElement	Data or objects used
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	S	0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.
lifecycle	S	0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.
securityLabel	S	0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
Documentation for this format

Terminology Bindings

Path	Conformance	ValueSet
AuditEvent.type	extensible	AuditEventID
AuditEvent.subtype	extensible	AuditEventSub-Type
AuditEvent.action	required	AuditEventAction
AuditEvent.purposeOfEvent	extensible	PurposeOfUse
AuditEvent.agent.role	example	SecurityRoleType
AuditEvent.agent.network.type	required	AuditEventAgentNetworkType
AuditEvent.agent.purposeOfUse	extensible	PurposeOfUse
AuditEvent.source.type	extensible	AuditEventSourceType
AuditEvent.entity.type	extensible	AuditEventEntityType
AuditEvent.entity.role	extensible	AuditEventEntityRole
AuditEvent.entity.lifecycle	extensible	ObjectLifecycleEvents
AuditEvent.entity.securityLabel	extensible	All Security Labels

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()