RIVO-Noord Zorgviewer Implementation Guide, published by RIVO-NN HL7NL. This guide is not an authorized publication; it is the continuous build for version 1.27.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/RIVO-Noord/zorgviewer-ig/ and changes regularly. See the Directory of published versions

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

Resource Profile: AuditEvent

AuditEvent

• NEN 7513:2018 ~vrij beschikbaar na registratie~
  • gebeurtenissen in scope van de Zorgviewer
    • Als de Zorgviewer een patient opent: "gegevens lezen"
    • Als een beheerder loggegevens inziet: "loggegevens lezen"
• Zie AuditEvent-example-1

key	value	FHIR Path
Gebeurtenis		AuditEvent
gebeurteniscode	DCM,110110,'Patient Record'	AuditEvent.type.coding.system = http://dicom.nema.org/resources/ontology/DCM AuditEvent.type.coding.code = 110110 AuditEvent.type.coding.code = Patient Record
actiecode	R	AuditEvent.action = R
datum en tijd	1986‐09‐14T14:12:12	AuditEvent.recorded
Gebruiker		AuditEvent.agent
gebruikers-id	Schroder, CP, Arts en system urn:oid:2.16.840.1.113883.2.4.3.8 of AGB-Z 06020101 met system http://fhir.nl/fhir/NamingSystem/agb-z	zorgaanbieder OID AuditEvent.agent.userId.system AuditEvent.agent.userId.value en AuditEvent.agent.name
	https://rivo-noord.nl/zorgviewer/toestemming	AuditEvent.agent.policy
gebruikersrol	05 Directly involved healthcare professional	AuditEvent.agent.role.coding.system AuditEvent.agent.role.coding.code AuditEvent.agent.role.coding.display
ID van verantwoordelijke gebruiker	zie gebruikers-id
Rol van verantwoordelijke gebruiker	zie gebruikersrol
Object		AuditEvent.entity
Identificatortype	Patiëntnummer	AuditEvent.entity.type.code = 1 AuditEvent.entity.type.system = http://hl7.org/fhir/audit-entity-type
Identificator	http://fhir.nl/fhir/NamingSystem/bsn 999911120	AuditEvent.entity.identifier.system AuditEvent.entity.identifier.value
Autorisatieprotocol	?
Toestemmingsprofiel	?
Loggegevens		AuditEvent.source
Identificatie van de bron	Zorgviewer RIVO-Noord	AuditEvent.source.identifier.value

NEN 7513 overzicht datamodel
geel is verplicht

Usages:

• CapabilityStatements using this Profile: Logging
• This Profile is not used by any profiles in this Specification

You can also check for usages in the FHIR IG Statistics

Formal Views of Profile Content

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

