Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Primary key Required Computed (squirrel writer/reader should handle these variables)
| Variable | Type | Default | Description (and possible values) |
|---|---|---|---|
AlternateIDs
JSON array
List of alternate IDs. Comma separated.
DateOfBirth
date
Subject’s date of birth. Used to calculate age-at-server. Can be YYYY-00-00 to store year only, or YYYY-MM-00 to store year and month only.
Gender
char
Gender.
GUID
string
Globally unique identifier, from NDA.
Ethnicity1
string
NIH defined ethnicity: Usually hispanic, non-hispanic
Ethnicity2
string
NIH defined race: americanindian, asian, black, hispanic, islander, white
Sex
char
Sex at birth (F,M,O,U).
SubjectID
string
Unique ID of this subject. Each subject ID must be unique within the package.
InterventionCount
number
Number of intervention objects.
ObservationCount
number
Number of observation objects.
StudyCount
number
Number of studies.
VirtualPath
string
Relative path to the data within the package.
JSON array
Array of imaging studies/sessions.
JSON array
Array of observations.
JSON array
Array of interventions.
Separate JSON file - params.json
Series collection parameters are stored in a separate JSON file called params.json stored in the series directory. The JSON object is an array of key-value pairs. This can be used for MRI sequence parameters.
All DICOM tags are acceptable parameters. See this list for available DICOM tags https://exiftool.org/TagNames/DICOM.html. Variable keys can be either the hexadecimal format (ID) or string format (Name). For example 0018:1030 or ProtocolName. The params object contains any number of key/value pairs.
Files associated with this section are stored in the following directory. subjectID, studyNum, seriesNum are the actual subject ID, study number, and series number. For example /data/S1234ABC/1/1.
/data/<SubjectID>/<StudyNum>/<SeriesNum>/params.json
JSON array
An array of series. Basic series information is stored in the main squirrel.json file. Extended information including series parameters such as DICOM tags are stored in a params.json file in the series directory.
Files associated with this section are stored in the following directory. subjectID, studyNum, seriesNum are the actual subject ID, study number, and series number. For example /data/S1234ABC/1/1.
/data/<SubjectID>/<StudyNum>/<SeriesNum>
Behavioral data is stored in
/data/<SubjectID>/<StudyNum>/<SeriesNum>/beh
JSON array
An array of imaging studies, with information about each study. An imaging study (or imaging session) is defined as a set of related series collected on a piece of equipment during a time period. An example is a research participant receiving an MRI exam. The participant goes into the scanner, has several MR images collected, and comes out. The time spent in the scanner and all of the data collected from it is considered to be a study.
Files associated with this section are stored in the following directory. SubjectID and StudyNum are the actual subject ID and study number, for example /data/S1234ABC/1.
/data/<SubjectID>/<StudyNum>
| Variable | Description | Example |
|---|---|---|
Primary key Required Computed (squirrel writer/reader should handle these variables)
Primary key Required Computed (squirrel writer/reader should handle these variables)
| Variable | Type | Default | Description |
|---|---|---|---|
Valid squirrel modalities are derived from the DICOM standard and from NiDB modalities. Modality can be any string, but some squirrel readers may not correctly interpret the modality or may convert it to “other” or “unknown”. See full list of .
Primary key Required Computed (squirrel writer/reader should handle these variables)
| Variable | Type | Default | Description |
|---|