Collection Protocol CSV

From v9.0. OpenSpecimen supports creating the participant and specimen-centric CPs using the CSV import. In order to use that user has to fill the below template and follow the steps to import the CPs in bulk.

Field Name	Data Type	Mandatory	Description	Validation
Title	String	Yes	Collection protocol long title	Unique within the system
Short Title	String	Yes	Collection protocol short title	Unique within the system
Code	String	No	Collection protocol code	Unique within the system
Start Date	Date	No	Collection protocol start date	-
End Date	Date	No	Collection protocol end date	-
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	-
IRB ID	String	No	IRB protocol number that was assigned to your study by the Institutional Review Board	-
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	Boolean	No	Pre-printing the label format. Refer wiki a page for more details.
Description URL	String	No	Collection Protocol additional details
Activity Status	String	No	Active/Disabled, By default, it's Active.
Sites#1#Name	String	Yes	Collection Protocol Site Name
Sites#1#Code	String	No	Site Code
Sites#2#Name	String	No	Collection Protocol Site Name
Sites#2#Code	String	No	Site Code
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

Example Collection Protocol Bulk Import Template:

Steps to Import Collection Protocol CSV:

Download the above template and fill in all the required details
Follow the steps on this wiki (Section - Rules for the import file naming) page to give the specific naming convention to the filled template.
Once the file is ready, Go to Extras → Import Records
Upload the CSV file you created (You can upload the CSV or ZIP, which includes the CSV)
Check the import status

Import CP Events and Specimen Requirement:

From v7.1, it is possible to bulk import CP event and specimen requirements. This is useful for bulk importing legacy data, managing large CPs, or interfacing with external apps.

Refer to the below pages for details.