Informationen zu den Metadaten

Name

Aspekt	Beschreibung
Definition	FIM-interner Name des Datenfelds, sichtbar für alle Anwender eines Redaktionssystems des Bausteins Datenfelder (fachliche Ersteller, Methodenexperten, Informationsmanager, FIM-Koordinierungsstelle, FIM-Nutzer).
Zielgruppe	Modellierende
Pflichtfeld	Ja
Elementspezifisches Qualitätskriterium	Der Name soll prägnant sein. Doppelbenennungen sind zu vermeiden. Namen sollen nicht als Frage formuliert sein. Namen sollten nicht als Teilsatz formuliert sein. Vorgaben durch eine Rechtsnorm sind umzusetzen. Vorgaben durch einen Standard sind zu berücksichtigen und ggf. zu übernehmen oder begründet abzuändern. Der Name soll grundsätzlich keine expliziten Bezüge zum Kontext herstellen. So soll sich der Name erst mit Hilfe der Zugehörigkeit zu einer Datenfeldgruppe in Kontext bringen lassen. Eine Notwendigkeit, den Kontext auch im Feldnamen anzugeben, ergibt sich etwa bei fachspezifischen Datenfeldern, die eigenständig in einem Stammdatenschema außerhalb einer Datenfeldgruppe verwendet werden. Darüber hinaus kann es Fälle geben, bei denen eine Datenfeldgruppe den Kontext nur ungenügend spezifiziert. Falls im Namen ein Wort mit mehreren gänzlich unterschiedlichen Bedeutungen verwendet werden soll (Homonym), ist derjenige Begriff mit der weitläufigsten Verbreitung als Grundform zu definieren (Beispiel: Schloss – das Bauwerk und Schloss – das Türschloss). Die weiteren Verwendungen dieses Wortes sind unter Angaben eines Bezugs in Klammern festzulegen.
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht	1002
Beispiel	Augenfarbe Positives Beispiel eines fachspezifischen Datenfelds einer Datenfeldgruppe mit ungenügend spezifiziertem Kontext: Farbe der Augen. Ein negatives Beispiel in diesem Fall ist: Farbe. Hier besteht Verwechslungsgefahr mit z. B. Hautfarbe. Datenschutz Positives Beispiel eines fachspezifischen Datenfelds, welches außerhalb einer Datenfeldgruppe verwendet werden kann: Datenschutzrechtlicher Hinweis. Ein negatives Beispiel in diesem Fall ist: Hinweis. Positives Beispiel eines fachübergreifenden Datenfelds: Geburtsort In diesem Beispiel wurde der Kontext stärker expliziert, da der Name Ort zu unspezifisch wäre. Zudem wird der Geburtsort nicht immer im Kontext einer Datenfeldgruppe mit Geburtsangaben verwendet. Beispiel für ein Homonym: Titel - wird als Grundform verwendet mit der Begriffsbedeutung: Ein vorangestellter Titel wird häufig im Zusammenhang mit Namen verwendet, ist aber kein originärer Bestandteil des Namens. Eine deutlich spezifischere Verwendung des Begriffs ist in der Rechtswissenschaft zu finden: Titel (Recht) - wird als ein verbrieftes Recht verstanden.
mögliche Abweichungen im Referenzkontext	nein

Definition

Aspekt	Beschreibung
Definition	Fasst den Inhalt des Datenfelds aus redaktioneller Sicht zusammen, d. h. aus Sicht der Rollen Ersteller, Methodenexperte, Informationsmanager, FIM- Koordinierungsstelle, FIM-Nutzer. Eine Definition muss einen Mehrwert bieten, ansonsten sollte sie weggelassen werden.
Zielgruppe	Modellierende, Fachlichkeit
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Datenfelder sollen möglichst (kontext-)spezifisch definiert sein. Falls vorhanden, soll die Definition aus einer Rechtsnorm oder aus einem Standardisierungsverfahren (wie z. B. XÖV) übernommen werden bzw. diese sollte der Definition zur Grundlage dienen. Abgeleitete Definitionen sollen wörtlich übernommen werden. Müssen diese angepasst werden, sind die Anpassungen (im Dokument XYZ oder Attribut ABC) deutlich zu machen und zu begründen. Nichtssagende Floskeln und allgemein gültige Aussagen, die einen Sachverhalt doppelt wiedergeben (Tautologien) sind zu vermeiden. Es sollte sich um eine kurze, präzise und eindeutige Erklärung des Feldes handeln. Definition, die sich an verwaltungsinterne Nutzer/Formularentwickler richten, sollten entsprechende Fachsprache verwenden. Für Datenfelder an denen eine (kurze) Codeliste hängt, dient es der Übersicht die entsprechenden Codelisteneinträge zu erwähnen.
Empfehlung für die maximale Länge	5000 Zeichen
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht	x
Beispiel	Datenfeld Familienname: "Der frühere Familienname einer natürlichen Person entspricht dem Familiennamen einer Person vor der Schließung einer neuen Ehe bzw. dem Eingehen einer neuen Lebenspartnerschaft." Datenfeld Titel: "Ein vorangestellter Titel wird häufig im Zusammen- hang mit Namen verwendet, ist aber kein originärer Bestandteil des Namens. Im Unterschied dazu gehören Adelstitel zum Familiennamen und sind daher in diesem Verständnis kein vorangestellter Titel. Zu den vorangestellten Titeln zählen beispielsweise akademische Grade wie Doktortitel." Datenfeld „Abfrage Wohnort des Kindes“: lebt beim antragstellenden Elternteil / lebt beim anderen Elternteil / absolviert ein Auslandschuljahr / lebt ausbildungsbedingt nicht im elterlichen Haushalt / lebt im Heim bzw. in einer Pflegestelle / lebt bei einer sonstigen Person / ist in Haft. Floskeln, die in einer Definition nicht zu verwenden sind: „bereits schon“, „nie und nimmer“, …
mögliche Abweichungen im Referenzkontext	💣 ja

