4.7 DataPoints
4.7 DataPoints
Overview
| Property | Value |
|---|---|
| Capability ID | ruml:datapoints |
| Scope | Root level (payload.data of the ruml:datapoints entry) |
Default required | false |
| Role | data |
DataPoints define the structured data required for decisions in the rulemap. They describe the schema of the data (name, type, validation) as well as a binding hint that indicates how the data should be obtained.
Core Principle: Schema-First
RUML follows the schema-first principle:
- In the RUML file: Only the data definition (What is needed?)
- At runtime: The actual values are provided by the tool
Embedding via the ruml:datapoints Capability
DataPoints are defined in the data object of the ruml:datapoints capability in the root
capabilities array. Reusable structured types are declared alongside in an optional sets object
(see 4.7.4):
{ "$format": "RUML", "$specVersion": "1.0", "capabilities": [ { "id": "ruml:datapoints", "payload": { "sets": { "set_person": {/* ... */}, "set_beschaeftigung": {/* ... */} }, "data": { "dp_annual_income": {/* ... */}, "dp_credit_score": {/* ... */} } } } ], "metadata": {/* ... */}, "rulemap": {/* ... */}}Note: For map structures like data, the object key (e.g., "dp_annual_income") serves as the
unique identifier. A separate id field is therefore not required (see
Chapter 3.2.6 — design principle “Key = ID”).
Note on usage by other capabilities: DataPoints exclusively define the data schema and
procurement. The collected data is available to other capabilities as a foundation — e.g.,
ruml:query for calculations and evaluations (see Chapter 4.8) or
ruml:ai-query for AI-powered decisions (see Chapter 4.9).
Basic Structure
"dp_annual_income": { "name": "Jahreseinkommen", "description": "Brutto-Jahreseinkommen des Antragstellers", "type": "currency", "unit": "EUR", "validation": { "required": true, "min": 0, "max": 10000000 }, "binding": { "type": "input" }}Required Fields
| Field | Type | Description |
|---|---|---|
name | String | MUST contain a display name (Rule DP-01DP-01 A DataPoint MUST have name, type and binding, and type MUST be one of the data types of 4.7.1.) |
type | Enum | MUST specify one of the defined data types (see 4.7.1) (Rule DP-01DP-01 A DataPoint MUST have name, type and binding, and type MUST be one of the data types of 4.7.1.) |
binding | Object | MUST specify how the data is obtained (see 4.7.2) (Rule DP-01DP-01 A DataPoint MUST have name, type and binding, and type MUST be one of the data types of 4.7.1.) |
Note: The object key serves as the unique ID of the DataPoint. It MUST match the pattern
[a-z_][a-z0-9_]* (Rule DP-02DP-02 The key of a DataPoint, the id of a set and the keys of a set's fields MUST match the pattern [a-z_][a-z0-9_]*.).
Optional Fields
| Field | Type | Description |
|---|---|---|
description | String | MAY contain a detailed description (Rule DP-03DP-03 A parser MUST accept description, validation and sensitive on any DataPoint, unit for number and percentage, format for location, identifier and address, and cardinality for object.) |
unit | String | MUST be present when type: "currency"; MAY be present when type: "number" or type: "percentage" (e.g., "EUR", "kg", "%") (Rule DP-03DP-03 A parser MUST accept description, validation and sensitive on any DataPoint, unit for number and percentage, format for location, identifier and address, and cardinality for object., Rule DP-05DP-05 A DataPoint with type: "currency" MUST have unit.). MUST NOT be used with other types (Rule DP-04DP-04 A DataPoint MUST NOT have unit, format, options, set or cardinality, nor a validation rule, that 4.7 and 4.7.3 do not provide for its type.). |
format | String | MAY refine the type when it is location (see Location Type), identifier (see Identifier Type) or address (see Address Type) (Rule DP-03DP-03 A parser MUST accept description, validation and sensitive on any DataPoint, unit for number and percentage, format for location, identifier and address, and cardinality for object.). MUST NOT be used with other types (Rule DP-04DP-04 A DataPoint MUST NOT have unit, format, options, set or cardinality, nor a validation rule, that 4.7 and 4.7.3 do not provide for its type.). |
options | Array | MUST be present and non-empty when type: "enum" — the permitted values (see Enum Type) (Rule DP-06DP-06 A DataPoint with type: "enum" MUST have a non-empty options, and every option MUST have value.). MUST NOT be used with other types (Rule DP-04DP-04 A DataPoint MUST NOT have unit, format, options, set or cardinality, nor a validation rule, that 4.7 and 4.7.3 do not provide for its type.). |
validation | Object | MAY contain validation rules (see 4.7.3) (Rule DP-03DP-03 A parser MUST accept description, validation and sensitive on any DataPoint, unit for number and percentage, format for location, identifier and address, and cardinality for object.) |
sensitive | Boolean | MAY indicate whether the data is sensitive. Default: false (Rule DP-03DP-03 A parser MUST accept description, validation and sensitive on any DataPoint, unit for number and percentage, format for location, identifier and address, and cardinality for object.) |
set | String | MUST be present when type: "object" — the id of the set type in sets (see 4.7.4) (Rule DP-07DP-07 A DataPoint with type: "object" MUST have set.). MUST NOT be used with other types (Rule DP-04DP-04 A DataPoint MUST NOT have unit, format, options, set or cardinality, nor a validation rule, that 4.7 and 4.7.3 do not provide for its type.). |
cardinality | Object | MAY be present when type: "object" — { "min": Integer, "max": Integer } for repetition; min MUST be at least 0 and max at least 1 (Rule DP-08DP-08 cardinality.min MUST be an integer of at least 0 and cardinality.max an integer of at least 1; minLength and maxLength MUST be integers from 0 to 253 − 1.). Absent = single instance; max > 1 = a list of instances. MUST NOT be used with other types (Rule DP-04DP-04 A DataPoint MUST NOT have unit, format, options, set or cardinality, nor a validation rule, that 4.7 and 4.7.3 do not provide for its type.). |
4.7.1 Data Types
The type field of a DataPoint defines the expected data type. RUML distinguishes between primitive
and specialized data types.
Primitive Types
| Type | Description | Example Value |
|---|---|---|
string | Text | "Max Mustermann" |
number | Number (integer or decimal) | 50000, 3.14 |
boolean | Boolean value | true, false |
date | Date without time | "2024-01-01" |
datetime | Date with time | "2024-01-01T10:00:00Z" |
time | Time without date | "14:30:00" |
integer | Integer (positive or negative) | 42, -7 |
Specialized Types
| Type | Description | Format | Example Value |
|---|---|---|---|
currency | Monetary amount | Number, unit via unit | 50000 (with "unit": "EUR") |
percentage | Percentage | Number between 0 and 100 | 32.5 |
duration | Time duration | ISO 8601 Duration | "P2Y3M" (2 years, 3 months) |
email | Email address | RFC 5322 | "max@example.com" |
phone | Phone number | E.164 | "+491234567890" |
location | Geographic location | See location formats | "DE", "DE-BY", "80331" |
identifier | Official identifier | String with format hint | "DE123456789" (VAT ID) |
iban | Bank account | ISO 13616 | "DE89370400440532013000" |
count | Count/quantity | Non-negative integer | 3 |
url | URL/URI | RFC 3986 | "https://example.com/bescheid/123" |
address | Structured postal address | See address formats | {"street": "Musterstr. 1", ...} |
enum | Selection from value list | Value from options | "married" |
object | Instance of a reusable set type | References a set; may repeat via cardinality (see 4.7.4) | { "dp_vorname": "Eva", "dp_nachname": "Schneider" } |
Location Type
The location type allows specifying geographic locations at various levels. The optional format
field specifies the expected granularity:
| Format | Description | Example Value |
|---|---|---|
country | Country (ISO 3166-1 alpha-2) | "DE", "AT", "CH" |
region | Country with subdivision (ISO 3166-2) | "DE-BY", "AT-9" |
union | State union | "EU", "EFTA", "EEA" |
postal | Postal code | "80331", "1010" |
municipality | Municipality key | "09162000" (Munich) |
coordinates | GPS coordinates | "48.1351,11.5820" |
Example:
"dp_residence": { "name": "Wohnsitz", "description": "Land des Hauptwohnsitzes", "type": "location", "format": "country", "validation": { "required": true, "enum": ["DE", "AT", "CH"] }, "binding": { "type": "input" }}"dp_jurisdiction": { "name": "Rechtsraum", "description": "Anwendbarer Rechtsraum", "type": "location", "format": "union", "validation": { "enum": ["EU", "EWR", "EFTA"] }, "binding": { "type": "input" }}Address Type
The address type allows specifying structured postal addresses.
| Field | Type | Description |
|---|---|---|
street | String | Street and house number |
postalCode | String | Postal code |
city | String | City |
region | String | State/canton (ISO 3166-2) |
country | String | Country (ISO 3166-1 alpha-2) |
Example:
"dp_residence_address": { "name": "Wohnadresse", "description": "Hauptwohnsitz des Antragstellers", "type": "address", "validation": { "required": true }, "binding": { "type": "input" }}Identifier Type
The identifier type is used for official identifiers. The format field SHOULD specify the type
of identifier:
| Format | Description | Example Value |
|---|---|---|
taxId | Tax identification number | "12345678901" |
vatId | VAT ID | "DE123456789" |
socialSecurity | Social security number | "12345678A123" |
passport | Passport number | "C01X00T47" |
nationalId | National ID card number | "L01X00T47" |
commercial | Commercial register number | "HRB 12345" |
custom | User-defined | Arbitrary |
Example:
"dp_tax_id": { "name": "Steuer-ID", "description": "Deutsche Steueridentifikationsnummer", "type": "identifier", "format": "taxId", "validation": { "required": true, "pattern": "^[0-9]{11}$" }, "binding": { "type": "input" }}Enum Type
The enum type allows selection from a predefined value list. The options field MUST define the
permitted values:
"dp_marital_status": { "name": "Familienstand", "type": "enum", "options": [ { "value": "single", "label": "Ledig" }, { "value": "married", "label": "Verheiratet" }, { "value": "divorced", "label": "Geschieden" }, { "value": "widowed", "label": "Verwitwet" } ], "binding": { "type": "input" }}Note: The options array MUST contain at least one entry. Each entry MUST contain a value
field and SHOULD contain a label field for display purposes (Rule DP-06DP-06 A DataPoint with type: "enum" MUST have a non-empty options, and every option MUST have value.).
Usage Notes
Currency:
- The
currencytype MUST be used together with theunitfield (Rule DP-05DP-05 A DataPoint withtype: "currency"MUST haveunit.) - The unit SHOULD conform to the ISO 4217 currency code (e.g.,
"EUR","USD","CHF")
"dp_loan_amount": { "name": "Kreditsumme", "type": "currency", "unit": "EUR", "binding": { "type": "input" }}Duration:
- Time durations MUST be specified in ISO 8601 Duration format
- Format:
P[n]Y[n]M[n]DT[n]H[n]M[n]S
| Example | Meaning |
|---|---|
"P1Y" | 1 year |
"P6M" | 6 months |
"P30D" | 30 days |
"PT24H" | 24 hours |
"P2Y3M15D" | 2 years, 3 months, 15 days |
Date and DateTime:
dateMUST conform to the formatYYYY-MM-DDdatetimeMUST conform to the ISO 8601 format and SHOULD include a timezone
Time:
- Times MUST be specified in the format
HH:MM:SS(ISO 8601) - The seconds component MAY be omitted:
"14:30"is valid
Integer:
- The
integertype allows positive and negative integers - For non-negative integers (counts),
countSHOULD be used instead
Count:
- The
counttype MUST be a non-negative integer - Typical usage: number of children, number of employees, etc.
"dp_children_count": { "name": "Anzahl Kinder", "type": "count", "validation": { "min": 0, "max": 20 }, "binding": { "type": "input" }}URL:
- URLs MUST conform to the RFC 3986 format
- Tools SHOULD NOT check reachability at validation time
4.7.2 Binding Types
The binding field of a DataPoint indicates how the data should be obtained at runtime. It serves
as a hint for the executing tool and enables clear categorization of data sources.
Basic Structure
"binding": { "type": "input"}Binding Types
| Type | Description | Tool Behavior |
|---|---|---|
input | User input required | Tool generates form field or chatbot question |
external | External data source | Tool displays configuration dialog for data source |
computed | Derived from other DataPoints via a JSONata expression | Tool computes the value at evaluation time — no user input |
Input Binding
The input type signals that this value must be entered by the user. The tool SHOULD automatically
generate an appropriate input element based on the DataPoint schema.
"dp_annual_income": { "name": "Jahreseinkommen", "type": "currency", "unit": "EUR", "binding": { "type": "input" }, "validation": { "required": true, "min": 0 }}Optional fields for input binding:
| Field | Type | Description |
|---|---|---|
hint | String | MAY contain a hint text for the user (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
placeholder | String | MAY contain placeholder text for the input field (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
defaultValue | Any | MAY provide a default value (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
Example with optional fields:
"binding": { "type": "input", "hint": "Bitte geben Sie Ihr Brutto-Jahreseinkommen an", "placeholder": "z.B. 45000", "defaultValue": 0}External Binding
The external type signals that this value is obtained from an external source. The tool MUST
provide the user with a way to configure the data source.
"dp_credit_score": { "name": "Bonitätsscore", "type": "number", "binding": { "type": "external", "ref": "schufa_api", "description": "SCHUFA-Schnittstelle zur Bonitätsprüfung" }}Required fields for external binding:
| Field | Type | Description |
|---|---|---|
ref | String | MUST contain a symbolic reference to the data source (Rule DP-10DP-10 An external binding MUST have ref.) |
Optional fields for external binding:
| Field | Type | Description |
|---|---|---|
description | String | MAY contain a description of the expected data source (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
sourceType | Enum | MAY specify the type of source: "api", "database", "file", "rulemap" (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
fallback | Object | MAY define an alternative binding if the external source is unavailable (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
Example with fallback:
"binding": { "type": "external", "ref": "schufa_api", "description": "SCHUFA-Schnittstelle", "sourceType": "api", "fallback": { "type": "input", "hint": "Automatische Abfrage nicht verfügbar. Bitte manuell eingeben." }}Tool workflow for external bindings:
- When loading the RUML file, the tool collects all
externalbindings - The tool displays an overview: “The following data sources must be configured:”
- For each
ref, the tool enables assignment to a concrete data source - The assignment is stored in the tool configuration, NOT in the RUML file
Complete Example
"data": { "dp_annual_income": { "name": "Jahreseinkommen", "type": "currency", "unit": "EUR", "binding": { "type": "input", "hint": "Brutto-Jahreseinkommen" }, "validation": { "required": true, "min": 0 } }, "dp_credit_score": { "name": "Bonitätsscore", "type": "number", "binding": { "type": "external", "ref": "schufa_api", "description": "SCHUFA-Schnittstelle", "fallback": { "type": "input" } } }}Computed Binding
The computed type derives the value from other DataPoints via a JSONata expression. A
calculation result thereby becomes a named, typed value — e.g. a monetary amount for a legal
consequence, a deadline date, or a value for a notice. Unlike ruml:query, which yields a truth
value for a node, a computed DataPoint yields a value that other capabilities can consume
(e.g. document templates, text snippets).
"dp_einkommensteuer": { "name": "Festzusetzende Einkommensteuer", "type": "currency", "unit": "EUR", "binding": { "type": "computed", "expression": "(dp_zve - 11604) * 0.14" }}Fields for computed binding:
| Field | Type | Description |
|---|---|---|
expression | String | MUST contain a JSONata expression (Rule DP-11DP-11 A computed binding MUST have expression, a valid JSONata expression; a parser MUST accept one that reads other DataPoints, including computed ones.). Other DataPoints are referenced by their ID. |
description | String | MAY describe the calculation (Rule DP-09DP-09 A parser MUST accept hint, placeholder and defaultValue in an input binding; description, sourceType and fallback in an external binding; and description in a computed binding.) |
Rules:
- The computed value MUST conform to the DataPoint’s
typeandvalidation. - The expression MAY reference other DataPoints, including other computed ones; references MUST NOT
be cyclic (directly or transitively) (
Rule DP-11DP-11 Acomputedbinding MUST haveexpression, a valid JSONata expression; a parser MUST accept one that reads other DataPoints, including computed ones.,Rule DP-12DP-12 The references betweencomputedDataPoints MUST NOT form a cycle, directly or transitively.). - Tools MUST NOT request user input for a computed DataPoint — the value is determined at evaluation time.
4.7.3 Validation
The optional validation field of a DataPoint defines rules for checking entered or obtained data
values at runtime. Tools SHOULD apply these rules before a value is used in the decision logic.
Basic Structure
"validation": { "required": true, "min": 0, "max": 100000, "message": "Bitte geben Sie einen gültigen Wert ein"}Validation Rules
| Rule | Type | Description |
|---|---|---|
required | Boolean | If true, a value MUST be present |
min | Number or String | Minimum value; its type depends on the data type (see Notes) |
max | Number or String | Maximum value; its type depends on the data type (see Notes) |
minLength | Integer | Minimum character length (see Notes) |
maxLength | Integer | Maximum character length (see Notes) |
pattern | String | Regular expression for format validation |
enum | Array | List of permitted values |
message | String | Custom error message |
Applicability by Data Type
| Data Type | Applicable Rules |
|---|---|
string | required, minLength, maxLength, pattern, enum, message |
number | required, min, max, enum, message |
boolean | required, message |
date | required, min, max, message |
datetime | required, min, max, message |
time | required, min, max, message |
integer | required, min, max, enum, message |
currency | required, min, max, message |
percentage | required, min, max, message |
duration | required, min, max, message |
email | required, pattern, message |
phone | required, pattern, message |
location | required, enum, message |
identifier | required, minLength, maxLength, pattern, message |
iban | required, pattern, message |
count | required, min, max, message |
url | required, pattern, message |
address | required, message |
enum | required, message |
object | required, message |
A validation rule MUST NOT be used with a data type the table does not list it for (Rule DP-04DP-04 A DataPoint MUST NOT have unit, format, options, set or cardinality, nor a validation rule, that 4.7 and 4.7.3 do not provide for its type.).
Examples
Required field with value range:
"dp_annual_income": { "name": "Jahreseinkommen", "type": "currency", "unit": "EUR", "validation": { "required": true, "min": 0, "max": 10000000, "message": "Bitte geben Sie ein gültiges Jahreseinkommen an" }, "binding": { "type": "input" }}Text field with length restriction and pattern:
"dp_postal_code": { "name": "Postleitzahl", "type": "string", "validation": { "required": true, "minLength": 5, "maxLength": 5, "pattern": "^[0-9]{5}$", "message": "Bitte geben Sie eine gültige deutsche Postleitzahl ein" }, "binding": { "type": "input" }}Selection from permitted values:
"dp_country": { "name": "Land", "type": "location", "format": "country", "validation": { "required": true, "enum": ["DE", "AT", "CH"], "message": "Diese Regelung gilt nur für Deutschland, Österreich und die Schweiz" }, "binding": { "type": "input" }}Date range:
"dp_birth_date": { "name": "Geburtsdatum", "type": "date", "validation": { "required": true, "min": "1900-01-01", "max": "2010-12-31", "message": "Das Geburtsdatum muss zwischen 1900 und 2010 liegen" }, "binding": { "type": "input" }}Identifier with format validation:
"dp_vat_id": { "name": "Umsatzsteuer-ID", "type": "identifier", "format": "vatId", "validation": { "required": false, "pattern": "^DE[0-9]{9}$", "message": "Bitte geben Sie eine gültige deutsche USt-ID ein (Format: DE123456789)" }, "binding": { "type": "input" }}Notes
Pattern:
- The
patternfield MUST contain a valid regular expression (Rule DP-13DP-13validation.patternMUST be a valid ECMA-262 regular expression.) - The expression is matched against the entire value (implicit
^...$) - Tools MUST support ECMAScript-compatible regular expressions (ECMA-262)
Min and Max:
min and max MUST have the type listed for their data type (Rule DP-14DP-14 validation.min and validation.max MUST have the type 4.7.3 gives for the data type.):
| Data Type | Type of min and max | Example |
|---|---|---|
number, integer, currency, percentage | Number | 0 |
count | Non-negative integer | 1 |
date | String, a full-date as defined in RFC 3339, section 5.6 | "1900-01-01" |
datetime | String, a date and time in the format YYYY-MM-DDTHH:MM, optionally with seconds, a fraction and an offset | "2024-01-01T08:00:00+01:00" |
time | String, a time in the format HH:MM or HH:MM:SS, optionally with a fraction of a second and an offset | "08:00", "17:30:00+01:00" |
duration | String, an ISO 8601 duration | "P18Y" |
- A
datetimeortimebound needs no offset, just as adatetimeortimevalue needs none (see 4.7.1). - Tools MUST compare dates, times and durations by their value, not as strings.
MinLength and MaxLength:
minLengthandmaxLengthMUST be integers from 0 to 253 − 1, the range of integers that JSON implementations exchange reliably (RFC 8259, section 6) (Rule DP-08DP-08cardinality.minMUST be an integer of at least 0 andcardinality.maxan integer of at least 1;minLengthandmaxLengthMUST be integers from 0 to 253 − 1.).
Enum in Combination with Other Rules:
- If
enumis defined, the value MUST be contained in the list - Other rules such as
min,max,patternare checked additionally
Message:
- If
messageis not defined, the tool SHOULD generate a default error message - The message SHOULD help the user correct the error
4.7.4 Sets (Reusable Structured Types)
A set is a reusable, named structure — a group of DataPoints that belong together (a person, an
employment, a bank account) or a section of inputs in a questionnaire. Sets solve the fact that
data is otherwise a flat map with no grouping.
The pattern separates definition from use:
- A set (the reusable template) is defined once in the
setsregistry. - An object (an instance) is a DataPoint of
type: "object"that references a set.
Defining sets
Set types are declared in the sets object of the ruml:datapoints capability, keyed by their id:
"sets": { "set_person": { "name": "Person", "fields": { "dp_vorname": { "name": "Vorname", "type": "string", "binding": { "type": "input" } }, "dp_nachname": { "name": "Nachname", "type": "string", "binding": { "type": "input" } }, "dp_geburtsdatum": { "name": "Geburtsdatum", "type": "date", "binding": { "type": "input" } }, "dp_beschaeftigung": { "name": "Beschäftigung", "type": "object", "set": "set_beschaeftigung", "binding": { "type": "input" } } } }, "set_beschaeftigung": { "name": "Beschäftigung", "fields": { "dp_arbeitgeber": { "name": "Arbeitgeber", "type": "string", "binding": { "type": "input" } }, "dp_beginn": { "name": "Beginn der Beschäftigung", "type": "date", "binding": { "type": "input" } }, "dp_nettoeinkommen": { "name": "Monatliches Nettoeinkommen", "type": "currency", "unit": "EUR", "validation": { "min": 0 }, "binding": { "type": "input" } } } }}| Field | Type | Description |
|---|---|---|
name | String | MUST contain a display name for the set (Rule DP-15DP-15 An entry of sets MUST have name and fields; a parser MUST accept description in it and a DataPoint of type: "object" among its fields.) |
fields | Object | MUST contain the member DataPoints, keyed by their ids. A field MAY itself be type: "object" (nesting) (Rule DP-15DP-15 An entry of sets MUST have name and fields; a parser MUST accept description in it and a DataPoint of type: "object" among its fields.). |
description | String | MAY describe the set (Rule DP-15DP-15 An entry of sets MUST have name and fields; a parser MUST accept description in it and a DataPoint of type: "object" among its fields.) |
Using sets
A DataPoint instantiates a set with type: "object" and a set reference:
"data": { "dp_antragsteller": { "name": "Antragsteller", "type": "object", "set": "set_person", "binding": { "type": "input" } }, "dp_buergen": { "name": "Bürgen", "type": "object", "set": "set_person", "cardinality": { "min": 0, "max": 3 }, "binding": { "type": "input" } }}setMUST reference an id declared insets(Rule DP-16DP-16 Thesetof a DataPoint MUST be the id of an entry ofsets.).cardinality({ min, max }) controls repetition: absent → a single object;max > 1→ a list of objects (e.g. a questionnaire “add another” list, FIM Multiplizität).- Nesting: because a
fieldsentry may itself betype: "object", sets compose (in the example,set_personhas aset_beschaeftigungfield).
Referencing fields
Fields inside an object are referenced by path (JSONata) from the DataPoint id, e.g.
dp_antragsteller.dp_geburtsdatum in a ruml:query expression. For a repeated object
(cardinality.max > 1) the value is an array and members are indexed, e.g.
dp_buergen[0].dp_nachname.
Rules:
- Every
setreference MUST resolve to an id insets(Rule DP-16DP-16 Thesetof a DataPoint MUST be the id of an entry ofsets.). - Set
fieldskeys and set ids MUST match the pattern[a-z_][a-z0-9_]*(Rule DP-02DP-02 The key of a DataPoint, the id of a set and the keys of a set'sfieldsMUST match the pattern[a-z_][a-z0-9_]*.). - Set definitions MAY nest but MUST NOT be recursive (a set MUST NOT reference itself directly or
transitively) (
Rule DP-17DP-17 A set MUST NOT reference itself, directly or transitively.).