Fachdaten
Die eigentlichen Fachdaten (Antragsdaten) werden bei der Nutzung von FIT-Connect immer maschinenlesbar übermittelt und folgen einem definierten Schema, das Inhalte und Struktur der übermittelten Daten definiert. Dabei sollte der Umfang eines Fachdatensatzes 200MB nicht überschreiten. Fachdaten, die größer als 13MB sind, werden automatisch in Attachments umgewandelt. Da die Fachdaten (encryptedData) verpflichtend sind, müssen diese mit einem Dummy (verschlüsselter leerer String) gefüllt werden.
Die folgende Dokumentation erläutert die Unterschiede zwischen einem Fachdatenschema und einem Prozessstandard (Datenaustauschstandard). Zudem beschreibt die Dokumentation, wie Sie in FIT-Connect ein Fachdatenschema und einen Prozessstandard referenzieren.
Weitere Informationen zur Validierung eines Fachdatensatzes finden sich im Artikel Schemavalidierung.
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=064350014014&leikaKey=99123456760610.
Die Referenzen sind im JSON-Object im "routes"-Array unterdestinationParameters.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 untercontentStructure.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
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.
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 kleinem
s
(s00000096
im folgenden Beispiel mit dem Datentyp JSON) - Version des Stammdatenschemas (
1.0
im Beispiel) - Art des Schemas (JSON- oder XML-Schema)
Für ein Schema mit dem Datentyp JSON wird die schemaUri
wie folgt gebildet:
https://schema.fitko.de/fim/{ID}_{Version}.schema.json
Für ein Schema mit dem Datentyp XML wird die schemaUri
wie folgt gebildet:
urn:xoev-de:xfall:standard:fim-{ID}_{Version}
Beispiel für eine FIM-Fachschemareferenz
JSON:
{
"schemaUri": "https://schema.fitko.de/fim/s00000096_1.0.schema.json",
"mimeType": "application/json"
}
XML:
{
"schemaUri": "urn:xoev-de:xfall:standard:fim-s00000092_1.0",
"mimeType": "application/xml"
}
XÖV-Fachschemareferenz
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"
}
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 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"
]
FIT-Connect als Rückkanal
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:
{
...
"processStandards": [
"urn:xoev-de:bmk:standard:xbau_2.3"
]
}