Implementation Guide
ePA Basisfunktionalitäten
Version 1.3.1 - release

## Resource Profile: EPA AuditEvent

Official URL: https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent | Version: 1.3.0
Active as of 2025-12-15 | Computable Name: EPAAuditEvent
Copyright/Legal: gematik GmbH / Dieses Artefakt ist lizenziert unter Apache License, Version 2.0.

Defines the data structure for audit events in the ePA system.

Das Profil `EPAAuditEvent` wird von dem ePA Audit Event Service verwendet, um Protokolleinträge an den ePA-Client bereitzustellen. Dieses Profil stellt sicher, dass alle relevanten Ereignisse im Zusammenhang mit der Nutzung der ePA korrekt und umfassend dokumentiert werden, um den Anforderungen an Datenschutz und Nachvollziehbarkeit gerecht zu werden.

Usages:

- Examples for this Profile: AuditEvent/12f84721-2ad9-4cfa-81c5-b1345bc74230, AuditEvent/15ad14c8-7fe4-479b-bd44-4bf0927b9478, AuditEvent/27a03af4-5ebc-4dd6-83ba-7b775e5b664a, AuditEvent/2b2053e2-3e48-4f3d-880e-e8a1e9aa2f6b... Show 20 more, AuditEvent/2b503f39-9c66-40e2-8f93-260b70c7020b, AuditEvent/49280fa1-5096-4bc7-901e-22f5dd72f822, AuditEvent/4fb73d96-49eb-4b5d-9f12-3afcc7cb9802, AuditEvent/532c1540-8403-4b57-8349-279f53443f23, AuditEvent/589b9862-7935-42f5-a06b-11a6f35833ee, AuditEvent/633ecbbf-d105-4e35-8c9f-0536ee7b6c59, AuditEvent/64689b74-d485-4eca-802e-1c71183195ff, AuditEvent/669699b2-f131-4097-b13d-71413a58aa92, AuditEvent/69b6ab63-03c5-4e4c-b9d8-dc68e51487c4, AuditEvent/825c3fdd-b784-4370-8dd2-c1d3bed674ec, AuditEvent/86604fc1-b356-57e3-8738-8ef36c8d608c, AuditEvent/8bedf920-ffcf-4cb7-b6ca-379f296d8740, AuditEvent/b580f152-cf07-4ef4-aafb-e66c2da28f02, AuditEvent/b5bd972a-39e0-4a19-a361-6b94b99d74d1, AuditEvent/bbf292eb-665d-4724-a2bc-86fa93e89835, AuditEvent/bfc506eb-a714-4373-a990-21d7144d3f58, AuditEvent/c24dcb68-e61b-46fb-b11b-5f37dccf01f8, AuditEvent/d36725fd-0d38-46fb-89f8-46e75a41ba97, AuditEvent/daf3263b-41ba-420c-aacd-bf98dc16d315 and AuditEvent/dc2cad66-28f3-4ad4-ae1b-c2f202217c4a
- CapabilityStatements using this Profile: Capability Statement für Clients des ePA Audit Event Service and EPA Capability Statement für den Audit Event Service

You can also check for usages in the FHIR IG Statistics

### Formal Views of Profile Content

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

