epa-mhd-document-consumer
type: CapabilityStatement
node role: treeRoot
id:
  v: epa-mhd-document-consumer
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.1.2

v: EPAMHDDocumentConsumer

v: EPA MHD Service (Document Consumer - Client)

v: active

v: 2026-03-20

v: gematik GmbH

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

v: CapabilityStatement für den ePA MHD Service (Document Consumer - Client)

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: DocumentReference
  supported profile:
    v: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-document-reference
    l: epa-mhd-document-reference
    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: SHALL
    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: SHALL
    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
  versioning:
    v: versioned-update
  read history:
    v: true
  search param:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    name:
      v: _id
    definition:
      v: http://hl7.org/fhir/SearchParameter/Resource-id
      l: Resource-id
    type:
      v: token
    documentation:
      v: Aktenweit eindeutige Kennung des Dokuments auf Basis von DocumentReference.entryUUID
  search param:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    name:
      v: _content
    definition:
      v: http://hl7.org/fhir/SearchParameter/Resource-content
      l: Resource-content
    type:
      v: string
    documentation:
      v: Angaben für inhaltsbasierte Volltextsuche in von DocumentReference referenzierten Dokumenten
  search param:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    name:
      v: _lastUpdated
    definition:
      v: http://hl7.org/fhir/SearchParameter/Resource-lastUpdated
      l: Resource-lastUpdated
    type:
      v: date
    documentation:
      v: Änderungszeitpunkt der DocumentReference
  search param:
    extension:
      url:
        v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
        l: capabilitystatement-expectation
      value: Code
        v: MAY
    name:
      v: author.given

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: DocumentReference

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: string

v: Vorname der dokumenterstellenden Person auf Basis von DocumentReference.author, welcher dem authorPerson-Slot der DocumentEntry.author-Classification entspricht

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: author.family
type:
  v: string
documentation:
  v: Nachname der dokumenterstellenden Person auf Basis von DocumentReference.author, welcher dem authorPerson-Slot der DocumentEntry.author-Classification entspricht

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: author.organization.name
type:
  v: string
documentation:
  v: Name der dokumenterstellenden Leistungserbringerinstitution auf Basis von DocumentReference.author, welcher dem authorInstitution-Slot der DocumentEntry.author-Classification entspricht

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: category
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-category
  l: DocumentReference-category
type:
  v: token
documentation:
  v: Grobe Klassifizierung des Dokuments auf Basis von DocumentReference.category

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: contenttype
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype
  l: DocumentReference-contenttype
type:
  v: token
documentation:
  v: MimeType des Dokuments auf Basis von DocumentReference.content.attachment.contentType

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: creation
definition:
  v: https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation
  l: DocumentReference-Creation
type:
  v: date
documentation:
  v: Erstellungszeitpunkt des Dokuments auf Basis von DocumentReference.content.attachment.creation

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: date
definition:
  v: https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-date
  l: DocumentReference-date
type:
  v: date
documentation:
  v: Erstellungszeitpunkt der DocumentReference

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: description
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-description
  l: DocumentReference-description
type:
  v: string
documentation:
  v: Ergänzende Hinweise in Freitext auf Basis von DocumentReference.description

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: event
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-event
  l: DocumentReference-event
type:
  v: token
documentation:
  v: Die zur Erstellung des Dokuments geführten Ereignisse auf Basis von DocumentReference.context.event

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: facility
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-facility
  l: DocumentReference-facility
type:
  v: token
documentation:
  v: Die auf Basis von DocumentReference.context.facilityTypeArt benannte Art der Einrichtung des dokumentierenden Ereignisses

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: format
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-format
  l: DocumentReference-format
type:
  v: token
documentation:
  v: Global eindeutiger Code für das Dokumentenformat auf Basis von DocumentReference.content.format

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: identifier
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-identifier
  l: clinical-identifier
type:
  v: token
documentation:
  v: Aktenweit eindeutige Kennung des Dokuments auf Basis von DocumentReference.entryUUID

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: language
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-contenttype
  l: DocumentReference-contenttype
type:
  v: token
documentation:
  v: Sprache in der ein Dokument verfasst ist

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: patient
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-patient
  l: clinical-patient
type:
  v: reference
documentation:
  v: Aktenkontoinhaber

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL
name:
  v: patient.identifier
type:
  v: token
documentation:
  v: Identifikator des Aktenkontoinhabers

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: period
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-period
  l: DocumentReference-period
type:
  v: date
documentation:
  v: Zeitraum des dokumentierenden Ereignisses auf Basis von DocumentReference.context.period

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: related
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-related
  l: DocumentReference-related
type:
  v: reference
documentation:
  v: ID-Liste mit assoziierten Dokumenten auf Basis von DocumentReference.context.related

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: security-label
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-security-label
  l: DocumentReference-security-label
type:
  v: token
documentation:
  v: Vertraulichkeitskennzeichnung/Datenkategorie des Dokuments auf Basis von DocumentReference.securityLabel

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: setting
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-setting
  l: DocumentReference-setting
type:
  v: token
documentation:
  v: Art der Fachrichtung der erstellenden Einrichtung auf Basis von DocumentReference.context.practiceSetting

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL
name:
  v: status
definition:
  v: http://hl7.org/fhir/SearchParameter/DocumentReference-status
  l: DocumentReference-status
type:
  v: token
documentation:
  v: Status des Dokuments auf Basis von DocumentReference.status

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: title
definition:
  v: https://gematik.de/fhir/epa-mhd/SearchParameter/epa-mhd-documentreference-title
  l: epa-mhd-documentreference-title
type:
  v: string
documentation:
  v: Titel des Dokuments auf Basis von DocumentReference.content.attachment.title

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: MAY
name:
  v: type
definition:
  v: http://hl7.org/fhir/SearchParameter/clinical-type
  l: clinical-type
type:
  v: token
documentation:
  v: Art des Dokuments auf Basis von DocumentReference.type

extension:
  url:
    v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
    l: capabilitystatement-expectation
  value: Code
    v: SHALL
type:
  v: Bundle
supported profile:
  v: https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-document-search-result-bundle
  l: epa-document-search-result-bundle
  extension:
    url:
      v: http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation
      l: capabilitystatement-expectation
    value: Code
      v: SHALL
versioning:
  v: versioned-update
read history:
  v: true