Bezug zur Handlungsgrundlage

info

Die Namensgebung zu diesem Metadatum hat sich geändert, in XDatenfelder 2 hieß dieses Metadatum noch Bezug zu Rechtsnorm oder Standardisierungsvorhaben.

Bezug zur Handlungsgrundlage

Aspekt	Beschreibung
Definition	Dieses Attribut ermöglicht es, Bezüge zu einschlägigen Rechtsnormen, Verordnungen oder Richtlinien zu dokumentieren. Auch ein Bezug zu XÖV-Vorhaben (oder ähnlichem) und den entsprechenden Datencontainern kann hier gesetzt werden, sowie die Nutzung dieses Standards rechtlich nachweisbar ist. Aus dem Bezug zur Rechtsnorm ergibt sich die Gestaltung des Datenfeldes.
Zielgruppe	Modellierende, Fachlichkeit
Pflichtfeld	Ja / Nein, aber trotzdem wünschenswert für harmonisierte Elemente.
Elementspezifisches Qualitätskriterium	Bei Datenfeldern, deren Strukturelementart „rechtsnormgebunden“ ist, ist dieses Metadatum ein Pflichtfeld, bei „harmonisierten“ Datenfeldern ist es keines. Falls die Bezugsquelle der Rechtsnorm oder des Standardisierungsvorhabens eine eigene Notation vorsieht, dann ist diese zu befolgen. Bei Angaben zu einem Bezug sollen diese möglichst konkret sein. Die Regeln zur Erfassung von Handlungsgrundlagen sind zu beachten. Rechtsnormen sind insbesondere dann anzugeben, wenn diese die rechtliche Grundlage für die Erstellung und die Definition des Datenfelds darstellen. Der Bezug zur Handlungsgrundlage sollte nach Möglichkeit bei harmonisierten Datenfeldern mit einer Version versehen werden, damit man einen sicheren (zeitlichen) Bezugspunkt für die Gültigkeit der Rechtsgrundlage hat. Bei mehreren Handlungsgrundlagen an einem Datenfeld, sollte man diese mit Strichpunkt voneinander trennen.
Empfehlung für die maximale Länge	255 Zeichen pro Bezug; ein Element kann davon mehrere haben.
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht
Beispiel	Datenfeld „Geschäftsbezeichnung / Organisationsbezeichnung“: XGewerbeanzeige.Betrieb.geschaeftsbezeichnung Version 2.2 Datenfeld „IBAN“: ISO 13616-1:2007: Financial services - International bank account number (IBAN) — Part 1: Structure of the IBAN Datenfeld „Ärztliche Bescheinigung“: § 3 (6) BÄO
mögliche Abweichungen im Referenzkontext	💣 ja

Link 🆕

Aspekt	Beschreibung
Definition	Dieses Attribut ermöglicht es, zu jedem Bezug einen entsprechenden Link anzugeben.
Zielgruppe	Modellierende, Fachlichkeit
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Es ist immer ein gültiger Link zu erfassen. Eine gute Quelle für Links zu Rechtsgrundlagen finden sich beispielsweise unter: Gesetze im Internet Eine gute Quelle für Links zu XÖV-Standards findet sich unter: XRepository 3.0 Es sind keine unpassenden Links zu ergänzen.
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht	x
Beispiel	Datenfeld “meldepflichtige Krankheiten” basierend auf § 6 IfSG Link: https://www.gesetze-im-internet.de/ifsg/__6.html Datenfeld “Ort der wirtschaftlichen Tätigkeit” Xunternehmen.Kerndatenmodell.Ort der wirtschaftlichen Tätigkeit.Art Version 1.0; basierend auf Codeliste urn:​xoev-de:xunternehmen:codeliste:artortwirtschaftlichetaetigkeit_1 Version 1 Link: https://www.xrepository.de/details/urn:xoev-de:xunternehmen:standard:basismodul
mögliche Abweichungen im Referenzkontext	nein

Strukturelementart

