{
  "description": "EPA CapabilityStatement für den Patient Service",
  "_filename": "CapabilityStatement-epa-patient-client.json",
  "package_name": "de.gematik.epa",
  "format": [ "application/fhir+json", "application/fhir+xml" ],
  "_imports": [ {
    "extension": [ {
      "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
      "valueCode": "SHALL"
    } ]
  } ],
  "date": "2025-05-28",
  "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": "EPAPatientClient",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "imports": [ "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client" ],
  "title": "Capability Statement für Clients des ePA Patient Service",
  "package_version": "1.1.5",
  "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": "Request does not match schema"
    }, {
      "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"
    }, {
      "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": "Health record is in state SUSPENDED"
    }, {
      "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-base-url",
    "valueString": "http://epa4all/epa/patient/api/v1/fhir"
  } ],
  "status": "active",
  "id": "49f87134-59d7-4df4-803d-d8e2498df454",
  "kind": "requirements",
  "url": "https://gematik.de/fhir/epa/CapabilityStatement/epa-patient-client",
  "version": "1.1.5",
  "contact": [ {
    "telecom": [ {
      "value": "https://www.gematik.de",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
        "documentation": "Patient.identifier"
      } ],
      "conditionalUpdate": true,
      "_conditionalUpdate": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "readHistory": true,
      "type": "Patient",
      "interaction": [ {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "200"
          }, {
            "url": "description",
            "valueString": "Successful operation"
          } ]
        }, {
          "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"
          } ]
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "200"
          }, {
            "url": "description",
            "valueString": "Successful operation"
          } ]
        }, {
          "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"
          } ]
        } ]
      }, {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "200"
          }, {
            "url": "description",
            "valueString": "Successful operation"
          } ]
        }, {
          "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"
          } ]
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "200"
          }, {
            "url": "description",
            "valueString": "Successful operation"
          } ]
        }, {
          "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"
          } ]
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "200"
          }, {
            "url": "description",
            "valueString": "Successful operation"
          } ]
        }, {
          "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"
          } ]
        } ]
      }, {
        "code": "update",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "201"
          }, {
            "url": "description",
            "valueString": "Created, wenn eine neue Ressourceninstanz erstellt wurde"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "200"
          }, {
            "url": "description",
            "valueString": "Successful operation"
          } ]
        }, {
          "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": "412"
          }, {
            "url": "description",
            "valueString": "Precondition Failed, wenn mehrere Ressourceninstanz gefunden wurden"
          }, {
            "url": "responseType",
            "valueString": "TIOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "UPDATE_MULTIPLE_MATCHES"
          } ]
        } ]
      } ],
      "_profile": {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      },
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "supportedProfile": [ "https://gematik.de/fhir/ti/StructureDefinition/ti-patient" ],
      "versioning": "versioned-update",
      "profile": "https://gematik.de/fhir/epa/StructureDefinition/epa-patient",
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    } ]
  } ]
}