Collection Protocol CSV
Got feedback or spotted a mistake?

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

Collection Protocol CSV

Users can create/update multiple CPs at once using the 'CP CSV import' feature of OpenSpecimen.

To update any field of the collection protocol, it's important to ensure that all columns and their existing values are maintained during the update process. If any fields are left blank, those fields will be overwritten with empty values, potentially causing data loss or incorrect updates.

Below are the fields in the template:

Field Name

Data Type

Mandatory

Description

Validation

Field Name

Data Type

Mandatory

Description

Validation

SitesX#Name

String

Yes

Sites for the CP. You can create multiple columns replacing 'X' with number. E.g., Sites#1#Name, Sites#2#Name, etc.

Site name should be present in OpenSpecimen.

SitesX#Code

String

No

Site codes for the CP. You can create multiple columns replacing 'X' with number. E.g., Sites#1#Code, Sites#2#Code, etc.

Site code should be present and associated to the site in OpenSpecimen.

Identifier

Integer

No

The CP Identifier. Mandatory: when updating Short Title.

Unique within the system

Title

String

Yes

Collection protocol long title

Unique within the system

Short Title

String

Yes

Collection protocol short title. Mandatory: when updating CP Details.

Unique within the system

Code

String

No

Collection protocol code

Unique within the system

PI#PI Email

Email

Yes

Principle Investigator of the collection protocol. Users need to provide the email ID in this field

 

Coordinator#1#Coordinator Email

Email

No

Collection Protocol coordinator. Users need to provide the email ID in this field

 

Start Date

Date

No

Collection protocol start date.

-

End Date

Date

No

Collection protocol end date

-

IRB ID

String

No

IRB protocol number that was assigned to your study by the Institutional Review Board

Unique across the system

Specimen Centric

Boolean

No

Collection Protocol Type: If value = TRUE/YES, it will create the Specimen Centric CP. Else, it will create the participant centric by default if you have not provided any option. For FALSE/NO, it will create the participant-centric CP

-

Anticipated Participants Count

Integer

No

A number of participants will be registered in the Collection protocol.

 

PPID Format

String

No

Participant Protocol ID format to generate the PPIDs by OpenSpecimen. Refer to this for more details.

 

Visit Name Format

String

No

Visit Name format to generate the Visits by OpenSpecimen. Refer to this for more details.

 

Label Format

String

No

Primary specimen label format, refer to this wiki for more details

 

Derivative Label Format

String

No

Derived specimen label format, refer to this wiki for more details

 

Aliquot Label Format

String

No

Aliquot specimen label format, refer to this wiki for more details

 

User inputs PPID

String

No

Values are Yes/No; if Yes, OpenSpecimen allows the user to input the PPID

 

User inputs Visit Name

String

No

Values are Yes/No; if Yes, OpenSpecimen allows the user to input the Visit Name

 

User inputs Specimen Label

String

No

Values are Yes/No; if Yes, OpenSpecimen allows the user to input the specimen labels

 

Label Pre-print Mode

String

No

Pre-create specimen labels before the actual collection. Refer wiki page for more details.

Values:
ON_REGISTRATION: On Registration
ON_PRIMARY_COLL: On Primary Collection
ON_VISIT: On Visit Collection
ON_PRIMARY_RECV: On Primary Receive
ON_SHIPMENT_RECV: On Shipment Receive
NONE: None

 

Description URL

String

No

Collection Protocol additional details

 

Activity Status

String

No

Active/Disabled, By default, it's Active.

 

Close Parent Specimens

String

No

Values are Yes/No; If yes, parent specimens are automatically closed after collection or processing. Refer to this wiki page for more details.

 

SOP Document URL

String

No

URL for the SOP Document. Refer to this wiki page for more details.

 

SOP Document Name

String

No

Name of the SOP Document (PDF) uploaded. Refer to this wiki page for more details.

 

Store SPRs?

String

No

Values are Yes/No; If yes, OpenSpecimen allows uploading SPRs. Refer to this wiki page for more details.

 

Extract Text from SPR PDF Docs?

String

No

Values are Yes/No; If yes, OpenSpecimen converts PDF to plain text. Refer to this wiki page for more details.

 

Zero Out Specimen Quantity

String

No

Values are Yes/No. If yes, it will make the specimen quantity zero when they are closed. Refer to this wiki page for more details.

 

Additional Label Format

String

No

To capture additional label/ID for the specimen. Refer to this wiki page for more details.

 

Enable Specimen Barcoding

String

No

Values are Yes/No. If yes, barcoding is enabled at the CP level. Refer to this wiki page for more details.

 

Specimen Barcode Format

String

No

Label format for barcodes. Refer to this wiki page for more details.

 

Label Sequence Key

String

No

Values are LABEL/ID. To track sequences based on Labels or IDs.

 

Kit Labels

String

No

Values are Yes/No. Kits will only be generated if this is enabled. Refer to this wiki page for more details.

 

Show On Visit Collection

String

No

Values are ALL_SPMNS/ PRIMARY_SPMNS.
If ALL_SPMNS, then all specimens are shown when collecting a visit.
If PRIMARY_SPMNS, then only primary specimens are shown when collecting a visit.

 

Storage Site Based Access

String

No

Values are Yes/No. Refer to this wiki page for more details.

 

Draft Data Entry

String

No

Values are Yes/No. Refer to this wiki page for more details.

 

Label Print Setting#1#Lineage

String

No

Value is New/Derived/Aliquot. It defines which specimens are printed. Refer to this wiki page for more details.

 

Label Print Setting#1#Print Mode

String

No

Defines when the specimen labels are printed.
Values are:
PRE_PRINT: Pre-print
ON_COLLECTION: On collection
NONE: None

Refer to this wiki page for more details.

 

Label Print Setting#1#Copies

Integer

No

Number of copies, e.g., 1,2,3….

 

Container Auto Allocation Strategy

String

No

Values are least-empty/recently-used. Refer to this wiki page for more details.

 

Store aliquots in the same box

String

No

Values are Yes/No. Refer to this wiki page for more details.

 

Distribution Protocols#1#Short Title

String

No

Value: Distribution Protocol Short Title.

Note: To link more than one DP to CP, add N number of columns as Distribution Protocols#2#Short Title, Distribution Protocols#3#Short Title and so on.

 

Example Collection Protocol Bulk Import Template:

Steps to Import:

  1. Download the above template and fill in all the required details

  2. Follow the steps on this wiki (Section - Rules for the import file naming) page to give the specific naming convention to the filled template.

  3. Once the file is ready, Go to Extras → Import Records

  4. Upload the CSV file you created (You can upload the CSV or ZIP, which includes the CSV)

  5. Check the import status

Steps to Update:

  1. Export the CP details by navigating to CP List Page → More → Export → Collection Protocol.

  2. Update values for required column, and save the CSV file.

  3. Navigate to CP List Page → Import Biospecimen Data → Select Collection Protocol → Choose the above saved CSV file → Import.

Got feedback or spotted a mistake?

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