RIVO-Noord Zorgviewer Implementation Guide
1.1.0 - sprint35 Netherlands flag

RIVO-Noord Zorgviewer Implementation Guide - Local Development build (v1.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: AuditEvent

Official URL: http://hl7.nl/fhir/zorgviewer/StructureDefinition/AuditEvent Version: 1.1.0
Draft as of 2024-06-21 Computable Name: 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
  Zelfde als voor ToestemmingConsent.policy:
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<br/>geel is verplicht
NEN 7513 overzicht datamodel
geel is verplicht

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.

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... type S 1..1 Coding Type/identifier of event
... action S 0..1 code Type of action performed during the event
... recorded S 1..1 instant Time when the event occurred on source
.... role S 0..* CodeableConcept Agent role in the event
.... userId S 0..1 Identifier Unique identifier for the user
.... name S 0..1 string Human-meaningful name for the agent
.... policy S 0..* uri Policy that authorized event
Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming
... source
.... identifier S 1..1 Identifier The identity of source detecting the event
... entity S 0..* BackboneElement Data or objects used
.... identifier S 0..1 Identifier Specific instance of object
.... type S 0..1 Coding Type of entity involved
.... detail SC 0..* BackboneElement Additional Information about the entity
zv-ae-1: At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
zv-ae-1errorAuditEvent.entity.detailAt least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
: type='X-Request-Id'
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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: Audit Event ID (extensible): Type of event.

... recorded SΣ 1..1 instant Time when the event occurred on source
... agent S 1..* BackboneElement Actor involved in the event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event


.... userId SΣ 0..1 Identifier Unique identifier for the user
.... name S 0..1 string Human-meaningful name for the agent
.... requestor 1..1 boolean Whether user is initiator
.... policy S 0..* uri Policy that authorized event

Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier SΣ 1..1 Identifier The identity of source detecting the event
... entity SC 0..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier SΣ 0..1 Identifier Specific instance of object
.... type S 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event

.... detail SC 0..* BackboneElement Additional Information about the entity
zv-ae-1: At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... type 1..1 string Name of the property
..... value 1..1 base64Binary Property value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typeextensibleAudit Event ID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action
from the FHIR Standard
AuditEvent.agent.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()
zv-ae-1errorAuditEvent.entity.detailAt least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
: type='X-Request-Id'
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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 Coding Type/identifier of event
Binding: Audit Event ID (extensible): Type of event.

... subtype Σ 0..* Coding More specific type/id for the event
Binding: Audit Event Sub-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 occurred on source
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed

... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... agent S 1..* BackboneElement Actor involved in the event
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event


.... reference Σ 0..1 Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Direct reference to resource
.... userId SΣ 0..1 Identifier Unique identifier for the user
.... altId 0..1 string Alternative User id e.g. authentication
.... name S 0..1 string Human-meaningful name for the agent
.... requestor 1..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) Where
.... policy S 0..* uri Policy that authorized event

Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming
.... media 0..1 Coding Type of media
Binding: Media Type Code (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 xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... address 0..1 string Identifier for the network access point of the user device
..... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event

.... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


... source 1..1 BackboneElement Audit Event Reporter
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... site 0..1 string Logical source location within the enterprise
.... identifier SΣ 1..1 Identifier The identity of source detecting the event
.... 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.


... entity SC 0..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier SΣ 0..1 Identifier Specific instance of object
.... reference Σ 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 SC 0..* BackboneElement Additional Information about the entity
zv-ae-1: At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... type 1..1 string Name of the property
..... value 1..1 base64Binary Property value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensibleAudit Event ID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAudit Event Sub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
AuditEvent.agent.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMedia Type Code
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
AuditEvent.source.typeextensibleAudit Event Source Type
http://hl7.org/fhir/ValueSet/audit-source-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()
zv-ae-1errorAuditEvent.entity.detailAt 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

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... type S 1..1 Coding Type/identifier of event
... action S 0..1 code Type of action performed during the event
... recorded S 1..1 instant Time when the event occurred on source
.... role S 0..* CodeableConcept Agent role in the event
.... userId S 0..1 Identifier Unique identifier for the user
.... name S 0..1 string Human-meaningful name for the agent
.... policy S 0..* uri Policy that authorized event
Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming
... source
.... identifier S 1..1 Identifier The identity of source detecting the event
... entity S 0..* BackboneElement Data or objects used
.... identifier S 0..1 Identifier Specific instance of object
.... type S 0..1 Coding Type of entity involved
.... detail SC 0..* BackboneElement Additional Information about the entity
zv-ae-1: At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
zv-ae-1errorAuditEvent.entity.detailAt least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
: type='X-Request-Id'

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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: Audit Event ID (extensible): Type of event.

... recorded SΣ 1..1 instant Time when the event occurred on source
... agent S 1..* BackboneElement Actor involved in the event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event


.... userId SΣ 0..1 Identifier Unique identifier for the user
.... name S 0..1 string Human-meaningful name for the agent
.... requestor 1..1 boolean Whether user is initiator
.... policy S 0..* uri Policy that authorized event

Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier SΣ 1..1 Identifier The identity of source detecting the event
... entity SC 0..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier SΣ 0..1 Identifier Specific instance of object
.... type S 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event

.... detail SC 0..* BackboneElement Additional Information about the entity
zv-ae-1: At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... type 1..1 string Name of the property
..... value 1..1 base64Binary Property value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typeextensibleAudit Event ID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action
from the FHIR Standard
AuditEvent.agent.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()
zv-ae-1errorAuditEvent.entity.detailAt least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
: type='X-Request-Id'

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... 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 Coding Type/identifier of event
Binding: Audit Event ID (extensible): Type of event.

... subtype Σ 0..* Coding More specific type/id for the event
Binding: Audit Event Sub-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 occurred on source
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed

... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept The purposeOfUse of the event
Binding: PurposeOfUse (extensible): The reason the activity took place.


... agent S 1..* BackboneElement Actor involved in the event
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... role S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (extensible): What security role enabled the agent to participate in the event


.... reference Σ 0..1 Reference(Practitioner | Organization | Device | Patient | RelatedPerson) Direct reference to resource
.... userId SΣ 0..1 Identifier Unique identifier for the user
.... altId 0..1 string Alternative User id e.g. authentication
.... name S 0..1 string Human-meaningful name for the agent
.... requestor 1..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) Where
.... policy S 0..* uri Policy that authorized event

