Implementation Guide
ePA Basisfunktionalitäten
Version 1.3.1 - release

## : EPA Basic Client - XML Representation

Active as of 2025-03-20

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="epa-basic-client"/>
      <meta>
        <profile
                 value="https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"/>
      </meta>
      <extension
                 url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-header">
        <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="false"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-header">
        <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/ti/StructureDefinition/extension-http-header">
        <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/ti/StructureDefinition/extension-http-response-info">
        <extension url="statusCode">
          <valueString value="403"/>
        </extension>
        <extension url="description">
          <valueString
                       value="Requestor not authorized (no user session with valid ID-Token available)"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="invalAuth"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
        <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/ti/StructureDefinition/extension-http-response-info">
        <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/ti/StructureDefinition/extension-http-response-info">
        <extension url="statusCode">
          <valueString value="403"/>
        </extension>
        <extension url="description">
          <valueString
                       value="Device registration does not exist (if requestor role is oid_versicherter only)"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="unregisteredDevice"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
        <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/ti/StructureDefinition/extension-http-response-info">
        <extension url="statusCode">
          <valueString value="409"/>
        </extension>
        <extension url="description">
          <valueString
                       value="Request conflicts with the current state of the health record"/>
        </extension>
        <extension url="responseType">
          <valueString value="application/json"/>
        </extension>
        <extension url="errorCode">
          <valueString value="statusMismatch"/>
        </extension>
      </extension>
      <extension
                 url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
        <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-client"/>
      <version value="1.3.1"/>
      <name value="EPABasicClient"/>
      <title value="EPA Basic Client"/>
      <status value="active"/>
      <date value="2025-03-20"/>
      <publisher value="gematik GmbH"/>
      <contact>
        <telecom>
          <system value="url"/>
          <value value="https://www.gematik.de"/>
        </telecom>
      </contact>
      <description
                   value="Dieses Capability Statement beschreibt die Anforderungen an Clients, die den FHIR Data Service der ePA verwenden. Es legt fest, welche HTTP-Header obligatorisch sind und welche einheitlichen Fehlercodes im Fehlerfall zu erwarten sind."/>
      <jurisdiction>
        <coding>
          <system value="urn:iso:std:iso:3166"/>
          <code value="DE"/>
        </coding>
      </jurisdiction>
      <copyright
                 value="gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0."/>
      <kind value="requirements"/>
      <fhirVersion value="4.0.1"/>
      <format value="application/fhir+json"/>
      <rest>
        <mode value="client"/>
      </rest>
    </CapabilityStatement>