biosamples

Name	bioSamples.txt
JSON File Name	bioSamples.json
Type	single
Schema Version	3.37
Description	The biological sample template is a legacy template that defines and annotates the types of samples derived from study subjects and when during the study schedule the sample was derived. The function of this template is also captured in the experiment samples template. This template will continue to be supported for the foreseeable future to support backward compatibility.
Download	⬇️ bioSamples.xlsx ⬇️ bioSamples.txt ⬇️ bioSamples.json This top-level schema references companion files (e.g. bioSamples.Datum.json) in the same json-templates folder — download the all_templates.zip to get them all together.

Reading this table: see How to read the template documentation for what Required / Conditionally required / Optional mean and how to read the Type & Constraints column.

Template Column	Requirement	Type & Constraints	Description
User Defined ID	Required	Text, max 100 characters JSON: userDefinedId (string)	The biological sample user defined ID is an identifier chosen by the data provider to refer to a sample. This ID may be referenced by other data records (e.g. experiment sample). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded.
Type	Required	Text, max 50 characters Controlled vocabulary — value must be one of lk_sample_type JSON: type (enum)	The sample types are adopted from Uberon, Cell and CHEBI ontologies. Please choose from the drop down list.
Subtype	Conditionally required when Type = "other"	Text, max 50 characters JSON: subtype (string)	Enter a sample type that is of finer resolution than the standard sample types provided. If the 'Biological Sample Type' is 'Other', then the sample subtype must be entered.
Name	Optional	Text, max 200 characters JSON: name (string)	The biological sample name is not referenced by other data records. The biological sample name is an alternate identifier that is visible when the sample is shared.
Description	Optional	Text, max 4000 characters JSON: description (string)	The biological sample description is used to describe details of the sample not captured in other columns.
Subject ID	Required	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a subject JSON: subjectId (string)	Please enter either a subject user defined ID or ImmPort accession for the subject from which the sample was derived. A single subject record is permitted.
Study ID	Required	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a study JSON: studyId (string)	A biological sample may be linked to a single study. Please enter either a study user defined ID or ImmPort accession.
Planned Visit ID	Required	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a planned_visit JSON: plannedVisitId (string)	The link to a study's planned visit provides temporal context for a sample's derivation from a subject. Please enter either a study's planned visit user defined ID or ImmPort accession.
Treatment ID(s)	Optional	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a treatment JSON: treatmentIds (array)	Please enter either a treatment user defined ID or ImmPort accession if the sample was manipulated in a manner significant to the assay prior to the assay being conducted. One or more identifiers can be entered per sample. Separate identifiers by semicolon (;). Please enter either a treatment user defined ID or ImmPort accession.
Study Time Collected	Required	Number JSON: studyTimeCollected (number)	Study time collected describes the time value for when a sample was derived from a subject. Please enter a number.
Study Time Collected Unit	Required	Text, max 25 characters Controlled vocabulary — value must be one of lk_time_unit JSON: studyTimeCollectedUnit (enum)	The time units are standard terms recommended by the HIPC Standards group. Please choose from the drop down list.
Study Time T0 Event	Required	Text, max 50 characters Controlled vocabulary — value must be one of lk_t0_event JSON: studyTimeT0Event (enum)	The time zero event refers to the study milestone upon which time is based. Please choose from the drop down list.
Study Time T0 Event Specify	Conditionally required when Study Time T0 Event = "other"	Text, max 50 characters JSON: studyTimeT0EventSpecify (string)	Enter a time zero event if 'Other' is selected in column 'Study Time T0 Event'.