Link Search Menu Expand Document

Subject model

Table of contents

  1. Introduction
  2. Fields
    1. Procedure data fields
  3. Permissions
  4. Subject API access

Introduction

The subject model describes your animal subject through a set of standard fields. Flexibility is built in through a rich text description field, extra fields, and tags. Procedures offer a modular framework that can be used to describe processes related to your subject.

Fields

FieldDescription
NameName of the subject (required; string; maximum length: 100 characters; must be unique across BrainSTEM). Example: “Mouse_01”, “Rat_2024_A”
ProjectsProjects the subject belongs to (required). Can belong to multiple projects. Example: Added to both “Memory Study” and “Aging Study”. Learn more about project inheritance here.
SexSex of the animal: (Male, Female, or Unknown; required). Selected from predefined choices. Example: “Female”
SpeciesSpecies of the subject (required). Please add in taxonomies section if not available. Example: “Mus musculus”
StrainStrain of the subject (required). Please add in taxonomies section if not available. Example: “C57BL/6J”
DescriptionA rich text description of the subject. Can be left empty. Example: “Male C57BL/6J mouse, exhibits normal behavior…”
Genetic lineGenetic line of the subject. Could also be wild type (string; maximum length: 100 characters). Example: “Wild type” or “PV-Cre”
Birth dateBirth date of the animal subject. Can be left empty. Example: “2023-03-22”
Death dateDeath date of the animal subject. Can be left empty. Example: “2024-03-25”
TagsTags for the subject. Great for organizational purposes, quick labeling, and filtering. Example: control-group”, “lesion”
Subject identifierAny identifier used for this subject outside of BrainSTEM, such as an ear tag or RFID number (string; maximum length: 100 characters). Example: “Ear tag #A1234”
SourceSource of the subject. Can be left empty (string; maximum length: 100 characters). Example: “Charles River”, “In-house breeding”
Name used in storageUse this field if you have another name for your subject in your local data storage (string; maximum length: 200 characters). Example: “M01_2024_exp3”
Extra fieldsAllows you to add extra fields to the subject. Values can be strings or numeric. Example: {“Weight”: “25g”, “Litter”: “A3”}

Procedure data fields

Please see the dedicated page describing the Procedure data model.

Permissions

Subjects inherit permissions from projects associated with them. Procedures, Subject logs, and Procedure logs all inherit permissions through the subject.

Visit the permissions page to learn more.

Subject API access

The API allows for programmable access to subjects. Learn more about the subjects’ fields and data structure on the Subject API page.