Data Dictionary
Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com

Data Dictionary

Introduction

This document provides information about all the attributes used in OpenSpecimen and their description listed on each user interface page.

Description of the fields in the below table:

  • Page: OpenSpecimen user interface page

  • Attribute name: Fields displayed per page

  • Definition: Description of the attribute

  • Permissible Values: For specific fields in OpenSpecimen, the user is restricted to use a set of permissible values (shown as dropdown fields on the interface). This column lists these permissible values.

 

Page

Attribute Name

Definition

Permissible Values

Page

Attribute Name

Definition

Permissible Values

Administrative Data

Users

Type

Type of user.

  • Super Administrator

  • Institute Administrator

  • Contact

  • Regular

 

Last Name

Last name of the user.

 

 

First Name

First Name of the User.

 

 

Email Address

The email address of the user.

 

 

Phone number

Phone number.

 

 

Domain Name

By default, this is an openspecimen to support normal logins. If the system is integrated with LDAP, then the domain can be selected based on that.

openspecimen

 

Login Name

Login name of the user.

 

 

Institute

Institute name to which the user is associated.

 

 

Primary Site

The primary site user belongs to. This is just for information and is not used to assign any privileges to the user. (Available in the version before v8.1)

 

 

Time Zone

Time zone of the user.

 

 

Manage forms?

Indicates whether the user can access custom forms or not.

  • Yes

  • No

 

Disable notification

Indicates whether the email notification for the user will be on or off.

  • Yes

  • No

 

Address

Address of the user.

 

 

API User?

Indicates whether the user can access OpenSpecimen APIs

  • Yes

  • No

 

Role

Defines user role according to which the privileges get assigned within one or more sites. A role can also be restricted to one or more collection protocols within the site.

Default Roles:

  • Administrator

  • Coordinator

  • Principal Investigator

  • Researcher

  • Technician

  • Tissue Banker

Institutes

Name

Name of the Institution (Overarching authoritative entity).

 

Sites

Institute

Institute name to which the site is associated.

 

 

Name

Name of the physical location (Biobank, repository, or hospital).

 

 

Code

Shortcode, which can be used in container name generation.

 

 

Type

The function of the site. It could be for collection, storage, experimentation, etc.

  • Collection Site

  • Repository

  • Laboratory

  • Not Specified

  • Not applicable

 

Coordinators

Coordinators name.

 

 

Address

Address of the site.

 

Container Types

Name

Name of the container type.

 

 

Name Format

Indicates the naming/labeling format of the container.

 

 

Dimensions

Dimensions of the container

  • Rows

  • Columns

 

Position labeling

Indicates position labeling of the container.

  • Linear

  • Row and Column

 

Labeling scheme

Labeling rows and columns

  • Numbers

  • Alphabetic Upper Case

  • Alphabetic Lower Case

  • Roman Upper Case

  • Roman Lower Case

Comments

Got feedback or spotted a mistake?

Leave a comment at the end of this page or email contact@krishagni.com