Zum Hauptinhalt springen

Überblick

Aufgaben der Metadaten​

Diese Seite zeigt, warum Metadaten in FIT-Connect erforderlich sind.

Metadaten​

Die Metadaten zu einer Einreichung sind ein zentraler Bestandteil von Einreichungen in FIT-Connect.
Die Metadaten beschreiben maschinenlesbar, wie eine Einreichung aufgebaut ist, d. h., welche Fachdaten diese Einreichung enthält und welche Anlagen mitgesendet werden.
Zudem steht in den Metadaten, wie die Leistung, die mit dieser Einreichung beantragt wird, bezahlt wurde.
Ferner enthalten die Metadaten zu einer Einreichung Angaben zu dem Rückkanal, den das empfangende System (das Verwaltungssystem) verwenden muss, also auf welchen Wegen das Verwaltungssystem antworten kann.
Eine Definition der Metadaten finden Sie im Schema zu den Metadaten (siehe unten). Das Schema legt fest, wie die Metadaten aufgebaut sein müssen, zum Beispiel, welche Angaben erforderlich (required) sind .
Ein Beispiel für die Metadaten zu einer Einreichung finden Sie auf der Seite Beispiel für die Metadaten.

Metadaten V2​

Mit der Submission API V2.0.0 wurde der Metadatensatz modularisiert. Der Sender stellt verschiedene dataSets und die dazugehörigen Schemas bereit. Dies soll die Übermittlung von Metadaten aus verschiedenen Quellen vereinfachen und transparenter machen. Des Weiteren wird der Metadatensatz durch diese Änderung flexibler gestaltet und ist somit leichter erweiterbar.

Das Objekt additionalReferenceInfo bleibt (vorerst) unverändert, es ist jedoch nicht mehr zulässig, über die definierten Inhalte hinaus individuelle Felder und Objekte dort hinzuzufügen. Bei Bedarf ist für individuelle Daten ein eigenes dataSet zu verwenden. Am Beispiel von authenticationInformation sehen Sie, wie ein solches Dataset verwendet werden kann, um ein beliebiges eigenes Schema zu verwenden. Dieses muss allerdings zwischen den Kommunikationspartnern abgestimmt sein. Dabei enthält schema.uri eine URI, die das versionierte Schema eindeutig identifiziert. Idealerweise, aber nicht notwendigerweise, ist unter dieser URI das Schema auch abrufbar, zum Beispiel im JSON-Schema-Format, wenn schema.mimeType=application/json ist. Das Feld content enthält dann die eigentliche Nutzlast, die dem Schema entsprechen muss. Wird application/json verwendet, kann dies inline passieren. Bei beispielsweise XML müsste content ein string sein, der das XML-Dokument enthält. Aus Sicherheits- und Zuverlässigkeitsgründen sollte die Schema-Datei nach Absprache lokal vorgehalten werden und nicht dynamisch von der URI nachgeladen werden.

Das Objekt authenticationInformation wurde entfernt und durch ein dataSet mit externem Schema ersetzt. Die Willensbekundung bzgl. des elektronischen Bescheids kann nun über die Metadaten transportiert werden: zustimmungZumDigitalenBescheid wurde als optionales Boolean-Feld zu additionalReferenceInfo hingefügt. Außerdem ist das Attribut $schema nun verpflichtend.

Fachdaten​

Die Fachdaten sind die eigentlichen Inhaltsdaten einer Einreichung. Zudem sind die Fachdaten die Inhaltsdaten einer Antwort zu einem Antrag, falls der Empfänger des Antrags (der Einreichung) über FIT-Connect antwortet (FIT-Connect als Rückkanal). Die Seite Fachdaten beschreibt die Fachdaten einer Einreichung für einem Antrag.

Hinweis

Wenn als Rückkanal FIT-Connect gewählt wird, wenn also der Empfänger einer Einreichung über FIT-Connect antwortet, dann enthält die Antwort (Reply) zusätzlich zu den Fachdaten auch Metadaten.

Metadaten erzeugen und auswerten​

Onlinedienste erzeugen die Metadaten​