- Key Elements Table
- Differential Table
- Snapshot Table
- Statistics/References
- All

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
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 | Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required)
action | S Σ | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded | S Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 1..1 | code | success: 0; failure: 4; major failure: 12 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
Slices for agent | S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
requestor | Σ | 1..1 | boolean | Whether user is initiator
agent:user | S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI)
Slices for extension |  |  |  | Content/Rules for all slices
extension:healthcareFacilityType | S | 0..1 | Coding | EPAHealthcareFacilityType Extension URL: https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension Binding: Healthcare Professional Roles ValueSet for ePA (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 1..1 | uri | Identity of the terminology system
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
who | S Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken Constraints: ref-1
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
altId | S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR)
name | S | 1..1 | string | Name of HCP or Insurant
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
agent:client | S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who | S Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken Constraints: ref-1
identifier | S Σ | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/sid/telematik-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
altId | S | 0..1 | string | Alternative client identity (e.g. Telematik-ID))
name | S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
agent:internal | S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Service Type (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
altId | S | 0..1 | string | altId MUST be epa Fixed Value: epa
name | S | 1..1 | string | Name MUST be ePA Fixed Value: ePA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
source | S | 1..1 | BackboneElement | Audit Event Reporter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
observer | Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event Constraints: ref-1
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst
type | S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Service Type (required)
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
entity | S C | 1..* | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ C | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
description | S | 0..1 | string | The OperationId
detail | S | 0..* | BackboneElement | Additional Information about the entity
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...).
Slices for value[x] |  | 1..1 | string | Property value Slice: Unordered, Closed by type:$this
value[x]:valueString | S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.type | Base | required | EPA AuditEvent Type | 📦1.2.0 | This IG
AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std.
AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​type | Base | required | EPA AuditEvent Agent Type User | 📦1.2.0 | This IG
AuditEvent.agent:user.​role | Base | required | EHealth DSI Healthcare Facility Type ValueSet for ePA | 📦1.0.7 | TI Terminology v1.0
AuditEvent.agent:user.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​type | Base | required | EPA AuditEvent Agent Type Client | 📦1.2.0 | This IG
AuditEvent.agent:client.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.type | Base | extensible | Identifier Type DeBasis ValueSet | 📦1.5.4 | de.basisprofil.r4 v1.5
AuditEvent.agent:internal.​type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG
AuditEvent.source.type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG

