Implementation Guide
ePA Basisfunktionalitäten
Version 1.0.6 - release

Resource Profile: AuditEvent for the ePA

Official URL: https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent Version: 1.0.6
Active as of 2025-05-09 Computable Name: EPAAuditEvent

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.

Usage:

Formal Views of Profile Content

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

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... type Σ 1..1 Coding Type/identifier of event
Binding: EPA AuditEvent Type (required)
ele-1: All FHIR elements must have a @value or children
... recorded SΣ 1..1 instant Time when the event was recorded
ele-1: All FHIR elements must have a @value or children
... outcome SΣ 1..1 code success: 0; failure: 4; major failure: 12
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


ele-1: All FHIR elements must have a @value or children
... purposeOfEvent SΣ 0..* CodeableConcept The purposeOfUse of the event
Binding: EPA AuditEvent Purpose of Event (required)
ele-1: All FHIR elements must have a @value or children
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... requestor Σ 1..1 boolean Whether user is initiator
ele-1: All FHIR elements must have a @value or children
.... agent:user S 0..1 BackboneElement The agent user refers to the service provider (LE) or the service provider institution (LEI)
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Agent Type User (required)
ele-1: All FHIR elements must have a @value or children
..... role S 0..* CodeableConcept Professional role of the service provider
Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
ele-1: All FHIR elements must have a @value or children
...... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
....... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
....... display SΣ 0..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... who SΣ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
ele-1: All FHIR elements must have a @value or children
...... identifier SΣ 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
..... altId S 0..1 string Alternative User identity (e.g. Telematik-ID or the KVNR)
ele-1: All FHIR elements must have a @value or children
..... name S 1..1 string Name of HCP or Insurant
ele-1: All FHIR elements must have a @value or children
..... requestor Σ 1..1 boolean Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
ele-1: All FHIR elements must have a @value or children
.... agent:client S 0..1 BackboneElement The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Agent Type Client (required)
ele-1: All FHIR elements must have a @value or children
..... role S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


ele-1: All FHIR elements must have a @value or children
..... who SΣ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
ele-1: All FHIR elements must have a @value or children
...... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
..... altId S 0..1 string Alternative client identity (e.g. Telematik-ID))
ele-1: All FHIR elements must have a @value or children
..... name S 1..1 string Name e.g. eRezept, EU access/country name or DiGA
ele-1: All FHIR elements must have a @value or children
..... requestor Σ 1..1 boolean Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
ele-1: All FHIR elements must have a @value or children
.... 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
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Service Type (required)
ele-1: All FHIR elements must have a @value or children
..... altId S 0..1 string altId MUST be epa
ele-1: All FHIR elements must have a @value or children
Fixed Value: epa
..... name S 1..1 string Name MUST be ePA
ele-1: All FHIR elements must have a @value or children
Fixed Value: ePA
..... requestor Σ 1..1 boolean Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
ele-1: All FHIR elements must have a @value or children
... source S 1..1 BackboneElement Audit Event Reporter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
ele-1: All FHIR elements must have a @value or children
..... display Σ 0..1 string Text alternative for the resource
ele-1: All FHIR elements must have a @value or children
Fixed Value: Elektronische Patientenakte Fachdienst
.... type S 1..1 Coding The type of source where event originated
Binding: EPA AuditEvent Service Type (required)
ele-1: All FHIR elements must have a @value or children
... entity SC 1..* BackboneElement Data or objects used
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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, ...).
ele-1: All FHIR elements must have a @value or children
.... description S 0..1 string The OperationId
ele-1: All FHIR elements must have a @value or children
.... detail S 0..* BackboneElement Additional Information about the entity
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 string The Name of the property (e.g. Document Format, DocumentID, ...).
ele-1: All FHIR elements must have a @value or children
..... Slices for value[x] 1..1 string Property value
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueString S 1..1 string Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typerequiredEPAAuditEventTypeVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
from this IG
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventrequiredEPAAuditEventPurposeOfEventVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
from this IG
AuditEvent.agent:user.typerequiredEPAAuditEventAgentTypeUserVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
from this IG
AuditEvent.agent:user.rolerequiredEPAEHealthDSIHealthcareFacilityTypeVS
https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent:client.typerequiredEPAAuditEventAgentTypeClientVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
from this IG
AuditEvent.agent:client.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:internal.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
AuditEvent.source.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... action S 1..1 code Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E
... 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
... purposeOfEvent S 0..* CodeableConcept The purposeOfUse of the event
Binding: EPA AuditEvent Purpose of Event (required)
... 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 0..* Extension Extension
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)
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Agent Type User (required)
..... 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
..... 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
..... policy 0..0
..... media 0..0
..... network 0..0
.... 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)
..... 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
..... 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
..... policy 0..0
..... media 0..0
..... network 0..0
.... 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)
..... role 0..0
..... 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
..... policy 0..0
..... media 0..0
..... network 0..0
... 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)
... entity S 1..* BackboneElement Data or objects used
.... what 0..0
.... type 0..0
.... role 0..0
.... lifecycle 0..0
.... securityLabel 0..0
.... 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
.... 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.typerequiredEPAAuditEventTypeVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
from this IG
AuditEvent.purposeOfEventrequiredEPAAuditEventPurposeOfEventVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
from this IG
AuditEvent.agent:user.typerequiredEPAAuditEventAgentTypeUserVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
from this IG
AuditEvent.agent:user.rolerequiredEPAEHealthDSIHealthcareFacilityTypeVS
https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent:client.typerequiredEPAAuditEventAgentTypeClientVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
from this IG
AuditEvent.agent:internal.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
AuditEvent.source.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 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 SΣ 0..* CodeableConcept The purposeOfUse of the event
Binding: EPA AuditEvent Purpose of Event (required)
... 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
..... 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 Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

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

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


