Skip to content

field_definition

Shared field definition components used across forms and templates

URI: https://open-and-sustainable.github.io/revaise-model/schema/objects/field_definition

Name: field_definition

Classes

Class Description
FieldDefinition Definition of a field used in forms, templates, or data collection
FieldDependency Dependency between fields
FieldOption Option for select/multi-select fields
FormSection Section within a form or template
RegistrationTemplate A template used for registering systematic reviews, defining required and opt...
TemplateField A field within a registration template
ValidationRule Validation rule for a field

Slots

Slot Description
conditional_on Field ID that this field's visibility depends on
created_date Date when the template was created
dependency_condition Condition for the dependency
dependency_type Type of dependency
dependency_value Value to check against
depends_on_field Field this depends on
deprecation_date Date when this template will be or was deprecated
error_message Error message when validation fails
field_category Category or section this field belongs to
field_default_value Default value for the field
field_definitions Formal definition of template fields (e
field_dependencies Dependencies on other fields
field_description Detailed description of the field
field_group Group this field belongs to
field_help_text Help text to guide users
field_id Unique identifier for this field
field_label Human-readable label for the field
field_metadata Additional metadata as JSON
field_name Machine-readable name for the field
field_options Options for select/multi-select fields
field_order Display order of the field
field_placeholder Placeholder text for the field
field_required Whether this field is required
field_type Data type of the field
field_validation_rules Validation rules for the field
is_default Whether this is a default selection
is_repeatable Whether this field can have multiple values
option_description Description of the option
option_group Group this option belongs to
option_label Display label for the option
option_order Display order of the option
option_value Value of the option
optional_fields Fields that may be completed in this template
required_fields Fields that must be completed in this template
rule_type Type of validation rule
rule_value Value or pattern for the rule
section_conditions Conditions for showing this section
section_description Description of the section
section_fields Fields in this section
section_id Unique identifier for this section
section_label Human-readable label for the section
section_name Machine-readable name for the section
section_order Display order of the section
section_repeatable Whether this section can be repeated
section_required Whether this section is required
severity Severity of validation failure
successor_template_id ID of the template that supersedes this one
template_description Description of the template and its purpose
template_doi DOI of the template publication if available
template_field_constraints Constraints on the field value
template_field_description Description of what should be entered in this field
template_field_example Example value for this field
template_field_format Expected format for the field value
template_field_help_text Help text to guide users
template_field_id Unique identifier for this template field
template_field_label Human-readable label for the field
template_field_name Technical name of the field
template_field_order Display order of the field
template_field_section Section of the template this field belongs to
template_field_type Data type of the field
template_id Unique identifier for the registration template
template_language Language of the template content
template_last_updated Date and time when the template was last updated
template_name Human-readable name of the template
template_provider Organization or registry providing the template
template_type Type of registration template
template_uri URI where the template can be accessed
template_version Version number of the template
validation_rules Rules for validating template field values

Enumerations

Enumeration Description
DependencyType Types of field dependencies
FieldType Data types for template fields
TemplateType Types of registration templates
ValidationRuleType Types of validation rules
ValidationSeverity Severity levels for validation failures

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description