#### 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:user.who, AuditEvent.agent:client.who, AuditEvent.source.observer | 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 AuditEvent

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes
type |  | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required)
subtype |  | 0..0 |  | More specific type/id for the event
action | S | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E
period |  | 0..0 |  | When the activity occurred
recorded | S | 1..1 | instant | Time when the event was recorded
outcome | S | 1..1 | code | success: 0; failure: 4; major failure: 12
outcomeDesc |  | 0..0 |  | Description of the event outcome
Slices for agent | S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent:user | S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI)
Slices for extension |  |  |  | Content/Rules for all slices
extension:healthcareFacilityType | S | 0..1 | Coding | EPAHealthcareFacilityType Extension URL: https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension Binding: Healthcare Professional Roles ValueSet for ePA (required)
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 1..1 | uri | Identity of the terminology system
code | S | 1..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
who | S | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken
identifier | S | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
system | S | 0..1 | uri | The namespace for the identifier value
value | S | 0..1 | string | The value that is unique
altId | S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR)
name | S | 1..1 | string | Name of HCP or Insurant
requestor |  | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
location |  | 0..0 |  | Where
policy |  | 0..0 |  | Policy that authorized event
media |  | 0..0 |  | Type of media
network |  | 0..0 |  | Logical network location for application activity
agent:client | S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Agent role in the event
who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken
identifier | S | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
altId | S | 0..1 | string | Alternative client identity (e.g. Telematik-ID))
name | S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA
requestor |  | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
location |  | 0..0 |  | Where
policy |  | 0..0 |  | Policy that authorized event
media |  | 0..0 |  | Type of media
network |  | 0..0 |  | Logical network location for application activity
agent:internal | S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Service Type (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
role |  | 0..0 |  | Agent role in the event
altId | S | 0..1 | string | altId MUST be epa Fixed Value: epa
name | S | 1..1 | string | Name MUST be ePA Fixed Value: ePA
requestor |  | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
location |  | 0..0 |  | Where
policy |  | 0..0 |  | Policy that authorized event
media |  | 0..0 |  | Type of media
network |  | 0..0 |  | Logical network location for application activity
source | S | 1..1 | BackboneElement | Audit Event Reporter
observer |  |  |  |
display |  | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst
type | S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Service Type (required)
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
entity | S | 1..* | BackboneElement | Data or objects used
what |  | 0..0 |  | Specific instance of resource
type |  | 0..0 |  | Type of entity involved
role |  | 0..0 |  | What role the entity played
lifecycle |  | 0..0 |  | Life-cycle stage for the entity
securityLabel |  | 0..0 |  | Security labels on the entity
name | S | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
description | S | 0..1 | string | The OperationId
query |  | 0..0 |  | Query parameters
detail | S | 0..* | BackboneElement | Additional Information about the entity
type | S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...).
Slices for value[x] |  | 1..1 | string | Property value Slice: Unordered, Open by type:$this
value[x]:valueString | S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.type | Base | required | EPA AuditEvent Type | 📦1.2.0 | This IG
AuditEvent.agent:user.​type | Base | required | EPA AuditEvent Agent Type User | 📦1.2.0 | This IG
AuditEvent.agent:user.​role | Base | required | EHealth DSI Healthcare Facility Type ValueSet for ePA | 📦1.0.7 | TI Terminology v1.0
AuditEvent.agent:client.​type | Base | required | EPA AuditEvent Agent Type Client | 📦1.2.0 | This IG
AuditEvent.agent:internal.​type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG
AuditEvent.source.type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | 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 | Σ | 0..1 | Meta | Metadata about the resource
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 | Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required)
action | S Σ | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded | S Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 1..1 | code | success: 0; failure: 4; major failure: 12 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
purposeOfEvent | Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent | S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent: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
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 | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
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 | 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.
agent:user | S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:healthcareFacilityType | S | 0..1 | Coding | EPAHealthcareFacilityType Extension URL: https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension Binding: Healthcare Professional Roles ValueSet for ePA (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
role | S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
who | S Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken 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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ C | 0..1 | Period | Time period when id is/was valid for use Constraints: per-1
assigner | Σ C | 0..1 | Reference(Organization) | Organization that issued id (may be just text) Constraints: ref-1
display | Σ | 0..1 | string | Text alternative for the resource
altId | S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR)
name | S | 1..1 | string | Name of HCP or Insurant
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
purposeOfUse |  | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:client | S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
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: EPA AuditEvent Agent Type Client (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
role | S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who | S Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken 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 | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/sid/telematik-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ C | 0..1 | Period | Time period when id is/was valid for use Constraints: per-1
assigner | Σ C | 0..1 | Reference(Organization) | Organization that issued id (may be just text) Constraints: ref-1
display | Σ | 0..1 | string | Text alternative for the resource
altId | S | 0..1 | string | Alternative client identity (e.g. Telematik-ID))
name | S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
purposeOfUse |  | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:internal | S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
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: EPA AuditEvent Service Type (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
who | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
altId | S | 0..1 | string | altId MUST be epa Fixed Value: epa
name | S | 1..1 | string | Name MUST be ePA Fixed Value: ePA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
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 |  | 0..1 | string | Logical source location within the enterprise
observer | Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | 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 | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst
type | S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Service Type (required)
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
entity | S C | 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
name | S Σ C | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
description | S | 0..1 | string | The OperationId
detail | S | 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 | S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...).
Slices for value[x] |  | 1..1 | string | Property value Slice: Unordered, Closed by type:$this
value[x]:valueString | S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
AuditEvent.type | Base | required | EPA AuditEvent Type | 📦1.2.0 | This IG
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.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.agent:user.​type | Base | required | EPA AuditEvent Agent Type User | 📦1.2.0 | This IG
AuditEvent.agent:user.​role | Base | required | EHealth DSI Healthcare Facility Type ValueSet for ePA | 📦1.0.7 | TI Terminology v1.0
AuditEvent.agent:user.​who.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​who.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:client.​type | Base | required | EPA AuditEvent Agent Type Client | 📦1.2.0 | This IG
AuditEvent.agent:client.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.type | Base | extensible | Identifier Type DeBasis ValueSet | 📦1.5.4 | de.basisprofil.r4 v1.5
AuditEvent.agent:client.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:internal.​type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG
AuditEvent.agent:internal.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:internal.​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 | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG

