Sie sind hier:

Codelisten-Handbuch

Mit dem Codelisten-Handbuch wird allen an der Herausgabe und Nutzung von Codelisten Beteiligten eine gemeinsame Basis für eine transparente, qualitätsgesicherte und letztendlich effiziente Ausgestaltung ihrer Aufgaben und Prozesse geboten. Diese gemeinsame Basis wird gebildet durch den in Teil 1 des Handbuchs dokumentierten Standard. Darin werden Metadatenelementen zur Beschreibung von Codelisten, Codelistenversionen sowie den in den Codelisten(-versionen) gehaltenen Daten spezifiziert.

Neben der Spezifikation dieser Metadatenelemente, ihrer semantischen Bedeutung und ihrer Multiplizitäten sind mit dem Standard allgemeine Regelungen in Form von Konformitätskriterien gegeben. Diese Kriterien regeln neben der Verwendung der Metadatenelemente auch die Ausgestaltung und Bereitstellung von Codelisten. So wird mit dem Standard die Möglichkeit geboten, die formale Qualität von Codelisten unabhängig von ihrem jeweiligen technischen Format auf der Basis der im Standard dokumentierten Kriterien festzustellen. Mit der Anwendung des Standards und des darin enthaltenen Konzepts zur Konformität von Codelisten kann die (semantische) Interoperabilität der an den Prozessen der Herausgabe und Nutzung von Codelisten beteiligten Organisationen gesteigert werden.

Die Abbildung von Codelisten in technische Formate ist nicht Bestandteil des Standards und besitzt somit keine Relevanz für die Konformität von Codelisten. Dieser Ansatz trägt der Anforderung Rechnung, dass Codelisten unter vielfältigsten technischen, organisatorischen und rechtlichen Rahmenbedingungen herausgegeben und genutzt werden. Die Einschränkung auf ein technisches Abbildungs- bzw. Austauschformat würde die angestrebte Interoperabilität wesentlich behindern.

Selbstverständlich erfordert die letztendliche Nutzung von Codelisten in der Praxis auch deren Abbildung in technisch verarbeitbare Formate. Wie eine solche Abbildung erfolgt und welchen Anforderungen sie entsprechen muss wird in Abschnitt 3 des Handbuchs beschrieben.


Zielgruppe und Zweck

Zielgruppe dieses Dokuments sind somit neben anderen die folgenden Organisationen

  • Organisationen, die Codelisten-relevante Inhalte bereitstellen
  • Betreiber von Standards
  • Betreiber von Plattformen zur Nachveröffentlichung
  • Betreiber von IT-Verfahren
  • Hersteller von IT-Verfahren
  • etc.

In diesem Zusammenhang sollen insbesondere die Mitarbeitenden der oben genannten Organisationen angesprochen werden, die in den Rollen Fachexperte, Fachlicher Entscheider, IT-Architekt und IT-Entwickler agieren.


Bezug

Das Codelisten-Handbuch kann hier in der aktuellen Version bezogen werden.


Betrieb

Das Codelisten-Handbuch wird im geregelten Betrieb unter direkter Beteiligung der betroffenen Nutzer fortentwickelt. Änderungsanträge können Sie direkt über diese Webseite stellen. Die Gültigkeit der Handbuchversionen im Zusammenhang mit den XÖV-Produkten entnehmen Sie bitte der Konfigurationstabelle.
Änderungsanträge und ggf. die Planung zur Umsetzung sind öffentlich einsehbar auf dieser Gitlab-Seite.


Versionen

Tabelle
VersionZusammenfassung und relevante Änderungen
1.2.1 (pdf, 1.5 MB)Abschnitt 1.2: Korrektur eines Tippfehlers. Abschnitt 1.3: Korrektur eines Tippfehlers. Abschnitt 3.1: Korrektur eines Tippfehlers: Es wurde fälschlich der Namensraum http://xoev.de/schemata/genericode/3“ statt „http://xoev.de/schemata/genericode/4“ benannt. Appendix D: Eintrag zum XÖV-Primer in das Glossar eingefügt. Hinweis auf erfolgte Abschaltung des Genericoders.
1.2 (pdf, 1.5 MB)Abschnitt 1.2: Neuer Abschnitt zu mehrsprachigen Codelisten. Abschnitt 1.3: Hinweise zur Verwendung der Metadaten in mehrsprachigen Codelisten wurden ergänzt. Abschnitt 1.5: Regelungen bezüglich mehrsprachigen Codelisten wurden hinzugefügt (K-10 bis K-13). Kapitel 3: Übersichten wurden um mehrsprachige Elemente ergänzt. Abschnitt 3.2: Bisheriger Abschnitt 3.2 (Intermediärformat Microsoft Excel) entfällt. Ehemals Abschnitt 3.3: Der Abschnitt 3.2.3 "Modellierung mehrsprachiger Codelisten" wurde ergänzt. Appendix A: Die Übersicht über das Syntax-Binding wurde um Angaben zur Mehrsprachigkeit ergänzt. Das Binding für MS Excel wurde entfernt. Anhang D. Gloassar: Begrifflichkeiten aus dem Bereich mehrsprachige Codelisten ergänzt. Hinweis auf Abschaltung des Genericoders eingefügt.
1.1 (pdf, 1.4 MB)Abschnitt 1.2: Multiplizität des Codelisten-Metadatums Herausgebername (kurz) von 0..1 zu 1 geändert. (Issue 9) Abschnitt 3.1: Der einleitende Absatz wurde um Hinweise zu den ergänzten XÖV-spezifischenMetadaten-Elementen erweitert. (Issue 23) Abschnitt 3.1.1: Der einleitende Absatz wurde redaktionell überarbeitet. (Issue 7)
1.0 (pdf, 1.4 MB)Initiale Erstellung der Codelisten-Handbuchs.