Informationen zu den Metadaten
Name
| Aspekt | Beschreibung |
|---|---|
| Definition | FIM-interner Name des Dokumentsteckbriefs, 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 | Konstruktionsregeln für die Namensgebung werden in einem gesonderten Abschnitt betrachtet. |
| Empfehlung für die maximale Länge | 500 Zeichen |
| Art der Prüfung | Komplett manuell |
| Verweis auf den QS-Bericht | x |
| Beispiel | Beispiele finden sich auch im Abschnitt zur Namensgebung. |
| mögliche Abweichungen im Referenzkontext | nein |
Definition
| Aspekt | Beschreibung |
|---|---|
| Definition | Fasst den Inhalt des beschriebenen Dokuments redaktioneller Sicht zusammen. Die Definition muss gegenüber dem Namen des Dokumentsteckbriefs einen Mehrwert bieten. |
| Zielgruppe | Modellierende, Fachlichkeit |
| Pflichtfeld | Ja |
| Elementspezifisches Qualitätskriterium | In dieser Angabe sollte möglichst verständlich und prägnant wiedergegeben werden, was die Bewandtnis dieses Dokuments ist. Dabei ist zu beachten, dass in der Definition nur das eigentlich Dokument zu beschreiben ist und keine darüberhinaus gehenden Informationen vermittelt werden. Die Definition beschreibt beispielsweise das Initialisierungsdokument d. h. einen Antrag oder eine Anzeige, aber nur das Dokument und nichts Weitergehendes; spezifische Angaben zum Antrag oder zur Anzeige selbst werden nicht gemacht. Außerdem sollte sie eine Hilfestellung für Modellierende sein, wenn es darum geht einem Schema und auch Prozessen die richtigen Dokumentsteckbriefe zuzuordnen. Entsprechende Angaben sind gemäß von Handlungsgrundlagen zu machen. |
| Empfehlung für die maximale Länge | 5000 Zeichen |
| Art der Prüfung | Komplett manuell |
| Verweis auf den QS-Bericht | x |
| Beispiel |
|
| mögliche Abweichungen im Referenzkontext | nein |
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 | |
| Zielgruppe | Modellierende, Fachlichkeit |
| Pflichtfeld | Ja |
| Elementspezifisches Qualitätskriterium 🆕 | Hilfestellung zur Identifizierung der entsprechenden Handlungsgrundlage für Dokumentsteckbrief werden in einem separaten Abschnitt behandelt. |
| Empfehlung für die maximale Länge | 255 Zeichen pro Bezug; ein Element kann davon mehrere haben. |
| Art der Prüfung | Komplett manuell |
| Verweis auf den QS-Bericht | x |
| Beispiel |
|
| mögliche Abweichungen im Referenzkontext | nein |
Link 🆕
| Aspekt | Beschreibung |
|---|---|
| Definition | Dieses Attribut ermöglicht es, zu jedem Bezug einen entsprechenden Link anzugeben. |
| Zielgruppe | Modellierende, Fachlichkeit |
| Pflichtfeld | Nein |
| Elementspezifisches Qualitätskriterium |
|
| Empfehlung für die maximale Länge | 255 Zeichen |
| Art der Prüfung | Exemplarisch manuell |
| Verweis auf den QS-Bericht | x |
| Beispiel | DOKUMENTSTECKBRIEF BEISPIELE ERGÄNZEN
|
| mögliche Abweichungen im Referenzkontext | nein |
Bezeichnung
| Aspekt | Beschreibung |
|---|---|
| Definition | Bezeichnung des Dokumentsteckbriefs, welche für den Bürger/das Unternehmen über den Baustein Leistungen sichtbar ist. |
| Zielgruppe | Modellierende, Fachlichkeit, Dienstleister nachnutzender Systeme, Antragstellende |
| Pflichtfeld | Ja |
| Elementspezifisches Qualitätskriterium | |
| Empfehlung für die maximale Länge | 255 Zeichen |
| Art der Prüfung | komplett manuell |
| Verweis auf den QS-Bericht | x |
| Beispiel | |
| mögliche Abweichungen im Referenzkontext | nein |
Dokumentart
| Aspekt | Beschreibung |
|---|---|
| Definition | Über die Dokumentart wird an einem Dokumentsteckbrief hinterlegt, um welche Art von Dokument es sich bei diesem Steckbrief handelt. |
| Zielgruppe | Modellierende, Fachlichkeit |
| Pflichtfeld | Ja, ein geeigneter Defaultwert ist unbestimmt. |
| Elementspezifisches Qualitätskriterium |
|
| Empfehlung für die maximale Länge | nicht relevant |
| Art der Prüfung | keine |
| Verweis auf den QS-Bericht | x |
| Beispiel |
|
| mögliche Abweichungen im Referenzkontext | nein |
Ist abstrakt?
| Aspekt | Beschreibung |
|---|---|
| Definition | Durch dieses Metadaten wird eindeutig beschrieben, ob es sich bei vorliegenden Dokumentsteckbrief um einen abstrakten handelt. |
| Zielgruppe | Modellierende, Fachlichkeit |
| Pflichtfeld | Ja, ein geeigneter Defaultwert lautet nein |
| Elementspezifisches Qualitätskriterium |
|
| Empfehlung für die maximale Länge | nicht relevant |
| Art der Prüfung | keine |
| Verweis auf den QS-Bericht | x |
| Beispiel |
|
| mögliche Abweichungen im Referenzkontext | nein |