.... 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 Extension
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)
..... 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Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
...... 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 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
..... 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)
..... 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Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
...... 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
...... 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
..... 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)
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site 0..1 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
..... 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)
... entity SC 1..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
..... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AuditEvent.typerequiredEPAAuditEventTypeVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
from this IG
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventrequiredEPAAuditEventPurposeOfEventVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
from this IG
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:user.typerequiredEPAAuditEventAgentTypeUserVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
from this IG
AuditEvent.agent:user.rolerequiredEPAEHealthDSIHealthcareFacilityTypeVS
https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent:user.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.agent:user.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:client.typerequiredEPAAuditEventAgentTypeClientVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
from this IG
AuditEvent.agent:client.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:client.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.agent:client.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:client.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:internal.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
AuditEvent.agent:internal.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:internal.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.observer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.source.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources
dom-3: 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
dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
dom-5: If a resource is contained in another resource, it SHALL NOT have a security label
dom-6: A resource should have narrative for robust management
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
ele-1: All FHIR elements must have a @value or children
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
... type Σ 1..1 Coding Type/identifier of event
Binding: EPA AuditEvent Type (required)
ele-1: All FHIR elements must have a @value or children
... recorded SΣ 1..1 instant Time when the event was recorded
ele-1: All FHIR elements must have a @value or children
... outcome SΣ 1..1 code success: 0; failure: 4; major failure: 12
Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed.


ele-1: All FHIR elements must have a @value or children
... purposeOfEvent SΣ 0..* CodeableConcept The purposeOfUse of the event
Binding: EPA AuditEvent Purpose of Event (required)
ele-1: All FHIR elements must have a @value or children
... Slices for agent S 1..* BackboneElement Actor involved in the event
Slice: Unordered, Open by value:type
ele-1: All FHIR elements must have a @value or children
.... agent:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... requestor Σ 1..1 boolean Whether user is initiator
ele-1: All FHIR elements must have a @value or children
.... agent:user S 0..1 BackboneElement The agent user refers to the service provider (LE) or the service provider institution (LEI)
ele-1: All FHIR elements must have a @value or children
..... Slices for extension 0..* Extension Extension
Slice: Unordered, Open by value:url
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
...... 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)
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Agent Type User (required)
ele-1: All FHIR elements must have a @value or children
..... role S 0..* CodeableConcept Professional role of the service provider
Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required)
ele-1: All FHIR elements must have a @value or children
...... coding SΣ 0..* Coding Code defined by a terminology system
ele-1: All FHIR elements must have a @value or children
....... system SΣ 1..1 uri Identity of the terminology system
ele-1: All FHIR elements must have a @value or children
....... code SΣ 1..1 code Symbol in syntax defined by the system
ele-1: All FHIR elements must have a @value or children
....... display SΣ 0..1 string Representation defined by the system
ele-1: All FHIR elements must have a @value or children
..... who SΣ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
ele-1: All FHIR elements must have a @value or children
...... identifier SΣ 1..1 IdentifierTelematikId, IdentifierKvid10 Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
..... altId S 0..1 string Alternative User identity (e.g. Telematik-ID or the KVNR)
ele-1: All FHIR elements must have a @value or children
..... name S 1..1 string Name of HCP or Insurant
ele-1: All FHIR elements must have a @value or children
..... requestor Σ 1..1 boolean Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
ele-1: All FHIR elements must have a @value or children
.... agent:client S 0..1 BackboneElement The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Agent Type Client (required)
ele-1: All FHIR elements must have a @value or children
..... role S 0..* CodeableConcept Agent role in the event
Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event.


