Active as of 2025-05-28 |
<CapabilityStatement xmlns="http://hl7.org/fhir">
<id value="epa-mhd-document-consumer"/>
<meta>
<profile
value="https://gematik.de/fhir/ti/StructureDefinition/ti-capability-statement"/>
</meta>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-header">
<extension url="name">
<valueString value="X-Request-ID"/>
</extension>
<extension url="type">
<valueString value="string"/>
</extension>
<extension url="description">
<valueString value="UUID of the request message"/>
</extension>
<extension url="format">
<valueString value="uuid"/>
</extension>
<extension url="required">
<valueBoolean value="false"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-header">
<extension url="name">
<valueString value="x-insurantid"/>
</extension>
<extension url="type">
<valueString value="string"/>
</extension>
<extension url="description">
<valueString value="Health Record Identifier"/>
</extension>
<extension url="pattern">
<valueString value="^[A-Z]{1}\d{9}$"/>
</extension>
<extension url="required">
<valueBoolean value="true"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-header">
<extension url="name">
<valueString value="x-useragent"/>
</extension>
<extension url="type">
<valueString value="string"/>
</extension>
<extension url="description">
<valueString value="user agent information"/>
</extension>
<extension url="pattern">
<valueString value="^[a-zA-Z0-9]{20}\/[a-zA-Z0-9\-\.]{1,15}$"/>
</extension>
<extension url="required">
<valueBoolean value="true"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="403"/>
</extension>
<extension url="description">
<valueString value="Request does not match schema"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="invalAuth"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="403"/>
</extension>
<extension url="description">
<valueString value="Requestor has no valid entitlement"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="notEntitled"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="403"/>
</extension>
<extension url="description">
<valueString
value="Requestor role is not in the list of allowed user groups"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="invalidOid"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="403"/>
</extension>
<extension url="description">
<valueString value="Device registration does not exist"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="unregisteredDevice"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="404"/>
</extension>
<extension url="description">
<valueString value="Health record is in state UNKNOWN or INITIALIZED"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="noHealthRecord"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="409"/>
</extension>
<extension url="description">
<valueString value="Health record is in state SUSPENDED"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="statusMismatch"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="500"/>
</extension>
<extension url="description">
<valueString value="Any other error"/>
</extension>
<extension url="responseType">
<valueString value="application/json"/>
</extension>
<extension url="errorCode">
<valueString value="internalError"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-base-url">
<valueString value="http://epa4all/epa/mhd/api/v1/fhir/"/>
</extension>
<url
value="https://gematik.de/fhir/epa-mhd/CapabilityStatement/epa-mhd-document-consumer"/>
<version value="1.0.0"/>
<name value="EPAMHDDocumentConsumer"/>
<title value="EPA MHD Service (Document Consumer - Client)"/>
<status value="active"/>
<date value="2025-05-28"/>
<publisher value="gematik GmbH"/>
<contact>
<telecom>
<system value="url"/>
<value value="https://www.gematik.de"/>
</telecom>
</contact>
<description
value="CapabilityStatement für den ePA MHD Service (Document Consumer - Client)"/>
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166"/>
<code value="DE"/>
</coding>
</jurisdiction>
<kind value="requirements"/>
<imports
value="https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-client">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</imports>
<fhirVersion value="4.0.1"/>
<format value="application/fhir+json"/>
<format value="application/fhir+xml"/>
<rest>
<mode value="client"/>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="DocumentReference"/>
<supportedProfile
value="https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-document-reference">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="200"/>
</extension>
<extension url="description">
<valueString value="Successful operation"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="400"/>
</extension>
<extension url="description">
<valueString value="Unknown search parameter"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_PARAM_UNKNOWN"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="400"/>
</extension>
<extension url="description">
<valueString value="Invalid query parameter(s)"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_BAD_SYNTAX"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="400"/>
</extension>
<extension url="description">
<valueString value="Invalid request"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_BAD_FORMAT"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="404"/>
</extension>
<extension url="description">
<valueString value="Unknown resource type"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_UNKNOWN_TYPE"/>
</extension>
</extension>
<code value="search-type"/>
</interaction>
<interaction>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="200"/>
</extension>
<extension url="description">
<valueString value="Successful operation"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="400"/>
</extension>
<extension url="description">
<valueString value="Invalid request"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_BAD_FORMAT"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="404"/>
</extension>
<extension url="description">
<valueString value="Unknown resource type"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_UNKNOWN_TYPE"/>
</extension>
</extension>
<extension
url="https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info">
<extension url="statusCode">
<valueString value="404"/>
</extension>
<extension url="description">
<valueString value="Resource is not known"/>
</extension>
<extension url="responseType">
<valueString value="TIOperationOutcome"/>
</extension>
<extension url="errorCode">
<valueString value="MSG_RESOURCE_ID_FAIL"/>
</extension>
</extension>
<code value="read"/>
</interaction>
<versioning value="versioned-update"/>
<readHistory value="true"/>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="_id"/>
<definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/>
<type value="token"/>
<documentation
value="Aktenweit eindeutige Kennung des Dokuments auf Basis von DocumentReference.entryUUID"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="_content"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-content"/>
<type value="string"/>
<documentation
value="Angaben für inhaltsbasierte Volltextsuche in von DocumentReference referenzierten Dokumenten"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="_lastUpdated"/>
<definition
value="http://hl7.org/fhir/SearchParameter/Resource-lastUpdated"/>
<type value="date"/>
<documentation value="Änderungszeitpunkt der DocumentReference"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="author.given"/>
<type value="string"/>
<documentation
value="Vorname der dokumenterstellenden Person auf Basis von DocumentReference.author, welcher dem authorPerson-Slot der DocumentEntry.author-Classification entspricht"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="author.family"/>
<type value="string"/>
<documentation
value="Nachname der dokumenterstellenden Person auf Basis von DocumentReference.author, welcher dem authorPerson-Slot der DocumentEntry.author-Classification entspricht"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="author.organization.name"/>
<type value="string"/>
<documentation
value="Name der dokumenterstellenden Leistungserbringerinstitution auf Basis von DocumentReference.author, welcher dem authorInstitution-Slot der DocumentEntry.author-Classification entspricht"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="category"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-category"/>
<type value="token"/>
<documentation
value="Grobe Klassifizierung des Dokuments auf Basis von DocumentReference.category"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="contenttype"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype"/>
<type value="token"/>
<documentation
value="MimeType des Dokuments auf Basis von DocumentReference.content.attachment.contentType"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="creation"/>
<definition
value="https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation"/>
<type value="date"/>
<documentation
value="Erstellungszeitpunkt des Dokuments auf Basis von DocumentReference.content.attachment.creation"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="date"/>
<definition
value="https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-date"/>
<type value="date"/>
<documentation value="Erstellungszeitpunkt der DocumentReference"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="description"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-description"/>
<type value="string"/>
<documentation
value="Ergänzende Hinweise in Freitext auf Basis von DocumentReference.description"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="event"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-event"/>
<type value="token"/>
<documentation
value="Die zur Erstellung des Dokuments geführten Ereignisse auf Basis von DocumentReference.context.event"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="facility"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-facility"/>
<type value="token"/>
<documentation
value="Die auf Basis von DocumentReference.context.facilityTypeArt benannte Art der Einrichtung des dokumentierenden Ereignisses"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="format"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-format"/>
<type value="token"/>
<documentation
value="Global eindeutiger Code für das Dokumentenformat auf Basis von DocumentReference.content.format"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="identifier"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/>
<type value="token"/>
<documentation
value="Aktenweit eindeutige Kennung des Dokuments auf Basis von DocumentReference.entryUUID"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="language"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype"/>
<type value="token"/>
<documentation value="Sprache in der ein Dokument verfasst ist"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="patient"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-patient"/>
<type value="reference"/>
<documentation value="Aktenkontoinhaber"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="patient.identifier"/>
<type value="token"/>
<documentation value="Identifikator des Aktenkontoinhabers"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="period"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-period"/>
<type value="date"/>
<documentation
value="Zeitraum des dokumentierenden Ereignisses auf Basis von DocumentReference.context.period"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="related"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-related"/>
<type value="reference"/>
<documentation
value="ID-Liste mit assoziierten Dokumenten auf Basis von DocumentReference.context.related"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="security-label"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-security-label"/>
<type value="token"/>
<documentation
value="Vertraulichkeitskennzeichnung/Datenkategorie des Dokuments auf Basis von DocumentReference.securityLabel"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="setting"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-setting"/>
<type value="token"/>
<documentation
value="Art der Fachrichtung der erstellenden Einrichtung auf Basis von DocumentReference.context.practiceSetting"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<name value="status"/>
<definition
value="http://hl7.org/fhir/SearchParameter/DocumentReference-status"/>
<type value="token"/>
<documentation
value="Status des Dokuments auf Basis von DocumentReference.status"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="title"/>
<definition
value="https://gematik.de/fhir/epa-mhd/SearchParameter/epa-mhd-documentreference-title"/>
<type value="string"/>
<documentation
value="Titel des Dokuments auf Basis von DocumentReference.content.attachment.title"/>
</searchParam>
<searchParam>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY"/>
</extension>
<name value="type"/>
<definition
value="http://hl7.org/fhir/SearchParameter/clinical-type"/>
<type value="token"/>
<documentation
value="Art des Dokuments auf Basis von DocumentReference.type"/>
</searchParam>
</resource>
<resource>
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
<type value="Bundle"/>
<supportedProfile
value="https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-document-search-result-bundle">🔗
<extension
url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL"/>
</extension>
</supportedProfile>
<versioning value="versioned-update"/>
<readHistory value="true"/>
</resource>
</rest>
</CapabilityStatement>