Zum Hauptinhalt springen

Fachdaten

Die Fachdaten zu einem Antrag sind die Inhaltsdaten dieses Antrags.
Bei FIT-Connect sind die Fachdaten maschinenlesbar und folgen einem definierten Schema, das Inhalt und Struktur der Fachdaten definiert.

Die folgende Dokumentation beschreibt, was ein Schema für die Fachdaten zu einem Antrag ist. Zudem werden die Unterschiede zwischen einem Fachdatenschema und einem Prozessstandard (Datenaustauschstandard) erläutert. Die nachfolgende Dokumentation zeigt ferner, wie Sie in FIT-Connect ein Fachdatenschema und einen Prozessstandard referenzieren.

Informationen zur Validierung eines Fachdatensatzes finden sich im Artikel Schemavalidierung.

Hinweis

Der Umfang eines Fachdatensatzes sollte 200MB nicht überschreiten. Fachdaten, die größer als 13MB sind, werden automatisch in Anhänge (Attachments) umgewandelt. Sollten bei einer Einreichung keine Fachdaten vorliegen, dann muss ein Dummy gesendet werden (ein leerer String).

Wie entsteht ein Schema für Fachdaten?​

Ein Schema für die Fachdaten eines Antrags hat seinen Ursprung in der gesetzlichen Grundlage für eine bestimmte Leistung, die mit diesem Antrag beantragt wird, zum Beispiel ein Antrag auf Ausstellung eines Schwerbehindertenausweises. Für die Bearbeitung sind Daten erforderlich, zum Beispiel den Namen des Antragstellers und seine Adresse.
Für den digitalen Antrag (Antrag auf der Webseite eines Onlinedienstes) müssen sich der Hersteller des Onlinedienstes (Sender der Antragsdaten) und der Hersteller des Verwaltungssystems (Empfänger der Daten) darüber absprechen, in welchem Format die Fachdaten gesendet werden, damit die gesendeten Daten maschinenlesbar sind.
Diese Absprachen werden in einer digitalen Form festgelegt, die Schema genannt wird. Das Schema zu einem bestimmten Antrag wird nun vom Hersteller des Onlinedienstes auf der FIM- oder XÖV-Plattform bereitgestellt. Nach der Prüfung durch fachlich zuständige Behörden wird das neue Schema veröffentlicht, sodass andere Onlinedienste und Verwaltungssystem dieses Fachdatenschema übernehmen können.
Die Hersteller von Onlinediensten und Fachverfahren müssen also nur dann ein neues Fachdatenschema erstellen, wenn es auf der FIM- oder XÖV-Plattform noch kein Schema für einen bestimmten Antrag gibt. Der Absatz Ein Schema herunterladen zeigt, wie Sie ein Fachdatenschema für einen bestimmten Antrag finden.

Hinweis

Der Empfänger eines Antrags (das Verwaltungssystem) kann prüfen, ob die Fachdaten dem vereinbarten Schema entsprechen (Fachdatenvalidierung). Die Seite Schemavalidierung beschreibt die Überprüfung der Fachdaten.

Unterscheidung Fachdatenschema / Prozessstandard​

Fachdatenschema​

Ein Fachdatenschema legt fest, welche Daten und Datentypen (Datenformate) in einer einzelnen Übermittlung (in einem Antrag) eines sendenden Systems an einen Zustellpunkt zu verwenden sind.

Prozessstandard​

Ein Prozessstandard (oder Datenaustauschstandard) beschreibt einen komplexen Prozess, der nicht nur aus einer Übermittlung (in einem bestimmten Datenformat) eines sendenden Systems an einen Zustellpunkt besteht.
Ein Prozessstandard besteht vielmehr aus einer Übermittlung eines sendenden Systems (Senders) an einen Zustellpunkt und einer Antwort auf diese Übermittlung durch den Zustellpunkt, gefolgt unter Umständen von weiteren Übermittlungen des Senders an diesen Zustellpunkt und weiteren Antworten darauf.
Ein solcher Prozessstandard mit mehreren Übermittlungen und Antworten (jeweils in einem bestimmten Datenformat/Schema) ist zum Beispiel der Standard XBau.

Referenzen auf Fachdatenschemata und Prozessstandards in FIT-Connect​