ele-1: All FHIR elements must have a @value or children
..... who SΣ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
ele-1: All FHIR elements must have a @value or children
...... identifier SΣ 1..1 IdentifierTelematikId Logical reference, when literal reference is not known
ele-1: All FHIR elements must have a @value or children
..... altId S 0..1 string Alternative client identity (e.g. Telematik-ID))
ele-1: All FHIR elements must have a @value or children
..... name S 1..1 string Name e.g. eRezept, EU access/country name or DiGA
ele-1: All FHIR elements must have a @value or children
..... requestor Σ 1..1 boolean Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
ele-1: All FHIR elements must have a @value or children
.... 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
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Service Type (required)
ele-1: All FHIR elements must have a @value or children
..... altId S 0..1 string altId MUST be epa
ele-1: All FHIR elements must have a @value or children
Fixed Value: epa
..... name S 1..1 string Name MUST be ePA
ele-1: All FHIR elements must have a @value or children
Fixed Value: ePA
..... requestor Σ 1..1 boolean Sollte auf true gesetzt sein, wenn dieser Agent das Ereignis initiiert hat
ele-1: All FHIR elements must have a @value or children
... source S 1..1 BackboneElement Audit Event Reporter
ele-1: All FHIR elements must have a @value or children
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
ele-1: All FHIR elements must have a @value or children
..... display Σ 0..1 string Text alternative for the resource
ele-1: All FHIR elements must have a @value or children
Fixed Value: Elektronische Patientenakte Fachdienst
.... type S 1..1 Coding The type of source where event originated
Binding: EPA AuditEvent Service Type (required)
ele-1: All FHIR elements must have a @value or children
... entity SC 1..* BackboneElement Data or objects used
ele-1: All FHIR elements must have a @value or children
sev-1: Either a name or a query (NOT both)
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
.... 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, ...).
ele-1: All FHIR elements must have a @value or children
.... description S 0..1 string The OperationId
ele-1: All FHIR elements must have a @value or children
.... detail S 0..* BackboneElement Additional Information about the entity
ele-1: All FHIR elements must have a @value or children
..... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
ele-1: All FHIR elements must have a @value or children
ext-1: Must have either extensions or value[x], not both
..... type S 1..1 string The Name of the property (e.g. Document Format, DocumentID, ...).
ele-1: All FHIR elements must have a @value or children
..... Slices for value[x] 1..1 string Property value
Slice: Unordered, Closed by type:$this
ele-1: All FHIR elements must have a @value or children
...... value[x]:valueString S 1..1 string Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0)
ele-1: All FHIR elements must have a @value or children

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.typerequiredEPAAuditEventTypeVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
from this IG
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventrequiredEPAAuditEventPurposeOfEventVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
from this IG
AuditEvent.agent:user.typerequiredEPAAuditEventAgentTypeUserVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
from this IG
AuditEvent.agent:user.rolerequiredEPAEHealthDSIHealthcareFacilityTypeVS
https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent:client.typerequiredEPAAuditEventAgentTypeClientVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
from this IG
AuditEvent.agent:client.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:internal.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
AuditEvent.source.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()

Differential View

This structure is derived from AuditEvent

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
... action S 1..1 code Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E
... 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
... purposeOfEvent S 0..* CodeableConcept The purposeOfUse of the event
Binding: EPA AuditEvent Purpose of Event (required)
... 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 0..* Extension Extension
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)
..... type S 1..1 CodeableConcept How agent participated
Binding: EPA AuditEvent Agent Type User (required)
..... 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
..... 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
..... policy 0..0
..... media 0..0
..... network 0..0
.... 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)
..... 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
..... 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
..... policy 0..0
..... media 0..0
..... network 0..0
.... 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)
..... role 0..0
..... 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
..... policy 0..0
..... media 0..0
..... network 0..0
... 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)
... entity S 1..* BackboneElement Data or objects used
.... what 0..0
.... type 0..0
.... role 0..0
.... lifecycle 0..0
.... securityLabel 0..0
.... 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
.... 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)

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
AuditEvent.typerequiredEPAAuditEventTypeVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
from this IG
AuditEvent.purposeOfEventrequiredEPAAuditEventPurposeOfEventVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
from this IG
AuditEvent.agent:user.typerequiredEPAAuditEventAgentTypeUserVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
from this IG
AuditEvent.agent:user.rolerequiredEPAEHealthDSIHealthcareFacilityTypeVS
https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent:client.typerequiredEPAAuditEventAgentTypeClientVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
from this IG
AuditEvent.agent:internal.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
AuditEvent.source.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. AuditEvent 0..* AuditEvent Event record kept for security purposes
... id Σ 0..1 id Logical id of this artifact
... meta Σ 0..1 Meta Metadata about the resource
... implicitRules ?!Σ 0..1 uri A set of rules under which this content was created
... text 0..1 Narrative Text summary of the resource, for human interpretation
... contained 0..* Resource Contained, inline Resources
... extension 0..* Extension Additional content defined by implementations
... modifierExtension ?! 0..* Extension Extensions that cannot be ignored
... type Σ 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 SΣ 0..* CodeableConcept The purposeOfUse of the event
Binding: EPA AuditEvent Purpose of Event (required)
... 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
..... 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 Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... altId 0..1 string Alternative User identity
..... name 0..1 string Human friendly name for the agent
..... requestor Σ 1..1 boolean Whether user is initiator
..... location 0..1 Reference(Location) Where
..... policy 0..* uri Policy that authorized event
..... media 0..1 Coding Type of media
Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media.

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

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


