{
"description": "CapabilityStatement für den ePA MHD Service (Document Responder - Server)",
"_filename": "CapabilityStatement-epa-mhd-document-responder.json",
"package_name": "de.gematik.epa.mhd",
"format": [ "application/fhir+json", "application/fhir+xml" ],
"_imports": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ],
"date": "2025-08-01",
"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": "EPAMHDDocumentResponder",
"type": null,
"experimental": null,
"resourceType": "CapabilityStatement",
"imports": [ "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server" ],
"title": "ePA MHD Service (Document Responder - Server)",
"package_version": "1.0.1-ballot2",
"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": true
} ]
}, {
"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": "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/mhd/api/v1/fhir/"
} ],
"status": "draft",
"id": "f1d083d9-05ec-4ce2-a31c-07242d30faca",
"kind": "requirements",
"url": "https://gematik.de/fhir/epa-mhd/CapabilityStatement/epa-mhd-document-responder",
"version": "1.0.1-ballot2",
"contact": [ {
"telecom": [ {
"value": "https://www.gematik.de",
"system": "url"
} ]
} ],
"rest": [ {
"mode": "server",
"resource": [ {
"type": "DocumentReference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"versioning": "versioned-update",
"interaction": [ {
"code": "search-type",
"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": "200"
}, {
"url": "description",
"valueString": "Successful operation"
}, {
"url": "responseType",
"valueString": "Bundle"
} ]
}, {
"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": "read",
"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": "200"
}, {
"url": "description",
"valueString": "Successful operation"
}, {
"url": "responseType",
"valueString": "DocumentReference"
} ]
}, {
"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"
} ]
} ]
} ],
"readHistory": true,
"searchParam": [ {
"name": "_id",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"documentation": "Aktenweit eindeutige Kennung des Dokuments auf Basis von DocumentReference.entryUUID"
}, {
"name": "_content",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-content",
"documentation": "Angaben für inhaltsbasierte Volltextsuche in von DocumentReference referenzierten Dokumenten"
}, {
"name": "_lastUpdated",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"documentation": "Änderungszeitpunkt der DocumentReference"
}, {
"name": "author.given",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Vorname der dokumenterstellenden Person auf Basis von DocumentReference.author, welcher dem authorPerson-Slot der DocumentEntry.author-Classification entspricht"
}, {
"name": "author.family",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Nachname der dokumenterstellenden Person auf Basis von DocumentReference.author, welcher dem authorPerson-Slot der DocumentEntry.author-Classification entspricht"
}, {
"name": "author.organization.name",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Name der dokumenterstellenden Leistungserbringerinstitution auf Basis von DocumentReference.author, welcher dem authorInstitution-Slot der DocumentEntry.author-Classification entspricht"
}, {
"name": "category",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"documentation": "Grobe Klassifizierung des Dokuments auf Basis von DocumentReference.category"
}, {
"name": "contenttype",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"documentation": "MimeType des Dokuments auf Basis von DocumentReference.content.attachment.contentType"
}, {
"name": "creation",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
"documentation": "Erstellungszeitpunkt des Dokuments auf Basis von DocumentReference.content.attachment.creation"
}, {
"name": "date",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-date",
"documentation": "Erstellungszeitpunkt der DocumentReference"
}, {
"name": "description",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-description",
"documentation": "Ergänzende Hinweise in Freitext auf Basis von DocumentReference.description"
}, {
"name": "event",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
"documentation": "Die zur Erstellung des Dokuments geführten Ereignisse auf Basis von DocumentReference.context.event"
}, {
"name": "facility",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"documentation": "Die auf Basis von DocumentReference.context.facilityTypeArt benannte Art der Einrichtung des dokumentierenden Ereignisses"
}, {
"name": "format",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"documentation": "Global eindeutiger Code für das Dokumentenformat auf Basis von DocumentReference.content.format"
}, {
"name": "identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"documentation": "Aktenweit eindeutige Kennung des Dokuments auf Basis von DocumentReference.entryUUID"
}, {
"name": "language",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype",
"documentation": "Sprache in der ein Dokument verfasst ist"
}, {
"name": "patient",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"documentation": "Aktenkontoinhaber"
}, {
"name": "patient.identifier",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"documentation": "Identifikator des Aktenkontoinhabers"
}, {
"name": "period",
"type": "date",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
"documentation": "Zeitraum des dokumentierenden Ereignisses auf Basis von DocumentReference.context.period"
}, {
"name": "related",
"type": "reference",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
"documentation": "ID-Liste mit assoziierten Dokumenten auf Basis von DocumentReference.context.related"
}, {
"name": "security-label",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"documentation": "Vertraulichkeitskennzeichnung/Datenkategorie des Dokuments auf Basis von DocumentReference.securityLabel"
}, {
"name": "setting",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"documentation": "Art der Fachrichtung der erstellenden Einrichtung auf Basis von DocumentReference.context.practiceSetting"
}, {
"name": "status",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"documentation": "Status des Dokuments auf Basis von DocumentReference.status"
}, {
"name": "title",
"type": "string",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "https://gematik.de/fhir/epa-mhd/SearchParameter/epa-mhd-documentreference-title",
"documentation": "Titel des Dokuments auf Basis von DocumentReference.content.attachment.title"
}, {
"name": "type",
"type": "token",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"documentation": "Art des Dokuments auf Basis von DocumentReference.type"
} ],
"supportedProfile": [ "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-document-reference" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
}, {
"type": "Bundle",
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ],
"versioning": "versioned-update",
"readHistory": true,
"supportedProfile": [ "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-document-search-result-bundle" ],
"_supportedProfile": [ {
"extension": [ {
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
} ]
} ]
} ]
} ]
}