#### 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.agent:user.who.identifier.period, AuditEvent.agent:client.who.identifier.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.agent:user.who, AuditEvent.agent:user.who.identifier.assigner, AuditEvent.agent:client.who, AuditEvent.agent:client.who.identifier.assigner, AuditEvent.agent:internal.who, AuditEvent.source.observer | 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 AuditEvent

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Must-Support: 58 elements
Fixed: 3 elements
Prohibited: 22 elements

Structures

This structure refers to these other structures:

- Identifier-Profil für die Telematik-ID (http://fhir.de/StructureDefinition/identifier-telematik-id)
- Identifier-Profil für die 10-stellige Krankenversichertennummer (http://fhir.de/StructureDefinition/identifier-kvid-10)

Extensions

This structure refers to these extensions:

- https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AuditEvent.agent
- The element 1 is sliced based on the value of AuditEvent.entity.detail.value[x]

Key Elements View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes Constraints: dom-2, dom-3, dom-4, dom-5, dom-6
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 | Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required)
action | S Σ | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded | S Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 1..1 | code | success: 0; failure: 4; major failure: 12 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
Slices for agent | S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent:All Slices |  |  |  | Content/Rules for all slices
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
requestor | Σ | 1..1 | boolean | Whether user is initiator
agent:user | S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI)
Slices for extension |  |  |  | Content/Rules for all slices
extension:healthcareFacilityType | S | 0..1 | Coding | EPAHealthcareFacilityType Extension URL: https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension Binding: Healthcare Professional Roles ValueSet for ePA (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 1..1 | uri | Identity of the terminology system
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
who | S Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken Constraints: ref-1
identifier | S Σ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
altId | S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR)
name | S | 1..1 | string | Name of HCP or Insurant
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
agent:client | S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who | S Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken Constraints: ref-1
identifier | S Σ | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/sid/telematik-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
altId | S | 0..1 | string | Alternative client identity (e.g. Telematik-ID))
name | S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
agent:internal | S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Service Type (required)
coding | S Σ | 0..* | Coding | Code defined by a terminology system
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
altId | S | 0..1 | string | altId MUST be epa Fixed Value: epa
name | S | 1..1 | string | Name MUST be ePA Fixed Value: ePA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
source | S | 1..1 | BackboneElement | Audit Event Reporter
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
observer | Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event Constraints: ref-1
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst
type | S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Service Type (required)
system | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
entity | S C | 1..* | BackboneElement | Data or objects used Constraints: sev-1
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
name | S Σ C | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
description | S | 0..1 | string | The OperationId
detail | S | 0..* | BackboneElement | Additional Information about the entity
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...).
Slices for value[x] |  | 1..1 | string | Property value Slice: Unordered, Closed by type:$this
value[x]:valueString | S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.type | Base | required | EPA AuditEvent Type | 📦1.2.0 | This IG
AuditEvent.action | Base | required | AuditEventAction | 📍4.0.1 | FHIR Std.
AuditEvent.outcome | Base | required | AuditEventOutcome | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​type | Base | required | EPA AuditEvent Agent Type User | 📦1.2.0 | This IG
AuditEvent.agent:user.​role | Base | required | EHealth DSI Healthcare Facility Type ValueSet for ePA | 📦1.0.7 | TI Terminology v1.0
AuditEvent.agent:user.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​type | Base | required | EPA AuditEvent Agent Type Client | 📦1.2.0 | This IG
AuditEvent.agent:client.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.type | Base | extensible | Identifier Type DeBasis ValueSet | 📦1.5.4 | de.basisprofil.r4 v1.5
AuditEvent.agent:internal.​type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG
AuditEvent.source.type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG

