TIFlow - Verordnungen für Arzneimittel
Version 2.0.0-ballot.1 - ci-build

## Resource Profile: GEM ERP PR AuditEvent

Official URL: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent | Version: 2.0.0-ballot.1
Active as of 2028-04-01 | Computable Name: GEM_ERP_PR_AuditEvent
Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

AuditEvent für die Protokollierung des Zugriffs auf E-Rezepte

Usages:

- Examples for this Profile: AuditEvent/9361863d-fec0-4ba9-8776-7905cf1b0cfa

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..* | TIAuditEventRest | Event record kept for security purposes Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
meta | S Σ | 1..1 | Meta | Metadata about the resource
Slices for profile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this
profile:workflowProfile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent|2.0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
type | S Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Fixed Value: As shown (RESTful Operation)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
system | Σ | 1..1 | uri | Identity of the terminology system
code | Σ | 1..1 | code | Symbol in syntax defined by the system
subtype | S Σ | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action | S Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded | Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
agent | S | 1..* | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
who | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
name | S | 0..1 | string | Human friendly name for the agent
requestor | Σ | 1..1 | boolean | Whether user is initiator
source | S | 1..1 | BackboneElement | Audit Event Reporter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
site | S | 1..1 | string | Logical source location within the enterprise Fixed Value: TI-Flow-Fachdienst
observer | Σ C | 1..1 | Reference(Device) | The identity of source detecting the event Constraints: ref-1
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
entity | S C | 1..1 | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | Σ C | 1..1 | Reference(Resource) | Specific instance of resource Constraints: ref-1
name | Σ C | 1..1 | string | KVNR des Patienten, auf den sich das AuditEvent bezieht
description |  | 1..1 | string | E-Rezept-ID
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std.
AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍4.0.1 | FHIR Std.
AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std.
AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std.
AuditEvent.agent.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | AuditEvent | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
ref-1 | error | AuditEvent.agent.who, AuditEvent.source.observer, AuditEvent.entity.what | SHALL have a contained resource if a local reference is provided | `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
sev-1 | error | AuditEvent.entity | Either a name or a query (NOT both) | `name.empty() or query.empty()`

This structure is derived from TIAuditEventRest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | TIAuditEventRest | Event record kept for security purposes
meta | S | 1..1 | Meta | Metadata about the resource
Slices for profile | S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this
profile:workflowProfile | S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent|2.0
source |  |  |  |
site |  | 1..1 | string | Logical source location within the enterprise Fixed Value: TI-Flow-Fachdienst
entity | S | 1..1 | BackboneElement | Data or objects used
what |  | 1..1 | Reference(Resource) | Specific instance of resource
name |  | 1..1 | string | KVNR des Patienten, auf den sich das AuditEvent bezieht
description |  | 1..1 | string | E-Rezept-ID
Documentation for this format

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | TIAuditEventRest | Event record kept for security purposes Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
id | Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 1..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
Slices for profile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this
profile:workflowProfile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent|2.0
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
type | S Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Fixed Value: As shown (RESTful Operation)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
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 | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
subtype | S Σ | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action | S Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period | C | 0..1 | Period | When the activity occurred Constraints: per-1
recorded | Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 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 | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..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 | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
altId |  | 0..1 | string | Alternative User identity
name | S | 0..1 | string | Human friendly name for the agent
requestor | Σ | 1..1 | boolean | Whether user is initiator
location | C | 0..1 | Reference(Location) | Where Constraints: ref-1
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 Slice: Unordered, Open by value:url
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 | S | 1..1 | BackboneElement | Audit Event Reporter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
site | S | 1..1 | string | Logical source location within the enterprise Fixed Value: TI-Flow-Fachdienst
observer | Σ C | 1..1 | Reference(Device) | The identity of source detecting the event Constraints: ref-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
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 | S C | 1..1 | BackboneElement | Data or objects used Constraints: sev-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | Σ C | 1..1 | Reference(Resource) | Specific instance of resource Constraints: ref-1
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 | 1..1 | string | KVNR des Patienten, auf den sich das AuditEvent bezieht
description |  | 1..1 | string | E-Rezept-ID
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 Slice: Unordered, Open by value:url
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 |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
AuditEvent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std.
AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍4.0.1 | FHIR Std.
AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std.
AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std.
AuditEvent.purposeOfEvent | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.who.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent.network.​type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.source.observer.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.source.type | Base | extensible | Audit Event Source Type | 📍4.0.1 | FHIR Std.
AuditEvent.entity.type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity.role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity.lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | AuditEvent | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
per-1 | error | AuditEvent.period | If present, start SHALL have a lower value than end | `start.hasValue().not() or end.hasValue().not() or (start <= end)`
ref-1 | error | AuditEvent.agent.who, AuditEvent.agent.location, AuditEvent.source.observer, AuditEvent.entity.what | SHALL have a contained resource if a local reference is provided | `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
sev-1 | error | AuditEvent.entity | Either a name or a query (NOT both) | `name.empty() or query.empty()`

