| Package | de.gematik.epa |
| Type | CapabilityStatement |
| Id | epa-patient-client |
| FHIR Version | R4 |
| Source | https://gematik.de/fhir/epa/https://simplifier.net/resolve?scope=de.gematik.epa@1.1.5&canonical=https://gematik.de/fhir/epa/CapabilityStatement/epa-patient-client |
| URL | https://gematik.de/fhir/epa/CapabilityStatement/epa-patient-client |
| Version | 1.1.5 |
| Status | active |
| Date | 2025-05-28 |
| Name | EPAPatientClient |
| Title | Capability Statement für Clients des ePA Patient Service |
| Realm | de |
| Description | EPA CapabilityStatement für den Patient Service |
| Kind | requirements |
No resources found
| CapabilityStatement | |
| epa-basic-client | EPA Basic Client |
| StructureDefinition | |
| ti-patient | TI Patient |
| epa-patient | EPA Patient |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement epa-patient-client
FHIRapplication/fhir+json, application/fhir+xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
This CapabilityStatement imports the CapabilityStatement EPA Basic Client
clientThe summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | V-R | S | U | C | H-I | H-T | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Patient | https://gematik.de/fhir/epa/StructureDefinition/epa-patient Additional supported profiles: TI Patient | y | y | y | y | y | y | identifier |
update.search-type, history-type, read, history-instance, vread.| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Patient.identifier |
{
"resourceType": "CapabilityStatement",
"id": "epa-patient-client",
"meta": {
"profile": [
"https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"
]
},
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"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": 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}[%content%]quot;
},
{
"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}[%content%]quot;
},
{
"url": "required",
"valueBoolean": true
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header"
},
{
"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-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-client",
"version": "1.1.5",
"name": "EPAPatientClient",
"title": "Capability Statement für Clients des ePA Patient Service",
"status": "active",
"date": "2025-05-28",
"publisher": "gematik GmbH",
"contact": [
{
"telecom": [
{
"system": "url",
"value": "https://www.gematik.de"
}
]
}
],
"description": "EPA CapabilityStatement für den Patient Service",
"jurisdiction": [
{
"coding": [
{
"system": "urn:iso:std:iso:3166",
"code": "DE"
}
]
}
],
"kind": "requirements",
"imports": [
"https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client"
],
"_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": "client",
"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": "MAY"
},
{
"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"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
}
],
"code": "search-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
},
{
"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"
}
],
"code": "history-type"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
},
{
"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"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
}
],
"code": "read"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
},
{
"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"
}
],
"url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info"
}
],
"code": "history-instance"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
},
{
"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"
}
],
"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": "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"
}
],
"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"
}
]
}
]
}
]
}