Official URL: https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent | Version: 1.0.5-ballot.1 | |||
Draft as of 2025-02-14 | 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:
Description of Profiles, Differentials, Snapshots and how the different presentations work.
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated 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-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored 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 |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | instant | Time when the event was recorded ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣC | 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of HCP or Insurant ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children Fixed Value: true |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
SΣC | 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative client identity (e.g. Telematik-ID)) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children Fixed Value: true |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Source Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | altId MUST be epa ele-1: All FHIR elements must have a @value or children Fixed Value: epa |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name MUST be ePA ele-1: All FHIR elements must have a @value or children Fixed Value: ePA |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children Fixed Value: true |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Audit Event Reporter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
ΣC | 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children Fixed Value: Elektronische Patientenakte Fachdienst |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Source Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The OperationId ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional Information about the entity ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Property value Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet | URI |
AuditEvent.type | required | EPAAuditEventTypeVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs from this IG | |
AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard | |
AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard | |
AuditEvent.purposeOfEvent | required | EPAAuditEventPurposeOfEventVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs from this IG | |
AuditEvent.agent:user.type | required | EPAAuditEventAgentTypeUserVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs from this IG | |
AuditEvent.agent:user.role | required | EPAEHealthDSIHealthcareFacilityTypeVShttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs | |
AuditEvent.agent:client.type | required | EPAAuditEventAgentTypeClientVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs from this IG | |
AuditEvent.agent:client.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
AuditEvent.agent:internal.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG | |
AuditEvent.source.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
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** elements | 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() ![]() |
1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required) | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | instant | Time when the event was recorded |
![]() ![]() ![]() |
S | 1..1 | code | success: 0; failure: 4; major failure: 12 |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | The purposeOfUse of the event Binding: EPA AuditEvent Purpose of Event (required) |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI) |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of HCP or Insurant |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Agent role in the event |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative client identity (e.g. Telematik-ID)) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Source Type (required) |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | altId MUST be epa Fixed Value: epa |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name MUST be ePA Fixed Value: ePA |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Audit Event Reporter |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Source Type (required) |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Data or objects used |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...). |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The OperationId |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional Information about the entity |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...). |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Property value Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0) |
![]() |
Path | Conformance | ValueSet | URI |
AuditEvent.type | required | EPAAuditEventTypeVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs from this IG | |
AuditEvent.purposeOfEvent | required | EPAAuditEventPurposeOfEventVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs from this IG | |
AuditEvent.agent:user.type | required | EPAAuditEventAgentTypeUserVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs from this IG | |
AuditEvent.agent:user.role | required | EPAEHealthDSIHealthcareFacilityTypeVShttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs | |
AuditEvent.agent:client.type | required | EPAAuditEventAgentTypeClientVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs from this IG | |
AuditEvent.agent:internal.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG | |
AuditEvent.source.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG |
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AuditEvent | Event record kept for security purposes | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required) | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | Time when the event was recorded | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | success: 0; failure: 4; major failure: 12 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: EPA AuditEvent Purpose of Event (required) | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Alternative User identity | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Human friendly name for the agent | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Location) | Where ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | uri | Policy that authorized event | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Logical network location for application activity | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Identifier for the network access point of the user device | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of HCP or Insurant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator Fixed Value: true | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative client identity (e.g. Telematik-ID)) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator Fixed Value: true | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Source Type (required) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | altId MUST be epa Fixed Value: epa | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name MUST be ePA Fixed Value: ePA | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator Fixed Value: true | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Audit Event Reporter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Logical source location within the enterprise | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Source Type (required) | ||||
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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, ...). | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | The OperationId | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional Information about the entity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...). | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Property value Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0) | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
AuditEvent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
AuditEvent.type | required | EPAAuditEventTypeVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs from this IG | ||||
AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard | ||||
AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard | ||||
AuditEvent.purposeOfEvent | required | EPAAuditEventPurposeOfEventVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs from this IG | ||||
AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:user.type | required | EPAAuditEventAgentTypeUserVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs from this IG | ||||
AuditEvent.agent:user.role | required | EPAEHealthDSIHealthcareFacilityTypeVShttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs | ||||
AuditEvent.agent:user.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:client.type | required | EPAAuditEventAgentTypeClientVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs from this IG | ||||
AuditEvent.agent:client.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent:client.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:internal.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG | ||||
AuditEvent.agent:internal.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:internal.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.source.observer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.source.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
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** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ref-1 | error | AuditEvent.agent.who, AuditEvent.agent.location, AuditEvent.agent:user.who, AuditEvent.agent:client.who, 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: 36 elements
Fixed: 6 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:
Key Elements View
Name | Flags | Card. | Type | Description & Constraints![]() |
---|---|---|---|---|
![]() ![]() |
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-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated 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-6: A resource should have narrative for robust management dom-5: If a resource is contained in another resource, it SHALL NOT have a security label | |
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored 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 |
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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. ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
SΣ | 1..1 | instant | Time when the event was recorded ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
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 |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
SΣC | 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of HCP or Insurant ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children Fixed Value: true |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
SΣC | 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative client identity (e.g. Telematik-ID)) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children Fixed Value: true |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Source Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | altId MUST be epa ele-1: All FHIR elements must have a @value or children Fixed Value: epa |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name MUST be ePA ele-1: All FHIR elements must have a @value or children Fixed Value: ePA |
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator ele-1: All FHIR elements must have a @value or children Fixed Value: true |
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Audit Event Reporter ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
ΣC | 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 ref-1: SHALL have a contained resource if a local reference is provided |
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource ele-1: All FHIR elements must have a @value or children Fixed Value: Elektronische Patientenakte Fachdienst |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Source Type (required) ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The OperationId ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional Information about the entity ele-1: All FHIR elements must have a @value or children |
![]() ![]() ![]() ![]() ![]() |
?!Σ | 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 |
![]() ![]() ![]() ![]() ![]() |
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 |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Property value Slice: Unordered, Closed by type:$this ele-1: All FHIR elements must have a @value or children | |
![]() ![]() ![]() ![]() ![]() ![]() |
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 |
![]() |
Path | Conformance | ValueSet | URI |
AuditEvent.type | required | EPAAuditEventTypeVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs from this IG | |
AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard | |
AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard | |
AuditEvent.purposeOfEvent | required | EPAAuditEventPurposeOfEventVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs from this IG | |
AuditEvent.agent:user.type | required | EPAAuditEventAgentTypeUserVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs from this IG | |
AuditEvent.agent:user.role | required | EPAEHealthDSIHealthcareFacilityTypeVShttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs | |
AuditEvent.agent:client.type | required | EPAAuditEventAgentTypeClientVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs from this IG | |
AuditEvent.agent:client.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | |
AuditEvent.agent:internal.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG | |
AuditEvent.source.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
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** elements | 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![]() |
---|---|---|---|---|
![]() ![]() |
0..* | AuditEvent | Event record kept for security purposes | |
![]() ![]() ![]() |
1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required) | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | code | Type of action performed during the event. CREATE: C | READ: R | UPDATE: U | DELETE: D | EXECUTE: E |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | instant | Time when the event was recorded |
![]() ![]() ![]() |
S | 1..1 | code | success: 0; failure: 4; major failure: 12 |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 0..* | CodeableConcept | The purposeOfUse of the event Binding: EPA AuditEvent Purpose of Event (required) |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type |
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI) |
![]() ![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||
![]() ![]() ![]() ![]() ![]() ![]() |
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) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required) |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..* | Coding | Code defined by a terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | uri | Identity of the terminology system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | code | Symbol in syntax defined by the system |
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Representation defined by the system |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of HCP or Insurant |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required) |
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Agent role in the event |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known |
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative client identity (e.g. Telematik-ID)) |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Source Type (required) |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | altId MUST be epa Fixed Value: epa |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name MUST be ePA Fixed Value: ePA |
![]() ![]() ![]() ![]() ![]() |
1..1 | boolean | Whether user is initiator Fixed Value: true | |
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Audit Event Reporter |
![]() ![]() ![]() ![]() |
||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst | |
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Source Type (required) |
![]() ![]() ![]() |
S | 1..* | BackboneElement | Data or objects used |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..1 | string | The title of the XDS document, FHIR resource or object name of a service (e.g. Entitlement Service, Device Management, ...). |
![]() ![]() ![]() ![]() |
S | 0..1 | string | The OperationId |
![]() ![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional Information about the entity |
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...). |
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Property value Slice: Unordered, Open by type:$this | |
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0) |
![]() |
Path | Conformance | ValueSet | URI |
AuditEvent.type | required | EPAAuditEventTypeVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs from this IG | |
AuditEvent.purposeOfEvent | required | EPAAuditEventPurposeOfEventVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs from this IG | |
AuditEvent.agent:user.type | required | EPAAuditEventAgentTypeUserVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs from this IG | |
AuditEvent.agent:user.role | required | EPAEHealthDSIHealthcareFacilityTypeVShttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs | |
AuditEvent.agent:client.type | required | EPAAuditEventAgentTypeClientVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs from this IG | |
AuditEvent.agent:internal.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG | |
AuditEvent.source.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints![]() | ||||
---|---|---|---|---|---|---|---|---|
![]() ![]() |
0..* | AuditEvent | Event record kept for security purposes | |||||
![]() ![]() ![]() |
Σ | 0..1 | id | Logical id of this artifact | ||||
![]() ![]() ![]() |
Σ | 0..1 | Meta | Metadata about the resource | ||||
![]() ![]() ![]() |
?!Σ | 0..1 | uri | A set of rules under which this content was created | ||||
![]() ![]() ![]() |
0..1 | code | Language of the resource content Binding: CommonLanguages (preferred): A human language.
| |||||
![]() ![]() ![]() |
0..1 | Narrative | Text summary of the resource, for human interpretation | |||||
![]() ![]() ![]() |
0..* | Resource | Contained, inline Resources | |||||
![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
?!N | 0..* | Extension | Extensions that cannot be ignored Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() |
Σ | 1..1 | Coding | Type/identifier of event Binding: EPA AuditEvent Type (required) | ||||
![]() ![]() ![]() |
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. | ||||
![]() ![]() ![]() |
SΣ | 1..1 | instant | Time when the event was recorded | ||||
![]() ![]() ![]() |
SΣ | 1..1 | code | success: 0; failure: 4; major failure: 12 Binding: AuditEventOutcome (required): Indicates whether the event succeeded or failed. | ||||
![]() ![]() ![]() |
SΣ | 0..* | CodeableConcept | The purposeOfUse of the event Binding: EPA AuditEvent Purpose of Event (required) | ||||
![]() ![]() ![]() |
S | 1..* | BackboneElement | Actor involved in the event Slice: Unordered, Open by pattern:type | ||||
![]() ![]() ![]() ![]() |
Content/Rules for all slices | |||||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | CodeableConcept | How agent participated Binding: ParticipationRoleType (extensible): The Participation type of the agent to the event. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | |||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Alternative User identity | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Human friendly name for the agent | |||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator | ||||
![]() ![]() ![]() ![]() ![]() |
C | 0..1 | Reference(Location) | Where ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | uri | Policy that authorized event | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | Coding | Type of media Binding: MediaTypeCode (extensible): Used when the event is about exporting/importing onto media. | |||||
![]() ![]() ![]() ![]() ![]() |
0..1 | BackboneElement | Logical network location for application activity | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Identifier for the network access point of the user device | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
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. | |||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent user refers to the service provider (LE) or the service provider institution (LEI) | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
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) | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type User (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Professional role of the service provider Binding: EHealth DSI Healthcare Facility Type ValueSet for ePA (required) | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..* | Coding | Code defined by a terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | uri | Identity of the terminology system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Version of the system - if relevant | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | code | Symbol in syntax defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 0..1 | string | Representation defined by the system | ||||
![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | boolean | If this coding was chosen directly by the user | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Plain text representation of the concept | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId, IdentifierKvid10 | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative User identity (e.g. Telematik-ID or the KVNR) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name of HCP or Insurant | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator Fixed Value: true | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent client refers to a software system that has executed the action, for example, E-Rezept Fachdienst | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Agent Type Client (required) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..* | CodeableConcept | Agent role in the event Binding: SecurityRoleType (example): What security role enabled the agent to participate in the event. | ||||
![]() ![]() ![]() ![]() ![]() |
SΣC | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The subject Id of the IDToken ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
SΣ | 1..1 | IdentifierTelematikId | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | Alternative client identity (e.g. Telematik-ID)) | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name e.g. eRezept, EU access/country name or DiGA | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator Fixed Value: true | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() ![]() |
S | 0..1 | BackboneElement | The agent internal refers to internal actions of the Elektronische Patientenakte Fachdienst (ePA) service, such as data export submissions | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | CodeableConcept | How agent participated Binding: EPA AuditEvent Source Type (required) | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | Identifier of who ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
S | 0..1 | string | altId MUST be epa Fixed Value: epa | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Name MUST be ePA Fixed Value: ePA | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 1..1 | boolean | Whether user is initiator Fixed Value: true | ||||
![]() ![]() ![]() ![]() ![]() |
0..* | CodeableConcept | Reason given for this user Binding: PurposeOfUse (extensible): The reason the activity took place. | |||||
![]() ![]() ![]() |
S | 1..1 | BackboneElement | Audit Event Reporter | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Logical source location within the enterprise | |||||
![]() ![]() ![]() ![]() |
ΣC | 1..1 | Reference(PractitionerRole | Practitioner | Organization | Device | Patient | RelatedPerson) | The identity of source detecting the event ref-1: SHALL have a contained resource if a local reference is provided | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
ΣC | 0..1 | string | Literal reference, Relative, internal or absolute URL | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 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). | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | Identifier | Logical reference, when literal reference is not known | ||||
![]() ![]() ![]() ![]() ![]() |
Σ | 0..1 | string | Text alternative for the resource Fixed Value: Elektronische Patientenakte Fachdienst | ||||
![]() ![]() ![]() ![]() |
S | 1..1 | Coding | The type of source where event originated Binding: EPA AuditEvent Source Type (required) | ||||
![]() ![]() ![]() |
SC | 1..* | BackboneElement | Data or objects used sev-1: Either a name or a query (NOT both) | ||||
![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() |
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, ...). | ||||
![]() ![]() ![]() ![]() |
S | 0..1 | string | The OperationId | ||||
![]() ![]() ![]() ![]() |
S | 0..* | BackboneElement | Additional Information about the entity | ||||
![]() ![]() ![]() ![]() ![]() |
0..1 | string | Unique id for inter-element referencing | |||||
![]() ![]() ![]() ![]() ![]() |
N | 0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | ||||
![]() ![]() ![]() ![]() ![]() |
?!Σ | 0..* | Extension | Extensions that cannot be ignored even if unrecognized | ||||
![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | The Name of the property (e.g. Document Format, DocumentID, ...). | ||||
![]() ![]() ![]() ![]() ![]() |
1..1 | string | Property value Slice: Unordered, Closed by type:$this | |||||
![]() ![]() ![]() ![]() ![]() ![]() |
S | 1..1 | string | Property value (e.g. urn:gematik:ig:Zahnbonusheft:v1.1.0) | ||||
![]() |
Path | Conformance | ValueSet | URI | |||
AuditEvent.language | preferred | CommonLanguageshttp://hl7.org/fhir/ValueSet/languages from the FHIR Standard
| ||||
AuditEvent.type | required | EPAAuditEventTypeVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-type-vs from this IG | ||||
AuditEvent.action | required | AuditEventActionhttp://hl7.org/fhir/ValueSet/audit-event-action|4.0.1 from the FHIR Standard | ||||
AuditEvent.outcome | required | AuditEventOutcomehttp://hl7.org/fhir/ValueSet/audit-event-outcome|4.0.1 from the FHIR Standard | ||||
AuditEvent.purposeOfEvent | required | EPAAuditEventPurposeOfEventVShttps://gematik.de/fhir/epa/ValueSet/epa-auditevent-purpose-of-event-vs from this IG | ||||
AuditEvent.agent.type | extensible | ParticipationRoleTypehttp://hl7.org/fhir/ValueSet/participation-role-type from the FHIR Standard | ||||
AuditEvent.agent.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent.media | extensible | MediaTypeCodehttp://hl7.org/fhir/ValueSet/dicm-405-mediatype from the FHIR Standard | ||||
AuditEvent.agent.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:user.type | required | EPAAuditEventAgentTypeUserVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-user-vs from this IG | ||||
AuditEvent.agent:user.role | required | EPAEHealthDSIHealthcareFacilityTypeVShttps://gematik.de/fhir/terminology/ValueSet/epa-ehealth-dsi-healthcare-facility-type-vs | ||||
AuditEvent.agent:user.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.agent:user.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:user.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:client.type | required | EPAAuditEventAgentTypeClientVShttps://gematik.de/fhir/epa/ValueSet/epa-audit-event-agent-type-client-vs from this IG | ||||
AuditEvent.agent:client.role | example | SecurityRoleTypehttp://hl7.org/fhir/ValueSet/security-role-type from the FHIR Standard | ||||
AuditEvent.agent:client.who.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.agent:client.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:client.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.agent:internal.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG | ||||
AuditEvent.agent:internal.network.type | required | AuditEventAgentNetworkTypehttp://hl7.org/fhir/ValueSet/network-type|4.0.1 from the FHIR Standard | ||||
AuditEvent.agent:internal.purposeOfUse | extensible | PurposeOfUsehttp://terminology.hl7.org/ValueSet/v3-PurposeOfUse | ||||
AuditEvent.source.observer.type | extensible | ResourceTypehttp://hl7.org/fhir/ValueSet/resource-types from the FHIR Standard | ||||
AuditEvent.source.type | required | EPAAuditEventSourceTypeVS (a valid code from EPA AuditEvent Source Type)https://gematik.de/fhir/epa/ValueSet/epa-auditevent-sourcetype-vs from this IG |
Id | Grade | Path(s) | Details | Requirements |
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** elements | Must have either extensions or value[x], not both : extension.exists() != value.exists() | |
ref-1 | error | AuditEvent.agent.who, AuditEvent.agent.location, AuditEvent.agent:user.who, AuditEvent.agent:client.who, 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: 36 elements
Fixed: 6 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:
Other representations of profile: CSV, Excel, Schematron