This topic lists the field names that are reserved in a study. The properties listed here are in addition to the reserved dataset system fields, present in every study dataset. The reserved fields each have a special role to play within the study container.

FieldData TypeReserved in Visit-based?Reserved in Date-based?Description
ParticipantIdText (String)YesYesThe default subject identifier, used to hold the unique id for each subject in the study. This default field name can be changed on study creation to a more appropriate value to reflect the nature of the organisms being studied, for example "MouseId".
ParticipantText (String)YesYesA reserved field name (but not currently used by the system).
VisitInteger, Number, or StringYesYesProvide special display and import behavior in Visit-based studies. When integer or number data is imported under the field name "Visit", the data will automatically be inserted into the dataset's "SequenceNum" field. Matching values will be loaded into any pre-existing visits; non-matching values will result in the creation of new visits. When string data is imported under this field name, LabKey will try to match the string value to an existing visit label. If a match is found, the data will be imported into the matching visit. If no match is found, no data will be imported and an error will be returned.
SequenceNumNumber (Double)YesYesA decimal number used to define the relative order of visits in the study.
StartDate (in Demographic datasets)DateTimeYesYesWhen present in Date-based studies, StartDate can be used as a participant-specific start date, overriding the study's generic start date. Relevant calculations, such as time charts and visit events, are calculated using each participant's StartDate, instead of the generic start date. StartDate must be included in a demographic dataset. For details see Timepoints FAQ.
DateDateTimeNoYesReserved field only in Date-based studies.
DayIntegerNoYesReserved field only in Date-based studies. In Date-based studies, "Day" is a calculated field, showing the number of days since the start date, either the study's general start date, or the participant-specific start date (if defined).
VisitDateDateTimeNoYesRecords the date of the visit. In Date-based studies, when importing data, this field can be used as a synonym for the Date field.

Specimen Reserved Fields

For details on specimen reserved fields, see the following topics:

Related Topics


Was this content helpful?

Log in or register an account to provide feedback

expand all collapse all