#### 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:user.who, AuditEvent.agent:client.who, AuditEvent.source.observer | 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 AuditEvent

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | Event record kept for security purposes
type |  | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required)
subtype |  | 0..0 |  | More specific type/id for the event
action | S | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E
period |  | 0..0 |  | When the activity occurred
recorded | S | 1..1 | instant | Time when the event was recorded
outcome | S | 1..1 | code | success: 0; failure: 4; major failure: 12
outcomeDesc |  | 0..0 |  | Description of the event outcome
Slices for agent | S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent:user | S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI)
Slices for extension |  |  |  | Content/Rules for all slices
extension:healthcareFacilityType | S | 0..1 | Coding | EPAHealthcareFacilityType Extension URL: https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension Binding: Healthcare Professional Roles ValueSet for ePA (required)
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 1..1 | uri | Identity of the terminology system
code | S | 1..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
who | S | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken
identifier | S | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known
system | S | 0..1 | uri | The namespace for the identifier value
value | S | 0..1 | string | The value that is unique
altId | S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR)
name | S | 1..1 | string | Name of HCP or Insurant
requestor |  | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
location |  | 0..0 |  | Where
policy |  | 0..0 |  | Policy that authorized event
media |  | 0..0 |  | Type of media
network |  | 0..0 |  | Logical network location for application activity
agent:client | S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
role | S | 0..* | CodeableConcept | Agent role in the event
who | S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken
identifier | S | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known
system | S | 1..1 | uri | The namespace for the identifier value
value | S | 1..1 | string | The value that is unique
altId | S | 0..1 | string | Alternative client identity (e.g. Telematik-ID))
name | S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA
requestor |  | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
location |  | 0..0 |  | Where
policy |  | 0..0 |  | Policy that authorized event
media |  | 0..0 |  | Type of media
network |  | 0..0 |  | Logical network location for application activity
agent:internal | S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Service Type (required)
coding | S | 0..* | Coding | Code defined by a terminology system
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
role |  | 0..0 |  | Agent role in the event
altId | S | 0..1 | string | altId MUST be epa Fixed Value: epa
name | S | 1..1 | string | Name MUST be ePA Fixed Value: ePA
requestor |  | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
location |  | 0..0 |  | Where
policy |  | 0..0 |  | Policy that authorized event
media |  | 0..0 |  | Type of media
network |  | 0..0 |  | Logical network location for application activity
source | S | 1..1 | BackboneElement | Audit Event Reporter
observer |  |  |  |
display |  | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst
type | S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Service Type (required)
system | S | 0..1 | uri | Identity of the terminology system
version | S | 0..1 | string | Version of the system - if relevant
code | S | 0..1 | code | Symbol in syntax defined by the system
display | S | 0..1 | string | Representation defined by the system
entity | S | 1..* | BackboneElement | Data or objects used
what |  | 0..0 |  | Specific instance of resource
type |  | 0..0 |  | Type of entity involved
role |  | 0..0 |  | What role the entity played
lifecycle |  | 0..0 |  | Life-cycle stage for the entity
securityLabel |  | 0..0 |  | Security labels on the entity
name | S | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
description | S | 0..1 | string | The OperationId
query |  | 0..0 |  | Query parameters
detail | S | 0..* | BackboneElement | Additional Information about the entity
type | S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...).
Slices for value[x] |  | 1..1 | string | Property value Slice: Unordered, Open by type:$this
value[x]:valueString | S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Documentation for this format

#### Terminology Bindings (Differential)

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.type | Base | required | EPA AuditEvent Type | 📦1.2.0 | This IG
AuditEvent.agent:user.​type | Base | required | EPA AuditEvent Agent Type User | 📦1.2.0 | This IG
AuditEvent.agent:user.​role | Base | required | EHealth DSI Healthcare Facility Type ValueSet for ePA | 📦1.0.7 | TI Terminology v1.0
AuditEvent.agent:client.​type | Base | required | EPA AuditEvent Agent Type Client | 📦1.2.0 | This IG
AuditEvent.agent:internal.​type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG
AuditEvent.source.type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG

Snapshot View

Name | Flags | Card. | Type | Description & Constraints Filter: Bindings Constraints Obligations
--- | --- | --- | --- | ---
AuditEvent |  | 0..* | AuditEvent | 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 | Σ | 0..1 | Meta | Metadata about the resource
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 | Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required)
action | S Σ | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E Binding: AuditEventAction (required): Indicator for type of action performed during the event that generated the event.
recorded | S Σ | 1..1 | instant | Time when the event was recorded
outcome | S Σ | 1..1 | code | success: 0; failure: 4; major failure: 12 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.
purposeOfEvent | Σ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: PurposeOfUse (extensible): The reason the activity took place.
Slices for agent | S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by value:type
agent: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
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 | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
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 | 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.
agent:user | S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI)
id |  | 0..1 | string | Unique id for inter-element referencing
Slices for extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
extension:healthcareFacilityType | S | 0..1 | Coding | EPAHealthcareFacilityType Extension URL: https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension Binding: Healthcare Professional Roles ValueSet for ePA (required)
modifierExtension | ?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized
type | S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
role | S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 1..1 | uri | Identity of the terminology system
version | Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 1..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
who | S Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken 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
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type Codes (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose.
system | S Σ | 0..1 | uri | The namespace for the identifier value Example General: http://www.acme.com/identifiers/patient
value | S Σ | 0..1 | string | The value that is unique Example General: 123456
period | Σ C | 0..1 | Period | Time period when id is/was valid for use Constraints: per-1
assigner | Σ C | 0..1 | Reference(Organization) | Organization that issued id (may be just text) Constraints: ref-1
display | Σ | 0..1 | string | Text alternative for the resource
altId | S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR)
name | S | 1..1 | string | Name of HCP or Insurant
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
purposeOfUse |  | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:client | S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
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: EPA AuditEvent Agent Type Client (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
role | S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.
who | S Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken 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 | Logical reference, when literal reference is not known
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
use | ?!Σ | 0..1 | code | usual | official | temp | secondary | old (If known) Binding: IdentifierUse (required): Identifies the purpose for this identifier, if known .
type | Σ | 0..1 | CodeableConcept | Description of identifier Binding: Identifier Type DeBasis ValueSet (extensible): A coded type for an identifier that can be used to determine which identifier to use for a specific purpose. Required Pattern: At least the following
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
coding |  | 1..* | Coding | Code defined by a terminology system Fixed Value: (Complex)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations
system |  | 1..1 | uri | Identity of the terminology system Fixed Value: http://terminology.hl7.org/CodeSystem/v2-0203
version |  | 0..1 | string | Version of the system - if relevant
code |  | 1..1 | code | Symbol in syntax defined by the system Fixed Value: PRN
display |  | 0..1 | string | Representation defined by the system
userSelected |  | 0..1 | boolean | If this coding was chosen directly by the user
text |  | 0..1 | string | Plain text representation of the concept
system | S Σ | 1..1 | uri | The namespace for the identifier value Fixed Value: https://gematik.de/fhir/sid/telematik-id
value | S Σ | 1..1 | string | The value that is unique Example General: 123456
period | Σ C | 0..1 | Period | Time period when id is/was valid for use Constraints: per-1
assigner | Σ C | 0..1 | Reference(Organization) | Organization that issued id (may be just text) Constraints: ref-1
display | Σ | 0..1 | string | Text alternative for the resource
altId | S | 0..1 | string | Alternative client identity (e.g. Telematik-ID))
name | S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
purposeOfUse |  | 0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place.
agent:internal | S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions
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: EPA AuditEvent Service Type (required)
id |  | 0..1 | string | Unique id for inter-element referencing
extension |  | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url
coding | S Σ | 0..* | Coding | Code defined by a terminology system
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
text | Σ | 0..1 | string | Plain text representation of the concept
who | Σ C | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who Constraints: ref-1
altId | S | 0..1 | string | altId MUST be epa Fixed Value: epa
name | S | 1..1 | string | Name MUST be ePA Fixed Value: ePA
requestor | Σ | 1..1 | boolean | Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
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 |  | 0..1 | string | Logical source location within the enterprise
observer | Σ C | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | 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 | 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 | Σ | 0..1 | Identifier | Logical reference, when literal reference is not known
display | Σ | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst
type | S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Service Type (required)
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 | S Σ | 0..1 | uri | Identity of the terminology system
version | S Σ | 0..1 | string | Version of the system - if relevant
code | S Σ | 0..1 | code | Symbol in syntax defined by the system
display | S Σ | 0..1 | string | Representation defined by the system
userSelected | Σ | 0..1 | boolean | If this coding was chosen directly by the user
entity | S C | 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
name | S Σ C | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...).
description | S | 0..1 | string | The OperationId
detail | S | 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 | S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...).
Slices for value[x] |  | 1..1 | string | Property value Slice: Unordered, Closed by type:$this
value[x]:valueString | S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
Documentation for this format

