Implementation Guide
ePA Basisfunktionalitäten
Version 1.3.1 - release

## : Capability Statement für Clients des ePA Patient Service - XML Representation

Active as of 2025-03-20

Raw xml | Download

    <CapabilityStatement xmlns="http://hl7.org/fhir">
      <id value="epa-patient-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>
      <extension
                 url="https://gematik.de/fhir/ti/StructureDefinition/extension-base-url">
        <valueString value="http://epa4all/epa/patient/api/v1/fhir"/>
      </extension>
      <url
           value="https://gematik.de/fhir/epa/CapabilityStatement/epa-patient-client"/>
      <version value="1.3.1"/>
      <name value="EPAPatientClient"/>
      <title value="Capability Statement für Clients des ePA Patient Service"/>
      <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="EPA CapabilityStatement für den Patient Service"/>
      <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"/>
      <imports
               value="https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client">🔗
        <extension
                   url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
          <valueCode value="SHALL"/>
        </extension>
      </imports>
      <fhirVersion value="4.0.1"/>
      <format value="application/fhir+json"/>
      <format value="application/fhir+xml"/>
      <rest>
        <mode value="client"/>
        <resource>
          <extension
                     url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
            <valueCode value="SHALL"/>
          </extension>
          <type value="Patient"/>
          <profile
                   value="https://gematik.de/fhir/epa/StructureDefinition/epa-patient">🔗
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
          </profile>
          <supportedProfile
                            value="https://gematik.de/fhir/ti/StructureDefinition/ti-patient">🔗
            <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="MAY"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
              <extension url="responseType">
                <valueString value="Bundle"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Unknown search parameter"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_PARAM_UNKNOWN"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid query parameter(s)"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_SYNTAX"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_FORMAT"/>
              </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="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_UNKNOWN_TYPE"/>
              </extension>
            </extension>
            <code value="search-type"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
              <extension url="responseType">
                <valueString value="Bundle"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_FORMAT"/>
              </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="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_UNKNOWN_TYPE"/>
              </extension>
            </extension>
            <code value="history-type"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
              <extension url="responseType">
                <valueString value="EPAPatient"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_FORMAT"/>
              </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="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_UNKNOWN_TYPE"/>
              </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="Resource is not known"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_RESOURCE_ID_FAIL"/>
              </extension>
            </extension>
            <code value="read"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
              <extension url="responseType">
                <valueString value="Bundle"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_FORMAT"/>
              </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="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_UNKNOWN_TYPE"/>
              </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="Resource is not known"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_RESOURCE_ID_FAIL"/>
              </extension>
            </extension>
            <code value="history-instance"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="MAY"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
              <extension url="responseType">
                <valueString value="EPAPatient"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_FORMAT"/>
              </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="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_UNKNOWN_TYPE"/>
              </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="Resource is not known"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_RESOURCE_ID_FAIL"/>
              </extension>
            </extension>
            <code value="vread"/>
          </interaction>
          <interaction>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="201"/>
              </extension>
              <extension url="description">
                <valueString
                             value="Created, wenn eine neue Ressourceninstanz erstellt wurde"/>
              </extension>
              <extension url="responseType">
                <valueString value="EPAPatient"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="200"/>
              </extension>
              <extension url="description">
                <valueString value="Successful operation"/>
              </extension>
              <extension url="responseType">
                <valueString value="EPAPatient"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_BAD_FORMAT"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="400"/>
              </extension>
              <extension url="description">
                <valueString value="Invalid request"/>
              </extension>
              <extension url="responseType">
                <valueString value="application/json"/>
              </extension>
              <extension url="errorCode">
                <valueString value="malformedRequest"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="422"/>
              </extension>
              <extension url="description">
                <valueString
                             value="Unprocessable Content, falls ein falscher Identifier (KVNR) in der Anfrage angegeben wurde"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_RESOURCE_ID_MISMATCH"/>
              </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="ID-Token or Insurant-ID mismatch"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="SVC_IDENTITY_MISMATCH"/>
              </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="Unknown resource type"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_UNKNOWN_TYPE"/>
              </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="Resource is not known"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="MSG_RESOURCE_ID_FAIL"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="422"/>
              </extension>
              <extension url="description">
                <valueString value="Unprocessable Entity"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
            </extension>
            <extension
                       url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
              <extension url="statusCode">
                <valueString value="412"/>
              </extension>
              <extension url="description">
                <valueString
                             value="Precondition Failed, wenn mehrere Ressourceninstanzen gefunden wurden"/>
              </extension>
              <extension url="responseType">
                <valueString value="TIOperationOutcome"/>
              </extension>
              <extension url="errorCode">
                <valueString value="UPDATE_MULTIPLE_MATCHES"/>
              </extension>
            </extension>
            <code value="update"/>
          </interaction>
          <versioning value="versioned-update"/>
          <readHistory value="true"/>
          <conditionalUpdate value="true">
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
          </conditionalUpdate>
          <searchParam>
            <extension
                       url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
              <valueCode value="SHALL"/>
            </extension>
            <name value="identifier"/>
            <definition
                        value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/>
            <type value="token"/>
            <documentation value="Patient.identifier"/>
          </searchParam>
        </resource>
      </rest>
    </CapabilityStatement>