NO Domain Trust Framework ("Nasjonalt tillitsrammeverk") AuditEvent Implementation Guide
0.9.8 - ci-build

NO Domain Trust Framework ("Nasjonalt tillitsrammeverk") AuditEvent Implementation Guide - Local Development build (v0.9.8) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: no-domain-Trustframework-Auditevent

Official URL: http://hl7.no/fhir/StructureDefinition/no-domain-Trustframework-Auditevent Version: 0.9.8
Active as of 2024-11-07 Computable Name: NoDomainTrustframeworkAuditEvent

This is the main profile that describes the mapping of Norwegian Trust Framework attributes ("Tillitsrammeverk") to AuditEvent Resource.

Two extentions is added to AuditEvent R4 resource to be forward compatible with R5:

Usage:

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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... _encounter S 0..1 Reference(no-domain-Trustframework-Encounter) AuditEventEncounterExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-encounter-extension
.... _patient S 1..1 Reference(no-domain-Trustframework-Patient) AuditEventPatientExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-patient-extension
.... _careRelationMetaData S 0..1 (Complex) toa, care_relationship:decision_ref:id, :description, :user_selected
URL: http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension
..... Slices for extension Content/Rules for all slices
...... extension:decision-ref-id 1..1 Extension care_relationship:decision_ref:id
...... extension:decision-ref-description 1..1 Extension care_relationship:decision_ref:description
...... extension:decision-ref-user-selected 1..1 Extension care_relationship:decision_ref:user_selected
...... extension:toa 1..1 Extension toa
... purposeOfEvent 0..* CodeableConcept care_relationship:purpose_of_use:code, :system and :text and care_relationship:purpose_of_use_details:code, :system and :text
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system 0..1 uri care_relationship:purpose_of_use:system and care_relationship:purpose_of_use_details:system
...... code 0..1 code care_relationship:purpose_of_use:code and care_relationship:purpose_of_use_details:code
...... display 0..1 string care_relationship:purpose_of_use:text and care_relationship:purpose_of_use_details:text
..... coding:PURPOSE_OF_USE_VALUESET 1..1 Coding Code defined by a terminology system
Binding: PurposeOfUse (required)
..... coding:DIPS_DECISIONTEMPLATE 0..1 Coding DIPS Decision template terminology (see https://hl7norway.github.io/AuditEvent/currentbuild/CodeSystem-decisiontemplate.html)
Binding: https://terminology.dips.com/decisiontemplate (required): DIPS

..... coding:VOLVEN_9151 0..1 Coding Volven 9151
Binding: urn:oid:2.16.578.1.12.4.1.1.9151 (required): Volven

... agent
.... who 1..1 Reference(no-domain-Trustframework-PractitioneRole) Identifier of who

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.purposeOfEvent.coding:PURPOSE_OF_USE_VALUESETrequiredPurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:DIPS_DECISIONTEMPLATErequiredhttps://terminology.dips.com/decisiontemplate
https://terminology.dips.com/decisiontemplate
AuditEvent.purposeOfEvent.coding:VOLVEN_9151required

urn:oid:2.16.578.1.12.4.1.1.9151

urn:oid:2.16.578.1.12.4.1.1.9151
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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... _encounter S 0..1 Reference(no-domain-Trustframework-Encounter) AuditEventEncounterExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-encounter-extension
.... _patient S 1..1 Reference(no-domain-Trustframework-Patient) AuditEventPatientExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-patient-extension
.... _careRelationMetaData S 0..1 (Complex) toa, care_relationship:decision_ref:id, :description, :user_selected
URL: http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension
..... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:decision-ref-id 1..1 Extension care_relationship:decision_ref:id
....... extension 0..0
....... url 1..1 uri "decision-ref-id"
...... extension:decision-ref-description 1..1 Extension care_relationship:decision_ref:description
....... extension 0..0
....... url 1..1 uri "decision-ref-description"
...... extension:decision-ref-user-selected 1..1 Extension care_relationship:decision_ref:user_selected
....... extension 0..0
....... url 1..1 uri "decision-ref-user-selected"
...... extension:toa 1..1 Extension toa
....... extension 0..0
....... url 1..1 uri "toa"
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... recorded Σ 1..1 instant Time when the event was recorded
... purposeOfEvent Σ 0..* CodeableConcept care_relationship:purpose_of_use:code, :system and :text and care_relationship:purpose_of_use_details:code, :system and :text
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system Σ 0..1 uri care_relationship:purpose_of_use:system and care_relationship:purpose_of_use_details:system
...... code Σ 0..1 code care_relationship:purpose_of_use:code and care_relationship:purpose_of_use_details:code
...... display Σ 0..1 string care_relationship:purpose_of_use:text and care_relationship:purpose_of_use_details:text
..... coding:PURPOSE_OF_USE_VALUESET Σ 1..1 Coding Code defined by a terminology system
Binding: PurposeOfUse (required)
..... coding:DIPS_DECISIONTEMPLATE Σ 0..1 Coding DIPS Decision template terminology (see https://hl7norway.github.io/AuditEvent/currentbuild/CodeSystem-decisiontemplate.html)
Binding: https://terminology.dips.com/decisiontemplate (required): DIPS


..... coding:VOLVEN_9151 Σ 0..1 Coding Volven 9151
Binding: urn:oid:2.16.578.1.12.4.1.1.9151 (required): Volven


... agent 1..* BackboneElement Actor involved in the event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who Σ 1..1 Reference(no-domain-Trustframework-PractitioneRole) Identifier of who
.... requestor Σ 1..1 boolean Whether user is initiator
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:PURPOSE_OF_USE_VALUESETrequiredPurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:DIPS_DECISIONTEMPLATErequiredhttps://terminology.dips.com/decisiontemplate
https://terminology.dips.com/decisiontemplate
AuditEvent.purposeOfEvent.coding:VOLVEN_9151required

urn:oid:2.16.578.1.12.4.1.1.9151

urn:oid:2.16.578.1.12.4.1.1.9151

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... _encounter S 0..1 Reference(no-domain-Trustframework-Encounter) AuditEventEncounterExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-encounter-extension
.... _patient S 1..1 Reference(no-domain-Trustframework-Patient) AuditEventPatientExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-patient-extension
.... _careRelationMetaData S 0..1 (Complex) toa, care_relationship:decision_ref:id, :description, :user_selected
URL: http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:decision-ref-id 1..1 Extension care_relationship:decision_ref:id
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "decision-ref-id"
....... value[x] 0..1 string care_relationship:decision_ref:id
...... extension:decision-ref-description 1..1 Extension care_relationship:decision_ref:description
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "decision-ref-description"
....... value[x] 0..1 string care_relationship:decision_ref:description
...... extension:decision-ref-user-selected 1..1 Extension care_relationship:decision_ref:user_selected
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "decision-ref-user-selected"
....... value[x] 0..1 boolean care_relationship:decision_ref:user_selected
...... extension:toa 1..1 Extension toa
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "toa"
....... value[x] 0..1 unsignedInt toa
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.

... subtype Σ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.


... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.

... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.

... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept care_relationship:purpose_of_use:code, :system and :text and care_relationship:purpose_of_use_details:code, :system and :text
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri care_relationship:purpose_of_use:system and care_relationship:purpose_of_use_details:system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code care_relationship:purpose_of_use:code and care_relationship:purpose_of_use_details:code
...... display Σ 0..1 string care_relationship:purpose_of_use:text and care_relationship:purpose_of_use_details:text
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:PURPOSE_OF_USE_VALUESET Σ 1..1 Coding Code defined by a terminology system
Binding: PurposeOfUse (required)
..... coding:DIPS_DECISIONTEMPLATE Σ 0..1 Coding DIPS Decision template terminology (see https://hl7norway.github.io/AuditEvent/currentbuild/CodeSystem-decisiontemplate.html)
Binding: https://terminology.dips.com/decisiontemplate (required): DIPS


..... coding:VOLVEN_9151 Σ 0..1 Coding Volven 9151
Binding: urn:oid:2.16.578.1.12.4.1.1.9151 (required): Volven


.... text Σ 0..1 string Plain text representation of the concept
... agent 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 (extensible): 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 Σ 1..1 Reference(no-domain-Trustframework-PractitioneRole) Identifier of who
.... altId 0..1 string Alternative User identity
.... name 0..1 string Human friendly name for the agent
.... requestor Σ 1..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) Where
.... policy 0..* uri Policy that authorized event
.... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

.... network 0..1 BackboneElement Logical network location for application activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... address 0..1 string Identifier for the network access point of the user device
..... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

.... purposeOfUse 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 Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site 0..1 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
.... type 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 C 0..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... 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 Σ 0..1 Reference(Resource) Specific instance of resource
.... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

.... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

.... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

.... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... name ΣC 0..1 string Descriptor for entity
.... description 0..1 string Descriptive text
.... query ΣC 0..1 base64Binary Query parameters
.... detail 0..* BackboneElement Additional Information about the entity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 string Name of the property
..... value[x] 1..1 Property value
...... valueString string
...... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:PURPOSE_OF_USE_VALUESETrequiredPurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:DIPS_DECISIONTEMPLATErequiredhttps://terminology.dips.com/decisiontemplate
https://terminology.dips.com/decisiontemplate
AuditEvent.purposeOfEvent.coding:VOLVEN_9151required

urn:oid:2.16.578.1.12.4.1.1.9151

urn:oid:2.16.578.1.12.4.1.1.9151
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
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
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.purposeOfEvent.coding

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... _encounter S 0..1 Reference(no-domain-Trustframework-Encounter) AuditEventEncounterExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-encounter-extension
.... _patient S 1..1 Reference(no-domain-Trustframework-Patient) AuditEventPatientExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-patient-extension
.... _careRelationMetaData S 0..1 (Complex) toa, care_relationship:decision_ref:id, :description, :user_selected
URL: http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension
..... Slices for extension Content/Rules for all slices
...... extension:decision-ref-id 1..1 Extension care_relationship:decision_ref:id
...... extension:decision-ref-description 1..1 Extension care_relationship:decision_ref:description
...... extension:decision-ref-user-selected 1..1 Extension care_relationship:decision_ref:user_selected
...... extension:toa 1..1 Extension toa
... purposeOfEvent 0..* CodeableConcept care_relationship:purpose_of_use:code, :system and :text and care_relationship:purpose_of_use_details:code, :system and :text
.... Slices for coding 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system 0..1 uri care_relationship:purpose_of_use:system and care_relationship:purpose_of_use_details:system
...... code 0..1 code care_relationship:purpose_of_use:code and care_relationship:purpose_of_use_details:code
...... display 0..1 string care_relationship:purpose_of_use:text and care_relationship:purpose_of_use_details:text
..... coding:PURPOSE_OF_USE_VALUESET 1..1 Coding Code defined by a terminology system
Binding: PurposeOfUse (required)
..... coding:DIPS_DECISIONTEMPLATE 0..1 Coding DIPS Decision template terminology (see https://hl7norway.github.io/AuditEvent/currentbuild/CodeSystem-decisiontemplate.html)
Binding: https://terminology.dips.com/decisiontemplate (required): DIPS

..... coding:VOLVEN_9151 0..1 Coding Volven 9151
Binding: urn:oid:2.16.578.1.12.4.1.1.9151 (required): Volven

... agent
.... who 1..1 Reference(no-domain-Trustframework-PractitioneRole) Identifier of who

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.purposeOfEvent.coding:PURPOSE_OF_USE_VALUESETrequiredPurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:DIPS_DECISIONTEMPLATErequiredhttps://terminology.dips.com/decisiontemplate
https://terminology.dips.com/decisiontemplate
AuditEvent.purposeOfEvent.coding:VOLVEN_9151required

urn:oid:2.16.578.1.12.4.1.1.9151

urn:oid:2.16.578.1.12.4.1.1.9151

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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... _encounter S 0..1 Reference(no-domain-Trustframework-Encounter) AuditEventEncounterExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-encounter-extension
.... _patient S 1..1 Reference(no-domain-Trustframework-Patient) AuditEventPatientExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-patient-extension
.... _careRelationMetaData S 0..1 (Complex) toa, care_relationship:decision_ref:id, :description, :user_selected
URL: http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension
..... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:decision-ref-id 1..1 Extension care_relationship:decision_ref:id
....... extension 0..0
....... url 1..1 uri "decision-ref-id"
...... extension:decision-ref-description 1..1 Extension care_relationship:decision_ref:description
....... extension 0..0
....... url 1..1 uri "decision-ref-description"
...... extension:decision-ref-user-selected 1..1 Extension care_relationship:decision_ref:user_selected
....... extension 0..0
....... url 1..1 uri "decision-ref-user-selected"
...... extension:toa 1..1 Extension toa
....... extension 0..0
....... url 1..1 uri "toa"
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... recorded Σ 1..1 instant Time when the event was recorded
... purposeOfEvent Σ 0..* CodeableConcept care_relationship:purpose_of_use:code, :system and :text and care_relationship:purpose_of_use_details:code, :system and :text
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... system Σ 0..1 uri care_relationship:purpose_of_use:system and care_relationship:purpose_of_use_details:system
...... code Σ 0..1 code care_relationship:purpose_of_use:code and care_relationship:purpose_of_use_details:code
...... display Σ 0..1 string care_relationship:purpose_of_use:text and care_relationship:purpose_of_use_details:text
..... coding:PURPOSE_OF_USE_VALUESET Σ 1..1 Coding Code defined by a terminology system
Binding: PurposeOfUse (required)
..... coding:DIPS_DECISIONTEMPLATE Σ 0..1 Coding DIPS Decision template terminology (see https://hl7norway.github.io/AuditEvent/currentbuild/CodeSystem-decisiontemplate.html)
Binding: https://terminology.dips.com/decisiontemplate (required): DIPS


..... coding:VOLVEN_9151 Σ 0..1 Coding Volven 9151
Binding: urn:oid:2.16.578.1.12.4.1.1.9151 (required): Volven


... agent 1..* BackboneElement Actor involved in the event
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... who Σ 1..1 Reference(no-domain-Trustframework-PractitioneRole) Identifier of who
.... requestor Σ 1..1 boolean Whether user is initiator
... source 1..1 BackboneElement Audit Event Reporter
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:PURPOSE_OF_USE_VALUESETrequiredPurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:DIPS_DECISIONTEMPLATErequiredhttps://terminology.dips.com/decisiontemplate
https://terminology.dips.com/decisiontemplate
AuditEvent.purposeOfEvent.coding:VOLVEN_9151required

urn:oid:2.16.578.1.12.4.1.1.9151

urn:oid:2.16.578.1.12.4.1.1.9151

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

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
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... _encounter S 0..1 Reference(no-domain-Trustframework-Encounter) AuditEventEncounterExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-encounter-extension
.... _patient S 1..1 Reference(no-domain-Trustframework-Patient) AuditEventPatientExtension
URL: http://hl7.no/fhir/StructureDefinition/auditevent-patient-extension
.... _careRelationMetaData S 0..1 (Complex) toa, care_relationship:decision_ref:id, :description, :user_selected
URL: http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension
..... id 0..1 string Unique id for inter-element referencing
..... Slices for extension 4..* Extension Extension
Slice: Unordered, Open by value:url
...... extension:decision-ref-id 1..1 Extension care_relationship:decision_ref:id
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "decision-ref-id"
....... value[x] 0..1 string care_relationship:decision_ref:id
...... extension:decision-ref-description 1..1 Extension care_relationship:decision_ref:description
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "decision-ref-description"
....... value[x] 0..1 string care_relationship:decision_ref:description
...... extension:decision-ref-user-selected 1..1 Extension care_relationship:decision_ref:user_selected
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "decision-ref-user-selected"
....... value[x] 0..1 boolean care_relationship:decision_ref:user_selected
...... extension:toa 1..1 Extension toa
....... id 0..1 string Unique id for inter-element referencing
....... extension 0..0
....... url 1..1 uri "toa"
....... value[x] 0..1 unsignedInt toa
..... url 1..1 uri "http://hl7.no/fhir/StructureDefinition/auditevent-carerelation-metadata-extension"
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 1..1 Coding Type/identifier of event
Binding: AuditEventID (extensible): Type of event.

... subtype Σ 0..* Coding More specific type/id for the event
Binding: AuditEventSub-Type (extensible): Sub-type of event.


... action Σ 0..1 code Type of action performed during the event
Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.

... period 0..1 Period When the activity occurred
... recorded Σ 1..1 instant Time when the event was recorded
... outcome Σ 0..1 code Whether the event succeeded or failed
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.

... outcomeDesc Σ 0..1 string Description of the event outcome
... purposeOfEvent Σ 0..* CodeableConcept care_relationship:purpose_of_use:code, :system and :text and care_relationship:purpose_of_use_details:code, :system and :text
Binding: PurposeOfUse (extensible): The reason the activity took place.


.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
.... Slices for coding Σ 1..* Coding Code defined by a terminology system
Slice: Unordered, Open by value:$this
..... coding:All Slices Content/Rules for all slices
...... id 0..1 string Unique id for inter-element referencing
...... extension 0..* Extension Additional content defined by implementations
Slice: Unordered, Open by value:url
...... system Σ 0..1 uri care_relationship:purpose_of_use:system and care_relationship:purpose_of_use_details:system
...... version Σ 0..1 string Version of the system - if relevant
...... code Σ 0..1 code care_relationship:purpose_of_use:code and care_relationship:purpose_of_use_details:code
...... display Σ 0..1 string care_relationship:purpose_of_use:text and care_relationship:purpose_of_use_details:text
...... userSelected Σ 0..1 boolean If this coding was chosen directly by the user
..... coding:PURPOSE_OF_USE_VALUESET Σ 1..1 Coding Code defined by a terminology system
Binding: PurposeOfUse (required)
..... coding:DIPS_DECISIONTEMPLATE Σ 0..1 Coding DIPS Decision template terminology (see https://hl7norway.github.io/AuditEvent/currentbuild/CodeSystem-decisiontemplate.html)
Binding: https://terminology.dips.com/decisiontemplate (required): DIPS


..... coding:VOLVEN_9151 Σ 0..1 Coding Volven 9151
Binding: urn:oid:2.16.578.1.12.4.1.1.9151 (required): Volven


.... text Σ 0..1 string Plain text representation of the concept
... agent 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 (extensible): 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 Σ 1..1 Reference(no-domain-Trustframework-PractitioneRole) Identifier of who
.... altId 0..1 string Alternative User identity
.... name 0..1 string Human friendly name for the agent
.... requestor Σ 1..1 boolean Whether user is initiator
.... location 0..1 Reference(Location) Where
.... policy 0..* uri Policy that authorized event
.... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

.... network 0..1 BackboneElement Logical network location for application activity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... address 0..1 string Identifier for the network access point of the user device
..... type 0..1 code The type of network access point
Binding: AuditEventAgentNetworkType (required): The type of network access point of this agent in the audit event.

.... purposeOfUse 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 Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site 0..1 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
.... type 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 C 0..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... 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 Σ 0..1 Reference(Resource) Specific instance of resource
.... type 0..1 Coding Type of entity involved
Binding: AuditEventEntityType (extensible): Code for the entity type involved in the audit event.

.... role 0..1 Coding What role the entity played
Binding: AuditEventEntityRole (extensible): Code representing the role the entity played in the audit event.

.... lifecycle 0..1 Coding Life-cycle stage for the entity
Binding: ObjectLifecycleEvents (extensible): Identifier for the data life-cycle stage for the entity.

.... securityLabel 0..* Coding Security labels on the entity
Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.


.... name ΣC 0..1 string Descriptor for entity
.... description 0..1 string Descriptive text
.... query ΣC 0..1 base64Binary Query parameters
.... detail 0..* BackboneElement Additional Information about the entity
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..* Extension Additional content defined by implementations
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
..... type 1..1 string Name of the property
..... value[x] 1..1 Property value
...... valueString string
...... valueBase64Binary base64Binary

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
AuditEvent.typeextensibleAuditEventID
http://hl7.org/fhir/ValueSet/audit-event-type
from the FHIR Standard
AuditEvent.subtypeextensibleAuditEventSub-Type
http://hl7.org/fhir/ValueSet/audit-event-sub-type
from the FHIR Standard
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:PURPOSE_OF_USE_VALUESETrequiredPurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.purposeOfEvent.coding:DIPS_DECISIONTEMPLATErequiredhttps://terminology.dips.com/decisiontemplate
https://terminology.dips.com/decisiontemplate
AuditEvent.purposeOfEvent.coding:VOLVEN_9151required

urn:oid:2.16.578.1.12.4.1.1.9151

urn:oid:2.16.578.1.12.4.1.1.9151
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.typeextensibleAuditEventSourceType
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
AuditEvent.entity.securityLabelextensibleAll Security Labels
http://hl7.org/fhir/ValueSet/security-labels
from the FHIR Standard

Constraints

IdGradePath(s)DetailsRequirements
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 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-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()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

Mandatory: 3 elements(2 nested mandatory elements)
Must-Support: 3 elements

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

  • The element 1 is sliced based on the value of AuditEvent.purposeOfEvent.coding

 

Other representations of profile: CSV, Excel, Schematron