FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagede.gematik.dipag
Resource TypeOperationDefinition
IdOperationDefinition-DiPagOperationRetrieve.json
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=de.gematik.dipag@1.0.8&canonical=https://gematik.de/fhir/dipag/OperationDefinition/Retrieve
URLhttps://gematik.de/fhir/dipag/OperationDefinition/Retrieve
Version1.0.8
Statusactive
Date2026-07-08
NameDiPagRetrieve
Realmde
Typetrue
Kindoperation

Resources that use this resource

CapabilityStatement
de.gematik.dipag#1.0.8DiPagCapabilityStatementFDCapabilityStatement Fachdienst E-Rechnnung

Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source1

{
  "resourceType": "OperationDefinition",
  "id": "DiPagOperationRetrieve",
  "status": "active",
  "version": "1.0.8",
  "experimental": false,
  "date": "2026-07-08",
  "url": "https://gematik.de/fhir/dipag/OperationDefinition/Retrieve",
  "kind": "operation",
  "name": "DiPagRetrieve",
  "code": "retrieve",
  "resource": [
    "DocumentReference"
  ],
  "system": false,
  "type": true,
  "instance": false,
  "affectsState": false,
  "parameter": [
    {
      "name": "token",
      "use": "in",
      "min": 1,
      "max": "1",
      "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.",
      "type": "string"
    },
    {
      "name": "pdf",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "Angabe, ob das angereicherte Rechnungsdokument oder der Anhang als PDF im Output enthalten sein soll. Default: false",
      "type": "boolean"
    },
    {
      "name": "strukturierterRechnungsinhalt",
      "use": "in",
      "min": 0,
      "max": "1",
      "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",
      "type": "boolean"
    },
    {
      "name": "originaleRechnung",
      "use": "in",
      "min": 0,
      "max": "1",
      "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.",
      "type": "boolean"
    },
    {
      "name": "dokument",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "DocumentReference-Ressource zum angefragten Dokumenttoken.",
      "type": "DocumentReference",
      "targetProfile": [
        "https://gematik.de/fhir/dipag/StructureDefinition/dipag-dokumentenmetadaten-intern"
      ]
    },
    {
      "name": "dokument.pdf",
      "use": "out",
      "min": 1,
      "max": "1",
      "documentation": "Binary-Ressource mit dem angereicherten PDF (inkl. Barcode) der Digitalen Patientenrechnung ODER dem angefragten Anhang (abhängig von der Art des angefragten Dokuments).",
      "type": "Binary"
    },
    {
      "name": "dokument.strukturierteRechnungsinhalte",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Binary-Ressource mit den strukturierten Rechnungsinhalten der Digitalen Patientenrechnung (abhängig vom strukturierterRechnungsinhalt-Parameter).",
      "type": "Binary"
    },
    {
      "name": "dokument.originaleRechnung",
      "use": "out",
      "min": 0,
      "max": "1",
      "documentation": "Binary-Ressource mit der originalen Rechnung inkl. Signatur (abhängig vom originaleRechnung-Parameter).",
      "type": "Binary"
    }
  ]
}