This structure is derived from TIAuditEventRest

Summary

Mandatory: 7 elements
Must-Support: 4 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AuditEvent.meta.profile (Closed)

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | TIAuditEventRest | Event record kept for security purposes Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
meta | S Σ | 1..1 | Meta | Metadata about the resource
Slices for profile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this
profile:workflowProfile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent|2.0
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
type | S Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Fixed Value: As shown (RESTful Operation)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
system | Σ | 1..1 | uri | Identity of the terminology system
code | Σ | 1..1 | code | Symbol in syntax defined by the system
subtype | S Σ | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action | S Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded | Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 0..1 | code | Whether the event succeeded or failed Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
agent | S | 1..* | BackboneElement | Actor involved in the event
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event.
who | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
name | S | 0..1 | string | Human friendly name for the agent
requestor | Σ | 1..1 | boolean | Whether user is initiator
source | S | 1..1 | BackboneElement | Audit Event Reporter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
site | S | 1..1 | string | Logical source location within the enterprise Fixed Value: TI-Flow-Fachdienst
observer | Σ C | 1..1 | Reference(Device) | The identity of source detecting the event Constraints: ref-1
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
entity | S C | 1..1 | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | Σ C | 1..1 | Reference(Resource) | Specific instance of resource Constraints: ref-1
name | Σ C | 1..1 | string | KVNR des Patienten, auf den sich das AuditEvent bezieht
description |  | 1..1 | string | E-Rezept-ID
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std.
AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍4.0.1 | FHIR Std.
AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std.
AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std.
AuditEvent.agent.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | AuditEvent | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
ref-1 | error | AuditEvent.agent.who, AuditEvent.source.observer, AuditEvent.entity.what | SHALL have a contained resource if a local reference is provided | `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
sev-1 | error | AuditEvent.entity | Either a name or a query (NOT both) | `name.empty() or query.empty()`

Differential View

This structure is derived from TIAuditEventRest

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | TIAuditEventRest | Event record kept for security purposes
meta | S | 1..1 | Meta | Metadata about the resource
Slices for profile | S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this
profile:workflowProfile | S | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent|2.0
source |  |  |  |
site |  | 1..1 | string | Logical source location within the enterprise Fixed Value: TI-Flow-Fachdienst
entity | S | 1..1 | BackboneElement | Data or objects used
what |  | 1..1 | Reference(Resource) | Specific instance of resource
name |  | 1..1 | string | KVNR des Patienten, auf den sich das AuditEvent bezieht
description |  | 1..1 | string | E-Rezept-ID
Documentation for this format

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | TIAuditEventRest | Event record kept for security purposes Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
id | Σ | 0..1 | id | Logical id of this artifact
meta | S Σ | 1..1 | Meta | Metadata about the resource
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
versionId | Σ | 0..1 | id | Version specific identifier
lastUpdated | Σ | 0..1 | instant | When the resource version last changed
source | Σ | 0..1 | uri | Identifies where the resource comes from
Slices for profile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Slice: Unordered, Closed by value:$this
profile:workflowProfile | S Σ | 1..1 | canonical(StructureDefinition) | Profiles this resource claims to conform to Fixed Value: https://gematik.de/fhir/erp/StructureDefinition/GEM_ERP_PR_AuditEvent|2.0
security | Σ | 0..* | Coding | Security Labels applied to this resource Binding: All Security Labels (extensible): Security Labels from the Healthcare Privacy and Security Classification System.
tag | Σ | 0..* | Coding | Tags applied to this resource Binding: CommonTags (example): Codes that represent various types of tags, commonly workflow-related; e.g. "Needs review by Dr. Jones".
implicitRules | ?!Σ | 0..1 | uri | A set of rules under which this content was created
language |  | 0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
Additional Bindings | Purpose
AllLanguages | Max Binding
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
contained |  | 0..* | Resource | Contained, inline Resources
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?! | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url
type | S Σ | 1..1 | Coding | Type/identifier of event Binding: AuditEventID (extensible): Type of event. Fixed Value: As shown (RESTful Operation)
id |  | 0..0 | string | Unique id for inter-element referencing
extension |  | 0..0 | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/audit-event-type
version |  | 0..0 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: rest
display |  | 0..0 | string | Representation defined by the system
userSelected |  | 0..0 | boolean | If this coding was chosen directly by the user
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 | Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | Σ | 1..1 | code | Symbol in syntax defined by the system
display | Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
subtype | S Σ | 0..* | Coding | More specific type/id for the event Binding: AuditEventSub-Type (extensible): Sub-type of event.
action | S Σ | 0..1 | code | Type of action performed during the event Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
period | C | 0..1 | Period | When the activity occurred Constraints: per-1
recorded | Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 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 | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..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 | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 0..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
altId |  | 0..1 | string | Alternative User identity
name | S | 0..1 | string | Human friendly name for the agent
requestor | Σ | 1..1 | boolean | Whether user is initiator
location | C | 0..1 | Reference(Location) | Where Constraints: ref-1
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 Slice: Unordered, Open by value:url
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 | S | 1..1 | BackboneElement | Audit Event Reporter
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
site | S | 1..1 | string | Logical source location within the enterprise Fixed Value: TI-Flow-Fachdienst
observer | Σ C | 1..1 | Reference(Device) | The identity of source detecting the event Constraints: ref-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
reference | Σ C | 1..1 | string | Literal reference, Relative, internal or absolute URL
type | Σ | 0..1 | uri | Type the reference refers to (e.g. "Patient") Binding: ResourceType (extensible): Aa resource (or, for logical models, the URI of the logical model).
identifier | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource
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 | S C | 1..1 | BackboneElement | Data or objects used Constraints: sev-1
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
what | Σ C | 1..1 | Reference(Resource) | Specific instance of resource Constraints: ref-1
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 | 1..1 | string | KVNR des Patienten, auf den sich das AuditEvent bezieht
description |  | 1..1 | string | E-Rezept-ID
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 Slice: Unordered, Open by value:url
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 |
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.meta.security | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.
AuditEvent.meta.tag | Base | example | Common Tags | 📍4.0.1 | FHIR Std.
AuditEvent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
AuditEvent.type | Base | extensible | Audit Event ID | 📍4.0.1 | FHIR Std.
AuditEvent.subtype | Base | extensible | Audit Event Sub-Type | 📍4.0.1 | FHIR Std.
AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std.
AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std.
AuditEvent.purposeOfEvent | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent.type | Base | extensible | ParticipationRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.who.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.media | Base | extensible | Media Type Code | 📍4.0.1 | FHIR Std.
AuditEvent.agent.network.​type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent.purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.source.observer.​type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.source.type | Base | extensible | Audit Event Source Type | 📍4.0.1 | FHIR Std.
AuditEvent.entity.type | Base | extensible | Audit event entity type | 📍4.0.1 | FHIR Std.
AuditEvent.entity.role | Base | extensible | AuditEventEntityRole | 📍4.0.1 | FHIR Std.
AuditEvent.entity.lifecycle | Base | extensible | ObjectLifecycleEvents | 📍4.0.1 | FHIR Std.
AuditEvent.entity.securityLabel | Base | extensible | SecurityLabels | 📍4.0.1 | FHIR Std.

#### Constraints

Id | Grade | Path(s) | Description | Expression
dom-2 | error | AuditEvent | If the resource is contained in another resource, it SHALL NOT contain nested Resources | `contained.contained.empty()`
dom-3 | error | AuditEvent | If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource | `contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()`
dom-4 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated | `contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()`
dom-5 | error | AuditEvent | If a resource is contained in another resource, it SHALL NOT have a security label | `contained.meta.security.empty()`
dom-6 | best practice | AuditEvent | A resource should have narrative for robust management | `text.`div`.exists()`
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children | `hasValue() or (children().count() > id.count())`
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both | `extension.exists() != value.exists()`
per-1 | error | AuditEvent.period | If present, start SHALL have a lower value than end | `start.hasValue().not() or end.hasValue().not() or (start <= end)`
ref-1 | error | AuditEvent.agent.who, AuditEvent.agent.location, AuditEvent.source.observer, AuditEvent.entity.what | SHALL have a contained resource if a local reference is provided | `reference.startsWith('#').not() or (reference.substring(1).trace('url') in %rootResource.contained.id.trace('ids'))`
sev-1 | error | AuditEvent.entity | Either a name or a query (NOT both) | `name.empty() or query.empty()`

This structure is derived from TIAuditEventRest

Summary

Mandatory: 7 elements
Must-Support: 4 elements
Fixed: 2 elements

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AuditEvent.meta.profile (Closed)

Other representations of profile: CSV, Excel, Schematron