{
  "description": "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.",
  "_filename": "CapabilityStatement-epa-basic-client.json",
  "package_name": "de.gematik.epa",
  "format": [ "application/fhir+json" ],
  "date": "2025-12-15",
  "meta": {
    "profile": [ "https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement" ]
  },
  "publisher": "gematik GmbH",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "DE",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "EPABasicClient",
  "copyright": "gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0.",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "title": "EPA Basic Client",
  "package_version": "1.3.0",
  "extension": [ {
    "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header",
    "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": false
    } ]
  }, {
    "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-response-info",
    "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"
    } ]
  } ],
  "status": "active",
  "id": "360c9037-2105-4183-85f4-ca70f35aa38d",
  "kind": "requirements",
  "url": "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client",
  "version": "1.3.0",
  "contact": [ {
    "telecom": [ {
      "value": "https://www.gematik.de",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "client"
  } ]
}