FIT-Connect nutzt Referenzen (Verweise) auf ein Fachdatenschema oder einen Prozessstandard (Datenaustauschstandard) an den folgenden Stellen:

  • Konfiguration eines Zustellpunktes eines empfangenden Systems
    In der Konfiguration eines Zustellpunktes ist hinterlegt, welche Schemata (Datenformate) dieser Zustellpunkt für die zu sendenden Fachdaten anbietet, d. h. welche Datenformate der zugehörige Empfänger (Subscriber) lesen und verarbeiten kann.
    Sendende Systeme (Sender) können die Konfiguration eines Zustellpunktes über die FIT-Connect Routing API erfragen.
    Die Referenzen auf die unterstützten Fachdatenschema finden sich im JSON-Object, das der Aufruf der Routing-API "/routes" zurückliefert, zum Beispiel der folgende API Aufruf: https://routing-api-testing.fit-connect.fitko.dev/v1/routes?ars=160510000000&leikaKey=99008001014002
    Die Referenzen sind im JSON-Object im "routes"-Array unter destinationParameters.submissionSchemas eingetragen.
    Weitere Informationen hierzu finden sich im Artikel Zustellpunkt ermitteln.
  • Metadaten einer Einreichung eines sendenden Systems
    In den Metadaten einer Einreichung (eines Antrags) gibt die Referenz zu einem Fachdatenschema an, in welchem Datenformat (in welchem Schema) der Sender die Fachdaten übertragen hat.
    Im Metadatensatz wird die Referenz auf das verwendete Fachdatenschema eingetragen unter contentStructure.data.submissionSchema.
    Weitere Informationen zur Hinterlegung der Referenz auf das verwendete Fachschema finden sich in der Dokumentation des Metadatensatzes.

Unterstütze Rahmenwerke und Standards​

Aktuell wird die Verwendung von Fachdatenschemata und Prozessstandards auf Basis folgender Rahmenwerke beschrieben:

  • Fachdatenschemata für Anträge auf Basis von FIM-Datenfeldern
  • Fachdatenschemata und Prozessstandards auf Basis von XÖV-konformen Fachstandards
Aufnahme weiterer Fachstandards und Rahmenwerke

Möchten Sie einen anderen Fachstandard gemeinsam mit FIT-Connect nutzen, dann können wir gerne die Beschreibung weiterer Fachschemareferenzen hier aufnehmen, um diese Informationen einem breiteren Nutzer:innenkreis zugänglich zu machen. Hierzu bitte einfach in unserem öffentlichen Issue-Tracker ein Issue aufmachen. Wir freuen uns sehr, wenn Sie uns bereits einen konkreten Vorschlag zuliefern.

Aufbau einer Referenz​

Eine Fachschemareferenz besteht aus zwei Angaben:

  • Die schemaUri referenziert das zu verwendende Fachschema.
  • Der mimeType gibt den Datentyp (JSON oder XML) der Fachdaten an.
Hinweis

Manche Fachschemata lassen nur JSON oder XML als Datentyp zu.

FIM-Fachschemareferenz​

Um ein FIM-Fachschema zu referenzieren, sind folgende Angaben notwendig:

  • ID des Stammdatenschemas mit großem S (S00000092 im folgenden Beispiel mit dem Datentyp JSON)
  • Version des Stammdatenschemas (1.0 im Beispiel)
  • Art des Schemas (JSON- oder XML-Schema)

Aufbau der schemaUri​

Bei einem Schema für den Datenaustausch mit JSON wird die schemaUri wie folgt aufgebaut:
https://schema.fim.fitko.net/immutable/schemas/{ID}V{Version}_{Zeitstempel}.schema.json

Bei einem Schema für den Datenaustausch mit XML wird die schemaUri wie folgt gebildet:
https://schema.fim.fitko.net/immutable/schemas/{ID}V{Version}_{Zeitstempel}.xsd

Beispiel für eine FIM-Fachschemareferenz​

JSON:

{
  "schemaUri": "https://schema.fim.fitko.net/immutable/schemas/S00000092V1.1_2024-03-27-1711553458904.schema.json",
  "mimeType": "application/json"
}

Ein Schema für den Datenaustausch mit XML ist analog aufgebaut:

XML:

{
  "schemaUri": "https://schema.fim.fitko.net/immutable/schemas/S00000092V1.1_2024-03-27-1711553459282.xsd",
  "mimeType": "application/xml"
}

Die URI eines Schemas erhalten​

