Class: Instrument

A logical REDCap instrument (form) grouping related fields. This class is not directly represented in the CSV but is derived from the contiguous grouping of fields sharing the same form_name. In RareLink, instruments follow the naming convention 'rarelink_N_section_name' and each has a completion status field.

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

 classDiagram
    class Instrument
    click Instrument href "../Instrument/"
      Instrument : fields





        Instrument --> "1..*" Field : fields
        click Field href "../Field/"



      Instrument : instrument_label

      Instrument : instrument_name

      Instrument : is_repeating

## Slots | Name | Cardinality and Range | Description | Inheritance | | --- | --- | --- | --- | | [instrument_name](instrument_name.md) | 1
[String](String.md) | The form_name shared by all fields in this instrument | direct | | [instrument_label](instrument_label.md) | 0..1
[String](String.md) | Human-readable label for the instrument | direct | | [is_repeating](is_repeating.md) | 0..1
[Boolean](Boolean.md) | Whether this instrument supports repeating instances | direct | | [fields](fields.md) | 1..*
[Field](Field.md) | All fields belonging to this instrument | direct | ## Identifier and Mapping Information ### Schema Source * from schema: https://w3id.org/linkml/redcap-data-dictionary ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | redcap_dd:Instrument | | native | redcap_dd:Instrument | ## LinkML Source ### Direct

name: Instrument
description: A logical REDCap instrument (form) grouping related fields. This class
  is not directly represented in the CSV but is derived from the contiguous grouping
  of fields sharing the same form_name. In RareLink, instruments follow the naming
  convention 'rarelink_N_section_name' and each has a completion status field.
from_schema: https://w3id.org/linkml/redcap-data-dictionary
attributes:
  instrument_name:
    name: instrument_name
    description: The form_name shared by all fields in this instrument.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    identifier: true
    domain_of:
    - Instrument
    range: string
    required: true
    pattern: ^[a-z][a-z0-9_]*$
  instrument_label:
    name: instrument_label
    description: Human-readable label for the instrument. REDCap derives this by capitalising
      and replacing underscores with spaces.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Instrument
    range: string
    required: false
  is_repeating:
    name: is_repeating
    description: Whether this instrument supports repeating instances. In RareLink,
      sections 4-8 (care pathway, disease, genetic findings, phenotypic features,
      measurements, family history) are repeating instruments.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    domain_of:
    - Instrument
    range: boolean
    required: false
  fields:
    name: fields
    description: All fields belonging to this instrument.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    domain_of:
    - DataDictionary
    - Instrument
    range: Field
    required: true
    multivalued: true
    inlined_as_list: true

### Induced

name: Instrument
description: A logical REDCap instrument (form) grouping related fields. This class
  is not directly represented in the CSV but is derived from the contiguous grouping
  of fields sharing the same form_name. In RareLink, instruments follow the naming
  convention 'rarelink_N_section_name' and each has a completion status field.
from_schema: https://w3id.org/linkml/redcap-data-dictionary
attributes:
  instrument_name:
    name: instrument_name
    description: The form_name shared by all fields in this instrument.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    identifier: true
    owner: Instrument
    domain_of:
    - Instrument
    range: string
    required: true
    pattern: ^[a-z][a-z0-9_]*$
  instrument_label:
    name: instrument_label
    description: Human-readable label for the instrument. REDCap derives this by capitalising
      and replacing underscores with spaces.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Instrument
    domain_of:
    - Instrument
    range: string
    required: false
  is_repeating:
    name: is_repeating
    description: Whether this instrument supports repeating instances. In RareLink,
      sections 4-8 (care pathway, disease, genetic findings, phenotypic features,
      measurements, family history) are repeating instruments.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    rank: 1000
    owner: Instrument
    domain_of:
    - Instrument
    range: boolean
    required: false
  fields:
    name: fields
    description: All fields belonging to this instrument.
    from_schema: https://w3id.org/linkml/redcap-data-dictionary
    owner: Instrument
    domain_of:
    - DataDictionary
    - Instrument
    range: Field
    required: true
    multivalued: true
    inlined: true
    inlined_as_list: true