PackagesCanonicalsLogsProblems
    Packages
    de.gematik.epa.mhd@1.2.0-ballot.1
    https://gematik.de/fhir/epa-mhd/CapabilityStatement/epa-mhd-document-recipient
{
  "description": "CapabilityStatement für den ePA MHD Service (Document Recipient - Server)",
  "_filename": "CapabilityStatement-epa-mhd-document-recipient.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": "2026-12-08",
  "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"
    } ]
  } ],
  "instantiates": [ "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server", "https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentRecipient.Generate", "https://profiles.ihe.net/ITI/MHD/CapabilityStatement/IHE.MHD.DocumentRecipient.Simplified", "http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentAccessProvider-SubmissionOption" ],
  "name": "EPAMHDDocumentRecipient",
  "copyright": "gematik GmbH / Dieser Implementation Guide ist lizenziert unter [Apache License](./license.html), Version 2.0.",
  "type": null,
  "experimental": null,
  "resourceType": "CapabilityStatement",
  "imports": [ "https://gematik.de/fhir/epa/CapabilityStatement/epa-basic-server" ],
  "title": "ePA MHD Service (Document Recipient - Server)",
  "package_version": "1.2.0-ballot.1",
  "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": "Request conflicts with the current state of the health record"
    }, {
      "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": "active",
  "id": "247f82d9-efd4-4577-a260-a4c0ead34e89",
  "kind": "requirements",
  "implementationGuide": [ "https://gematik.de/fhir/ti/ImplementationGuide/de.gematik.ti", "https://gematik.de/fhir/terminology/ImplementationGuide/de.gematik.terminology", "https://gematik.de/fhir/epa/ImplementationGuide/de.gematik.epa", "https://gematik.de/fhir/epa-mhd/ImplementationGuide/de.gematik.epa.mhd", "https://gematik.de/fhir/epa-laboratory/ImplementationGuide/de.gematik.epa.laboratory" ],
  "url": "https://gematik.de/fhir/epa-mhd/CapabilityStatement/epa-mhd-document-recipient",
  "version": "1.2.0",
  "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"
      } ],
      "operation": [ {
        "name": "generate-metadata",
        "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-header",
          "extension": [ {
            "url": "name",
            "valueString": "X-Requesting-Organization"
          }, {
            "url": "type",
            "valueString": "string"
          }, {
            "url": "description",
            "valueString": "Base64 encoded FHIR Organization resource in JSON format used to identify the originator of the request"
          }, {
            "url": "format",
            "valueString": "base64(fhir+json:Organization)"
          }, {
            "url": "required",
            "valueBoolean": true
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "431"
          }, {
            "url": "description",
            "valueString": "Requesting Organization Header exceeds maximum size"
          }, {
            "url": "responseType",
            "valueString": "TIOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "SVC_ORG_HEADER_TOO_LARGE"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "422"
          }, {
            "url": "description",
            "valueString": "Profile mismatch in header Organization"
          }, {
            "url": "responseType",
            "valueString": "TIOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "SVC_ORG_HEADER_PROFILE_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": "400"
          }, {
            "url": "description",
            "valueString": "Bad Request - resource could not be parsed or failed basic FHIR validation rules"
          }, {
            "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": "422"
          }, {
            "url": "description",
            "valueString": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules"
          }, {
            "url": "responseType",
            "valueString": "EPAMHDOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "[proper code from EPAMHDOperationOutcomeDetailsCS]"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "403"
          }, {
            "url": "description",
            "valueString": "Action inconsistent with legal policy"
          }, {
            "url": "responseType",
            "valueString": "application/json"
          }, {
            "url": "errorCode",
            "valueString": "legalPolicyViolation"
          } ]
        } ],
        "definition": "https://gematik.de/fhir/epa-mhd/OperationDefinition/generate-metadata-op",
        "documentation": "Die Generate-Metadata-Operation ermöglicht das Einstellen eines FHIR-Dokuments in die ePA mit automatisch generierten Metadaten und Ressourceninstanzen."
      } ],
      "interaction": [ {
        "code": "create",
        "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": "201"
          }, {
            "url": "description",
            "valueString": "Created - Location header with logical id and version id, created DocumentReference in the response body"
          }, {
            "url": "responseType",
            "valueString": "DocumentReference"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-header",
          "extension": [ {
            "url": "name",
            "valueString": "X-Requesting-Organization"
          }, {
            "url": "type",
            "valueString": "string"
          }, {
            "url": "description",
            "valueString": "Base64 encoded FHIR Organization resource in JSON format used to identify the originator of the request"
          }, {
            "url": "format",
            "valueString": "base64(fhir+json:Organization)"
          }, {
            "url": "required",
            "valueBoolean": true
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "431"
          }, {
            "url": "description",
            "valueString": "Requesting Organization Header exceeds maximum size"
          }, {
            "url": "responseType",
            "valueString": "TIOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "SVC_ORG_HEADER_TOO_LARGE"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "422"
          }, {
            "url": "description",
            "valueString": "Profile mismatch in header Organization"
          }, {
            "url": "responseType",
            "valueString": "TIOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "SVC_ORG_HEADER_PROFILE_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": "Resource is not found - resource type not supported, or not a FHIR end-point"
          }, {
            "url": "responseType",
            "valueString": "TIOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "MSG_RESOURCE_TYPE_MISMATCH"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "400"
          }, {
            "url": "description",
            "valueString": "Bad Request - resource could not be parsed or failed basic FHIR validation rules"
          }, {
            "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": "422"
          }, {
            "url": "description",
            "valueString": "Unprocessable Entity - the proposed resource violated applicable FHIR profiles or server business rules"
          }, {
            "url": "responseType",
            "valueString": "EPAMHDOperationOutcome"
          }, {
            "url": "errorCode",
            "valueString": "[proper code from EPAMHDOperationOutcomeDetailsCS]"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "413"
          }, {
            "url": "description",
            "valueString": "Payload too large"
          }, {
            "url": "responseType",
            "valueString": "application/json"
          }, {
            "url": "errorCode",
            "valueString": "'MaxDocSizeExceeded' or 'MaxPkgSizeExceeded'"
          } ]
        }, {
          "url": "https://gematik.de/fhir/ti/StructureDefinition/extension-http-response-info",
          "extension": [ {
            "url": "statusCode",
            "valueString": "403"
          }, {
            "url": "description",
            "valueString": "Action inconsistent with legal policy"
          }, {
            "url": "responseType",
            "valueString": "application/json"
          }, {
            "url": "errorCode",
            "valueString": "legalPolicyViolation"
          } ]
        } ]
      } ],
      "supportedProfile": [ "https://gematik.de/fhir/epa-mhd/StructureDefinition/epa-mhd-simplified-publish-document-reference" ],
      "_supportedProfile": [ {
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      } ]
    } ]
  } ]
}