treatments
| Name | treatments.txt |
| JSON File Name | treatments.json |
| Type | single |
| Schema Version | 3.37 |
| Description | The treatment template defines and annotates the in vitro modifications (molecule added, temperature, duration) made to a sample. Treatments are required to be referenced by experiment samples and optionally by biologic samples. |
| Download | ⬇️ treatments.xlsx ⬇️ treatments.txt ⬇️ treatments.json This top-level schema references companion files (e.g. treatments.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.
At least one of Amount Value, Amount Unit, Duration Value, Duration Unit, Temperature Value, Temperature Unit is required when Use Treatment? = "Yes".
| Template Column | Requirement | Type & Constraints | Description |
|---|---|---|---|
| User Defined ID | Required | Text, max 100 characters JSON: userDefinedId (string) | The treatment user defined ID is an identifier chosen by the data provider to refer to a treatment agent which can be a molecule, time or temperature. This ID may be referenced by other data records (e.g. study). The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| Name | Required | Text, max 100 characters JSON: name (string) | The treatment name is not referenced directly by other data records. The name should be an informative to a researcher reviewing the data. Treatments may be referenced by more than one biological or experiment sample. There are three categories to describe the molecular content, time and/or temperature applied in a sample treatment. You may enter data for amount, duration or temperature only any combination of these categories (e.g. amount and duration). Treatments refer to in vitro modifications of samples. The treatment name is an alternate identifier that is visible when the treatment is shared. |
| Use Treatment? | Required | Controlled vocabulary — value must be one of lk_yes_no JSON: useTreatment (enum) | If 'No' is selected, you must enter a value in the Treatment User Defined ID and Name columns and that is all. If 'Yes' is selected, you must enter a value in the Treatment User Defined ID and Name columns and the value/unit pair of columns for amount or duration or temperature. Was a treatment applied to a sample? |
| Amount Value | Optional Must be provided together with Amount Unit (or leave both blank). | Text, max 50 characters JSON: amountValue (string) | The value should be a number. The Amount Value indicates how much (concentration, mass, volume) of a treatment agent was applied to a sample. |
| Amount Unit | Optional Must be provided together with Amount Value (or leave both blank). | Text, max 50 characters Controlled vocabulary — value must be one of lk_amount_unit JSON: amountUnit (enum) | The amount unit preferred terms list has commonly used units. If additional units are needed, please contact the ImmPort HelpDesk. The unit should be selected from the drop down list. |
| Duration Value | Optional Must be provided together with Duration Unit (or leave both blank). | Text, max 200 characters JSON: durationValue (string) | The Duration Value indicates how long a treatment agent was applied to a sample. The value should be a number. |
| Duration Unit | Optional Must be provided together with Duration Value (or leave both blank). | Text, max 25 characters Controlled vocabulary — value must be one of lk_time_unit JSON: durationUnit (enum) | The duration unit preferred terms list has commonly used units. If additional units are needed, please contact the ImmPort HelpDesk. The unit should be selected from the drop down list. |
| Temperature Value | Optional Must be provided together with Temperature Unit (or leave both blank). | Text, max 50 characters JSON: temperatureValue (string) | The Temperature Value indicates how long a treatment agent was applied to a sample. The value should be a number. |
| Temperature Unit | Optional Must be provided together with Temperature Value (or leave both blank). | Text, max 50 characters Controlled vocabulary — value must be one of lk_temperature_unit JSON: temperatureUnit (enum) | The temperature unit preferred terms list has commonly used units. If additional units are needed, please contact the ImmPort HelpDesk. The unit should be selected from the drop down list. |
| Comments | Optional | Text, max 500 characters JSON: comments (string) | The Comments column allows the data provider to provide additional descriptive information. Please provide additional comments as needed. |