• 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
AuditEvent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AuditEvent.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.type	S This element must be supported. Σ This element is included in summaries.	1..1	Coding	Type/identifier of event Binding: Audit Event ID (extensible): Type of event.
AuditEvent.action	S This element must be supported. Σ This element is included in summaries.	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
AuditEvent.recorded	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Time when the event occurred on source
AuditEvent.agent	S This element must be supported.	1..*	BackboneElement	Actor involved in the event
AuditEvent.agent.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.agent.role	S This element must be supported.	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event
AuditEvent.agent.userId	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Unique identifier for the user
AuditEvent.agent.name	S This element must be supported.	0..1	string	Human-meaningful name for the agent
AuditEvent.agent.requestor		1..1	boolean	Whether user is initiator
AuditEvent.agent.policy	S This element must be supported.	0..*	uri	Policy that authorized event Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming (no extensions allowed)
AuditEvent.source		1..1	BackboneElement	Audit Event Reporter
AuditEvent.source.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.source.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	The identity of source detecting the event
AuditEvent.entity	S This element must be supported. C	0..*	BackboneElement	Data or objects used Constraints: sev-1
AuditEvent.entity.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Specific instance of object
AuditEvent.entity.type	S This element must be supported.	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event
AuditEvent.entity.detail	S This element must be supported. C	0..*	BackboneElement	Additional Information about the entity Constraints: zv-ae-1
AuditEvent.entity.detail.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.detail.type		1..1	string	Name of the property
AuditEvent.entity.detail.value		1..1	base64Binary	Property value
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AuditEvent.type	Base	extensible	Audit Event ID	📍20150326	FHIR Std.
AuditEvent.action	Base	required	AuditEventAction	📍3.0.2	FHIR Std.
AuditEvent.agent.role	Base	extensible	SecurityRoleType	📍1.8.0	FHIR Std.
AuditEvent.entity.type	Base	extensible	AuditEventEntityType	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both)	name.empty() or query.empty()
zv-ae-1	error	AuditEvent.entity.detail	At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.	type='X-Request-Id'

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
AuditEvent.type	S This element must be supported.	1..1	Coding	Type/identifier of event
AuditEvent.action	S This element must be supported.	0..1	code	Type of action performed during the event
AuditEvent.recorded	S This element must be supported.	1..1	instant	Time when the event occurred on source
AuditEvent.agent	S This element must be supported.	1..*	BackboneElement	Actor involved in the event
AuditEvent.agent.role	S This element must be supported.	0..*	CodeableConcept	Agent role in the event
AuditEvent.agent.userId	S This element must be supported.	0..1	Identifier	Unique identifier for the user
AuditEvent.agent.name	S This element must be supported.	0..1	string	Human-meaningful name for the agent
AuditEvent.agent.policy	S This element must be supported.	0..*	uri	Policy that authorized event Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming (no extensions allowed)
AuditEvent.source
AuditEvent.source.identifier	S This element must be supported.	1..1	Identifier	The identity of source detecting the event
AuditEvent.entity	S This element must be supported.	0..*	BackboneElement	Data or objects used
AuditEvent.entity.identifier	S This element must be supported.	0..1	Identifier	Specific instance of object
AuditEvent.entity.type	S This element must be supported.	0..1	Coding	Type of entity involved
AuditEvent.entity.detail	S This element must be supported. C	0..*	BackboneElement	Additional Information about the entity Constraints: zv-ae-1
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
zv-ae-1	error	AuditEvent.entity.detail	At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.	type='X-Request-Id'

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
AuditEvent.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
AuditEvent.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
AuditEvent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AuditEvent.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
AuditEvent.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
AuditEvent.contained		0..*	Resource	Contained, inline Resources
AuditEvent.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.type	S This element must be supported. Σ This element is included in summaries.	1..1	Coding	Type/identifier of event Binding: Audit Event ID (extensible): Type of event.
AuditEvent.subtype	Σ This element is included in summaries.	0..*	Coding	More specific type/id for the event Binding: Audit Event Sub-Type (extensible): Sub-type of event.
AuditEvent.action	S This element must be supported. Σ This element is included in summaries.	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
AuditEvent.recorded	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Time when the event occurred on source
AuditEvent.outcome	Σ This element is included in summaries.	0..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed
AuditEvent.outcomeDesc	Σ This element is included in summaries.	0..1	string	Description of the event outcome
AuditEvent.purposeOfEvent	Σ This element is included in summaries.	0..*	CodeableConcept	​The purposeOfUse of the event Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place.
AuditEvent.agent	S This element must be supported.	1..*	BackboneElement	Actor involved in the event
AuditEvent.agent.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.agent.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.agent.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.agent.role	S This element must be supported.	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event
AuditEvent.agent.reference	Σ This element is included in summaries.	0..1	Reference(Practitioner | Organization | Device | Patient | RelatedPerson)	Direct reference to resource
AuditEvent.agent.userId	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Unique identifier for the user
AuditEvent.agent.altId		0..1	string	Alternative User id e.g. authentication
AuditEvent.agent.name	S This element must be supported.	0..1	string	Human-meaningful name for the agent
AuditEvent.agent.requestor		1..1	boolean	Whether user is initiator
AuditEvent.agent.location		0..1	Reference(Location)	Where
AuditEvent.agent.policy	S This element must be supported.	0..*	uri	Policy that authorized event Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming (no extensions allowed)
AuditEvent.agent.media		0..1	Coding	Type of media Binding: Media Type Code (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.agent.network		0..1	BackboneElement	Logical network location for application activity
AuditEvent.agent.network.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.agent.network.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.agent.network.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.agent.network.address		0..1	string	Identifier for the network access point of the user device
AuditEvent.agent.network.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
AuditEvent.agent.purposeOfUse		0..*	CodeableConcept	​Reason given for this user Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place.
AuditEvent.source		1..1	BackboneElement	Audit Event Reporter
AuditEvent.source.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.source.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.source.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.source.site		0..1	string	Logical source location within the enterprise
AuditEvent.source.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	The identity of source detecting the event
AuditEvent.source.type		0..*	Coding	The type of source where event originated Binding: Audit Event Source Type (extensible): Code specifying the type of system that detected and recorded the event.
AuditEvent.entity	S This element must be supported. C	0..*	BackboneElement	Data or objects used Constraints: sev-1
AuditEvent.entity.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.entity.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.entity.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Specific instance of object
AuditEvent.entity.reference	Σ This element is included in summaries.	0..1	Reference(Resource)	Specific instance of resource
AuditEvent.entity.type	S This element must be supported.	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event
AuditEvent.entity.role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event
AuditEvent.entity.lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity
AuditEvent.entity.securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.entity.name	Σ This element is included in summaries. C	0..1	string	Descriptor for entity
AuditEvent.entity.description		0..1	string	Descriptive text
AuditEvent.entity.query	Σ This element is included in summaries. C	0..1	base64Binary	Query parameters
AuditEvent.entity.detail	S This element must be supported. C	0..*	BackboneElement	Additional Information about the entity Constraints: zv-ae-1
AuditEvent.entity.detail.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.entity.detail.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.entity.detail.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.detail.type		1..1	string	Name of the property
AuditEvent.entity.detail.value		1..1	base64Binary	Property value
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AuditEvent.language	Base	extensible	Common Languages	📍3.0.2	FHIR Std.
AuditEvent.type	Base	extensible	Audit Event ID	📍20150326	FHIR Std.
AuditEvent.subtype	Base	extensible	Audit Event Sub-Type	📍20100826	FHIR Std.
AuditEvent.action	Base	required	AuditEventAction	📍3.0.2	FHIR Std.
AuditEvent.outcome	Base	required	AuditEventOutcome	📍3.0.2	FHIR Std.
AuditEvent.purposeOfEvent	Base	extensible	PurposeOfUse	📍2014-03-26	FHIR Std.
AuditEvent.agent.role	Base	extensible	SecurityRoleType	📍1.8.0	FHIR Std.
AuditEvent.agent.media	Base	extensible	Media Type Code	📍20100826	FHIR Std.
AuditEvent.agent.network.​type	Base	required	AuditEventAgentNetworkType	📍3.0.2	FHIR Std.
AuditEvent.agent.purposeOfUse	Base	extensible	PurposeOfUse	📍2014-03-26	FHIR Std.
AuditEvent.source.type	Base	extensible	Audit Event Source Type	📍20100826	FHIR Std.
AuditEvent.entity.type	Base	extensible	AuditEventEntityType	📍3.0.2	FHIR Std.
AuditEvent.entity.role	Base	extensible	AuditEventEntityRole	📍3.0.2	FHIR Std.
AuditEvent.entity.lifecycle	Base	extensible	ObjectLifecycleEvents	📍1.1.0	FHIR Std.
AuditEvent.entity.securityLabel	Base	extensible	All Security Labels	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both)	name.empty() or query.empty()
zv-ae-1	error	AuditEvent.entity.detail	At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.	type='X-Request-Id'

