labtestpanels
| Name | labTestPanels.txt |
| JSON File Name | labTestPanels.json |
| Type | single |
| Schema Version | 3.37 |
| Description | The lab test panels template is a legacy template that defines and annotates the collection of lab tests applied to a sample (but not the lab test results). The function of this template is also captured in the lab tests template. This template will continue to be supported for the foreseeable future to support backward compatibility. |
| Download | ⬇️ labTestPanels.xlsx ⬇️ labTestPanels.txt ⬇️ labTestPanels.json This top-level schema references companion files (e.g. labTestPanels.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 lab test panel user defined ID is an identifier chosen by the data provider to refer to lab panel. This ID may be referenced by other data records (e.g. lab test). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| Name Reported | Required | Text, max 125 characters Preferred vocabulary — reported value is kept; a preferred term from lk_lab_test_panel_name is filled in when it matches JSON: nameReported (enum) | The lab panel name describes a lab test panel. Please select a preferred value from the list provided if the name matches your name or enter a name if there is not an appropriate one provided. This name is visible when the panel is shared. |
| Study ID | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a studyJSON: studyId (string) | A lab test panel may be linked to a single study. Please enter either a study user defined ID or ImmPort accession for the study in which the lab test panel occurs. |
| Protocol ID(s) | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a protocolJSON: protocolIds (array) | Please enter either a protocol user defined ID or ImmPort accession. One or more identifiers can be entered per subject. Separate identifiers by semicolon (;). |