Skip to content

Class: FieldDefinition

Definition of a field used in forms, templates, or data collection

URI: revaise:FieldDefinition

```mermaid classDiagram class FieldDefinition click FieldDefinition href "../FieldDefinition/" FieldDefinition : field_category

  FieldDefinition : field_default_value

  FieldDefinition : field_dependencies





    FieldDefinition --> "*" FieldDependency : field_dependencies
    click FieldDependency href "../FieldDependency/"



  FieldDefinition : field_description

  FieldDefinition : field_group

  FieldDefinition : field_help_text

  FieldDefinition : field_id

  FieldDefinition : field_label

  FieldDefinition : field_metadata

  FieldDefinition : field_name

  FieldDefinition : field_options





    FieldDefinition --> "*" FieldOption : field_options
    click FieldOption href "../FieldOption/"



  FieldDefinition : field_order

  FieldDefinition : field_placeholder

  FieldDefinition : field_required

  FieldDefinition : field_type





    FieldDefinition --> "1" FieldType : field_type
    click FieldType href "../FieldType/"



  FieldDefinition : field_validation_rules





    FieldDefinition --> "*" ValidationRule : field_validation_rules
    click ValidationRule href "../ValidationRule/"

```

Slots

Name Cardinality and Range Description Inheritance
field_id 1
String
Unique identifier for this field direct
field_name 1
String
Machine-readable name for the field direct
field_label 1
String
Human-readable label for the field direct
field_type 1
FieldType
Data type of the field direct
field_description 0..1
String
Detailed description of the field direct
field_required 0..1
Boolean
Whether this field is required direct
field_category 0..1
String
Category or section this field belongs to direct
field_order 0..1
Integer
Display order of the field direct
field_group 0..1
String
Group this field belongs to direct
field_help_text 0..1
String
Help text to guide users direct
field_placeholder 0..1
String
Placeholder text for the field direct
field_default_value 0..1
String
Default value for the field direct
field_validation_rules *
ValidationRule
Validation rules for the field direct
field_options *
FieldOption
Options for select/multi-select fields direct
field_dependencies *
FieldDependency
Dependencies on other fields direct
field_metadata 0..1
String
Additional metadata as JSON direct

Usages

used by used in type used
FormSection section_fields range FieldDefinition

Identifier and Mapping Information

Schema Source

  • from schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction

Mappings

Mapping Type Mapped Value
self revaise:FieldDefinition
native revaise:FieldDefinition

LinkML Source

Direct

name: FieldDefinition
description: Definition of a field used in forms, templates, or data collection
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
slots:
- field_id
- field_name
- field_label
- field_type
- field_description
- field_required
- field_category
- field_order
- field_group
- field_help_text
- field_placeholder
- field_default_value
- field_validation_rules
- field_options
- field_dependencies
- field_metadata
slot_usage:
  field_id:
    name: field_id
    description: Unique identifier for this field
    identifier: true
    range: string
  field_name:
    name: field_name
    description: Machine-readable name for the field
    range: string
    required: true
  field_label:
    name: field_label
    description: Human-readable label for the field
    range: string
    required: true
  field_type:
    name: field_type
    description: Data type of the field
    range: FieldType
    required: true
  field_description:
    name: field_description
    description: Detailed description of the field
    range: string
  field_required:
    name: field_required
    description: Whether this field is required
    range: boolean
  field_category:
    name: field_category
    description: Category or section this field belongs to
    range: string
  field_order:
    name: field_order
    description: Display order of the field
    range: integer
  field_group:
    name: field_group
    description: Group this field belongs to
    range: string
  field_help_text:
    name: field_help_text
    description: Help text to guide users
    range: string
  field_placeholder:
    name: field_placeholder
    description: Placeholder text for the field
    range: string
  field_default_value:
    name: field_default_value
    description: Default value for the field
    range: string
  field_validation_rules:
    name: field_validation_rules
    description: Validation rules for the field
    range: ValidationRule
    multivalued: true
  field_options:
    name: field_options
    description: Options for select/multi-select fields
    range: FieldOption
    multivalued: true
  field_dependencies:
    name: field_dependencies
    description: Dependencies on other fields
    range: FieldDependency
    multivalued: true
  field_metadata:
    name: field_metadata
    description: Additional metadata as JSON
    range: string

Induced

name: FieldDefinition
description: Definition of a field used in forms, templates, or data collection
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
slot_usage:
  field_id:
    name: field_id
    description: Unique identifier for this field
    identifier: true
    range: string
  field_name:
    name: field_name
    description: Machine-readable name for the field
    range: string
    required: true
  field_label:
    name: field_label
    description: Human-readable label for the field
    range: string
    required: true
  field_type:
    name: field_type
    description: Data type of the field
    range: FieldType
    required: true
  field_description:
    name: field_description
    description: Detailed description of the field
    range: string
  field_required:
    name: field_required
    description: Whether this field is required
    range: boolean
  field_category:
    name: field_category
    description: Category or section this field belongs to
    range: string
  field_order:
    name: field_order
    description: Display order of the field
    range: integer
  field_group:
    name: field_group
    description: Group this field belongs to
    range: string
  field_help_text:
    name: field_help_text
    description: Help text to guide users
    range: string
  field_placeholder:
    name: field_placeholder
    description: Placeholder text for the field
    range: string
  field_default_value:
    name: field_default_value
    description: Default value for the field
    range: string
  field_validation_rules:
    name: field_validation_rules
    description: Validation rules for the field
    range: ValidationRule
    multivalued: true
  field_options:
    name: field_options
    description: Options for select/multi-select fields
    range: FieldOption
    multivalued: true
  field_dependencies:
    name: field_dependencies
    description: Dependencies on other fields
    range: FieldDependency
    multivalued: true
  field_metadata:
    name: field_metadata
    description: Additional metadata as JSON
    range: string
attributes:
  field_id:
    name: field_id
    description: Unique identifier for this field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    identifier: true
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
    required: true
  field_name:
    name: field_name
    description: Machine-readable name for the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
    required: true
  field_label:
    name: field_label
    description: Human-readable label for the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
    required: true
  field_type:
    name: field_type
    description: Data type of the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: FieldType
    required: true
  field_description:
    name: field_description
    description: Detailed description of the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
  field_required:
    name: field_required
    description: Whether this field is required
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: boolean
  field_category:
    name: field_category
    description: Category or section this field belongs to
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
  field_order:
    name: field_order
    description: Display order of the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: integer
  field_group:
    name: field_group
    description: Group this field belongs to
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
  field_help_text:
    name: field_help_text
    description: Help text to guide users
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
  field_placeholder:
    name: field_placeholder
    description: Placeholder text for the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
  field_default_value:
    name: field_default_value
    description: Default value for the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string
  field_validation_rules:
    name: field_validation_rules
    description: Validation rules for the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: ValidationRule
    multivalued: true
  field_options:
    name: field_options
    description: Options for select/multi-select fields
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: FieldOption
    multivalued: true
  field_dependencies:
    name: field_dependencies
    description: Dependencies on other fields
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: FieldDependency
    multivalued: true
  field_metadata:
    name: field_metadata
    description: Additional metadata as JSON
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/extraction
    rank: 1000
    owner: FieldDefinition
    domain_of:
    - FieldDefinition
    range: string