This structure is derived from AuditEvent

Summary

Must-Support: 13 elements
Fixed: 1 element

Key Elements View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
AuditEvent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AuditEvent.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.type	S This element must be supported. Σ This element is included in summaries.	1..1	Coding	Type/identifier of event Binding: Audit Event ID (extensible): Type of event.
AuditEvent.action	S This element must be supported. Σ This element is included in summaries.	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
AuditEvent.recorded	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Time when the event occurred on source
AuditEvent.agent	S This element must be supported.	1..*	BackboneElement	Actor involved in the event
AuditEvent.agent.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.agent.role	S This element must be supported.	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event
AuditEvent.agent.userId	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Unique identifier for the user
AuditEvent.agent.name	S This element must be supported.	0..1	string	Human-meaningful name for the agent
AuditEvent.agent.requestor		1..1	boolean	Whether user is initiator
AuditEvent.agent.policy	S This element must be supported.	0..*	uri	Policy that authorized event Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming (no extensions allowed)
AuditEvent.source		1..1	BackboneElement	Audit Event Reporter
AuditEvent.source.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.source.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	The identity of source detecting the event
AuditEvent.entity	S This element must be supported. C	0..*	BackboneElement	Data or objects used Constraints: sev-1
AuditEvent.entity.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Specific instance of object
AuditEvent.entity.type	S This element must be supported.	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event
AuditEvent.entity.detail	S This element must be supported. C	0..*	BackboneElement	Additional Information about the entity Constraints: zv-ae-1
AuditEvent.entity.detail.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.detail.type		1..1	string	Name of the property
AuditEvent.entity.detail.value		1..1	base64Binary	Property value
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AuditEvent.type	Base	extensible	Audit Event ID	📍20150326	FHIR Std.
AuditEvent.action	Base	required	AuditEventAction	📍3.0.2	FHIR Std.
AuditEvent.agent.role	Base	extensible	SecurityRoleType	📍1.8.0	FHIR Std.
AuditEvent.entity.type	Base	extensible	AuditEventEntityType	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both)	name.empty() or query.empty()
zv-ae-1	error	AuditEvent.entity.detail	At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.	type='X-Request-Id'

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
AuditEvent.type	S This element must be supported.	1..1	Coding	Type/identifier of event
AuditEvent.action	S This element must be supported.	0..1	code	Type of action performed during the event
AuditEvent.recorded	S This element must be supported.	1..1	instant	Time when the event occurred on source
AuditEvent.agent	S This element must be supported.	1..*	BackboneElement	Actor involved in the event
AuditEvent.agent.role	S This element must be supported.	0..*	CodeableConcept	Agent role in the event
AuditEvent.agent.userId	S This element must be supported.	0..1	Identifier	Unique identifier for the user
AuditEvent.agent.name	S This element must be supported.	0..1	string	Human-meaningful name for the agent
AuditEvent.agent.policy	S This element must be supported.	0..*	uri	Policy that authorized event Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming (no extensions allowed)
AuditEvent.source
AuditEvent.source.identifier	S This element must be supported.	1..1	Identifier	The identity of source detecting the event
AuditEvent.entity	S This element must be supported.	0..*	BackboneElement	Data or objects used
AuditEvent.entity.identifier	S This element must be supported.	0..1	Identifier	Specific instance of object
AuditEvent.entity.type	S This element must be supported.	0..1	Coding	Type of entity involved
AuditEvent.entity.detail	S This element must be supported. C	0..*	BackboneElement	Additional Information about the entity Constraints: zv-ae-1
Documentation for this format

