PackagesCanonicalsLogsProblems
    Packages
    de.gematik.dipag@1.0.8
    https://gematik.de/fhir/dipag/OperationDefinition/Retrieve
{
  "description": null,
  "_filename": "OperationDefinition-DiPagOperationRetrieve.json",
  "package_name": "de.gematik.dipag",
  "date": "2026-07-08",
  "system": false,
  "publisher": null,
  "instance": false,
  "name": "DiPagRetrieve",
  "type": "true",
  "experimental": "false",
  "resourceType": "OperationDefinition",
  "title": null,
  "package_version": "1.0.8",
  "status": "active",
  "id": "1fb97da8-74d3-4e36-81c9-6e20fa0f3d51",
  "resource": [ "DocumentReference" ],
  "affectsState": false,
  "kind": "operation",
  "url": "https://gematik.de/fhir/dipag/OperationDefinition/Retrieve",
  "code": "retrieve",
  "version": "1.0.8",
  "parameter": [ {
    "max": "1",
    "min": 1,
    "use": "in",
    "name": "token",
    "type": "string",
    "documentation": "Dokumenttoken zur Identifikation des Dokuments, welches abgerufen werden soll. Das Token entspricht dem Identifier der DocumentReference mit dem System 'https://gematik.de/fhir/sid/dipag-token' (siehe Slice 'Token' im Profil DiPagDokumentenmetadatenIntern) und ist NICHT mit der technischen DocumentReference-id identisch. Im Default wird nur die DocumentReference Ressource zurückgegeben. Durch die Angabe weiterer Parameter können zusätzlich das angereicherte PDF (bzw. der Anhang), die strukturierten Rechnungsinhalte und/oder die originale Rechnung mit Signatur zurückgegeben werden."
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "pdf",
    "type": "boolean",
    "documentation": "Angabe, ob das angereicherte Rechnungsdokument oder der Anhang als PDF im Output enthalten sein soll. Default: false"
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "strukturierterRechnungsinhalt",
    "type": "boolean",
    "documentation": "Angabe, ob die strukturierten Rechnungsinhalte neben dem angereicherten Rechnungsdokument als zusätzliche Binary Ressorce im Output enthalten sein sollen. Hat bei Anhängen keine Funktion. Default: false"
  }, {
    "max": "1",
    "min": 0,
    "use": "in",
    "name": "originaleRechnung",
    "type": "boolean",
    "documentation": "Angabe ob die originale Rechnung inkl. Signatur neben dem angereicherten Rechnungsdokument als zusätzliche Binary Ressource im Output enthalten sein soll. Hat bei Anhängen keine Funktion. Default: false. \n  Die originale Rechnung ist nur vom FdV an das ITSys-KTR direkt weiterzugeben. Falls das Rechnungsdokument ausgedruckt werden sollte durch immer das angereicherte PDF inkl. Barcode zu verwenden."
  }, {
    "max": "1",
    "min": 1,
    "use": "out",
    "name": "dokument",
    "type": "DocumentReference",
    "documentation": "DocumentReference-Ressource zum angefragten Dokumenttoken.",
    "targetProfile": [ "https://gematik.de/fhir/dipag/StructureDefinition/dipag-dokumentenmetadaten-intern" ]
  }, {
    "max": "1",
    "min": 1,
    "use": "out",
    "name": "dokument.pdf",
    "type": "Binary",
    "documentation": "Binary-Ressource mit dem angereicherten PDF (inkl. Barcode) der Digitalen Patientenrechnung ODER dem angefragten Anhang (abhängig von der Art des angefragten Dokuments)."
  }, {
    "max": "1",
    "min": 0,
    "use": "out",
    "name": "dokument.strukturierteRechnungsinhalte",
    "type": "Binary",
    "documentation": "Binary-Ressource mit den strukturierten Rechnungsinhalten der Digitalen Patientenrechnung (abhängig vom strukturierterRechnungsinhalt-Parameter)."
  }, {
    "max": "1",
    "min": 0,
    "use": "out",
    "name": "dokument.originaleRechnung",
    "type": "Binary",
    "documentation": "Binary-Ressource mit der originalen Rechnung inkl. Signatur (abhängig vom originaleRechnung-Parameter)."
  } ]
}