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

## : EPA Capability Statement für den Audit Event Service - XML Representation

Active as of 2025-05-12

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="epa-audit-event-server"/>
      <meta>
        <profile
                 value="https://gematik.de/fhir/epa/StructureDefinition/epa-capability-statement"/>
      </meta>
      <text>
        <status value="extensions"/>
        <div xmlns="http://www.w3.org/1999/xhtml"><p class="res-header-id"><b>Generated Narrative: CapabilityStatement epa-audit-event-server</b></p><a name="epa-audit-event-server"> </a><a name="hcepa-audit-event-server"> </a><a name="epa-audit-event-server-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">EPA Capability Statement für den 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-server.html">EPA Basic Server</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>server</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/>  <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>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr><tr><td><b>SHALL</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>
    </div></td></tr></tbody></table></div><div class="col-lg-5"> </div></div></div></div></div></div>
      </text>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-header-extenstion">
        <extension url="name">
          <valueString value="X-Request-ID"/>
        </extension>
        <extension url="type">
          <valueString value="string"/>
        </extension>
        <extension url="description">
          <valueString value="UUID of the request message"/>
        </extension>
        <extension url="format">
          <valueString value="uuid"/>
        </extension>
        <extension url="required">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-header-extenstion">
        <extension url="name">
          <valueString value="x-insurantid"/>
        </extension>
        <extension url="type">
          <valueString value="string"/>
        </extension>
        <extension url="description">
          <valueString value="Health Record Identifier"/>
        </extension>
        <extension url="pattern">
          <valueString value="^[A-Z]{1}\d{9}$"/>
        </extension>
        <extension url="required">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-header-extenstion">
        <extension url="name">
          <valueString value="x-useragent"/>
        </extension>
        <extension url="type">
          <valueString value="string"/>
        </extension>
        <extension url="description">
          <valueString value="user agent information"/>
        </extension>
        <extension url="pattern">
          <valueString value="^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$"/>
        </extension>
        <extension url="required">
          <valueBoolean value="true"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="403"/>
        </extension>
        <extension url="description">
          <valueString value="Request does not match schema"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="invalAuth"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="403"/>
        </extension>
        <extension url="description">
          <valueString value="Requestor has no valid entitlement"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="notEntitled"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="403"/>
        </extension>
        <extension url="description">
          <valueString
                       value="Requestor role is not in the list of allowed user groups"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="invalidOid"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="403"/>
        </extension>
        <extension url="description">
          <valueString value="Device registration does not exist"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="unregisteredDevice"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="404"/>
        </extension>
        <extension url="description">
          <valueString value="Health record is in state UNKNOWN or INITIALIZED"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="noHealthRecord"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="409"/>
        </extension>
        <extension url="description">
          <valueString value="Health record is in state SUSPENDED"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="statusMismatch"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
        <extension url="statusCode">
          <valueString value="500"/>
        </extension>
        <extension url="description">
          <valueString value="Any other error"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="internalError"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/epa/StructureDefinition/base-url-extenstion">
        <valueString value="http://epa4all/epa/audit/api/v1/fhir"/>
      </extension>
      <url
           value="https://gematik.de/fhir/epa/CapabilityStatement/epa-audit-event-server"/>
      <version value="1.0.6-2"/>
      <name value="EPAAuditEventServer"/>
      <title value="EPA Capability Statement für den Audit Event Service"/>
      <status value="active"/>
      <date value="2025-05-12"/>
      <publisher value="gematik GmbH"/>
      <contact>
        <telecom>
          <system value="url"/>
          <value value="https://www.gematik.de"/>
        </telecom>
      </contact>
      <description value="EPA Capability Statement für den Audit Event Service"/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="DE"/>
        </coding>
      </jurisdiction>
      <kind value="requirements"/>
      <imports
               value="https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server">🔗
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
      </imports>
      <fhirVersion value="4.0.1"/>
      <format value="application/fhir+json"/>
      <rest>
        <mode value="server"/>
        <resource>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="AuditEvent"/>
          <profile
                   value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent">🔗
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
          </profile>
          <supportedProfile
                            value="https://gematik.de/fhir/epa/StructureDefinition/epa-auditevent">🔗
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
          </supportedProfile>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Unknown search parameter"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid query parameter(s)"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="404"/>
              </extension>
              <extension url="description">
                <valueString value="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="404"/>
              </extension>
              <extension url="description">
                <valueString value="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="404"/>
              </extension>
              <extension url="description">
                <valueString value="Resource is not known"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/epa/StructureDefinition/http-response-info-extenstion">
              <extension url="statusCode">
                <valueString value="404"/>
              </extension>
              <extension url="description">
                <valueString value="Not found"/>
              </extension>
              <extension url="responseType">
                <valueString value="OperationOutcome"/>
              </extension>
            </extension>
            <code value="read"/>
          </interaction>
          <versioning value="versioned-update"/>
          <readHistory value="true"/>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="_id"/>
            <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
            <type value="token"/>
            <documentation value="Resource.id"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="_lastUpdated"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
            <type value="date"/>
            <documentation value="Resource.meta.lastUpdated"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="action"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-action"/>
            <type value="token"/>
            <documentation value="AuditEvent.action"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="altid"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-altid"/>
            <type value="token"/>
            <documentation value="AuditEvent.agent.altId"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="date"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-date"/>
            <type value="date"/>
            <documentation value="AuditEvent.recorded"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="outcome"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-outcome"/>
            <type value="token"/>
            <documentation value="AuditEvent.outcome"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="entity-name"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-entity-name"/>
            <type value="string"/>
            <documentation value="AuditEvent.entity.name"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="agent-name"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-agent-name"/>
            <type value="string"/>
            <documentation value="AuditEvent.agent.name"/>
          </searchParam>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="type"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/AuditEvent-type"/>
            <type value="token"/>
            <documentation value="AuditEvent.type"/>
          </searchParam>
        </resource>
      </rest>
    </CapabilityStatement>