assessments

Name	assessments.txt
JSON File Name	assessments.json
Type	combined-result
Schema Version	3.37
Description	The assessment panels template defines and annotates the assessment panels and the assessment components (results) defines and annotates the assessment for the panel. Assessment panels are often encoded in Case Report Forms (CRFs) and these are linked to a study. Assessment components are the answers to questions or assessments recorded in a CRF for a given subject within a study. The assessment template enables you to define the panel and its components in a single form. The assessment panel can be either new or pre-defined in this template. Any combination is acceptable. The only restriction is that the assessment panel id is the key to the template and must be unique within the template.
Download	⬇️ assessments.xlsx ⬇️ assessments.txt ⬇️ assessments.json This top-level schema references companion files (e.g. assessments.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
Subject ID	Required	Text, max 100 characters Metadata column JSON: subjectId (string)	Please enter either a subject user defined ID or ImmPort accession for the subject for the subject from which the assessment was completed. A single subject record is permitted. Please enter either a subject user defined ID or ImmPort accession for the subject from which the assessment was completed.
Assessment Panel ID	Required	Text, max 100 characters Metadata column JSON: assessmentPanelId (string)	The assessment panel user defined ID is an identifier chosen by the data provider to refer to a set of assessments, often organized into a Case Report Form. This ID may be referenced by other data records (e.g. assessment). The user defined ID is not shared Please enter either an assessment panel user defined ID or ImmPort accession.
Study ID	Conditionally required when you are defining a new Assessment Panel in this row (rather than referencing an existing one)	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a study Metadata column JSON: studyId (string)	An assessment panel may be linked to a single study. Please enter either a study user defined ID or ImmPort accession. This column is only required when both the assessment panel is new.
Name Reported	Conditionally required when you are defining a new Assessment Panel in this row (rather than referencing an existing one)	Text, max 125 characters Metadata column JSON: nameReported (string)	The assessment panel name is a display name that is available when the data is shared, but it is not referenced by other data. The assessment panel name is an alternate identifier that is visible when the assessment panel is shared.
Assessment Type	Optional	Text, max 125 characters Metadata column JSON: assessmentType (string)	The assessment type is not a constrained list of terms and suggested values include Physical Exam, Questionnaire, Medical History, Family History. Suggested values include Physical Exam, Questionnaire, Medical History, Family History.
Status	Optional	Text, max 40 characters Metadata column JSON: status (string)	The assessment status is not a constrained list of terms and suggested values include Completed, Partial, and Not Completed.
CRF File Names	Optional	Metadata column JSON: crfFileNames (array)	Separate file names by a semi-colon (;). The file size name limit is 240 characters. Please enter CRF file(s) to link to the assessment panel. Separate file names by a semi-colon (;). The file size name limit is 240 characters.
Result Separator Column	Optional	Metadata column JSON: resultSeparatorColumn (string)	This pseudo column separates meta data from results. This pseudo column separates the results (assessment components) from the assessment panel meta data. It must always appear and be the column that appears immediately after the last meta-data column and before any result columns.
User Defined ID	Required	Text, max 200 characters Result data column JSON: userDefinedId (string)	The assessment component user defined ID is an identifier chosen by the data provider to refer to this assessment result. An assessment component is a portion of an assessment panel. The user defined ID is not shared. The assessment component identifier should be unique to the ImmPort workspace to which the data will be uploaded.
Planned Visit ID	Required	Text, max 15 characters Reference — must already exist (in this package or the workspace) as a planned_visit Result data column JSON: plannedVisitId (string)	The link to a study's planned visit provides temporal context for a subjects assessment during the course of a study. Please enter either a study's planned visit user defined ID or ImmPort accession.
Name Reported	Required	Text, max 150 characters Result data column JSON: nameReported (string)	The assessment component name is a display name that is available when the data is shared, but it is not referenced by other data. The assessment component name is an alternate identifier that is visible when the sample is shared.
Study Day	Required	Number Result data column JSON: studyDay (number)	Study time collected describes the time value for when the assessment was completed. Please enter a number.
Age At Onset Reported	Conditionally required when Age At Onset Unit Reported is provided	Text, max 100 characters Result data column JSON: ageAtOnsetReported (number)	Please indicate the age at which a condition reported in the assessment occurred. This column is optional unless units (Age At Onset Unit Reported) is provided. Please enter a number.
Age At Onset Unit Reported	Conditionally required when Age At Onset Reported is provided	Text, max 25 characters Preferred vocabulary — reported value is kept; a preferred term from lk_preferred_time_unit is filled in when it matches Result data column JSON: ageAtOnsetUnitReported (enum)	The time unit for the age of onset value. This column is optional unless value (Age At Onset Reported) is provided. Suggested values include Days, Months, Years.
Is Clinically Significant	Optional	Text, max 1 characters Result data column JSON: isClinicallySignificant (string)	Is the condition reported in the assessment significant for the study analysis? Please enter a 'Y' or 'N.'
Location Of Finding Reported	Optional	Text, max 256 characters Result data column JSON: locationOfFindingReported (string)	Please use SnoMED CT terms if possible. Where on the subject's body does the condition reported in the assessment occur?
Organ Or Body System Reported	Optional	Text, max 100 characters Result data column JSON: organOrBodySystemReported (string)	Please use SnoMED CT terms if possible. What is the organ or body system affected by the condition reported in the assessment?
Result Value Reported	Optional	Text, max 250 characters Result data column JSON: resultValueReported (number)	The assessment component value is often the response to a question in a CRF.
Result Unit Reported	Optional	Text, max 40 characters Preferred vocabulary — reported value is kept; a preferred term from lk_unit_of_measure is filled in when it matches Result data column JSON: resultUnitReported (enum)	The unit for the assessment value.
Result Value Category	Optional	Text, max 40 characters Result data column JSON: resultValueCategory (string)	Suggested terms include Mild, Moderate, and Severe. A categorical representation of the assessment value.
Subject Position Reported	Optional	Text, max 40 characters Result data column JSON: subjectPositionReported (string)	Suggested terms include prone, supine, seated, and standing. The position the subject was in when the assessment was completed.
Time Of Day	Optional	Text, max 40 characters Result data column JSON: timeOfDay (string)	There are no preferrred response values. When during the day was the assessment completed.
Verbatim Question	Optional	Text, max 250 characters Result data column JSON: verbatimQuestion (string)	What is the wording of the question to elicit the assessment result? What is the actual question in the CRF?
Who Is Assessed	Optional	Text, max 40 characters Result data column JSON: whoIsAssessed (string)	Assessments can include study subject medical history and/or family history. Is the study subject assessed or a member of the study subject's family?