Skip to content

Class: StructuredRecord

Root of the structured (record-grouped) serialization: one object per record_id, the lossless re-grouping of the flat export's rows for that record, with its repeating-instrument instances nested in repeated_elements. This is REDCap's own record model serialized hierarchically. Abstract and convention-free: a project specialises it (is_a: StructuredRecord), marks itself tree_root: true, and adds its typed non-repeating instrument slots; it narrows repeated_elements to its own specialised RepeatedElement via slot_usage. The package defines no instrument classes, naming rules, or mappings — those are the project's and rarelink's.

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

      StructuredRecord : repeated_elements





        StructuredRecord --> "*" RepeatedElement : repeated_elements
        click RepeatedElement href "../RepeatedElement/"
## 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 | | [repeated_elements](repeated_elements.md) | *
[RepeatedElement](RepeatedElement.md) | The repeating-instrument instances of a structured record, as a single list t... | direct | ## Identifier and Mapping Information ### Schema Source * from schema: https://w3id.org/linkml/redcap-record ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | redcap_record:StructuredRecord | | native | redcap_record:StructuredRecord | ## LinkML Source ### Direct
name: StructuredRecord
description: 'Root of the structured (record-grouped) serialization: one object per
  ``record_id``, the lossless re-grouping of the flat export''s rows for that record,
  with its repeating-instrument instances nested in ``repeated_elements``. This is
  REDCap''s own record model serialized hierarchically. Abstract and convention-free:
  a project *specialises* it (``is_a: StructuredRecord``), marks itself ``tree_root:
  true``, and adds its typed non-repeating instrument slots; it narrows ``repeated_elements``
  to its own specialised ``RepeatedElement`` via ``slot_usage``. The package defines
  no instrument classes, naming rules, or mappings  those are the project''s and
  rarelink''s.'
from_schema: https://w3id.org/linkml/redcap-record
abstract: true
slots:
- record_id
- repeated_elements
slot_usage:
  record_id:
    name: record_id
    identifier: true
    required: true
### Induced
name: StructuredRecord
description: 'Root of the structured (record-grouped) serialization: one object per
  ``record_id``, the lossless re-grouping of the flat export''s rows for that record,
  with its repeating-instrument instances nested in ``repeated_elements``. This is
  REDCap''s own record model serialized hierarchically. Abstract and convention-free:
  a project *specialises* it (``is_a: StructuredRecord``), marks itself ``tree_root:
  true``, and adds its typed non-repeating instrument slots; it narrows ``repeated_elements``
  to its own specialised ``RepeatedElement`` via ``slot_usage``. The package defines
  no instrument classes, naming rules, or mappings  those are the project''s and
  rarelink''s.'
from_schema: https://w3id.org/linkml/redcap-record
abstract: true
slot_usage:
  record_id:
    name: record_id
    identifier: true
    required: 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
    identifier: true
    owner: StructuredRecord
    domain_of:
    - FlatRecord
    - StructuredRecord
    range: string
    required: true
  repeated_elements:
    name: repeated_elements
    description: The repeating-instrument instances of a structured record, as a single
      list tagged by ``(instrument, instance)`` — the minimal lossless representation
      of REDCap's repeats. A project root redeclares the range to its own specialised
      ``RepeatedElement`` via ``slot_usage``.
    from_schema: https://w3id.org/linkml/redcap-record
    rank: 1000
    owner: StructuredRecord
    domain_of:
    - StructuredRecord
    range: RepeatedElement
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true