Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

3.3 Metadata-Objekt

3.3 Metadata-Objekt

Das Metadata-Objekt enthält alle Informationen über die RUML-Datei selbst.

3.3.1 Pflichtfelder

FeldTypBeschreibung
idUUIDMUSS eine eindeutige Identifikation der RUML-Datei sein (Regel META-01META-01 metadata MUSS id, version, created, modified und status haben.)
versionStringMUSS die Version des Inhalts angeben (Regel META-01META-01 metadata MUSS id, version, created, modified und status haben.). Frei wählbar, wie ein Container-Image-Tag; SOLLTE dem Muster [A-Za-z0-9_][A-Za-z0-9._-]{0,127} entsprechen, damit sie als Versions-Tag einer RUML-URI dienen kann (…/<name>:<version>). Rulemaps SOLLTEN Semantic Versioning verwenden; Dateien mit documentType: "law" SOLLTEN das Datum der Gesetzesfassung verwenden (JJJJ-MM-TT, mit .n für eine weitere Fassung am selben Tag)
createdDateTimeMUSS den Erstellungszeitpunkt angeben (Regel META-01META-01 metadata MUSS id, version, created, modified und status haben.)
modifiedDateTimeMUSS den Zeitpunkt der letzten Änderung angeben (Regel META-01META-01 metadata MUSS id, version, created, modified und status haben.) MUSS >= created sein (Regel META-03META-03 modified DARF NICHT vor created liegen.)
statusEnumMUSS den Status der Regelung angeben (Regel META-01META-01 metadata MUSS id, version, created, modified und status haben.) MUSS einer der definierten Status-Werte sein (Regel META-02META-02 status MUSS einer der sieben Werte aus 3.3.3 sein.)

3.3.2 Optionale Felder

FeldTypBeschreibung
titleStringDARF einen menschenlesbaren Titel der Rulemap enthalten.
descriptionStringDARF eine kurze Beschreibung der Rulemap enthalten.
documentTypeEnumDARF den Typ des Dokuments klassifizieren. MUSS wenn vorhanden einer der definierten Werte sein (Regel META-05META-05 documentType MUSS einer der Werte aus 3.3.6 sein.). Siehe Abschnitt 3.3.6 für die vollständige Werteliste.
authorsArray[Object]DARF eine Liste von Autoren enthalten. MUSS wenn vorhanden mindestens einen Eintrag enthalten (Regel META-06META-06 authors MUSS mindestens einen Eintrag haben, und jeder Eintrag MUSS name haben.). Jedes Objekt MUSS ein name-Feld (String) enthalten (Regel META-06META-06 authors MUSS mindestens einen Eintrag haben, und jeder Eintrag MUSS name haben.). Die Felder email (String, RFC 5321) und organization (String) sind optional. Hinweis: authors[].organization bezeichnet die institutionelle Zugehörigkeit des Autors — nicht die herausgebende Organisation des Dokuments (siehe organization).
organizationStringDARF die herausgebende Organisation angeben (wer ist institutionell für das Dokument verantwortlich). Hinweis: Unterschied zu authors[].organization: Dieses Feld beschreibt die Verantwortung für das Dokument, nicht die Zugehörigkeit einer Einzelperson.
jurisdictionStringDARF den Rechtsraum angeben. MUSS mit ISO 3166-1 alpha-2 Ländercode beginnen (Regel META-07META-07 jurisdiction MUSS mit einem ISO-3166-1-Alpha-2-Ländercode beginnen; ein Parser MUSS danach bindestrichgetrennte Unterteilungen akzeptieren.). DARF mit Bindestrichen getrennte Untergliederungen enthalten (Regel META-07META-07 jurisdiction MUSS mit einem ISO-3166-1-Alpha-2-Ländercode beginnen; ein Parser MUSS danach bindestrichgetrennte Unterteilungen akzeptieren.). Format: "CC" oder "CC-XX" oder "CC-XX-YY-...". Beispiele: "DE", "DE-BY", "DE-BY-M", "DE-BY-09162".
legalDomainStringDARF das Rechtsgebiet angeben.
tagsArray[String]DARF Kategorisierung/Verschlagwortung enthalten.
derivedFromObjectDARF Informationen über die Herkunft enthalten. MUSS bei Arbeitskopien verwendet werden.
languageStringDARF die Sprache angeben. MUSS dem ISO 639-1 Format entsprechen (z.B. "de", "en") (Regel META-08META-08 language MUSS ein ISO-639-1-Code sein.).
validFromDateTimeDARF den Gültigkeitsbeginn angeben.
validUntilDateTimeDARF das Gültigkeitsende angeben. Wenn sowohl validFrom als auch validUntil gesetzt sind, MUSS validUntil > validFrom sein (Regel META-09META-09 Sind beide gesetzt, MUSS validUntil später als validFrom sein.).
replacesUUIDDARF auf eine ersetzte Version verweisen. DARF zusammen mit replacedBy verwendet werden (Regel META-04META-04 Ein Parser MUSS jedes optionale Feld aus 3.3.2 und derivedFrom.originalHash akzeptieren, ob vorhanden oder nicht, auch replaces und replacedBy zusammen.).
replacedByUUIDDARF auf eine Nachfolgeversion verweisen. DARF zusammen mit replaces verwendet werden (Regel META-04META-04 Ein Parser MUSS jedes optionale Feld aus 3.3.2 und derivedFrom.originalHash akzeptieren, ob vorhanden oder nicht, auch replaces und replacedBy zusammen.).
commentStringDARF einen Freitext-Kommentar zum Dokument enthalten, z. B. den Grund für den Status suspended.

