FHIR © HL7.org  |  FHIRsmith 0.18.0  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagede.gematik.epa
Resource TypeCapabilityStatement
IdCapabilityStatement-epa-audit-event-client.json
FHIR VersionR4
Sourcehttps://gematik.de/fhir/epa/1.4.0-ballot.1/CapabilityStatement-epa-audit-event-client.html
URLhttps://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-client
Version1.4.0
Statusactive
Date2026-12-08
NameEPAAuditEventClient
TitleCapability Statement für Clients des ePA Audit Event Service
Realmde
DescriptionDieses Capability Statement legt die Anforderungen an ePA Clients fest, die den Audit Event Service der verwenden. Es definiert die unterstützten Interaktionen, erforderliche HTTP Header sowie erwartete Statuscodes.
Copyrightgematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0.
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

CapabilityStatement
de.gematik.epa#1.4.0-ballot.1epa-basic-clientEPA Basic Client

Narrative

No narrative content found in resource


Source1

{
  "resourceType": "CapabilityStatement",
  "id": "epa-audit-event-client",
  "meta": {
    "profile": [
      "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"
    ]
  },
  "extension": [
    {
      "extension": [
        {
          "url": "name",
          "valueString": "X-Request-ID"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "UUID of the request message"
        },
        {
          "url": "format",
          "valueString": "uuid"
        },
        {
          "url": "required",
          "valueBoolean": false
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "name",
          "valueString": "x-insurantid"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "Health Record Identifier"
        },
        {
          "url": "pattern",
          "valueString": "^[A-Z]{1}\\d{9}$"
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "name",
          "valueString": "x-useragent"
        },
        {
          "url": "type",
          "valueString": "string"
        },
        {
          "url": "description",
          "valueString": "user agent information"
        },
        {
          "url": "pattern",
          "valueString": "^[a-zA-Z0-9]{20}\\/[a-zA-Z0-9\\-\\.]{1,15}$"
        },
        {
          "url": "required",
          "valueBoolean": true
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Requestor not authorized (no user session with valid ID-Token available)"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "invalAuth"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Requestor has no valid entitlement"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "notEntitled"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Requestor role is not in the list of allowed user groups"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "invalidOid"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "403"
        },
        {
          "url": "description",
          "valueString": "Device registration does not exist (if requestor role is oid_versicherter only)"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "unregisteredDevice"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "404"
        },
        {
          "url": "description",
          "valueString": "Health record is in state UNKNOWN or INITIALIZED"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "noHealthRecord"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "409"
        },
        {
          "url": "description",
          "valueString": "Request conflicts with the current state of the health record"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "statusMismatch"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "extension": [
        {
          "url": "statusCode",
          "valueString": "500"
        },
        {
          "url": "description",
          "valueString": "Any other error"
        },
        {
          "url": "responseType",
          "valueString": "application/json"
        },
        {
          "url": "errorCode",
          "valueString": "internalError"
        }
      ],
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
    },
    {
      "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-base-url",
      "valueString": "http://epa4all/epa/audit/api/v1/fhir"
    }
  ],
  "url": "https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-client",
  "version": "1.4.0",
  "name": "EPAAuditEventClient",
  "title": "Capability Statement für Clients des ePA Audit Event Service",
  "status": "active",
  "date": "2026-12-08",
  "publisher": "gematik GmbH",
  "contact": [
    {
      "telecom": [
        {
          "system": "url",
          "value": "https://www.gematik.de"
        }
      ]
    }
  ],
  "description": "Dieses Capability Statement legt die Anforderungen an ePA Clients fest, die den Audit Event Service der verwenden. Es definiert die unterstützten Interaktionen, erforderliche HTTP Header sowie erwartete Statuscodes.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "DE"
        }
      ]
    }
  ],
  "copyright": "gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0.",
  "kind": "requirements",
  "imports": [
    "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client"
  ],
  "_imports": [
    {
      "extension": [
        {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }
      ]
    }
  ],
  "fhirVersion": "4.0.1",
  "format": [
    "application/fhir+json",
    "application/fhir+xml"
  ],
  "rest": [
    {
      "mode": "client"
    }
  ]
}