assessmentcomponent
| Name | assessmentcomponent.txt |
| JSON File Name | assessmentcomponent.json |
| Type | single |
| Schema Version | 3.37 |
| Description | The assessment an 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 | ⬇️ assessmentcomponent.xlsx ⬇️ assessmentcomponent.txt ⬇️ assessmentcomponent.json This top-level schema references companion files (e.g. assessmentcomponent.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 assessment component user defined ID is an identifier chosen by the data provider to refer to an assessment. The user defined ID is not shared Please enter either an assessment component user defined ID or ImmPort accession. |
| Assessment Panel ID | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a assessment_panelJSON: assessmentPanelId (string) | Please enter either a assessment panel user defined ID or ImmPort accession for the assessment panel. Please enter either a assessment panel user defined ID or ImmPort accession for the assessment_panel. |
| Subject ID | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a subjectJSON: 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. |
| Planned Visit ID | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a planned_visitJSON: 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 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 JSON: studyDay (number) | Study time collected describes the time value for when the assessment was completed. Please enter a number. |
| Result Value Reported | Optional | Text, max 250 characters 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 JSON: resultUnitReported (enum) | The unit for the assessment value. |
| Result Value Category | Optional | Text, max 40 characters JSON: resultValueCategory (string) | Suggested terms include Mild, Moderate, and Severe. A categorical representation of the assessment value. |
| Age At Onset Reported | Optional | Text, max 100 characters 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 | Optional | Text, max 25 characters Preferred vocabulary — reported value is kept; a preferred term from lk_preferred_time_unit is filled in when it matches 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 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 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 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? |
| Subject Position Reported | Optional | Text, max 40 characters 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 JSON: timeOfDay (string) | There are no preferrred response values. When during the day was the assessment completed. |
| Verbatim Question | Optional | Text, max 250 characters 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 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? |