3.3.3 Status-Werte

Der Status einer RUML-Datei MUSS einer der folgenden Werte sein (Regel META-02META-02 status MUSS einer der sieben Werte aus 3.3.3 sein.):

StatusBeschreibungAnforderungen
"draft"EntwurfKEINE zusätzlichen Anforderungen
"review"In ÜberprüfungSOLLTE authors gesetzt haben
"approved"GenehmigtSOLLTE organization gesetzt haben
"inForce"In KraftMUSS validFrom gesetzt haben (Regel META-10META-10 Status inForce MUSS validFrom gesetzt haben.) SOLLTE jurisdiction gesetzt haben
"suspended"AusgesetztSOLLTE validUntil oder comment gesetzt haben
"expired"AbgelaufenMUSS validUntil gesetzt haben (Regel META-11META-11 Status expired MUSS validUntil gesetzt haben, und dieser Wert MUSS in der Vergangenheit liegen.) validUntil MUSS in der Vergangenheit liegen (Regel META-11META-11 Status expired MUSS validUntil gesetzt haben, und dieser Wert MUSS in der Vergangenheit liegen.)
"replaced"ErsetztMUSS replacedBy gesetzt haben (Regel META-12META-12 Status replaced MUSS replacedBy gesetzt haben.)

Zusätzliche Regeln:

  • Der Status MUSS bei jeder inhaltlichen Änderung geprüft werden
  • Bei Statuswechsel von "draft" zu "inForce" MÜSSEN alle Pflichtfelder validiert sein
  • Ein Status "replaced" DARF NICHT zurück auf einen anderen Status gesetzt werden

Hinweis: Dokument-Status vs. Knotenstatus

Die hier definierten Status-Werte (draft, review, approved, inForce, suspended, expired, replaced) beschreiben den Dokument-Status der RUML-Datei. Sie werden im metadata.status-Feld gespeichert und beschreiben den Gültigkeitszustand des gesamten Regelwerks.

Diese sind zu unterscheiden vom Knotenstatus (pending, true, false, undefined, ignored), der zur Laufzeit während der Auswertung berechnet wird. Der Knotenstatus wird NICHT in der RUML-Struktur gespeichert, sondern ausschließlich in einer separaten RUML-Result-Datei (.ruml-result). Details siehe Kapitel 5.

3.3.4 Beispiel Metadata-Objekt

"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "2024.1.0",
"created": "2024-01-15T10:00:00+01:00",
"modified": "2024-02-01T14:30:00+01:00",
"status": "inForce",
"documentType": "law",
"authors": [
{
"name": "Max Mustermann",
"email": "max.mustermann@bmf.bund.de",
"organization": "Bundesministerium der Finanzen"
}
],
"jurisdiction": "DE",
"legalDomain": "Steuerrecht",
"language": "de",
"validFrom": "2024-01-01T00:00:00+01:00",
"tags": ["Einkommensteuer", "§32a", "Grundtarif"]
}

Hinweise:

  • Dieses Beispiel zeigt ein Metadata-Objekt mit Status "inForce" und documentType: "law"

  • Das erforderliche Feld validFrom ist gesetzt

  • Die optionalen Felder jurisdiction, legalDomain etc. sind beispielhaft befüllt

  • Integritätssicherung (Hashing, Signaturen) erfolgt auf Container-Ebene (siehe Kapitel 7)

3.3.5 Arbeitskopien von Dokumenten mit Status "inForce"

Grundprinzip: Dokumente mit Status "inForce" SOLLTEN NICHT verändert werden. Die Unveränderlichkeit wird durch Signaturen auf Container-Ebene gewährleistet (siehe Kapitel 7). Arbeitskopien MÜSSEN möglich sein.

Regeln für Arbeitskopien:

  1. Bei der Erstellung einer Arbeitskopie MUSS:
  • Eine neue UUID vergeben werden
  • Der Status auf "draft" geändert werden
  • Die Herkunft im derivedFrom-Objekt dokumentiert werden
  1. Das derivedFrom-Objekt:
FeldTypBeschreibung
originalIdUUIDMUSS die ID des Originaldokuments enthalten (Regel META-13META-13 derivedFrom MUSS originalId, originalStatus, derivationType und derivedAt enthalten.)
originalHashStringDARF den Hash des Originaldokuments enthalten (Regel META-04META-04 Ein Parser MUSS jedes optionale Feld aus 3.3.2 und derivedFrom.originalHash akzeptieren, ob vorhanden oder nicht, auch replaces und replacedBy zusammen.). Der Hash wird auf Container-Ebene berechnet (siehe Kapitel 7).
originalStatusEnumMUSS den Status des Originals zum Zeitpunkt der Kopie enthalten (Regel META-13META-13 derivedFrom MUSS originalId, originalStatus, derivationType und derivedAt enthalten.)
derivationTypeEnumMUSS den Typ angeben: "workingCopy", "amendment", "revision" (Regel META-13META-13 derivedFrom MUSS originalId, originalStatus, derivationType und derivedAt enthalten.)
derivedAtDateTimeMUSS den Zeitpunkt der Kopie-Erstellung enthalten (Regel META-13META-13 derivedFrom MUSS originalId, originalStatus, derivationType und derivedAt enthalten.)
derivedByStringSOLLTE die erstellende Stelle/Person angeben
  1. Validierung bei Arbeitskopien:
  • Das System DARF die Integrität des Originals über den Container-Hash verifizieren (siehe Kapitel 7)
  • Das System MUSS sicherstellen, dass die Kopie NICHT als "inForce" markiert ist (Regel META-14META-14 Eine Arbeitskopie (derivedFrom.derivationType: "workingCopy") DARF NICHT den Status inForce haben.)
  • Das System SOLLTE die Abstammungskette nachvollziehbar machen

Beispiel einer Arbeitskopie:

"metadata": {
"id": "d8129e0c-cf2e-4ef9-b7b6-fa8b206d5517",
"version": "1.0.1-draft",
"created": "2024-01-15T10:00:00+01:00",
"modified": "2024-01-15T10:00:00+01:00",
"status": "draft",
"derivedFrom": {
"originalId": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"originalHash": "sha3-256:4e03657aea45a94fc7d47c89e3f5a2b7c4d8e9f0a1b2c3d4e5f6a7b8c9d0e1f2",
"originalStatus": "inForce",
"derivationType": "workingCopy",
"derivedAt": "2024-01-15T10:00:00+01:00",
"derivedBy": "Bundesministerium der Justiz"
}
}

Hinweis: Diese Struktur ermöglicht es Legisten, mit Kopien rechtskräftiger Dokumente zu arbeiten. Die Integrität und Unveränderlichkeit der Originale wird durch Signaturen auf Container-Ebene gewährleistet (siehe Kapitel 7).

3.3.6 documentType-Werte

Das optionale Feld documentType klassifiziert den Dokumenttyp der RUML-Datei. Es MUSS wenn vorhanden einer der folgenden Werte sein (Regel META-05META-05 documentType MUSS einer der Werte aus 3.3.6 sein.):

WertBeschreibung
"law"Formelles Gesetz (z.B. EStG, BGB, SGB)
"regulation"Verordnung, Satzung oder verbindliche Regelung — öffentlich-rechtlich (z.B. Durchführungsverordnung) oder privatwirtschaftlich (z.B. interne Unternehmensrichtlinie mit Verbindlichkeitscharakter)
"guideline"Leitfaden, Handlungsempfehlung oder nicht-verbindliche Vorgabe — z.B. Verwaltungsvorschrift, Compliance-Leitlinie, Best-Practice-Dokument
"decision"Entscheidungslogik für regelbasierte Bescheide oder Urteile — öffentlich-rechtlich (z.B. Verwaltungsentscheid, Gerichtsurteil) oder privatwirtschaftlich (z.B. Kreditentscheidung, Compliance-Prüfung, Versicherungsfall)
"procedure"Prozess- oder Verfahrensbeschreibung — z.B. Verwaltungsverfahren, Genehmigungsprozess, unternehmensinterner Workflow
"form"Strukturierter Erfassungs- oder Antragsprozess — z.B. Antragsformular, Onboarding-Prozess, Datenerhebung
"documentGeneration"Rulemap zur regelbasierten Generierung von Dokumenten — z.B. Bescheide, Verträge, Berichte, Zertifikate. Die Auswertung erzeugt als Ergebnis ein oder mehrere Dokumente.
"other"Sonstige Dokumenttypen, die keinem der spezifischeren Werte entsprechen

Hinweise:

  • Das Feld documentType ist unabhängig vom Feld legalDomain: legalDomain beschreibt den fachlichen Anwendungsbereich (z.B. "Steuerrecht", "Kreditwesen", "HR-Compliance"), documentType beschreibt die Form des Dokuments (z.B. "decision", "documentGeneration")
  • Der Wert "other" SOLLTE NICHT verwendet werden, wenn einer der spezifischeren Werte passt
  • Die Werteliste DARF in zukünftigen Versionen der Spezifikation erweitert werden
  • documentType ist die einzige Klassifikation einer RUML-Datei. Das rulemap-Objekt enthält bewusst kein type-Feld — die Dokument-Klassifikation ist ausschließlich im metadata-Objekt verortet.

Konformitätstests