#### Terminology Bindings

Path | Status | Usage | ValueSet | Version | Source
AuditEvent.language | Base | preferred | Common Languages | 📍4.0.1 | FHIR Std.
AuditEvent.type | Base | required | EPA AuditEvent Type | 📦1.2.0 | This IG
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.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.agent:user.​type | Base | required | EPA AuditEvent Agent Type User | 📦1.2.0 | This IG
AuditEvent.agent:user.​role | Base | required | EHealth DSI Healthcare Facility Type ValueSet for ePA | 📦1.0.7 | TI Terminology v1.0
AuditEvent.agent:user.​who.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​who.identifier.type | Base | extensible | IdentifierType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:user.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:client.​type | Base | required | EPA AuditEvent Agent Type Client | 📦1.2.0 | This IG
AuditEvent.agent:client.​role | Base | example | SecurityRoleType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.type | Base | extensible | ResourceType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.use | Base | required | IdentifierUse | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​who.identifier.type | Base | extensible | Identifier Type DeBasis ValueSet | 📦1.5.4 | de.basisprofil.r4 v1.5
AuditEvent.agent:client.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:client.​purposeOfUse | Base | extensible | PurposeOfUse | 📦3.1.0 | THO v7.1
AuditEvent.agent:internal.​type | Base | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG
AuditEvent.agent:internal.​network.type | Base | required | AuditEventAgentNetworkType | 📍4.0.1 | FHIR Std.
AuditEvent.agent:internal.​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 | required | EPA AuditEvent Service Type | 📦1.2.0 | This IG

#### 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.agent:user.who.identifier.period, AuditEvent.agent:client.who.identifier.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.agent:user.who, AuditEvent.agent:user.who.identifier.assigner, AuditEvent.agent:client.who, AuditEvent.agent:client.who.identifier.assigner, AuditEvent.agent:internal.who, AuditEvent.source.observer | 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 AuditEvent

Summary

Mandatory: 4 elements(12 nested mandatory elements)
Must-Support: 58 elements
Fixed: 3 elements
Prohibited: 22 elements

Structures

This structure refers to these other structures:

- Identifier-Profil für die Telematik-ID (http://fhir.de/StructureDefinition/identifier-telematik-id)
- Identifier-Profil für die 10-stellige Krankenversichertennummer (http://fhir.de/StructureDefinition/identifier-kvid-10)

Extensions

This structure refers to these extensions:

- https://gematik.de/fhir/epa/StructureDefinition/epa-healthcare-facility-type-extension

Slices

This structure defines the following Slices:

- The element 1 is sliced based on the value of AuditEvent.agent
- The element 1 is sliced based on the value of AuditEvent.entity.detail.value[x]

Other representations of profile: CSV, Excel, Schematron