Leave a comment at the end of this page or email contact@krishagni.com
Data Dictionary
- 1 Introduction
- 2 Administrative Data
- 2.1 Users
- 2.2 Institutes
- 2.3 Sites
- 2.4 Container Types
- 2.5 Containers
- 2.6 Collection Protocol
- 3 Carts
- 4 BioSpecimen Data
- 4.1 Participant
- 4.2 Consents
- 4.3 Visits
- 4.4 Surgical Pathology Report
- 4.5 Specimen
- 5 Gels
- 6 Distribution Protocols and Distribution Orders
- 7 Specimen Events
- 7.1 Collection Event
- 7.2 Received Event
- 7.3 Cell Review Event
- 7.4 Check In Check Out Event
- 7.5 Embedded Event
- 7.6 Fixed Event
- 7.7 Frozen Event
- 7.8 Molecular Review Event
- 7.9 Procedure Event
- 7.10 Spun Event
- 7.11 Tissue Review Event
- 7.12 Transfer Event
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 |
|---|---|---|---|
Administrative Data | |||
Users | Type | Type of user. |
|
| 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. |
|
| Disable notification | Indicates whether the email notification for the user will be on or off. |
|
| Address | Address of the user. |
|
| API User? | Indicates whether the user can access OpenSpecimen APIs |
|
| 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:
|
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. |
|
| 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 |
|
| Position labeling | Indicates position labeling of the container. |
|
| Labeling scheme | Labeling rows and columns |
|
| Position assignment | Indicates how the specimens will be placed in the container. |
|
| Temperature (Celsius) | The temperature of the container. |
|
| Store specimen? | Indicates whether the container will hold specimens or not. |
|
| Can hold | Indicates whether the current container will hold any other container. |
|
Containers | Create | Type of container User wants to create. |
|
| Number of containers | The number of containers to be created. |
|
| Used for | Usage of Container. |
|
| Type | Name of Container Type. |
|
| Name | Name of the container. |
|
| Barcode |
|
|
| Parent Site | The site to which the container will belong. |
|
| Parent Container | The site with which the container is associated. | Select parent container if creating child container. |
| Dimensionless? | Indicates if the container will have dimensions or not. |
|
| Dimensions | The number of rows and number of columns. |
|
| Approximate capacity | The capacity of the container to hold specimens. |
|
| Position labeling | Indicates how specimen labeling should be done. |
|
| Position assignment | Indicates how the specimens will be placed in the container. |
|
| Labeling scheme | Labeling rows and columns. |
|
| Temperature (Celsius) | The temperature of the current type of storage container. |
|
| Stores Specimens | This indicates at which level the specimens will be stored like a box. |
|
| Display in Map | Indicated what label type should be displayed for a specimen. |
|
| Collection Protocol | Restrict to store specimens from specific collection protocols. |
|
| Specimen Types | Restrict specimen types to be stored in the container. |
|
Collection Protocol | Sites | Sites with which the collection protocol is associated. |
|
| Site Code Information | Code of Site |
|
| Title | Title of the protocol. |
|
| Short Title | Short title of the protocol. This will be displayed on all data entry pages. |
|
| Code | Collection Protocol Code. Usually used to generate Participants Ids. |
|
| Principal Investigator | User will be assigned PI role, which gets read access to all protocol data. |
|
| Protocol Coordinators | User will be assigned coordinator role, who gets all access to all protocol data. |
|
| Start/End Date | Start date and end date of the collection protocol based on which protocol expiry reports are sent. |
|
| Ethics Approval/ IRB ID | IRB ID assigned by the review board. |
|
| Type | Type of Collection protocol |
|
| 'Expected Registrations' | Number of Participants Anticipated to get registered in the protocol |
|
| SOP Document URL | Standard operating procedure document link. |
|
| SOP Document file | Standard operating procedure document file. |
|
| Store SPR's | Indicates whether to store surgical pathology reports or not. |
|
| Extract Text from SPR PDF Docs? | Indicates whether to Extract Text from SPR PDF Documents or not. |
|
| Participant Protocol Identifier Format | Allows setting PPI format according to which PPI of the future participants will be generated on registration. |
|
| Visit Name Format |
|
|
| Specimen Label Format | The format in which the specimen label will be created. |
|
| Derivative Label Format |
|
|
| Aliquot Label Format |
|
|
| User inputs allowed | Manual inputs for labels. | |