# EPA CapabilityStatement für den Patient Service - Implementation Guide ePA Basisfunktionalitäten v1.3.1

Implementation Guide

ePA Basisfunktionalitäten

Version 1.3.1 - release 

* [**Table of Contents**](toc.md)
* [**FHIR-Artefakte**](artifacts.md)
* **EPA CapabilityStatement für den Patient Service**

## CapabilityStatement: EPA CapabilityStatement für den Patient Service 

| | |
| :--- | :--- |
| *Official URL*:https://gematik.de/fhir/epa/CapabilityStatement/epa-patient-server | *Version*:1.3.1 |
| Active as of 2025-03-20 | *Computable Name*:EPAPatientServer |
| **Copyright/Legal**: gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.md), Version 2.0. | |

 
EPA Capability Statement für den Patient Service 



## Resource Content

```json
{
  "resourceType" : "CapabilityStatement",
  "id" : "epa-patient-server",
  "meta" : {
    "profile" : ["https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"]
  },
  "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" : true
    }],
    "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
  },
  {
    "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/ti/StructureDefinition/extension-http-header"
  },
  {
    "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/ti/StructureDefinition/extension-http-header"
  },
  {
    "extension" : [{
      "url" : "statusCode",
      "valueString" : "403"
    },
    {
      "url" : "description",
      "valueString" : "Requestor not authorized (no user session with valid ID-Token available)"
    },
    {
      "url" : "responseType",
      "valueString" : "application/json"
    },
    {
      "url" : "errorCode",
      "valueString" : "invalAuth"
    }],
    "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "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/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "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/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "extension" : [{
      "url" : "statusCode",
      "valueString" : "403"
    },
    {
      "url" : "description",
      "valueString" : "Device registration does not exist (if requestor role is oid_versicherter only)"
    },
    {
      "url" : "responseType",
      "valueString" : "application/json"
    },
    {
      "url" : "errorCode",
      "valueString" : "unregisteredDevice"
    }],
    "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "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/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "extension" : [{
      "url" : "statusCode",
      "valueString" : "409"
    },
    {
      "url" : "description",
      "valueString" : "Request conflicts with the current state of the health record"
    },
    {
      "url" : "responseType",
      "valueString" : "application/json"
    },
    {
      "url" : "errorCode",
      "valueString" : "statusMismatch"
    }],
    "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "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/ti/StructureDefinition/extension-http-response-info"
  },
  {
    "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-base-url",
    "valueString" : "http://epa4all/epa/patient/api/v1/fhir"
  }],
  "url" : "https://gematik.de/fhir/epa/CapabilityStatement/epa-patient-server",
  "version" : "1.3.1",
  "name" : "EPAPatientServer",
  "title" : "EPA CapabilityStatement für den Patient Service",
  "status" : "active",
  "date" : "2025-03-20",
  "publisher" : "gematik GmbH",
  "contact" : [{
    "telecom" : [{
      "system" : "url",
      "value" : "https://www.gematik.de"
    }]
  }],
  "description" : "EPA Capability Statement für den Patient Service",
  "jurisdiction" : [{
    "coding" : [{
      "system" : "urn:iso:std:iso:3166",
      "code" : "DE"
    }]
  }],
  "copyright" : "gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0.",
  "kind" : "requirements",
  "imports" : ["https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server"],
  "_imports" : [{
    "extension" : [{
      "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode" : "SHALL"
    }]
  }],
  "fhirVersion" : "4.0.1",
  "format" : ["application/fhir+json", "application/fhir+xml"],
  "rest" : [{
    "mode" : "server",
    "resource" : [{
      "extension" : [{
        "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode" : "SHALL"
      }],
      "type" : "Patient",
      "profile" : "https://gematik.de/fhir/epa/StructureDefinition/epa-patient",
      "_profile" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }]
      },
      "supportedProfile" : ["https://gematik.de/fhir/ti/StructureDefinition/ti-patient"],
      "_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" : "responseType",
            "valueString" : "Bundle"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Unknown search parameter"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_PARAM_UNKNOWN"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid query parameter(s)"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_SYNTAX"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_FORMAT"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Unknown resource type"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_UNKNOWN_TYPE"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        }],
        "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" : "responseType",
            "valueString" : "Bundle"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_FORMAT"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Unknown resource type"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_UNKNOWN_TYPE"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        }],
        "code" : "history-type"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "200"
          },
          {
            "url" : "description",
            "valueString" : "Successful operation"
          },
          {
            "url" : "responseType",
            "valueString" : "EPAPatient"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_FORMAT"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Unknown resource type"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_UNKNOWN_TYPE"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Resource is not known"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_RESOURCE_ID_FAIL"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        }],
        "code" : "read"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "200"
          },
          {
            "url" : "description",
            "valueString" : "Successful operation"
          },
          {
            "url" : "responseType",
            "valueString" : "Bundle"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_FORMAT"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Unknown resource type"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_UNKNOWN_TYPE"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Resource is not known"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_RESOURCE_ID_FAIL"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        }],
        "code" : "history-instance"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "200"
          },
          {
            "url" : "description",
            "valueString" : "Successful operation"
          },
          {
            "url" : "responseType",
            "valueString" : "EPAPatient"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_FORMAT"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Unknown resource type"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_UNKNOWN_TYPE"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Resource is not known"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_RESOURCE_ID_FAIL"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        }],
        "code" : "vread"
      },
      {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "201"
          },
          {
            "url" : "description",
            "valueString" : "Created, wenn eine neue Ressourceninstanz erstellt wurde"
          },
          {
            "url" : "responseType",
            "valueString" : "EPAPatient"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "200"
          },
          {
            "url" : "description",
            "valueString" : "Successful operation"
          },
          {
            "url" : "responseType",
            "valueString" : "EPAPatient"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_BAD_FORMAT"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "400"
          },
          {
            "url" : "description",
            "valueString" : "Invalid request"
          },
          {
            "url" : "responseType",
            "valueString" : "application/json"
          },
          {
            "url" : "errorCode",
            "valueString" : "malformedRequest"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "422"
          },
          {
            "url" : "description",
            "valueString" : "Unprocessable Content, falls ein falscher Identifier (KVNR) in der Anfrage angegeben wurde"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_RESOURCE_ID_MISMATCH"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "403"
          },
          {
            "url" : "description",
            "valueString" : "ID-Token or Insurant-ID mismatch"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "SVC_IDENTITY_MISMATCH"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Unknown resource type"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_UNKNOWN_TYPE"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "404"
          },
          {
            "url" : "description",
            "valueString" : "Resource is not known"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "MSG_RESOURCE_ID_FAIL"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "422"
          },
          {
            "url" : "description",
            "valueString" : "Unprocessable Entity"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        },
        {
          "extension" : [{
            "url" : "statusCode",
            "valueString" : "412"
          },
          {
            "url" : "description",
            "valueString" : "Precondition Failed, wenn mehrere Ressourceninstanzen gefunden wurden"
          },
          {
            "url" : "responseType",
            "valueString" : "TIOperationOutcome"
          },
          {
            "url" : "errorCode",
            "valueString" : "UPDATE_MULTIPLE_MATCHES"
          }],
          "url" : "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
        }],
        "code" : "update"
      }],
      "versioning" : "versioned-update",
      "readHistory" : true,
      "conditionalUpdate" : true,
      "_conditionalUpdate" : {
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }]
      },
      "searchParam" : [{
        "extension" : [{
          "url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode" : "SHALL"
        }],
        "name" : "identifier",
        "definition" : "http://hl7.org/fhir/SearchParameter/Patient-identifier",
        "type" : "token",
        "documentation" : "Patient.identifier"
      }]
    }]
  }]
}

```
