Render API: PDF Audit

Der Audit Event Service unterstützt die aufbereitete Generierung der Protokolle im Datenformat PDF/A (d.h. hier kein FHIR).

Voraussetzungen

Dem Patient Information Service MÜSSEN zur Auswertung in Operationen für jede Aktivität die folgenden Informationen bereitstehen:

  • Name des Nutzers
  • Nutzergruppe/Rolle ((profession-)oid)
  • Kennung (Telematik-ID)
  • Hinweis auf eine gültige Befugnis des aktuellen Benutzers (requestor)

HTTP Header-Parameter

Ein ePA-Client MUSS die folgenden HTTP Header bei einer Anfrage an den Patient Information Service setzen:

Name Anforderung Datentyp Beschreibung
x-insurantid MUSS String Health Record Identifier
x-useragent MUSS String User Agent Information
X-Request-ID MUSS String UUID der Nachricht

Wiederholungsintervalle

Die folgenden Wiederholungsintervalle werden im Falle einer Fehlerantwort definiert:

  • '409' Conflict (statusMismatch)
    • etwa 24 Stunden
  • '500' Internal Error
    • etwa 10 Minuten

Erlaubte Nutzergruppe

professionOID
oid_versicherter
oid_ombudsstelle

Interaktion (Render Audits)

GET [base]/epa/audit/render/v1/pdf

OperationId: renderAuditEventsToPDF_AuditEventSvc


Der Audit Event Service MUSS eine Liste von Audit-Ereignissen als PDF/A (signiert oder unsigniert) erstellen und bei diesem API GET Aufruf zurückgeben. Die Liste MUSS nach _lastUpdated sortiert sein.

Abfrageparameter

Parameter Bedeutung Standardwert Anforderung
signed Signierte PDF/A anfordern (true) oder unsignierte PDF/A anfordern (false) false MUSS
lowerDateTime Frühester Zeitpunkt zur Berücksichtigung der Audit-Ereignisse
z.B. 2025-07-15T00:00:00		 MUSS
upperDateTime Spätester Zeitpunkt zur Berücksichtigung der Audit-Ereignisse
z.B. 2025-07-15T23:59:59		 MUSS

Beispiel

Den Audit Event Service zur Bereitstellung eines signierten PDF/A anfragen

GET [base]/epa/audit/render/v1/pdf?signed=true

Den Audit Event Service zur Bereitstellung eines unsignierten PDF/A für die Protokolleinträge vom 15. Juli 2025 anfragen

GET [base]/epa/audit/render/v1/pdf?lowerDateTime=2025-07-15T00:00:00&upperDateTime=2025-07-15T23:59:59

Rückgabeformate

Den folgenden Media Type (d.h. Content-Type) MUSS der Audit Event Service für eine erfolgreiche Ausgabe setzen:

Ausgabeformat Media Type HTTP Code
PDF/A application/pdf 200

Antwort-Status-Codes

Status Code Bedingung Error Code Bemerkung
200 Successful operation
403 Requestor has no valid entitlement notEntitled
403 Requestor role is not in the list of allowed user groups invalidOid
404 Health record is in state UNKNOWN or INITIALIZED noHealthRecord (siehe 'Wiederholungsintervalle')
404 Rendering led to empty list noEntries
409 Health record is in state SUSPENDED statusMismatch (siehe 'Wiederholungsintervalle')
500 Any other error internalError (siehe 'Wiederholungsintervalle')

Error Codes MÜSSEN mit dem entsprechenden HTTP Status Code vom Audit Event Service mit dem Media Type application/json nach folgendem Schema zurückgegeben werden:

{
  "errorCode": "statusMismatch"
}