Constraints

Id	Grade	Path(s)	Description	Expression
zv-ae-1	error	AuditEvent.entity.detail	At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.	type='X-Request-Id'

Snapshot View

Name	Flags	Card.	Type	Description & Constraints    Filter: Bindings Constraints Obligations
AuditEvent		0..*	AuditEvent	Event record kept for security purposes
AuditEvent.id	Σ This element is included in summaries.	0..1	id	Logical id of this artifact
AuditEvent.meta	Σ This element is included in summaries.	0..1	Meta	Metadata about the resource
AuditEvent.implicitRules	?! This element is a modifier element. Σ This element is included in summaries.	0..1	uri	A set of rules under which this content was created
AuditEvent.language		0..1	code	Language of the resource content Binding: Common Languages (extensible): A human language. Additional Bindings Purpose All Languages Max Binding
AuditEvent.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
AuditEvent.contained		0..*	Resource	Contained, inline Resources
AuditEvent.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.modifierExtension	?! This element is a modifier element.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.type	S This element must be supported. Σ This element is included in summaries.	1..1	Coding	Type/identifier of event Binding: Audit Event ID (extensible): Type of event.
AuditEvent.subtype	Σ This element is included in summaries.	0..*	Coding	More specific type/id for the event Binding: Audit Event Sub-Type (extensible): Sub-type of event.
AuditEvent.action	S This element must be supported. Σ This element is included in summaries.	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
AuditEvent.recorded	S This element must be supported. Σ This element is included in summaries.	1..1	instant	Time when the event occurred on source
AuditEvent.outcome	Σ This element is included in summaries.	0..1	code	Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed
AuditEvent.outcomeDesc	Σ This element is included in summaries.	0..1	string	Description of the event outcome
AuditEvent.purposeOfEvent	Σ This element is included in summaries.	0..*	CodeableConcept	​The purposeOfUse of the event Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place.
AuditEvent.agent	S This element must be supported.	1..*	BackboneElement	Actor involved in the event
AuditEvent.agent.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.agent.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.agent.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.agent.role	S This element must be supported.	0..*	CodeableConcept	Agent role in the event Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event
AuditEvent.agent.reference	Σ This element is included in summaries.	0..1	Reference(Practitioner | Organization | Device | Patient | RelatedPerson)	Direct reference to resource
AuditEvent.agent.userId	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Unique identifier for the user
AuditEvent.agent.altId		0..1	string	Alternative User id e.g. authentication
AuditEvent.agent.name	S This element must be supported.	0..1	string	Human-meaningful name for the agent
AuditEvent.agent.requestor		1..1	boolean	Whether user is initiator
AuditEvent.agent.location		0..1	Reference(Location)	Where
AuditEvent.agent.policy	S This element must be supported.	0..*	uri	Policy that authorized event Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming (no extensions allowed)
AuditEvent.agent.media		0..1	Coding	Type of media Binding: Media Type Code (extensible): Used when the event is about exporting/importing onto media.
AuditEvent.agent.network		0..1	BackboneElement	Logical network location for application activity
AuditEvent.agent.network.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.agent.network.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.agent.network.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.agent.network.address		0..1	string	Identifier for the network access point of the user device
AuditEvent.agent.network.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
AuditEvent.agent.purposeOfUse		0..*	CodeableConcept	​Reason given for this user Binding: PurposeOfUse|2014-03-26 (extensible): The reason the activity took place.
AuditEvent.source		1..1	BackboneElement	Audit Event Reporter
AuditEvent.source.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.source.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.source.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.source.site		0..1	string	Logical source location within the enterprise
AuditEvent.source.identifier	S This element must be supported. Σ This element is included in summaries.	1..1	Identifier	The identity of source detecting the event
AuditEvent.source.type		0..*	Coding	The type of source where event originated Binding: Audit Event Source Type (extensible): Code specifying the type of system that detected and recorded the event.
AuditEvent.entity	S This element must be supported. C	0..*	BackboneElement	Data or objects used Constraints: sev-1
AuditEvent.entity.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.entity.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.entity.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.identifier	S This element must be supported. Σ This element is included in summaries.	0..1	Identifier	Specific instance of object
AuditEvent.entity.reference	Σ This element is included in summaries.	0..1	Reference(Resource)	Specific instance of resource
AuditEvent.entity.type	S This element must be supported.	0..1	Coding	Type of entity involved Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event
AuditEvent.entity.role		0..1	Coding	What role the entity played Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event
AuditEvent.entity.lifecycle		0..1	Coding	Life-cycle stage for the entity Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity
AuditEvent.entity.securityLabel		0..*	Coding	Security labels on the entity Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
AuditEvent.entity.name	Σ This element is included in summaries. C	0..1	string	Descriptor for entity
AuditEvent.entity.description		0..1	string	Descriptive text
AuditEvent.entity.query	Σ This element is included in summaries. C	0..1	base64Binary	Query parameters
AuditEvent.entity.detail	S This element must be supported. C	0..*	BackboneElement	Additional Information about the entity Constraints: zv-ae-1
AuditEvent.entity.detail.id		0..1	string	xml:id (or equivalent in JSON)
AuditEvent.entity.detail.extension		0..*	Extension	Additional Content defined by implementations
AuditEvent.entity.detail.modifierExtension	?! This element is a modifier element. Σ This element is included in summaries.	0..*	Extension	Extensions that cannot be ignored
AuditEvent.entity.detail.type		1..1	string	Name of the property
AuditEvent.entity.detail.value		1..1	base64Binary	Property value
Documentation for this format