Aspekt	Beschreibung
Definition	Mit Hilfe einer Klassifizierung nach Arten soll es möglich sein, zwischen harmonisierten und nicht harmonisierten Elementen bzw. nach geeigneten und ungeeigneten Elementen für die Zusammensetzung von Referenz- und Stammdatenschemata zu unterscheiden.
Zielgruppe	Modellierende
Pflichtfeld	Ja, ein geeigneter Defaultwert ist: rechtsnormgebunden
Elementspezifisches Qualitätskriterium	Es ist immer eine der vordefinierten Strukturelementarten auszuwählen. Es existieren zwei Arten von Feldern: harmonisierte (fachübergreifend oder fachspezifisch) oder rechtsnormgebundene (nicht harmonisierbar). Rechtsnormgebundene Felder können aber auch zu einem späteren Zeitpunkt noch harmonisiert werden. Die Strukturelementart “abstrakt” ist nur für Gruppen anzuwenden.
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	keine, (darf nicht abstrakt sein)
Verweis auf den QS-Bericht	1031
Beispiel	Rechtsnormgebunden
mögliche Abweichungen im Referenzkontext	💣 ja

Feldart ✨

info

Im Standard XDatenfelder 3 sind neue Feldarten hinzugekommen: versteckt und gesperrt.

Aspekt	Beschreibung
Definition	Die Feldart bezeichnet, um welche Art von Datenfeld es sich handelt. Sie gibt Auskunft darüber, ob das Feld eine Eingabe erwartet, oder auch nicht. Zusammen mit dem Datentyp wird damit eindeutig die Verwendung eines Datenfeldes spezifiziert.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Ja, ein geeigneter Defaultwert ist: Eingabe.
Elementspezifisches Qualitätskriterium	Es ist immer eine der im Standard vordefinierten Feldarten anzuwenden. Die Kombination aus Feldart und Datentyp muss einer gültigen Kombination entsprechen. Siehe: Was sind die Metadaten Feldart und Datentyp?
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht	1027
Beispiel	Eingabe Auswahl Statisch
mögliche Abweichungen im Referenzkontext	nein

Datentyp ✨

info

Im Standard XDatenfelder 3 sind neue Datentypen hinzugekommen: String.Latin+, Zeit und Zeitpunkt.

Aspekt	Beschreibung
Definition	Der Datentyp bezeichnet die Zusammenfassung konkreter Wertebereiche und ggf. darauf definierten Operationen zu einer Einheit, die mit Hilfe von Regeln abbildbar sind. Zudem spezifiziert der Datentyp die Struktur des Inhalts oder gibt Aufschlüsse über die Feldinhaltsänderbarkeit. Zusammen mit der Feldart wird damit eindeutig die Verwendung eines Datenfeldes spezifiziert.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Ja, ein geeigneter Defaultwert ist: Text
Elementspezifisches Qualitätskriterium	Es ist immer einer der im Standard vordefinierten Datentypen anzuwenden. Die Kombination aus Feldart und Datentyp muss einer gültigen Kombination entsprechen. Siehe: Was sind die Metadaten Feldart und Datentyp?
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht	1028
Beispiel	Text – in Kombination mit der Feldart Eingabe ergibt sich ein Texteingabefeld für „Vornamen“ oder auch „Familienname“ Objekt – in Kombination mit der Feldart Eingabe ergibt sich ein Eingabefeld, welches einen Dienststempel abbilden soll oder auch ein Unterschriftsfeld.
mögliche Abweichungen im Referenzkontext	nein

Inhalt

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, den Inhalt eines Datenfeldes zu spezifizieren. Dies kann einerseits ein vordefinierter (Default-)Wert sein z. B. für ein Textfeld oder auch ein statischer Text, der direkt angezeigt wird.
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme, Antragstellende (für statische Textfelder)
Pflichtfeld	Ja, wenn es sich um ein Feld mit der Feldart „statisch“ und dem Datentyp „Text“ handelt. / Nein, in allen anderen Fällen.
Elementspezifisches Qualitätskriterium	Bei Rechtsbelehrungen oder ähnlichen Vorgaben, die sich aus Handlungsgrundlagen ergeben, ist der Bezug über das entsprechende Metadatum festzulegen.
Empfehlung für die maximale Länge	5000 Zeichen
Art der Prüfung	Komplett manuell
Verweis auf den QS-Bericht	Bezüglich Präzisierungsangaben: 1069, 1070, 1071, 1072, 1073, 1074, 1075, 1076, 1077, 1083, 1084 und 1085. Für statische Textfelder: 1109
Beispiel	Datenfeld „Hinweis zu unvollständigen Angaben (Wohngeld)“: Falls Sie den Wohngeldantrag unvollständig absenden, bestätigt die Wohngeldbehörde lediglich den Eingang zur Fristwahrung. Eine Entscheidung über den Antrag kann erst bei Vollständigkeit erfolgen. (Default-)Wert für ein Datenfeld des Datentyps Wahrheitswert: falsch (Default-)Wert für ein Datenfeld der Feldart Auswahl: 001
mögliche Abweichungen im Referenzkontext	nein

Präzisierungsangaben

