Class: Field

A single variable (field) in a REDCap data dictionary. This class maps directly to one row of the REDCap data dictionary CSV, with each attribute corresponding to one of the 18 standard columns.

URI: [redcap_dd:Field](https://w3id.org/linkml/redcap-data-dictionary/Field)

 classDiagram
    class Field
    click Field href "../Field/"
      Field : branching_logic

      Field : choices_calculations_slider_labels

      Field : custom_alignment





        Field --> "0..1" CustomAlignment : custom_alignment
        click CustomAlignment href "../CustomAlignment/"



      Field : field_annotation

      Field : field_label

      Field : field_note

      Field : field_type





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



      Field : form_name

      Field : identifier





        Field --> "0..1" IdentifierStatus : identifier
        click IdentifierStatus href "../IdentifierStatus/"



      Field : matrix_group_name

      Field : matrix_ranking





        Field --> "0..1" MatrixRanking : matrix_ranking
        click MatrixRanking href "../MatrixRanking/"



      Field : question_number

      Field : required_field

      Field : section_header

      Field : text_validation_max

      Field : text_validation_min

      Field : text_validation_type_or_show_slider_number





        Field --> "0..1" TextValidationType : text_validation_type_or_show_slider_number
        click TextValidationType href "../TextValidationType/"



      Field : variable_field_name

## Slots | Name | Cardinality and Range | Description | Inheritance | | --- | --- | --- | --- | | [variable_field_name](variable_field_name.md) | 1
[String](String.md) | The unique variable name for this field | direct | | [form_name](form_name.md) | 1
[String](String.md) | The instrument (form) this field belongs to | direct | | [section_header](section_header.md) | 0..1
[String](String.md) | Optional section header text displayed above this field to visually group fie... | direct | | [field_type](field_type.md) | 1
[FieldType](FieldType.md) | The type of input field | direct | | [field_label](field_label.md) | 1
[String](String.md) | The display label shown to users during data entry | direct | | [choices_calculations_slider_labels](choices_calculations_slider_labels.md) | 0..1
[String](String.md) | For dropdown, radio, and checkbox fields: pipe-delimited list of 'raw_value, ... | direct | | [field_note](field_note.md) | 0..1
[String](String.md) | Supplementary text displayed below the field during data entry | direct | | [text_validation_type_or_show_slider_number](text_validation_type_or_show_slider_number.md) | 0..1
[TextValidationType](TextValidationType.md) | For text fields: the validation type constraining input format | direct | | [text_validation_min](text_validation_min.md) | 0..1
[String](String.md) | Minimum allowed value for validated text fields (dates, numbers) | direct | | [text_validation_max](text_validation_max.md) | 0..1
[String](String.md) | Maximum allowed value for validated text fields (dates, numbers) | direct | | [identifier](identifier.md) | 0..1
[IdentifierStatus](IdentifierStatus.md) | Whether this field contains identifying information (PHI) | direct | | [branching_logic](branching_logic.md) | 0..1
[String](String.md) | Conditional display logic | direct | | [required_field](required_field.md) | 0..1
[String](String.md) | Whether the field is required for form completion | direct | | [custom_alignment](custom_alignment.md) | 0..1
[CustomAlignment](CustomAlignment.md) | Controls the alignment of the field on the form | direct | | [question_number](question_number.md) | 0..1
[String](String.md) | Custom question number for surveys | direct | | [matrix_group_name](matrix_group_name.md) | 0..1
[String](String.md) | Groups multiple radio/checkbox fields into a matrix display | direct | | [matrix_ranking](matrix_ranking.md) | 0..1
[MatrixRanking](MatrixRanking.md) | Whether ranking is enabled for this matrix group | direct | | [field_annotation](field_annotation.md) | 0..1
[String](String.md) | REDCap's field annotation column — free text plus action tags (e | direct | ## Usages | used by | used in | type | used | | --- | --- | --- | --- | | [DataDictionary](DataDictionary.md) | [fields](fields.md) | range | [Field](Field.md) | | [Instrument](Instrument.md) | [fields](fields.md) | range | [Field](Field.md) | ## Identifier and Mapping Information ### Schema Source * from schema: https://w3id.org/linkml/redcap-data-dictionary ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | redcap_dd:Field | | native | redcap_dd:Field | ## LinkML Source ### Direct

name: Field
description: A single variable (field) in a REDCap data dictionary. This class maps
  directly to one row of the REDCap data dictionary CSV, with each attribute corresponding
  to one of the 18 standard columns.
from_schema: https://w3id.org/linkml/redcap-data-dictionary
attributes:
  variable_field_name:
    name: variable_field_name
    description: The unique variable name for this field. Must contain only lowercase
      letters, numbers, and underscores. Cannot start with a number. Must be unique
      across the entire project.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    identifier: true
    domain_of:
    - Field
    range: string
    required: true
    pattern: ^[a-z][a-z0-9_]*$
  form_name:
    name: form_name
    description: The instrument (form) this field belongs to. Must be lowercase with
      underscores only. All fields for a form must be contiguous.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: true
    pattern: ^[a-z][a-z0-9_]*$
  section_header:
    name: section_header
    description: Optional section header text displayed above this field to visually
      group fields within a form. Supports HTML/rich text.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  field_type:
    name: field_type
    description: The type of input field. Determines how the field is rendered in
      the data entry form and what data it can accept.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: FieldType
    required: true
  field_label:
    name: field_label
    description: The display label shown to users during data entry. Supports HTML/rich
      text formatting. For ontology-based models, this typically includes a section
      number and human-readable name (e.g., '2.1 Date of birth').
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: true
  choices_calculations_slider_labels:
    name: choices_calculations_slider_labels
    description: 'For dropdown, radio, and checkbox fields: pipe-delimited list of
      ''raw_value, label'' pairs (e.g., ''1, Yes | 2, No | 3, Unknown''). For calc
      fields: the calculation expression. For slider fields: ''left | center | right''
      anchor labels. For text fields with BioPortal ontology autocomplete: ''BIOPORTAL:ONTOLOGY_NAME''
      (e.g., ''BIOPORTAL:HP'').'
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  field_note:
    name: field_note
    description: Supplementary text displayed below the field during data entry. Typically
      provides instructions, expected formats, or context.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  text_validation_type_or_show_slider_number:
    name: text_validation_type_or_show_slider_number
    description: 'For text fields: the validation type constraining input format.
      For slider fields: whether to show the numeric value (''number'').'
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: TextValidationType
    required: false
  text_validation_min:
    name: text_validation_min
    description: Minimum allowed value for validated text fields (dates, numbers).
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  text_validation_max:
    name: text_validation_max
    description: Maximum allowed value for validated text fields (dates, numbers).
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  identifier:
    name: identifier
    description: Whether this field contains identifying information (PHI). Set to
      'y' for identifier fields. Affects data export behaviour.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: IdentifierStatus
    required: false
  branching_logic:
    name: branching_logic
    description: Conditional display logic. Uses REDCap's branching syntax (e.g.,
      '[field_name] = ''value'''). When specified, the field is only shown if the
      condition evaluates to true.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  required_field:
    name: required_field
    description: Whether the field is required for form completion. Set to 'y' for
      required fields. Can also contain conditional expressions for conditionally
      required fields.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  custom_alignment:
    name: custom_alignment
    description: Controls the alignment of the field on the form. LV = Left Vertical,
      LH = Left Horizontal, RV = Right Vertical (default), RH = Right Horizontal.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: CustomAlignment
    required: false
  question_number:
    name: question_number
    description: Custom question number for surveys. Overrides auto-numbering. Any
      text entered here is displayed as the question number.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
  matrix_group_name:
    name: matrix_group_name
    description: Groups multiple radio/checkbox fields into a matrix display. All
      fields with the same matrix_group_name must be contiguous and use the same field_type
      and choices.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false
    pattern: ^[a-z0-9_]*$
  matrix_ranking:
    name: matrix_ranking
    description: Whether ranking is enabled for this matrix group. When enabled, no
      two fields in the matrix can have the same selected value.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: MatrixRanking
    required: false
  field_annotation:
    name: field_annotation
    description: REDCap's field annotation column — free text plus action tags (e.g.
      @HIDDEN, @READONLY, @CALCTEXT). Any structured convention layered inside it
      (semantic variable codes, ontology-coded choices, ontology versions, interoperability
      mappings) is defined downstream by rarelink, not by this base schema.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Field
    range: string
    required: false

