Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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.
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.
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 modalities.
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>
JSON object
This object contains information about the squirrel package.
orig
- Original subject, study, series directory structure format. Example S1234ABC/1/1
seq
- Sequential. Zero-padded sequential numbers. Example 00001/0001/00001