Pattern

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, die Form der erwarteten Eingabe des Bürgers für ein Datenfeld in einem nachnutzenden System näher zu spezifizieren.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Dieses Metadatum findet nur im Zusammenhang mit einem Datenfeld der Feldart Eingabe und des Datentyps Text, String.Latin+, Nummer oder Ganzzahl Anwendung. Siehe dazu auch: Präzisierung von Datenfeldern. Ein Pattern ist gemäß des RegEx-Syntaxes für HTML bzw. JavaScript zu erstellen. Das eingegebene Pattern ist vorher unbedingt auf seine Richtigkeit zu prüfen, da es sonst zu Ausführungsfehlern in einem nachnutzenden System kommen könnte. Bei Unsicherheit kann statt eines Patterns auch eine Regel für dieses Feld formuliert werden.
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	keine
Verweis auf den QS-Bericht
Beispiel	Datenfeld „Postleitzahl“ enthält einen Pattern für eine deutsche Postleitzahl: ([0]1[1-9]1|[1-9]1[0-9]1)[0-9]3 In Worten: Eine “0” gefolgt von einer Ziffer von “1” bis “9” ODER eine “1” gefolgt von einer Ziffer von “0” bis “9” UND drei Ziffern, jeweils von “0” bis “9”. Alternative: Datenfeld „Postleitzahl“ ist mit einer Regel verknüpft mit folgender Definition „Bitte sicherstellen, dass in diesem Feld nur korrekte Deutsche Postleitzahlen angegeben werden können“.
mögliche Abweichungen im Referenzkontext	nein

Minimale bzw. maximale Länge

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, die Länge der erwarteten Text-Eingabe des Bürgers für ein Datenfeld in einem nachnutzenden System näher zu spezifizieren.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Dieses Metadatum findet nur im Zusammenhang mit einem Datenfeld der Feldart Eingabe und des Datentyps Text oder String.Latin+ Anwendung. Siehe dazu auch: Präzisierung von Datenfeldern. Falls es eine Vorgabe durch eine Handlungsgrundlage gibt, ist diese zu berücksichtigen. Die Eingabe erfolgt NUR in Form von Ganzzahlen. Es kann auch nur eine der beiden Angaben gemacht werden.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung	wird nicht geprüft
Verweis auf den QS-Bericht	1012, 1015, 1059, 1060, 1061, 1102
Beispiel	Datenfeld „Postleitzahl“ mit der Feldart Eingabe hat eine minimale Länge von fünf und eine maximale Länge von fünf. Datenfeld „Eingetragener Name / Organisationsname“ mit der Feldart Eingabe hat eine minimale Länge von einem und eine maximale Länge von 1000 Zeichen. In diesem Fall ist es wichtig darauf zu achten, dass der Hinweis woher diese Vorgabe stammt (XGewerbeanzeige.Betrieb.eingetragenerName) in der Beschreibung zu diesem Feld hinterlegt wird. Datenfeld “Anzahl der Kinder” mit der Feldart Eingabe und dem Datentyp Ganzzahl hat einen minimalen Wert von 0 und keine Beschränkung des maximalen Werts. Mit der Beschränkung für den minimal Wert verhindert man, dass eine negative Anzahl von Kindern erfasst werden kann.
mögliche Abweichungen im Referenzkontext	nein

Minimaler bzw. maximaler Wert

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, den erwarteten Wertebereich der Eingabe des Bürgers für ein Datenfeld in einem nachnutzenden System näher zu spezifizieren.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Dieses Metadatum findet nur im Zusammenhang mit einem Datenfeld der Feldart Eingabe und des Datentyps Dezimalzahl, Ganzzahl, Geldbetrag, Datum, Zeit oder Zeitpunkt Anwendung. Siehe dazu auch: Präzisierung von Datenfeldern. Falls es eine Vorgabe durch eine Handlungsgrundlage gibt, ist diese zu berücksichtigen. Die Eingaben für Dezimalzahl, Ganzzahl oder Geldbetrag sollten NUR in Form von Ganzzahlen erfolgen. Die Eingaben für Datum und Zeit sollten sich an die Norm ISO 8601 halten, d. h. ein Datum ist in der Form YYYY-MM-DD einzugeben (Beispiel: 2024-02-24). Für Zeit gilt das Eingabeformat hh:mm:ss (Beispiel 14:12:10). Die Eingabe für den Zeitpunkt ist eine Kombination aus den beiden zuvor genannten Angaben für Datum und Zeit. Eine Eingabe für den Zeitpunkt hat laut ISO 8601 das Format YYYY-MM-DDThh:mm:ss (Beispiel: 2024-06-08T13:10:42). Es kann auch nur eine der beiden Angaben gemacht werden; d. h. es kann auch nur ein minimaler oder auch nur ein maximaler Wert angegeben werden.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung
Verweis auf den QS-Bericht	wird nicht geprüft
Beispiel	Datenfeld „Monat“ vom Datentyp Ganzzahl hat einen minimalen Wert von eins und einen maximalen Wert von zwölf. Datenfeld „Tag“ vom Datentyp Ganzzahl hat einen minimalen Wert von eins und einen maximalen Wert von 31. Datenfeld „Datum“ vom Datentyp Datum hat einen minimalen Wert von 2000-01-01 und einen maximalen Wert von 2100-12-31.
mögliche Abweichungen im Referenzkontext	nein

