Query API: AuditEvent

Implementation Guide
ePA Basisfunktionalitäten

Version 1.0.5 - release

Seiteninhalt:

Einsatzbereich
Nachricht
Sicherheitsanforderungen
Protokollierung

Die Query API: AuditEvent ermöglicht den Abruf protokollierter Ereignisse und Zugriffe auf die ePA eines Versicherten im ePA-Aktensystem.

Einsatzbereich

Das ePA-FdV oder das Primärsystem einer Ombudsstelle nehmen Einsicht in die Protokolldaten zum Zwecke der Datenschutzkontrolle für den Akteninhaber.

Nachricht

Die Nachricht zum Abruf von Protkolldaten wird als HTTP GET-Anfrage an den Audit Event Service gesendet, um eine Liste von Audit-Ereignislisten abzurufen.

Auslösung

Wenn das ePA-Client-System eine Suche über protokollierter Ereignisse und ePA-Zugriffe durchführen und dazu die korrespondierenden AuditEvent-Ressourcen ermitteln möchte, sendet es eine Query API: AuditEvent-Nachricht an den Audit Event Service.

Resource API

Anfragen an die AuditEvent-Ressource werden über die RESTful API mittels HTTP GET-Anfragen durchgeführt werden. Dabei können spezifische Suchparameter genutzt werden, um die Anfragen zu verfeinern.

Bei Anfragen an die Query API für die AuditEvent-Ressource wird die Antwort als ein FHIR Bundle des Typs searchset zurückgegeben. Dieses Bundle enthält eine Sammlung von Einträgen, die jeweils eine Instanz der AuditEvent-Ressource enthalten.

base: "[base]"
    paths:
      /epa/audit/api/v1/fhir/AuditEvent:
        get:
          include:
          - "#DefaultApi"
          operationId: "listAuditEvents_AuditEventSvc"
          fhir:
            capabilityStatement:
              url: "CapabilityStatement-epa-audit-event-server.json"
              forResourceType: "AuditEvent"
          responseExamples:
            - name: "application/fhir+json"
              type: JSON
              url: './Bundle-example-searchset-audit-event.json'
          responses:
            - statusCode: '200'
              description: "Successful operation"
              errorCode: "-"
              note: "-"
            - statusCode: '400'
              description: "Unknown search parameter"
              errorCode: "-"
              note: "EPAOperationOutcome"
            - statusCode: '400'
              description: "Invalid query parameter(s)"
              errorCode: "-"
              note: "EPAOperationOutcome"
            - statusCode: '400'
              description: "Invalid request"
              errorCode: "-"
              note: "EPAOperationOutcome"
            - statusCode: '404'
              description: "Unknown resource type"
              errorCode: "-"
              note: "EPAOperationOutcome"

GET

[base]/epa/audit/api/v1/fhir/AuditEvent

OperationId: listAuditEvents_AuditEventSvc

Content Types: application/fhir+xml, application/fhir+json

HTTP Header-Parameter

Parameter	Type	Beschreibung	Service Anforderung
x-insurantid	`string`	Health Record Identifier	MUSS
x-useragent	`string`	User Agent Information	KANN
X-Request-ID	`string`	UUID der Nachricht	MUSS

Beispielantworten

Antwort Status-Codes

Code	Beschreibung	Error Code	Beschreibung
`200`	Successful operation	-	-
`400`	Unknown search parameter	-	EPAOperationOutcome
`400`	Invalid query parameter(s)	-	EPAOperationOutcome
`400`	Invalid request	-	EPAOperationOutcome
`404`	Unknown resource type	-	EPAOperationOutcome

IG-EPA04413PXH - Unterstützung definierter Suchparameter - MUSS

Der Audit Event Service MUSS die Suchparameter, die in dem CapabilityStatement mit dem Namen EPAAuditEventServer verarbeiten können. EPA-Audit-Service [<=]

IG-EPA20251N8N - Standardsortierung des Suchergebnisses - MUSS

Die Standardsortierung des Audit Event Service MUSS anhand des Attributs _lastUpdated erfolgen. EPA-Audit-Service [<=]

Instance API

Um spezifische Details zu einem einzelnen Audit Event mittels der RESTful API zu erhalten, wird die AuditEvent Instance API verwendet, indem eine HTTP GET-Anfrage an den Endpunkt /AuditEvent/[id] gestellt wird.

GET

[base]/epa/audit/api/v1/fhir/AuditEvent/[id]

OperationId: getAuditEventById_AuditEventSvc

Content Types: application/fhir+xml, application/fhir+json

HTTP Header-Parameter

Parameter	Type	Beschreibung	Service Anforderung
x-insurantid	`string`	Health Record Identifier	MUSS
x-useragent	`string`	User Agent Information	KANN
X-Request-ID	`string`	UUID der Nachricht	MUSS

Antwort Status-Codes

Code	Beschreibung	Error Code	Beschreibung
`200`	Successful operation	-	-
`400`	Invalid request	malformedRequest	-
`400`	Invalid request	-	EPAOperationOutcome
`404`	Unknown resource type	-	EPAOperationOutcome
`404`	Resource is not known	-	EPAOperationOutcome

Verarbeitung

Der Audit Event Service verarbeitet die Anfrage, um die AuditEvent-Einträge zu ermitteln, die den angegebenen Suchparametern entsprechen. Darüber hinaus gibt er einen zur Verarbeitung passenden HTTP Status Code sowie ein FHIR Bundle der passenden AuditEvent-Ressourcen zurück.

Sicherheitsanforderungen

Generelle Sicherheitsanforderungen werden hier festgehalten.

Protokollierung

Die Protokollierung erfolgt über den Audit Event Service. Weitere Anforderungen sind [gemSpec_Aktensystem_ePAfueralle#Protokollierung] zu entnehmen.

IG © 2025+ gematik GmbH. Package de.gematik.epa#1.0.5 based on FHIR 4.0.1. Generated 2025-03-03
Links: Table of Contents | QA Report