Skip to content

REDCap Data Dictionary LinkML Schema

A LinkML meta-schema that formally models the structure of REDCap data dictionaries (CSV format). This schema defines the rules, constraints, and relationships of all 18 REDCap data dictionary columns, enabling programmatic validation, generation, and transformation of REDCap instruments. It is a vendor-neutral model of REDCap itself; RareLink-style ontology conventions (variable-name prefixes, coded choices, structured field annotations, BioPortal/ontology curation) are layered on top in the rarelink repository, not defined here.

URI: https://w3id.org/linkml/redcap-data-dictionary

Name: redcap_data_dictionary

Classes

Class Description
Choice A single permissible value for a dropdown, radio, or checkbox field
DataDictionary A complete REDCap data dictionary representing one or more instruments (forms...
Field A single variable (field) in a REDCap data dictionary
Instrument A logical REDCap instrument (form) grouping related fields

Slots

Slot Description
branching_logic Conditional display logic
choices_calculations_slider_labels For dropdown, radio, and checkbox fields: pipe-delimited list of 'raw_value, ...
custom_alignment Controls the alignment of the field on the form
field_annotation REDCap's field annotation column — free text plus action tags (e
field_label The display label shown to users during data entry
field_note Supplementary text displayed below the field during data entry
field_type The type of input field
fields Ordered list of all fields (variables) in the data dictionary
form_name The instrument (form) this field belongs to
identifier Whether this field contains identifying information (PHI)
instrument_label Human-readable label for the instrument
instrument_name The form_name shared by all fields in this instrument
is_repeating Whether this instrument supports repeating instances
label The human-readable display label for this choice (e
matrix_group_name Groups multiple radio/checkbox fields into a matrix display
matrix_ranking Whether ranking is enabled for this matrix group
question_number Custom question number for surveys
raw_value The stored value (code) for this choice
required_field Whether the field is required for form completion
section_header Optional section header text displayed above this field to visually group fie...
text_validation_max Maximum allowed value for validated text fields (dates, numbers)
text_validation_min Minimum allowed value for validated text fields (dates, numbers)
text_validation_type_or_show_slider_number For text fields: the validation type constraining input format
variable_field_name The unique variable name for this field

Enumerations

Enumeration Description
CustomAlignment Field alignment options for the data entry form
FieldType The complete set of REDCap field types that determine how a variable is rende...
IdentifierStatus Whether a field contains Protected Health Information
MatrixRanking Whether matrix ranking is enabled
TextValidationType Validation rules for text fields constraining the input format

Types

Type Description
Boolean A binary (true or false) value
Curie a compact URI
Date a date (year, month and day) in an idealized calendar
DateOrDatetime Either a date or a datetime
Datetime The combination of a date and time
Decimal A real number with arbitrary precision that conforms to the xsd:decimal speci...
Double A real number that conforms to the xsd:double specification
Float A real number that conforms to the xsd:float specification
Integer An integer
Jsonpath A string encoding a JSON Path
Jsonpointer A string encoding a JSON Pointer
Ncname Prefix part of CURIE
Nodeidentifier A URI, CURIE or BNODE that represents a node in a model
Objectidentifier A URI or CURIE that represents an object in the model
Sparqlpath A string encoding a SPARQL Property Path
String A character string
Time A time object represents a (local) time of day, independent of any particular...
Uri a complete URI
Uriorcurie a URI or a CURIE

Subsets

Subset Description