### Induced

name: Field
description: A single variable (field) in a REDCap data dictionary. This class maps
  directly to one row of the REDCap data dictionary CSV, with each attribute corresponding
  to one of the 18 standard columns.
from_schema: https://w3id.org/linkml/redcap-data-dictionary
attributes:
  variable_field_name:
    name: variable_field_name
    description: The unique variable name for this field. Must contain only lowercase
      letters, numbers, and underscores. Cannot start with a number. Must be unique
      across the entire project.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    identifier: true
    owner: Field
    domain_of:
    - Field
    range: string
    required: true
    pattern: ^[a-z][a-z0-9_]*$
  form_name:
    name: form_name
    description: The instrument (form) this field belongs to. Must be lowercase with
      underscores only. All fields for a form must be contiguous.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: true
    pattern: ^[a-z][a-z0-9_]*$
  section_header:
    name: section_header
    description: Optional section header text displayed above this field to visually
      group fields within a form. Supports HTML/rich text.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  field_type:
    name: field_type
    description: The type of input field. Determines how the field is rendered in
      the data entry form and what data it can accept.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: FieldType
    required: true
  field_label:
    name: field_label
    description: The display label shown to users during data entry. Supports HTML/rich
      text formatting. For ontology-based models, this typically includes a section
      number and human-readable name (e.g., '2.1 Date of birth').
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: true
  choices_calculations_slider_labels:
    name: choices_calculations_slider_labels
    description: 'For dropdown, radio, and checkbox fields: pipe-delimited list of
      ''raw_value, label'' pairs (e.g., ''1, Yes | 2, No | 3, Unknown''). For calc
      fields: the calculation expression. For slider fields: ''left | center | right''
      anchor labels. For text fields with BioPortal ontology autocomplete: ''BIOPORTAL:ONTOLOGY_NAME''
      (e.g., ''BIOPORTAL:HP'').'
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  field_note:
    name: field_note
    description: Supplementary text displayed below the field during data entry. Typically
      provides instructions, expected formats, or context.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  text_validation_type_or_show_slider_number:
    name: text_validation_type_or_show_slider_number
    description: 'For text fields: the validation type constraining input format.
      For slider fields: whether to show the numeric value (''number'').'
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: TextValidationType
    required: false
  text_validation_min:
    name: text_validation_min
    description: Minimum allowed value for validated text fields (dates, numbers).
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  text_validation_max:
    name: text_validation_max
    description: Maximum allowed value for validated text fields (dates, numbers).
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  identifier:
    name: identifier
    description: Whether this field contains identifying information (PHI). Set to
      'y' for identifier fields. Affects data export behaviour.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: IdentifierStatus
    required: false
  branching_logic:
    name: branching_logic
    description: Conditional display logic. Uses REDCap's branching syntax (e.g.,
      '[field_name] = ''value'''). When specified, the field is only shown if the
      condition evaluates to true.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  required_field:
    name: required_field
    description: Whether the field is required for form completion. Set to 'y' for
      required fields. Can also contain conditional expressions for conditionally
      required fields.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  custom_alignment:
    name: custom_alignment
    description: Controls the alignment of the field on the form. LV = Left Vertical,
      LH = Left Horizontal, RV = Right Vertical (default), RH = Right Horizontal.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: CustomAlignment
    required: false
  question_number:
    name: question_number
    description: Custom question number for surveys. Overrides auto-numbering. Any
      text entered here is displayed as the question number.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
  matrix_group_name:
    name: matrix_group_name
    description: Groups multiple radio/checkbox fields into a matrix display. All
      fields with the same matrix_group_name must be contiguous and use the same field_type
      and choices.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false
    pattern: ^[a-z0-9_]*$
  matrix_ranking:
    name: matrix_ranking
    description: Whether ranking is enabled for this matrix group. When enabled, no
      two fields in the matrix can have the same selected value.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: MatrixRanking
    required: false
  field_annotation:
    name: field_annotation
    description: REDCap's field annotation column — free text plus action tags (e.g.
      @HIDDEN, @READONLY, @CALCTEXT). Any structured convention layered inside it
      (semantic variable codes, ontology-coded choices, ontology versions, interoperability
      mappings) is defined downstream by rarelink, not by this base schema.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Field
    domain_of:
    - Field
    range: string
    required: false