Maximale Dateigröße 🆕

info

Die maximale Dateigröße wird laut der Spezifikation zum Standard XDatenfelder 3 in Byte erfasst. Es kann sein, dass Ihr Editor zur besseren Übersicht die Angabe in Megabyte oder einem anderen Format einfordert.

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, eine maximale Größe für Dateien von Analgen festzulegen, die in einem nachnutzenden System bei einem Dateiupload nicht überschritten werden kann.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Dieses Metadatum findet nur im Zusammenhang mit einem Datenfeld der Feldart Eingabe und des Datentyps Anlage Anwendung. Siehe dazu auch: Präzisierung von Datenfeldern. Falls es eine Vorgabe durch eine Handlungsgrundlage gibt, ist diese zu berücksichtigen.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung	wird nicht geprüft
Verweis auf den QS-Bericht	x
Beispiel	Datenfeld „Geburtsurkunde“ vom Datentyp Anlage hat eine maximale Dateigröße von 5MB.
mögliche Abweichungen im Referenzkontext	nein

Medientyp 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu den Medientyp für Datenfelder vom Datentyp Analgen festzulegen. Nur die angegebenen Medientypen dürfen an dieser Stelle angehängt werden und ein nachnutzenden System muss dies überprüfen.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Dieses Metadatum findet nur im Zusammenhang mit einem Datenfeld der Feldart Eingabe und des Datentyps Anlage Anwendung. Siehe dazu auch: Präzisierung von Datenfeldern. Falls es eine Vorgabe durch eine Handlungsgrundlage gibt, ist diese zu berücksichtigen. Es ist ein gültiger Medientyp gemäß des IANA Registrys (https://www.iana.org/assignments/media-types/mediatypes.xhtml) zu erfassen.
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	wird nicht geprüft
Verweis auf den QS-Bericht	x
Beispiel	Datenfeld „Geburtsurkunde“ vom Datentyp Anlage wird als PDF oder Foto spezifiziert.
mögliche Abweichungen im Referenzkontext	nein

Verweis auf Codeliste

Codelisten Referenz 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, eine Referenz auf eine Codeliste zu setzen, die an externer Stelle - dem XRepository - gepflegt wird.
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme
Pflichtfeld	Ja, bei Datenfeldern der Feldart Auswahl und des Datentyps Text muss immer eine Code- oder Werteliste zugewiesen oder gepflegt werden. / Nein, das Metadatum darf in allen anderen Fällen nicht gepflegt werden.
Elementspezifisches Qualitätskriterium	Es muss eine gültige Codeliste zugewiesen werden. Die Referenz wird in Form der Codelisten Kennung an einem Datenfeld gepflegt. Dabei macht es einen entscheidenden Unterschied, ob eine Kennung mit oder ohne Versionskennung referenziert wird. Im Kontext ist eine Festlegung zu treffen, auf welche Version der Codeliste sich die Versionskennungsfreie Kennung bezieht. Sollte im entsprechenden Kontext keine anderweitige Festlegung existieren, so bezeichnet die Versionskennungsfreie Kennung stets die aktuellste Version der Codeliste.
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	automatisiert
Verweis auf den QS-Bericht	x
Beispiel	urn:​de:bund:destatis:bevoelkerungsstatistik:schluessel:staatsangehoerigkeit urn:​de:bund:destatis:bevoelkerungsstatistik:schluessel:staatsangehoerigkeit_2021-02-19
mögliche Abweichungen im Referenzkontext	nein

Code Key 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, eine Referenz auf die Spalte einer Codeliste zu setzen, die den Code Key enthält.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein, aber es muss immer auch ein Name Key erfasst werden, wenn ein Code Key gepflegt wird.
Elementspezifisches Qualitätskriterium	Es muss ein Spaltenname einer gültigen Codeliste angegeben werden. Dieser Spaltenname entspricht dem technischen Schlüssel einer Spalte. Die Angabe eines Code Keys ist sinnvoll, wenn ein Bezug zu einer konkreten Version einer Codeliste vorliegt.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung	nicht
Verweis auf den QS-Bericht	x
Beispiel	Bezüglich der Codeliste urn:​de:bund:destatis:bevoelkerungsstatistik:schluessel:staatsangehoerigkeit_2023-02-24 wählt man die Spalte: DESTATIS-Schluessel-Staatsangehoerigkeit
mögliche Abweichungen im Referenzkontext	nein

Name Key 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, eine Referenz auf die Spalte einer Codeliste zu setzen, die den Name Key enthält.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Nein, aber es muss immer auch ein Code Key erfasst werden, wenn ein Name Key gepflegt wird.
Elementspezifisches Qualitätskriterium	Es muss ein Spaltenname einer gültigen Codeliste angegeben werden. Dieser Spaltenname entspricht dem technischen Schlüssel einer Spalte. Die Angabe eines Name Keys ist sinnvoll, wenn ein Bezug zu einer konkreten Version einer Codeliste vorliegt.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung	nicht
Verweis auf den QS-Bericht	x
Beispiel	Bezüglich der Codeliste urn:​de:bund:destatis:bevoelkerungsstatistik:schluessel:staatsangehoerigkeit_2023-02-24 wählt man die Spalte: Staatsname-kurz
mögliche Abweichungen im Referenzkontext	nein

Help Key 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, eine Referenz auf die Spalte einer Codeliste zu setzen, die den Help Key enthält.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Es muss ein Spaltenname einer gültigen Codeliste angegeben werden. Dieser Spaltenname entspricht dem technischen Schlüssel einer Spalte. Die Angabe eines Help Keys ist sinnvoll, wenn ein Bezug zu einer konkreten Version einer Codeliste vorliegt.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung	nicht
Verweis auf den QS-Bericht	x
Beispiel	Bezüglich der Codeliste urn:​de:bund:destatis:bevoelkerungsstatistik:schluessel:staatsangehoerigkeit_2023-02-24 wählt man die Spalte: Staatsname-voll
mögliche Abweichungen im Referenzkontext	nein

Wertelisten

Code / Schlüssel 🆕

Aspekt	Beschreibung
Definition	Der Code (oder auch Schlüssel) ist Teil des Eintrags einer Werteliste. Er dient der einfachen Zuordnung von Einträgen einer Werteliste.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein, aber ohne diese Angaben hat die Werteliste keinen Inhalt.
Elementspezifisches Qualitätskriterium	Für einen Code von Wertelisten sind möglichst kurze und prägnante Codes zu verwenden. Ein Code muss eindeutig sein und darf nicht mehrfach verwendet werden. Alle Codes sollten nach Möglichkeit alphanummerisch sein, empfohlen wird eine Nummerierung in der Form 001 für den ersten Eintrag, 002 für den zweiten, 003, … 998. Der Code 999 ist immer dem Codelisteneintrag Sonstige/s vorenthalten. Ein Code kann nicht-nummerisch sein, so wie es sinnvoll ist. Dies ist nur dann sinnvoll, wenn der Code bereits etablierten Kürzeln entspricht.
Empfehlung für die maximale Länge	20 Zeichen
Art der Prüfung	Exemplarisch manuell
Verweis auf den QS-Bericht	x
Beispiel	Code: 001 Name: Inland; Code: 002 Name: Ausland Merkzeichen Schwerbehindertenausweis Code: H Name: Merkzeichen H (hilflos); Code BI Name: Merkzeichen BI (blind); … Fahrerlaubnisklassen Code: AM, Name: Leichte zweirädrige Kleinkrafträder der Klasse L1e-B (Mopeds); Code: B, Name: Kraftfahrzeuge (außer solche der Klassen AM, A1, A2 und A); …
mögliche Abweichungen im Referenzkontext	nein

Name / Wert 🆕

Aspekt	Beschreibung
Definition	Der Name (oder auch Wert) ist Teil des Eintrags einer Werteliste. Er ist immer einem Code zugeordnet.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Nein, aber ohne diese Angaben hat die Werteliste keinen Inhalt.
Elementspezifisches Qualitätskriterium	Der Name eines Codelisteneintrags muss einzigartig sein. Hier ist besonders auf die Sprachhinweise vom Anfang des Dokumentes zu achten (Gendering, Singular/Plural, …).
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	exemplarisch manuell
Verweis auf den QS-Bericht	x
Beispiel	Code: 001 Name: Inland; Code: 002 Name: Ausland Merkzeichen Schwerbehindertenausweis Code: H Name: Merkzeichen H (hilflos); Code BI Name: Merkzeichen BI (blind); … Fahrerlaubnisklassen Code: AM, Name: Leichte zweirädrige Kleinkrafträder der Klasse L1e-B (Mopeds); Code: B, Name: Kraftfahrzeuge (außer solche der Klassen AM, A1, A2 und A); …
mögliche Abweichungen im Referenzkontext	nein

Hilfe 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum bietet die Möglichkeit zu jedem Eintrag einer Werteliste einen expliziten Hilfetext zu hinterlegen.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Beschreibung der Bedeutung des Eintrags einer Werteliste für den Endnutzer auf Inputformularen (Bürger/Unternehmen). Hilfetext sollen bei der Auswahl des richtigen Wertes unterstützen. Dies kann beispielsweise durch eine Eintrag spezifische Erläuterung erfolgen. Ein allgemeiner Hilfetext für die Werteliste sollte durch einen Hilfetext am Datenfeld selbst erfolgen. Aktive Ansprache des Bürgers ist möglich. (“Wählen Sie diesen Wert aus, wenn… “. Ist in den Einträgen der Werteliste Spezialvokabular verwendet worden, sollte es in der Hilfe erklärt werden; z. B. durch die Verwendung von Synonymen. Fremdwörter sollten vermieden werden. Hilfetexte können einen Hinweis liefern, welche Konsequenz die Auswahl eines bestimmten Wertes hat. Hilfetexte dürfen nur angegeben werden, wenn Sie einen Mehrwert bieten. D. h. insbesondere, dass diese nicht identisch mit dem Namen / Wert der Werteliste sein sollten. Es können auch nur für einzelne Einträge der Werteliste Hilfetexte ergänzt werden.
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	exemplarisch manuell
Verweis auf den QS-Bericht	x
Beispiel	Code: 001 Name: Inland; Code: 002 Name: Ausland Hilfe: Wählen Sie diesen Eintrag aus, wenn Sie Ihre ausländische Meldeanschrift hinterlegen wollen. Code: 999 Name: Sonstiges Hilfe: Wählen Sie diesen Wert nur aus, wenn keine der genannten Optionen auf Sie zutrifft.
mögliche Abweichungen im Referenzkontext	nein

Vorbefüllung 🆕

Aspekt	Beschreibung
Definition	Dieses Metadatum dient dazu, zu klären, ob für dieses Datenfeld von der zuständigen Behörde / Stelle ein Vorgabewert getätigt werden muss. Siehe auch Was ist das neue Metadatum Vorbefüllung und wie geht man damit um?
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme
Pflichtfeld	Ja, ein geeigneter Defaultwert ist: keine
Elementspezifisches Qualitätskriterium	Es ist immer einer der vordefinierten Werte auszuwählen. Die Vorbefüllung gibt an, ob dieses Feld durch die nachnutzende Behörde vorzubefüllen ist. Mögliche Ausprägungen sind keine, optional oder verpflichtend. Wenn optional ausgewählt wurde, müssen nachnutzende Systeme darauf achten, dass eine Vorbefüllung hinterlegt werden kann. Wenn verpflichtend ausgewählt wurde, müssen nachnutzende Systeme darauf achten, dass eine Vorbefüllung hinterlegt werden muss.
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	Wird nicht geprüft.
Verweis auf den QS-Bericht	1030
Beispiel	Ein Datenfeld "Flurstücknummer" erhält den Vorbefüllungswert keine. Ein Datenfeld "zuständige Behörde" erhält den Vorbefüllungswert verpflichtend.
mögliche Abweichungen im Referenzkontext	nein

Beschreibung

Aspekt	Beschreibung
Definition	Zusätzliche Beschreibung und Erläuterungen eines Datenfelds für FIM-Nutzer. Dies kann z. B. ein Hinweis an den Fachpaten bzw. ans Fachverfahren sein.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Über die Beschreibung können Umsetzungshinweise zu einem Datenfeld ergänzt werden, außerdem können hier Hinweise an andere Modellierende hinterlegt werden. Vorstellbar sind Hinweise zu Codelisten und Quellen Möglichkeit der Abkürzung Zeichenbeschränkung Notwendigkeit von verschiedenen Zeichensätzen etc.
Empfehlung für die maximale Länge	5000 Zeichen
Art der Prüfung	Wird nicht geprüft.
Verweis auf den QS-Bericht	x
Beispiel	Datenfeld „Datum (aktuelles)“: Falls technisch möglich, kann dieses Feld auch automatisch mit dem aktuellen Datum belegt werden. In diesem Fall sollte das Feld als read-only gestaltet werden. Datenfeld „Staatsangehörigkeit“: Hier muss die 3. Spalte der Codeliste (Staatsangehörigkeit) angezeigt werden. Verwendete Codeliste: Staatsangehoerigkeit 2021-02-19 Datenfeld „Sterbeurkunde“: Falls die Informationen, die in der Sterbeurkunde stehen, direkt aus den Meldedaten abgerufen werden können, sollte dieser Nachweis nicht eingefordert werden. Datenfeld „Familienname“: Laut BSI TR-03123 soll die Gesamtlänge für Familienname, Titel und Geburtsname nicht mehr als 120 Zeichen betragen. Laut PAuswV soll Name (Familienname und Geburtsname) nicht mehr als 2*26 = 52 Zeichen bzw. 3*40 = 120 Zeichen betragen.
mögliche Abweichungen im Referenzkontext	nein

Bezeichnung Eingabe

Aspekt	Beschreibung
Definition	Bezeichnung des Feldes, welche für den Bürger/das Unternehmen auf Formularen sichtbar ist.
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Ja
Elementspezifisches Qualitätskriterium	Die Bezeichnung Eingabe soll kurz und prägnant sein. Die Bezeichnung Eingabe soll keine expliziten Bezüge zum Kontext herstellen, wenn dies nicht zwingend notwendig ist. Die Bezeichnung Eingabe kann als Frage formuliert werden. Einheiten sollen möglichst Teil der Bezeichnung Eingabe sein (z. B. Miete in Euro pro Monat). Für Datenfelder, bei denen eine Codeliste hinterlegt ist, gilt: Die Bezeichnung muss mit den einzelnen Einträgen der Codeliste stimmig sein.
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	komplett manuell
Verweis auf den QS-Bericht	1009
Beispiel	Positiv: Postfach Negativ: Postfach Anschrift natürliche Person Positiv: Bedürfnisgrund Negativ: Bedürfnisgrund Waffe bzw. Munition (Freitext) Positiv: Geben Sie an, über welches Kommunikationsmedium bzw. -mittel die Person erreichbar ist. Negativ: Bitte geben Sie hier an, über welches Kommunikationsmedium bzw. -mittel die Person erreichbar ist. Negativ (in Zusammenhang mit einer Codeliste): Das Kind: 001 wird vertreten durch einen Beistand / 002 wird vertreten durch einen Vormund / 999 Sonstiges Positiv (in Zusammenhang mit einer Codeliste): Das Kind: 001 wird vertreten durch einen Beistand / 002 wird vertreten durch einen Vormund / 999 hat keine Vertretung durch einen Beistand oder Vormund
mögliche Abweichungen im Referenzkontext	nein

Bezeichnung Ausgabe

Aspekt	Beschreibung
Definition	Bezeichnung des Feldes, welche für den Bürger/das Unternehmen auf Formularen sichtbar ist.
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Ja
Elementspezifisches Qualitätskriterium	Die Bezeichnung soll kurz und prägnant sein. Die Bezeichnung soll keine expliziten Bezüge zum Kontext herstellen, wenn dies nicht zwingend notwendig ist. Die Bezeichnung Ausgabe sollte nicht als Frage formuliert werden. Einheiten sollen möglichst Teil der Bezeichnung Ausgabe sein (z. B. Miete in Euro pro Monat).
Empfehlung für die maximale Länge	255 Zeichen
Art der Prüfung	komplett manuell
Verweis auf den QS-Bericht	1010
Beispiel	Positiv: Postfach Negativ: Postfach Anschrift natürliche Person Positiv: Bedürfnisgrund Negativ: Bedürfnisgrund Waffe bzw. Munition (Freitext)
mögliche Abweichungen im Referenzkontext	nein

Hilfetext Eingabe

Aspekt	Beschreibung
Definition	Erläuternder Hilfetext für den Formularanwender eines Auslöser-Formulars, um zu verdeutlichen, welche Inhalte in einem Datenfeld einzugeben sind bzw. welche Aktion vorzunehmen ist.
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Beschreibung der Bedeutung des Feldes für den Endnutzer auf Inputformularen (Bürger/Unternehmen). Hilfetext sollte eine Ausfüllhilfe für das Datenfeld seine; dies erfolgt z. B. durch aktive Ansprache des Bürgers („Geben Sie… an“) Es sollten sinnvolle Beispiele für die Befüllung des Datenfeldes gegeben werden. Ist in der Bezeichnung Spezialvokabular verwendet worden, sollte es in der Hilfe erklärt werden; z. B. durch die Verwendung von Synonymen. Fremdwörter sollten vermieden werden. Hilfetexte dürfen nur angegeben werden, wenn Sie einen Mehrwert bieten. D. h. insbesondere, dass sie nicht identisch mit der Bezeichnung sein sollen.
Empfehlung für die maximale Länge	500 Zeichen
Art der Prüfung	keine
Verweis auf den QS-Bericht	x
Beispiel	siehe Tabelle
mögliche Abweichungen im Referenzkontext	nein

Hilfetext Ausgabe

Aspekt	Beschreibung
Definition	Erläuternder Hilfetext für den Formularanwender (Bürger/Unternehmen) eines Ergebnis-Formulars.
Zielgruppe	Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme, Antragstellende
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	Beschreibung der Bedeutung des Feldes für den Endnutzer auf Output- Formularen (Bürger/Unternehmen). Hilfetext sollte Erläuterung zu dem Inhalt des Felds geben („Dieses Feld enthält …“) Ergibt sich aus Anforderungen an die Barrierefreiheit. Hilfetexte dürfen nur angegeben werden, wenn Sie einen Mehrwert bieten, d. h. sie dürfen nicht identisch die Bezeichnung wiedergeben.
Empfehlung für die maximale Länge	500 Zeichen
Art der Prüfung	keine
Verweis auf den QS-Bericht	x
Beispiel	Datenfeld „Sterbeort (Stadt)“: Ort, in dem die Person verstorben ist.
mögliche Abweichungen im Referenzkontext	nein

Verweis auf Regeln

Aspekt	Beschreibung
Definition	Die von einem Datenfeld verwendeten Regeln sind direkt an einem Datenfeld verortet, d. h. das Datenfeld referenziert die IDs dieser Regeln.
Zielgruppe	Modellierende, Dienstleister nachnutzender Systeme
Pflichtfeld	Nein
Elementspezifisches Qualitätskriterium	An einem Datenfeld selbst hängen selten Regeln. Anstelle eines Patterns kann zur Präzisierung eines Datenfelds auch eine Regel genutzt werden, falls kein gültiges Pattern existiert oder falls es dem Modellierenden nicht möglich ist ein Pattern zu schreiben. Es dürfen nur gültige Regel Identifikatoren referenziert werden. Es können mehrere Regeln referenziert werden.
Empfehlung für die maximale Länge	nicht relevant
Art der Prüfung	keine
Verweis auf den QS-Bericht	x
Beispiel	R00 000 001 489 Beispiel für ein Datenfeld ‘IP-Adresse’, in der eine Regel statt einem Pattern eingegeben wurde: Es muss sichergestellt werden, dass es sich bei der getätigten Angabe um eine gültige IP-Adresse handelt.
mögliche Abweichungen im Referenzkontext	nein