interventions

Name	interventions.txt
JSON File Name	interventions.json
Type	single
Schema Version	3.37
Description	The Intervention Template records the study interventions, concomitant medications, and anything else that was reported as entering a subject.
Download	⬇️ interventions.xlsx ⬇️ interventions.txt ⬇️ interventions.json This top-level schema references companion files (e.g. interventions.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 200 characters JSON: userDefinedId (string)	The intervention user defined ID is an identifier chosen by the data provider to refer to a adverse event. The user defined ID is not shared. The identifier should be unique to the ImmPort workspace to which the data will be uploaded.
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.
Name Reported	Required	Text, max 125 characters JSON: nameReported (string)	The intervention name is not referenced by other data records. The intervention name is an alternate identifier that is visible when the sample is shared.
Compound Name Reported	Required	Text, max 250 characters JSON: compoundNameReported (string)	The compound name describes what substance entered the subject.
Compound Role	Required	Text, max 40 characters Controlled vocabulary — value must be one of lk_compound_role JSON: compoundRole (enum)	Compound role indicates the purpose or category of the substance.
Dose Reported	Required	Text, max 150 characters JSON: doseReported (string)	The amount of a substance.
Start Day	Optional	Text, max 40 characters JSON: startDay (string)	The study day in which the substance was initially encountered.
End Day	Optional	Text, max 40 characters JSON: endDay (string)	The study day in which the substance was encounter ended.
Status	Optional	Text, max 40 characters JSON: status (string)	Did the substance encounter complete or was ended.
Reported Indication	Optional	Text, max 255 characters JSON: reportedIndication (string)	The purpose the substance was encountered.
Formulation	Optional	Text, max 125 characters JSON: formulation (string)	The packaging or delivery of the substance.
Dose	Optional	Number JSON: dose (number)	The dose value.
Dose Units	Optional	Text, max 40 characters JSON: doseUnits (string)	The dose unit.
Dose Freq Per Interval	Optional	Text, max 40 characters JSON: doseFreqPerInterval (string)	How often the substance was encountered.
Route Of Admin Reported	Optional	Text, max 40 characters JSON: routeOfAdminReported (string)	How the substance was administered.
Is Ongoing	Optional	Text, max 40 characters JSON: isOngoing (string)	Is the substance encounter continuing.
Start Time	Optional	Text, max 40 characters JSON: startTime (string)	Time within a study day the substance is initially encountered.
End Time	Optional	Text, max 40 characters JSON: endTime (string)	Time within a study day the substance encounter ended.
Duration	Optional	Text, max 40 characters JSON: duration (string)	Length of time for the encounter.
Duration Unit	Optional	Text, max 10 characters Controlled vocabulary — value must be one of lk_time_unit JSON: durationUnit (enum)	Time unit for the duration.