Link Search Menu Expand Document

Procedure model

Table of contents

  1. Introduction
  2. Fields
  3. Types of procedures
  4. Permissions
  5. Procedure API access

Introduction

Procedures covers surgical procedures and other methods that allows you to track or record from a subject(s). Procedures have type-specific fields that are tailored to various procedure-types. The types of procedures currently supported by BrainSTEM are listed further down the page. An procedure is described by the fields in the next section.

Fields

FieldDescription
Typethe type of procedure (required). See options below
NoteeNotes to the procedure (max length: 500)
SubjectThe subject the procedure was performed on (required)
Date and timeDate and time the procedure was performed (e.g. “2023-03-22”)
ConsumableConsumable used for the procedure
Hardware deviceHardware device used to perform the procedure
Brain regionTarget brain region where the procedure was performed
Coordinates systemCoordinate system (required). See options below
Type detailsThere are also a number of type specific fields. See options below

Types of procedures

These are the available Type options for Procedure:

  • Optic fiber implant
  • Single wire electrode
  • Silicon probe implant
  • Tetrode wire electrode
  • Virus injection

A detailed list of the type-specific fields, can be found in the procedure type page.

Below are the available Coordinates system options for Procedure:

TypeDescription
Stereotaxic Bregma absoluteStereotaxic coordinates with Bregma as the origin. AP, ML, DV are used as coordinates
Stereotaxic Bregma brain surfaceStereotaxic coordinates with Bregma as the origin. AP, ML and depth are used as coordinates
Stereotaxic Lambda absoluteStereotaxic coordinates with Lambda as the origin. AP, ML, DV are used as coordinates
Stereotaxic Lampda brain surfaceStereotaxic coordinates with Lambda as the origin. AP, ML and depth are used as coordinates
Stereotaxic X-Y-ZStereotaxic coordinates using the Allen Institutes’s absolute X-Y-Z as coordinates
Stereotaxic X-Y SurfaceStereotaxic coordinates using the Allen Institutes’s absolute X-Y-Surface depth as coordinates

A detailed list of the fields in Coordinates system, can be found in the Coordinate system page.

Permissions

Procedures inherit permissions through the subject associated with it.

Visit the [permissions page] to learn more.

Procedure API access

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