.... 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 Extension
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)
..... 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Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
...... 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 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
..... 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)
..... 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Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The subject Id of the IDToken
...... 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
...... 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
..... 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)
..... who Σ 0..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) Identifier of who
..... 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
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... site 0..1 string Logical source location within the enterprise
.... observer Σ 1..1 Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) The identity of source detecting the event
..... 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)
... entity SC 1..* BackboneElement Data or objects used
sev-1: Either a name or a query (NOT both)
.... id 0..1 string Unique id for inter-element referencing
.... extension 0..* Extension Additional content defined by implementations
.... modifierExtension ?!Σ 0..* Extension Extensions that cannot be ignored even if unrecognized
.... 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
..... 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)

doco Documentation for this format

Terminology Bindings

PathConformanceValueSetURI
AuditEvent.languagepreferredCommonLanguages
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
Additional Bindings Purpose
AllLanguages Max Binding
AuditEvent.typerequiredEPAAuditEventTypeVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs
from this IG
AuditEvent.actionrequiredAuditEventAction
http://hl7.org/fhir/ValueSet/audit-event-action|4.0.1
from the FHIR Standard
AuditEvent.outcomerequiredAuditEventOutcome
http://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1
from the FHIR Standard
AuditEvent.purposeOfEventrequiredEPAAuditEventPurposeOfEventVS
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs
from this IG
AuditEvent.agent.typeextensibleParticipationRoleType
http://hl7.org/fhir/ValueSet/participation-role-type
from the FHIR Standard
AuditEvent.agent.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent.mediaextensibleMediaTypeCode
http://hl7.org/fhir/ValueSet/dicm-405-mediatype
from the FHIR Standard
AuditEvent.agent.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:user.typerequiredEPAAuditEventAgentTypeUserVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs
from this IG
AuditEvent.agent:user.rolerequiredEPAEHealthDSIHealthcareFacilityTypeVS
https://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs
AuditEvent.agent:user.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.agent:user.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:user.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:client.typerequiredEPAAuditEventAgentTypeClientVS
https://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs
from this IG
AuditEvent.agent:client.roleexampleSecurityRoleType
http://hl7.org/fhir/ValueSet/security-role-type
from the FHIR Standard
AuditEvent.agent:client.who.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.agent:client.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:client.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.agent:internal.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG
AuditEvent.agent:internal.network.typerequiredAuditEventAgentNetworkType
http://hl7.org/fhir/ValueSet/network-type|4.0.1
from the FHIR Standard
AuditEvent.agent:internal.purposeOfUseextensiblePurposeOfUse
http://terminology.hl7.org/ValueSet/v3-PurposeOfUse
AuditEvent.source.observer.typeextensibleResourceType
http://hl7.org/fhir/ValueSet/resource-types
from the FHIR Standard
AuditEvent.source.typerequiredEPAAuditEventServiceTypeVS (a valid code from EPA AuditEvent Source Type)
https://gematik.de/fhir/epa/ValueSet/epa-auditevent-service-type-vs
from this IG

Constraints

IdGradePath(s)DetailsRequirements
dom-2errorAuditEventIf the resource is contained in another resource, it SHALL NOT contain nested Resources
: contained.contained.empty()
dom-3errorAuditEventIf the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource or SHALL refer to the containing resource
: contained.where((('#'+id in (%resource.descendants().reference | %resource.descendants().as(canonical) | %resource.descendants().as(uri) | %resource.descendants().as(url))) or descendants().where(reference = '#').exists() or descendants().where(as(canonical) = '#').exists() or descendants().where(as(canonical) = '#').exists()).not()).trace('unmatched', id).empty()
dom-4errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated
: contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()
dom-5errorAuditEventIf a resource is contained in another resource, it SHALL NOT have a security label
: contained.meta.security.empty()
dom-6best practiceAuditEventA resource should have narrative for robust management
: text.`div`.exists()
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
sev-1errorAuditEvent.entityEither a name or a query (NOT both)
: name.empty() or query.empty()

This structure is derived from AuditEvent

Summary

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

Structures

This structure refers to these other structures:

Extensions

This structure refers to these extensions:

Slices

This structure defines the following Slices:

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

 

Other representations of profile: CSV, Excel, Schematron