epa-basic-client
type: CapabilityStatement
node role: treeRoot
id:
  v: epa-basic-client
meta:
  profile:
    v: https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement
    l: ti-capability-statement
extension:
  extension:
    url:
      v: name
      l: name
    value: String
      v: X-Request-ID
  extension:
    url:
      v: type
      l: type
    value: String
      v: string
  extension:
    url:
      v: description
      l: description
    value: String
      v: UUID of the request message
  extension:
    url:
      v: format
      l: format
    value: String
      v: uuid
  extension:
    url:
      v: required
      l: required
    value: Boolean
      v: false
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-header
    l: extension-http-header
extension:
  extension:
    url:
      v: name
      l: name
    value: String
      v: x-insurantid
  extension:
    url:
      v: type
      l: type
    value: String
      v: string
  extension:
    url:
      v: description
      l: description
    value: String
      v: Health Record Identifier
  extension:
    url:
      v: pattern
      l: pattern
    value: String
      v: ^[A-Z]{1}\d{9}$
  extension:
    url:
      v: required
      l: required
    value: Boolean
      v: true
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-header
    l: extension-http-header
extension:
  extension:
    url:
      v: name
      l: name
    value: String
      v: x-useragent
  extension:
    url:
      v: type
      l: type
    value: String
      v: string
  extension:
    url:
      v: description
      l: description
    value: String
      v: user agent information
  extension:
    url:
      v: pattern
      l: pattern
    value: String
      v: ^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$
  extension:
    url:
      v: required
      l: required
    value: Boolean
      v: true
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-header
    l: extension-http-header
extension:
  extension:
    url:
      v: statusCode
      l: statusCode
    value: String
      v: 403
  extension:
    url:
      v: description
      l: description
    value: String
      v: Requestor not authorized (no user session with valid ID-Token available)
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: application/json
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: invalAuth
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
    l: extension-http-response-info
extension:
  extension:
    url:
      v: statusCode
      l: statusCode
    value: String
      v: 403
  extension:
    url:
      v: description
      l: description
    value: String
      v: Requestor has no valid entitlement
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: application/json
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: notEntitled
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
    l: extension-http-response-info
extension:
  extension:
    url:
      v: statusCode
      l: statusCode
    value: String
      v: 403
  extension:
    url:
      v: description
      l: description
    value: String
      v: Requestor role is not in the list of allowed user groups
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: application/json
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: invalidOid
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
    l: extension-http-response-info
extension:
  extension:
    url:
      v: statusCode
      l: statusCode
    value: String
      v: 403

url:
  v: description
  l: description
value: String
  v: Device registration does not exist (if requestor role is oid_versicherter only)

url:
  v: responseType
  l: responseType
value: String
  v: application/json

url:
  v: errorCode
  l: errorCode
value: String
  v: unregisteredDevice

extension:
  url:
    v: statusCode
    l: statusCode
  value: String
    v: 404
extension:
  url:
    v: description
    l: description
  value: String
    v: Health record is in state UNKNOWN or INITIALIZED
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: application/json
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: noHealthRecord
url:
  v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
  l: extension-http-response-info

extension:
  url:
    v: statusCode
    l: statusCode
  value: String
    v: 409
extension:
  url:
    v: description
    l: description
  value: String
    v: Request conflicts with the current state of the health record
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: application/json
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: statusMismatch
url:
  v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
  l: extension-http-response-info

extension:
  url:
    v: statusCode
    l: statusCode
  value: String
    v: 500
extension:
  url:
    v: description
    l: description
  value: String
    v: Any other error
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: application/json
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: internalError
url:
  v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
  l: extension-http-response-info

v: 1.3.1

v: EPABasicClient

v: EPA Basic Client

v: active

v: 2025-03-20

v: gematik GmbH

telecom:
  system:
    v: url
  value:
    v: https://www.gematik.de

v: 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.

coding:
  system:
    v: urn:iso:std:iso:3166
    l: 3166
  code:
    v: DE

v: gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0.

v: requirements

v: 4.0.1

v: application/fhir+json

mode:
  v: client