1.0.0
Erforderliche Unterlagen
| Fachliche Kategorie | Technische Kategorie |
|---|---|
| Stammdaten der Leistung | XZuFi-basierte Parameter ohne direkten Onlinedienst-Bezug |
Fachliche Bedeutung
Erforderliche Unterlagen. Diese Angabe spezifiziert für eine Leistung beizubringende Dokumente. Ein Dokument bezeichnet einen physischen oder elektronischen Informationsträger.
Wertemenge
Eine Menge von komplexen Datenstrukturen Dokument, die jeweils die folgenden Elemente enthalten:
- typ: Ein Dokumententyp als Code aus der Code-Liste
urn:de:fim:codeliste:dokumenttyp - bezeichnung: Eine Bezeichnung als internationalisierte Zeichenkette
- beschreibung: Eine Beschreibung als internationalisierte Zeichenkette
- referenzFormularID: Referenzen auf Formulare (i.e. FormularIDs)
- angabeSignatur: Einen Code aus der Code-Liste
urn:xoev-de:fim:codeliste:xzufi.signatur, der bestimmt, ob bzw. welche Stufe einer Signatur notwendig ist.
Die (optionalen) Referenzen auf Formular-IDs sind Stand Q2/2024 für einen Onlinedienst nur schwer nutzbar, da es keine Möglichkeit gibt, Formulardaten anhand einer ID direkt aus dem PVOG abzufragen. Vielmehr sind Formulare im PVOG stets Stammdaten der Organisationseinheiten. Weil für eine Leistung in der Regel mehrere - oder sogar sehr viele - Organisationseinheiten zuständig sind, und deren Zuständigkeit wieder an ein Gebiet gekoppelt ist, das in der Regel kleiner ist als das Zuständigkeitsgebiet der Leistung, ist es nicht möglich, die Formulardaten, auf die hier referenziert wird, zu ermitteln. Der Mechanismus der FormularIDs ist in XZuFi vollständig generisch, so dass es zusätzlicher Abprachen und Vorgaben bedarf, um diese Daten maschinell auswertbar zu machen. Besteht eine solche Anforderung, so ist es die Aufgabe des Architekten des Onlinedienstes, individuell einen Mechanismus zu finden, der von nachnutzenden Ländern genutzt werden kann.
All dies ist aber nur relevant für erforderliche Unterlagen, die Formulare sind. Andere Dokumente wie z.B. Geburtsurkunden, haben ohnehin keine referenzFormularID.
Verortung im Datenmodell
Die Leistungsinformationen zu den erforderlichen Unterlagen werden in optionalen Elementen dokumentEingehend abgelegt, die Teil des ebenfalls optionalen Elements modulDokument sind, das Teil des Elements Leistung ist.
Ermittlungsmöglichkeit PVOG API
Zunächst ermittelt der Onlinedienst die Daten der Leistungsbeschreibung.
In der Response findet sich ein Element modulDokument:dokumentEinhegend[], das die gesuchten Informationen in den Kind-Elementen typ, bezeichnung[], beschreibung[], referenzFormularID[] und angabeSignatur enthält.
Ermittlungsmöglichkeit FIT-Connect Routing API
(Der Parameter kann nicht über das FIT-Connect Routing API ermittelt werden)
Über die FIT-Connect Routing API können Informationen zu den erforderlichen Unterlagen in unstrukturierter Form ermittelt werden, sofern diese im PVOG vorhanden sind. Diese Informationen stammen aus einer anderen Quelle im XZuFi-Datenmodell, nämlich einem TextModul mit dem Diskriminator leikaTextmodul:code = 08 (für "erforderliche Dokumente"). Dieser Typ von Textmodul ist z.B. für die Anzeige in einem Informationsportal gut geeignet, aber nicht, um z.B. das vorliegen aller erforderlicher Dokumente automatisiert und dialog-gestützt validieren zu können.
Der Onlinedienst benutzt zur Ermittlung dieser alternativen Informationen den Endpunkt /routes mit den URL-Parametern zur Identifikation des gesuchten Adressaten, z.B. leikaKey = <LeikaId der Leistung> und ars = <ARS des gesuchten Gebiets> und erhält eine JSON-Datenstruktur als Response.
In dieser Datenstruktur enthält das Element route[]:requiredDocuments:description, das einen internationalisierten Text enthält, der die erforderlichen Unterlagen beschreibt.
Ermittlungsmöglichkeit DVDV API
(Der Parameter kann nicht über das DVDV-API ermittelt werden)
Best Practices
(keine Empfehlungen)