Onlinedienste erzeugen die Metadaten zu einer Einreichung und senden sie mit zum Empfänger. In den Metadaten gibt der Onlinedienst (das sendende System) Auskunft darüber, welche Daten (Fachdaten) in der Einreichung gesendet werden. Zum Erzeugen der Metadaten können Onlinedienste die Software Development Kits (SDKs) verwenden, die von FIT-Connect zur Verfügung gestellt werden. Die Seite Übersicht gibt eine allgemeine Einführung zu den SDKs von FIT-Connect.
Die Seite .NET-SDK beschreibt, wie Sie mit dem .NET-SDK von FIT-Connect einen Onlinedienst implementieren und damit eine Submission (Einreichung) senden. Das SDK erzeugt dabei automatisch die Metadaten zu dieser Einreichung.
Die Seite Java-SDK beschreibt, wie Sie mit dem Java-SDK von FIT-Connect einen Onlinedienst implementieren und damit eine Submission (Einreichung) senden. Das jeweilige SDK erzeugt dabei automatisch die Metadaten zu dieser Einreichung.

Verwaltungssysteme werten die Metadaten aus​

Verwaltungssysteme werten die Metadaten aus, die ein Onlinesystem zu einer Einreichung mitgesendet hat. In den Metadaten enthält das Verwaltungssystem (das empfangende System) Informationen zum Aufbau der Einreichung. Zum Auswerten der Metadaten können Verwaltungssysteme die Software Development Kits (SDKs) verwenden, die von FIT-Connect zur Verfügung gestellt werden.
Die Seite .NET-SDK beschreibt, wie Sie mit dem .NET-SDK von FIT-Connect einen Empfänger (Subscriber) implementieren und damit eine Submission (Einreichung) erhalten. Das SDK wertet dabei automatisch die Metadaten zu dieser Einreichung aus.
Die Seite Java-SDK beschreibt wie Sie mit dem Java-SDK von FIT-Connect einen Empfänger (Subscriber) implementieren und damit eine Submission (Einreichung) erhalten. Das jeweilige SDK wertet dabei automatisch die Metadaten zu dieser Einreichung aus.

Metadaten einer Einreichung​

Die Metadaten einer Einreichung enthalten die folgenden Bereiche:

Die Details zu den Bereichen der Metadaten sind in den jeweiligen Unterseiten der SDKs (siehe vorherige Links) beschrieben.
Der Bereich publicServiceType ist veraltet (deprecated) und wird nicht mehr verwendet.

Inhaltsstruktur​

Der Bereich contentStructure muss in den Metadaten zu einer Einreichung enthalten sein, d.h., dieser Bereich ist erforderlich (required) gemäß dem Schema der Metadaten.
Im Bereich contentStructure muss angegeben werden, ob und in welchem Format Fachdaten mitgesendet werden. In diesem Bereich der Metadaten sind ferner die Anhänge zu beschreiben, falls dieser Einreichung Anhänge hinzugefügt sind. Zudem sind in diesem Bereich die Hashwerte der übermittelten Fachdaten und Anlagen enthalten, um einen bösartigen Austausch von einzelnen Anlagen zu verhindern.

Weitere Bereiche der Metadaten​

Sollten weitere Informationen notwendig sein (zum Beispiel zum Rückkanal oder zu den Bezahlmöglichkeiten), dann können weitere im Metadatenschema definierte Bereiche befüllt und mitgesendet werden. Ob diese Bereiche jedoch ausgewertet werden, hängt vom Empfänger (Verwaltungssystem) ab, davon, welche Version der Metadaten der Empfänger unterstützt.

Hinweis

Die Seite Beispiel für die Metadaten enthält ein Beispiel für die Metadaten, die zu einem Antrag auf Ausstellung eines Schwerbehindertenausweises mitgesendet werden.

Hinweis
  • Ab 01. Oktober 2025 nicht mehr gültige Versionen: 1.0.0, 1.1.0, 1.1.1
  • Ab 01. April 2026 nicht mehr gültige Version: 1.2.0
  • Ab 01. April 2026 gültige Versionen: ab 1.3.0

Schema der Metadaten​

Das Schema der Metadaten orientiert sich an der JSON Schema Spezifikation von 2020-12.

Lädt...