Fixed Value: https://rivo-noord.nl/zorgviewer/toestemming
.... media 0..1 Coding Type of media
Binding: Media Type Code (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 xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... address 0..1 string Identifier for the network access point of the user device
..... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event

.... purposeOfUse 0..* CodeableConcept Reason given for this user
Binding: PurposeOfUse (extensible): The reason the activity took place.


... source 1..1 BackboneElement Audit Event Reporter
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... site 0..1 string Logical source location within the enterprise
.... identifier SΣ 1..1 Identifier The identity of source detecting the event
.... 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.


... entity SC 0..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... id 0..1 string xml:id (or equivalent in JSON)
.... extension 0..* Extension Additional Content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
.... identifier SΣ 0..1 Identifier Specific instance of object
.... reference Σ 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 SC 0..* BackboneElement Additional Information about the entity
zv-ae-1: At least 1 detail with name 'X-Request-Id' containing the associated HTTP Header value must exist.
..... id 0..1 string xml:id (or equivalent in JSON)
..... extension 0..* Extension Additional Content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored
..... type 1..1 string Name of the property
..... value 1..1 base64Binary Property value

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languageextensibleCommon Languages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensibleAudit Event ID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAudit Event Sub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
AuditEvent.agent.roleextensibleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMedia Type Code
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://hl7.org/fhir/ValueSet/v3-PurposeOfUse
from the FHIR Standard
AuditEvent.source.typeextensibleAudit Event Source Type
http://hl7.org/fhir/ValueSet/audit-source-type
from the FHIR Standard
AuditEvent.entity.typeextensibleAuditEventEntityType
http://hl7.org/fhir/ValueSet/audit-entity-type
from the FHIR Standard
AuditEvent.entity.roleextensibleAuditEventEntityRole
http://hl7.org/fhir/ValueSet/object-role
from the FHIR Standard
AuditEvent.entity.lifecycleextensibleObjectLifecycleEvents
http://hl7.org/fhir/ValueSet/object-lifecycle-events
from the FHIR Standard
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
dom-1errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain any narrative
: contained.text.empty()
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf 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-4errorAuditEventIf 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-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() | (children().count() > id.count())
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()
zv-ae-1errorAuditEvent.entity.detailAt 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