Skip to content

Class: FlatRecord

One row of a REDCap flat record export — a single element of the JSON export array, or one CSV data row. It holds the structural columns present in every project's export. A project's flat schema specialises this class (is_a: FlatRecord) by adding one typed slot per field variable in its data dictionary.

* __NOTE__: this is an abstract class and should not be instantiated directly URI: [redcap_record:FlatRecord](https://w3id.org/linkml/redcap-record/FlatRecord)
 classDiagram
    class FlatRecord
    click FlatRecord href "../FlatRecord/"
      FlatRecord : record_id

      FlatRecord : redcap_data_access_group

      FlatRecord : redcap_event_name

      FlatRecord : redcap_repeat_instance

      FlatRecord : redcap_repeat_instrument

      FlatRecord : redcap_survey_identifier
## Slots | Name | Cardinality and Range | Description | Inheritance | | --- | --- | --- | --- | | [record_id](record_id.md) | 1
[String](String.md) | The REDCap record identifier — the project's first field (primary key) | direct | | [redcap_event_name](redcap_event_name.md) | 0..1
[String](String.md) | The unique event name of the row, for longitudinal projects | direct | | [redcap_repeat_instrument](redcap_repeat_instrument.md) | 0..1
[String](String.md) | The machine name (``form_name``) of the repeating instrument this row / eleme... | direct | | [redcap_repeat_instance](redcap_repeat_instance.md) | 0..1
[RedcapInteger](RedcapInteger.md) | The 1-based instance number of the repeating instrument | direct | | [redcap_data_access_group](redcap_data_access_group.md) | 0..1
[String](String.md) | The Data Access Group (DAG) the record belongs to, when DAGs are enabled and ... | direct | | [redcap_survey_identifier](redcap_survey_identifier.md) | 0..1
[String](String.md) | The survey participant identifier, present on rows captured through a public ... | direct | ## Identifier and Mapping Information ### Schema Source * from schema: https://w3id.org/linkml/redcap-record ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | redcap_record:FlatRecord | | native | redcap_record:FlatRecord | ## LinkML Source ### Direct
name: FlatRecord
description: 'One row of a REDCap flat record export  a single element of the JSON
  export array, or one CSV data row. It holds the structural columns present in every
  project''s export. A project''s flat schema *specialises* this class (``is_a: FlatRecord``)
  by adding one typed slot per field variable in its data dictionary.'
from_schema: https://w3id.org/linkml/redcap-record
abstract: true
slots:
- record_id
- redcap_event_name
- redcap_repeat_instrument
- redcap_repeat_instance
- redcap_data_access_group
- redcap_survey_identifier
### Induced
name: FlatRecord
description: 'One row of a REDCap flat record export  a single element of the JSON
  export array, or one CSV data row. It holds the structural columns present in every
  project''s export. A project''s flat schema *specialises* this class (``is_a: FlatRecord``)
  by adding one typed slot per field variable in its data dictionary.'
from_schema: https://w3id.org/linkml/redcap-record
abstract: true
attributes:
  record_id:
    name: record_id
    description: The REDCap record identifier — the project's first field (primary
      key). REDCap names this field arbitrarily (commonly ``record_id``); a project
      whose first field has a different name aliases this slot.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: FlatRecord
    domain_of:
    - FlatRecord
    - StructuredRecord
    range: string
    required: true
  redcap_event_name:
    name: redcap_event_name
    description: The unique event name of the row, for longitudinal projects. Empty
      in classic (non-longitudinal) projects.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: FlatRecord
    domain_of:
    - FlatRecord
    range: string
    required: false
  redcap_repeat_instrument:
    name: redcap_repeat_instrument
    description: The machine name (``form_name``) of the repeating instrument this
      row / element belongs to. Empty for non-repeating data. A project may narrow
      this to an enum of its own repeating form names for stronger typing.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: FlatRecord
    domain_of:
    - FlatRecord
    - RepeatedElement
    range: string
    required: false
  redcap_repeat_instance:
    name: redcap_repeat_instance
    description: The 1-based instance number of the repeating instrument. In a flat
      export this is an integer-valued string and is empty for non-repeating rows;
      the structured ``RepeatedElement`` narrows it to a native ``integer``.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: FlatRecord
    domain_of:
    - FlatRecord
    - RepeatedElement
    range: redcap_integer
    required: false
  redcap_data_access_group:
    name: redcap_data_access_group
    description: The Data Access Group (DAG) the record belongs to, when DAGs are
      enabled and exported.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: FlatRecord
    domain_of:
    - FlatRecord
    range: string
    required: false
  redcap_survey_identifier:
    name: redcap_survey_identifier
    description: The survey participant identifier, present on rows captured through
      a public survey link.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: FlatRecord
    domain_of:
    - FlatRecord
    range: string
    required: false