| Package | de.gematik.epa |
| Type | CapabilityStatement |
| Id | epa-audit-event-client |
| FHIR Version | R4 |
| Source | https://gematik.de/fhir/epa/https://simplifier.net/resolve?scope=de.gematik.epa@1.1.5&canonical=https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-client |
| URL | https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-client |
| Version | 1.1.5 |
| Status | active |
| Date | 2025-05-28 |
| Name | EPAAuditEventClient |
| Title | Capability Statement für Clients des ePA Audit Event Service |
| Realm | 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. |
| Kind | requirements |
No resources found
| CapabilityStatement | |
| epa-basic-client | EPA Basic Client |
| StructureDefinition | |
| epa-auditevent | EPA AuditEvent |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement epa-audit-event-client
FHIRapplication/fhir+json, application/fhir+xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
This CapabilityStatement imports the CapabilityStatement EPA Basic Client
clientThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| AuditEvent | https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent Additional supported profiles: EPA AuditEvent | y | y | _id, _lastUpdated, action, altid, date, outcome, entity-name, agent-name, type |
search-type, read.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| MAY | _id | token | Resource.id |
| MAY | _lastUpdated | date | Resource.meta.lastUpdated |
| MAY | action | token | AuditEvent.action |
| MAY | altid | token | AuditEvent.agent.altId |
| MAY | date | date | AuditEvent.recorded |
| MAY | outcome | token | AuditEvent.outcome |
| MAY | entity-name | string | AuditEvent.entity.name |
| MAY | agent-name | string | AuditEvent.agent.name |
| MAY | type | token | AuditEvent.type |
{
"resourceType": "CapabilityStatement",
"id": "epa-audit-event-client",
"meta": {
"profile": [
"https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"
]
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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}[%content%]quot;
},
{
"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}[%content%]quot;
},
{
"url": "required",
"valueBoolean": true
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "403"
},
{
"url": "description",
"valueString": "Request does not match schema"
},
{
"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"
},
{
"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": "Health record is in state SUSPENDED"
},
{
"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.1.5",
"name": "EPAAuditEventClient",
"title": "Capability Statement für Clients des ePA Audit Event Service",
"status": "active",
"date": "2025-05-28",
"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"
}
]
}
],
"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",
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "AuditEvent",
"profile": "https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent",
"_profile": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
"supportedProfile": [
"https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent"
],
"_supportedProfile": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "200"
},
{
"url": "description",
"valueString": "Successful operation"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "400"
},
{
"url": "description",
"valueString": "Unknown search parameter"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_PARAM_UNKNOWN"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "400"
},
{
"url": "description",
"valueString": "Invalid query parameter(s)"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_BAD_SYNTAX"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "400"
},
{
"url": "description",
"valueString": "Invalid request"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_BAD_FORMAT"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "404"
},
{
"url": "description",
"valueString": "Unknown resource type"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_UNKNOWN_TYPE"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "200"
},
{
"url": "description",
"valueString": "Successful operation"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "400"
},
{
"url": "description",
"valueString": "Invalid request"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_BAD_FORMAT"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "404"
},
{
"url": "description",
"valueString": "Unknown resource type"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_UNKNOWN_TYPE"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
},
{
"extension": [
{
"url": "statusCode",
"valueString": "404"
},
{
"url": "description",
"valueString": "Resource is not known"
},
{
"url": "responseType",
"valueString": "TIOperationOutcome"
},
{
"url": "errorCode",
"valueString": "MSG_RESOURCE_ID_FAIL"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
}
],
"code": "read"
}
],
"searchParam": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Resource.id"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "Resource.meta.lastUpdated"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "action",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-action",
"type": "token",
"documentation": "AuditEvent.action"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "altid",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-altid",
"type": "token",
"documentation": "AuditEvent.agent.altId"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-date",
"type": "date",
"documentation": "AuditEvent.recorded"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "outcome",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-outcome",
"type": "token",
"documentation": "AuditEvent.outcome"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "entity-name",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-entity-name",
"type": "string",
"documentation": "AuditEvent.entity.name"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "agent-name",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name",
"type": "string",
"documentation": "AuditEvent.agent.name"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/AuditEvent-type",
"type": "token",
"documentation": "AuditEvent.type"
}
]
}
]
}
]
}