epa-patient-client
type: CapabilityStatement
node role: treeRoot
id:
  v: epa-patient-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: EPAPatientClient

v: Capability Statement für Clients des ePA Patient Service

v: active

v: 2025-03-20

v: gematik GmbH

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

v: EPA CapabilityStatement für den Patient Service

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: https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client
l: epa-basic-client
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL

v: 4.0.1

v: application/fhir+json

v: application/fhir+xml

mode:
  v: client
resource:
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
  type:
    v: Patient
  profile:
    v: https://gematik.de/fhir/epa/StructureDefinition/epa-patient
    l: epa-patient
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: SHALL
  supported profile:
    v: https://gematik.de/fhir/ti/StructureDefinition/ti-patient
    l: ti-patient
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: SHALL
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    code:
      v: search-type
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    code:
      v: history-type
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    extension:
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      extension:
        value: String
      url:
        v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
        l: extension-http-response-info
    code:
      v: read
  interaction:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    extension:
      extension:
        value: String

v: statusCode
l: statusCode

String
v: 200

v: description
l: description

String
v: Successful operation

v: responseType
l: responseType

String
v: Bundle

v: statusCode
l: statusCode

String
v: 400

v: description
l: description

String
v: Unknown search parameter

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_PARAM_UNKNOWN

v: statusCode
l: statusCode

String
v: 400

v: description
l: description

String
v: Invalid query parameter(s)

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_BAD_SYNTAX

v: statusCode
l: statusCode

String
v: 400

v: description
l: description

String
v: Invalid request

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_BAD_FORMAT

v: statusCode
l: statusCode

String
v: 404

v: description
l: description

String
v: Unknown resource type

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_UNKNOWN_TYPE

v: statusCode
l: statusCode

String
v: 200

v: description
l: description

String
v: Successful operation

v: responseType
l: responseType

String
v: Bundle

v: statusCode
l: statusCode

String
v: 400

v: description
l: description

String
v: Invalid request

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_BAD_FORMAT

v: statusCode
l: statusCode

String
v: 404

v: description
l: description

String
v: Unknown resource type

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_UNKNOWN_TYPE

v: statusCode
l: statusCode

String
v: 200

v: description
l: description

String
v: Successful operation

v: responseType
l: responseType

String
v: EPAPatient

v: statusCode
l: statusCode

String
v: 400

v: description
l: description

String
v: Invalid request

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_BAD_FORMAT

v: statusCode
l: statusCode

String
v: 404

v: description
l: description

String
v: Unknown resource type

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_UNKNOWN_TYPE

v: statusCode
l: statusCode

String
v: 404

v: description
l: description

String
v: Resource is not known

v: responseType
l: responseType

String
v: TIOperationOutcome

v: errorCode
l: errorCode

String
v: MSG_RESOURCE_ID_FAIL

v: statusCode
l: statusCode

String
v: 200

url:
  v: description
  l: description
value: String
  v: Successful operation

url:
  v: responseType
  l: responseType
value: String
  v: Bundle

extension:
  url:
    v: statusCode
    l: statusCode
  value: String
    v: 400
extension:
  url:
    v: description
    l: description
  value: String
    v: Invalid request
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: TIOperationOutcome
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: MSG_BAD_FORMAT
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: 404
extension:
  url:
    v: description
    l: description
  value: String
    v: Unknown resource type
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: TIOperationOutcome
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: MSG_UNKNOWN_TYPE
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: 404
extension:
  url:
    v: description
    l: description
  value: String
    v: Resource is not known
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: TIOperationOutcome
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: MSG_RESOURCE_ID_FAIL
url:
  v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
  l: extension-http-response-info

v: history-instance

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
extension:
  extension:
    url:
      v: statusCode
      l: statusCode
    value: String
      v: 200
  extension:
    url:
      v: description
      l: description
    value: String
      v: Successful operation
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: EPAPatient
  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: 400
  extension:
    url:
      v: description
      l: description
    value: String
      v: Invalid request
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: MSG_BAD_FORMAT
  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: 404
  extension:
    url:
      v: description
      l: description
    value: String
      v: Unknown resource type
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: MSG_UNKNOWN_TYPE
  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: 404
  extension:
    url:
      v: description
      l: description
    value: String
      v: Resource is not known
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: MSG_RESOURCE_ID_FAIL
  url:
    v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
    l: extension-http-response-info
code:
  v: vread

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL
extension:
  extension:
    url:
      v: statusCode
      l: statusCode
    value: String
      v: 201
  extension:
    url:
      v: description
      l: description
    value: String
      v: Created, wenn eine neue Ressourceninstanz erstellt wurde
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: EPAPatient
  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: 200
  extension:
    url:
      v: description
      l: description
    value: String
      v: Successful operation
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: EPAPatient
  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: 400
  extension:
    url:
      v: description
      l: description
    value: String
      v: Invalid request
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: MSG_BAD_FORMAT
  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: 400
  extension:
    url:
      v: description
      l: description
    value: String
      v: Invalid request
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: application/json
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: malformedRequest
  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: 422
  extension:
    url:
      v: description
      l: description
    value: String
      v: Unprocessable Content, falls ein falscher Identifier (KVNR) in der Anfrage angegeben wurde
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: MSG_RESOURCE_ID_MISMATCH
  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: ID-Token or Insurant-ID mismatch
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: SVC_IDENTITY_MISMATCH
  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: 404
  extension:
    url:
      v: description
      l: description
    value: String
      v: Unknown resource type
  extension:
    url:
      v: responseType
      l: responseType
    value: String
      v: TIOperationOutcome
  extension:
    url:
      v: errorCode
      l: errorCode
    value: String
      v: MSG_UNKNOWN_TYPE
  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: 404
  extension:
    url:
      v: description
      l: description
    value: String
      v: Resource is not known

url:
  v: responseType
  l: responseType
value: String
  v: TIOperationOutcome

url:
  v: errorCode
  l: errorCode
value: String
  v: MSG_RESOURCE_ID_FAIL

extension:
  url:
    v: statusCode
    l: statusCode
  value: String
    v: 422
extension:
  url:
    v: description
    l: description
  value: String
    v: Unprocessable Entity
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: TIOperationOutcome
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: 412
extension:
  url:
    v: description
    l: description
  value: String
    v: Precondition Failed, wenn mehrere Ressourceninstanzen gefunden wurden
extension:
  url:
    v: responseType
    l: responseType
  value: String
    v: TIOperationOutcome
extension:
  url:
    v: errorCode
    l: errorCode
  value: String
    v: UPDATE_MULTIPLE_MATCHES
url:
  v: https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info
  l: extension-http-response-info

v: update

v: versioned-update

v: true

v: true
extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL
name:
  v: identifier
definition:
  v: http://hl7.org/fhir/SearchParameter/Patient-identifier
  l: Patient-identifier
type:
  v: token
documentation:
  v: Patient.identifier