Terminology Bindings

Path	Status	Usage	ValueSet	Version	Source
AuditEvent.language	Base	extensible	Common Languages	📍3.0.2	FHIR Std.
AuditEvent.type	Base	extensible	Audit Event ID	📍20150326	FHIR Std.
AuditEvent.subtype	Base	extensible	Audit Event Sub-Type	📍20100826	FHIR Std.
AuditEvent.action	Base	required	AuditEventAction	📍3.0.2	FHIR Std.
AuditEvent.outcome	Base	required	AuditEventOutcome	📍3.0.2	FHIR Std.
AuditEvent.purposeOfEvent	Base	extensible	PurposeOfUse	📍2014-03-26	FHIR Std.
AuditEvent.agent.role	Base	extensible	SecurityRoleType	📍1.8.0	FHIR Std.
AuditEvent.agent.media	Base	extensible	Media Type Code	📍20100826	FHIR Std.
AuditEvent.agent.network.​type	Base	required	AuditEventAgentNetworkType	📍3.0.2	FHIR Std.
AuditEvent.agent.purposeOfUse	Base	extensible	PurposeOfUse	📍2014-03-26	FHIR Std.
AuditEvent.source.type	Base	extensible	Audit Event Source Type	📍20100826	FHIR Std.
AuditEvent.entity.type	Base	extensible	AuditEventEntityType	📍3.0.2	FHIR Std.
AuditEvent.entity.role	Base	extensible	AuditEventEntityRole	📍3.0.2	FHIR Std.
AuditEvent.entity.lifecycle	Base	extensible	ObjectLifecycleEvents	📍1.1.0	FHIR Std.
AuditEvent.entity.securityLabel	Base	extensible	All Security Labels	📍3.0.2	FHIR Std.

Constraints

Id	Grade	Path(s)	Description	Expression
dom-1	error	AuditEvent	If the resource is contained in another resource, it SHALL NOT contain any narrative	contained.text.empty()
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	contained.where(('#'+id in %resource.descendants().reference).not()).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()
ele-1	error	**ALL** elements	All FHIR elements must have a @value or children	hasValue() | (children().count() > id.count())
sev-1	error	AuditEvent.entity	Either a name or a query (NOT both)	name.empty() or query.empty()
zv-ae-1	error	AuditEvent.entity.detail	At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.	type='X-Request-Id'

This structure is derived from AuditEvent

Summary

Must-Support: 13 elements
Fixed: 1 element

Other representations of profile: CSV, Excel, Schematron