Class: TemplateField¶

A field within a registration template.

```mermaid classDiagram class TemplateField click TemplateField href "../TemplateField/" TemplateField : conditional_on

  TemplateField : is_repeatable

  TemplateField : template_field_constraints

  TemplateField : template_field_description

  TemplateField : template_field_example

  TemplateField : template_field_format

  TemplateField : template_field_help_text

  TemplateField : template_field_id

  TemplateField : template_field_label

  TemplateField : template_field_name

  TemplateField : template_field_order

  TemplateField : template_field_section

  TemplateField : template_field_type





    TemplateField --> "1" FieldType : template_field_type
    click FieldType href "../FieldType/"

```

Slots¶

Name	Cardinality and Range	Description	Inheritance
template_field_id	1 String	Unique identifier for this field within the template	direct
template_field_name	1 String	Technical name of the field	direct
template_field_label	1 String	Human-readable label for the field	direct
template_field_description	0..1 String	Description of what should be entered in this field	direct
template_field_type	1 FieldType	Data type of the field	direct
template_field_format	0..1 String	Expected format for the field value	direct
template_field_constraints	* String	Constraints on the field value	direct
template_field_help_text	0..1 String	Help text to guide users	direct
template_field_example	0..1 String	Example value for this field	direct
template_field_section	0..1 String	Section of the template this field belongs to	direct
template_field_order	0..1 Integer	Display order of the field	direct
is_repeatable	0..1 Boolean	Whether this field can have multiple values	direct
conditional_on	0..1 String	Field ID that this field depends on	direct

Usages¶

used by	used in	type	used
RegistrationTemplate	required_fields	range	TemplateField
RegistrationTemplate	optional_fields	range	TemplateField

Identifier and Mapping Information¶

Schema Source¶

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

Mappings¶

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

LinkML Source¶

Direct¶

name: TemplateField
description: A field within a registration template.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
slots:
- template_field_id
- template_field_name
- template_field_label
- template_field_description
- template_field_type
- template_field_format
- template_field_constraints
- template_field_help_text
- template_field_example
- template_field_section
- template_field_order
- is_repeatable
- conditional_on
slot_usage:
  template_field_id:
    name: template_field_id
    description: Unique identifier for this field within the template
    identifier: true
    required: true
  template_field_name:
    name: template_field_name
    description: Technical name of the field
    range: string
    required: true
  template_field_label:
    name: template_field_label
    description: Human-readable label for the field
    range: string
    required: true
  template_field_description:
    name: template_field_description
    description: Description of what should be entered in this field
    range: string
  template_field_type:
    name: template_field_type
    description: Data type of the field
    range: FieldType
    required: true
  template_field_format:
    name: template_field_format
    description: Expected format for the field value
    range: string
  template_field_constraints:
    name: template_field_constraints
    description: Constraints on the field value
    range: string
    multivalued: true
  template_field_help_text:
    name: template_field_help_text
    description: Help text to guide users
    range: string
  template_field_example:
    name: template_field_example
    description: Example value for this field
    range: string
  template_field_section:
    name: template_field_section
    description: Section of the template this field belongs to
    range: string
  template_field_order:
    name: template_field_order
    description: Display order of the field
    range: integer
  is_repeatable:
    name: is_repeatable
    description: Whether this field can have multiple values
    range: boolean
  conditional_on:
    name: conditional_on
    description: Field ID that this field depends on
    range: string

Induced¶

name: TemplateField
description: A field within a registration template.
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
slot_usage:
  template_field_id:
    name: template_field_id
    description: Unique identifier for this field within the template
    identifier: true
    required: true
  template_field_name:
    name: template_field_name
    description: Technical name of the field
    range: string
    required: true
  template_field_label:
    name: template_field_label
    description: Human-readable label for the field
    range: string
    required: true
  template_field_description:
    name: template_field_description
    description: Description of what should be entered in this field
    range: string
  template_field_type:
    name: template_field_type
    description: Data type of the field
    range: FieldType
    required: true
  template_field_format:
    name: template_field_format
    description: Expected format for the field value
    range: string
  template_field_constraints:
    name: template_field_constraints
    description: Constraints on the field value
    range: string
    multivalued: true
  template_field_help_text:
    name: template_field_help_text
    description: Help text to guide users
    range: string
  template_field_example:
    name: template_field_example
    description: Example value for this field
    range: string
  template_field_section:
    name: template_field_section
    description: Section of the template this field belongs to
    range: string
  template_field_order:
    name: template_field_order
    description: Display order of the field
    range: integer
  is_repeatable:
    name: is_repeatable
    description: Whether this field can have multiple values
    range: boolean
  conditional_on:
    name: conditional_on
    description: Field ID that this field depends on
    range: string
attributes:
  template_field_id:
    name: template_field_id
    description: Unique identifier for this field within the template
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    identifier: true
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
    required: true
  template_field_name:
    name: template_field_name
    description: Technical name of the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
    required: true
  template_field_label:
    name: template_field_label
    description: Human-readable label for the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
    required: true
  template_field_description:
    name: template_field_description
    description: Description of what should be entered in this field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
  template_field_type:
    name: template_field_type
    description: Data type of the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: FieldType
    required: true
  template_field_format:
    name: template_field_format
    description: Expected format for the field value
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
  template_field_constraints:
    name: template_field_constraints
    description: Constraints on the field value
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
    multivalued: true
  template_field_help_text:
    name: template_field_help_text
    description: Help text to guide users
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
  template_field_example:
    name: template_field_example
    description: Example value for this field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
  template_field_section:
    name: template_field_section
    description: Section of the template this field belongs to
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string
  template_field_order:
    name: template_field_order
    description: Display order of the field
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: integer
  is_repeatable:
    name: is_repeatable
    description: Whether this field can have multiple values
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    ifabsent: 'false'
    owner: TemplateField
    domain_of:
    - TemplateField
    range: boolean
  conditional_on:
    name: conditional_on
    description: Field ID that this field depends on
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/stages/screening
    rank: 1000
    owner: TemplateField
    domain_of:
    - TemplateField
    range: string