Active as of 2025-05-09 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="epa-basic-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-basic-server</b></p><a name="epa-basic-server"> </a><a name="hcepa-basic-server"> </a><a name="epa-basic-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 Basic Server</h2><ul><li>Implementation Guide Version: 1.0.6 </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-09 </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><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></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>
<url
value="https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server"/>
<version value="1.0.6"/>
<name value="EPABasicServer"/>
<title value="EPA Basic Server"/>
<status value="active"/>
<date value="2025-05-09"/>
<publisher value="gematik GmbH"/>
<contact>
<telecom>
<system value="url"/>
<value value="https://www.gematik.de"/>
</telecom>
</contact>
<description
value="Das Basis Capability Statement für einen FHIR Data Service in der ePA. Es beschreibt globale Header-Anforderungen und einheitliche HTTP Fehler Codes."/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="DE"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+json"/>
<rest>
<mode value="server"/>
</rest>
</CapabilityStatement>