Um den exakten Namen einer Datei mit einem Schema zu erhalten, gehen Sie folgendermaßen vor:

  • Öffnen Sie das FIM-Portal (https://fimportal.de/) unter der Adresse https://fimportal.de/schemas/{ID}/{Version}. Wenn Sie zum Beispiel den Namen des Schemas mit der ID S00000092 mit der Version 1.1 suchen, dann rufen Sie den folgenden Link auf https://fimportal.de/schemas/S00000092/1.1
  • Klicken Sie dann unter Downloads auf das Symbol rechts neben Datenschema (JSON Schema), um den Namen der JSON-Datei in die Zwischenablage Ihres Rechners zu übernehmen.
  • Oder klicken Sie auf das Symbol rechts neben Datenschema (XSD), um den Namen der XSD-Datei in die Zwischenablage Ihres Rechners zu übernehmen.

FIM-Portal Downloads

Ein Schema herunterladen​

Wenn Ihnen die ID eines Schemas noch nicht bekannt ist, dann gehen Sie folgendermaßen vor:

  • Öffnen Sie das FIM-Portal (https://fimportal.de/)
  • Suchen Sie nach Datenfeldern, indem Sie den folgenden Link aufrufen Datenschemas.
  • Suchen Sie nach einem Datenschema, indem Sie einen Begriff in das Suchfeld eingeben, zum Beispiel "Behinderung".
  • Wählen Sie einen zutreffenden Eintrag aus.
  • Klicken Sie dann unter Downloads auf Datenschema (JSON Schema), um die JSON-Datei des Schemas auf Ihren Rechner zu laden.
  • Oder klicken Sie auf Datenschema (XSD), um die XSD-Datei des Schemas auf Ihren Rechner zu laden.

XÖV-Fachdatenschemareferenz​

Ein XÖV-Fachschema wird über folgende Angaben referenziert:

  • Kennung (ID) des Fachschemas (urn:xoev-de:bmk:standard:xbau im folgenden Beispiel)
  • Version des Fachschemas (2.2 im Beispiel)
  • Verwendete Nachricht aus dem Fachschema (baugenehmigung.antrag.0200 im Beispiel)

Die schemaUri wird wie folgt gebildet: {Kennung}_{Version}#{Nachricht}

Beispiel für eine XÖV-Fachschemareferenz​

{
  "schemaUri": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
  "mimeType": "application/xml"
}

XÖV: Zusammenhang von Fachdatenschema und Prozessstandard​

Innerhalb eines Prozessstandards, zum Beispiel urn:xoev-de:bmk:standard:xbau_2.2, sind bestimmte Anträge definiert, zum Beispiel urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200 für einen Antrag auf Baugenehmigung aus XBau 2.2

urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200 ist die Referenz auf ein konkretes Fachdatenschema.

urn:xoev-de:bmk:standard:xbau_2.2 ist die Referenz auf den dazugehörigen Prozessstandard.

FIT-Connect als Rückkanal​

Angaben zum Prozessstandard​

Wenn ein Empfänger (Subscriber) die Option anbietet, FIT-Connect als Rückkanal zu nutzen (Subscriber antwortet über FIT-Connect), dann muss der zugehörige Zustellpunkt dafür auch die von ihm unterstützten Prozessstandards in seiner Konfiguration definieren (z.B. XBau).

Wenn ein Onlinedienst (Sender) FIT-Connect als Rückkanal nutzen will (Antworten über FIT-Connect vom Subscriber), dann muss der Sender in den Metadaten angeben, welches Metadatenschema der Zustellpunkt für die Antwort (Reply) nutzen muss.

Das folgende Beispiel zeigt einen Auszug aus den Metadaten eines Senders: Der Sender weist den Empfänger an, XBAU 2.3 als Prozessstandard für die Antwort (Reply) zu nutzen:

Beispiel für die Angaben zu einem Prozessstandard in FIT-Connect​

{
  ...
  "processStandards": [
    "urn:xoev-de:bmk:standard:xbau_2.3"
  ]

}

Referenz auf einen XÖV-Prozessstandard​

Ein XÖV-Prozessstandard wird über folgende Angaben referenziert:

  • Kennung (ID) des Prozessstandards (urn:xoev-de:bmk:standard:xbau im folgenden Beispiel)
  • Version des Prozessstandards (2.3 im folgen Beispiel)

Die processStandards werden wie folgt gebildet: {Kennung}_{Version}

Beispiel für eine Referenz zu einem XÖV-Prozessstandard​

 "processStandards": [
    "urn:xoev-de:bmk:standard:xbau_2.3"
  ]