Implementation Guide
ePA Basisfunktionalitäten
Version 1.0.6-2 - release

## : Capability Statement für Clients des ePA Audit Event Service - JSON Representation

Active as of 2025-05-12

Raw json | Download

    {
      "resourceType" : "CapabilityStatement",
      "id" : "epa-audit-event-client",
      "meta" : {
        "profile" : [
          🔗 "https://gematik.de/fhir/epa/StructureDefinition/epa-capability-statement"
        ]
      },
      "text" : {
        "status" : "extensions",
        "div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement epa-audit-event-client</b></p><a name=\"epa-audit-event-client\"> </a><a name=\"hcepa-audit-event-client\"> </a><a name=\"epa-audit-event-client-de-DE\"> </a><div style=\"display: inline-block; background-color: #d9e0e7; padding: 6px; margin: 4px; border: 1px solid #8da1b4; border-radius: 5px; line-height: 60%\"><p style=\"margin-bottom: 0px\"/><p style=\"margin-bottom: 0px\">Profile: <a href=\"StructureDefinition-epa-capability-statement.html\">Capability Statement Profil für ePA FHIR Data Service</a></p></div><h2 id=\"title\">Capability Statement für Clients des ePA Audit Event Service</h2><ul><li>Implementation Guide Version: 1.0.6-2 </li><li>FHIR Version: 4.0.1 </li><li>Supported Formats: <code>application/fhir+json</code></li><li>Supported Patch Formats: </li><li>Published on: 2025-05-12 </li><li>Published by: gematik GmbH </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>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.</p></blockquote><p>This CapabilityStatement imports the CapabilityStatement <a href=\"CapabilityStatement-epa-basic-client.html\">EPA Basic Client</a></p><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>client</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#AuditEvent1-1\">AuditEvent</a></td><td><a href=\"StructureDefinition-epa-auditevent.html\">https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent</a><br/><em>Additional supported profiles:</em><br/>\u00a0\u00a0<a href=\"StructureDefinition-epa-auditevent.html\">AuditEvent for the ePA</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\"></td><td class=\"text-center\"></td><td>_id, _lastUpdated, action, altid, date, outcome, entity-name, agent-name, type</td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"AuditEvent1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>AuditEvent</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-epa-auditevent.html\">AuditEvent for the ePA</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-6\"><span class=\"lead\">Supported Profiles</span><p><a href=\"StructureDefinition-epa-auditevent.html\">AuditEvent for the ePA</a></p></div><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <code>search-type</code>, <code>read</code>.</li></ul></div></div><p/><div class=\"row\"><div class=\"col-lg-7\"><span class=\"lead\">Search Parameters</span><table class=\"table table-condensed table-hover\"><thead><tr><th>Conformance</th><th>Parameter</th><th>Type</th><th>Documentation</th></tr></thead><tbody><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_id</a></td><td><code>token</code></td><td><div><p>Resource.id</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/resource.html#search\">_lastUpdated</a></td><td><code>date</code></td><td><div><p>Resource.meta.lastUpdated</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">action</a></td><td><code>token</code></td><td><div><p>AuditEvent.action</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">altid</a></td><td><code>token</code></td><td><div><p>AuditEvent.agent.altId</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">date</a></td><td><code>date</code></td><td><div><p>AuditEvent.recorded</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">outcome</a></td><td><code>token</code></td><td><div><p>AuditEvent.outcome</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">entity-name</a></td><td><code>string</code></td><td><div><p>AuditEvent.entity.name</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">agent-name</a></td><td><code>string</code></td><td><div><p>AuditEvent.agent.name</p>\n</div></td></tr><tr><td><b>MAY</b></td><td><a href=\"http://hl7.org/fhir/R4/auditevent.html#search\">type</a></td><td><code>token</code></td><td><div><p>AuditEvent.type</p>\n</div></td></tr></tbody></table></div><div class=\"col-lg-5\">\u00a0</div></div></div></div></div></div>"
      },
      "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/epa/StructureDefinition/http-header-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-header-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-header-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "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/epa/StructureDefinition/http-response-info-extenstion"
        },
        {
          "url" : "https://gematik.de/fhir/epa/StructureDefinition/base-url-extenstion",
          "valueString" : "http://epa4all/epa/audit/api/v1/fhir"
        }
      ],
      "url" : "https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-client",
      "version" : "1.0.6-2",
      "name" : "EPAAuditEventClient",
      "title" : "Capability Statement für Clients des ePA Audit Event Service",
      "status" : "active",
      "date" : "2025-05-12",
      "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 Status Codes.",
      "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"
      ],
      "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/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "400"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Unknown search parameter"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "400"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Invalid query parameter(s)"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "400"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Invalid request"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "404"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Unknown resource type"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    }
                  ],
                  "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/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "400"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Invalid request"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "404"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Unknown resource type"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "404"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Resource is not known"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    },
                    {
                      "extension" : [
                        {
                          "url" : "statusCode",
                          "valueString" : "404"
                        },
                        {
                          "url" : "description",
                          "valueString" : "Not found"
                        },
                        {
                          "url" : "responseType",
                          "valueString" : "OperationOutcome"
                        }
                      ],
                      "url" : "https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion"
                    }
                  ],
                  "code" : "read"
                }
              ],
              "versioning" : "versioned-update",
              "readHistory" : true,
              "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"
                }
              ]
            }
          ]
        }
      ]
    }