subjecthumans
| Name | subjectHumans.txt |
| JSON File Name | subjectHumans.json |
| Type | combined-result |
| Schema Version | 3.37 |
| Description | The subject human template defines and annotates key elements of study subjects including demographics and links subjects to an arm within a study. |
| Download | ⬇️ subjectHumans.xlsx ⬇️ subjectHumans.txt ⬇️ subjectHumans.json This top-level schema references companion files (e.g. subjectHumans.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) | The subject defined ID is an identifier chosen by the data provider to refer to a subject. This ID may be referenced by other data records (e.g. biological sample). The user defined ID is not shared. For human subjects, the ID should not be identifying. The identifier should be unique to the ImmPort workspace to which the data will be uploaded. |
| Sex | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Text, max 20 characters Controlled vocabulary — value must be one of lk_human_sex Metadata column JSON: sex (enum) | A list of preferred terms is available. Please choose from the drop down list. |
| Min Subject Age | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Number Metadata column JSON: minSubjectAge (number) | The subject age at the outset of the study may be determined form one of several study milestones as indicated in the Age Event column. Please enter a number. |
| Max Subject Age | Optional | Number Metadata column JSON: maxSubjectAge (number) | The subject age at the end of the study may be determined form one of several study milestones. Please enter a number. |
| Age Unit | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Text, max 25 characters Controlled vocabulary — value must be one of lk_time_unit Metadata column JSON: ageUnit (enum) | A list of preferred terms is available. The age unit must conform to the age unit assigned to the study. Please choose from the drop down list. The age unit must conform to the age unit assigned to the study. |
| Age Event | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Text, max 40 characters Controlled vocabulary — value must be one of lk_age_event Metadata column JSON: ageEvent (enum) | A list of preferred terms is available. Please choose from the drop down list. |
| Age Event Specify | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) and Age Event = "other" | Text, max 50 characters Metadata column JSON: ageEventSpecify (string) | This column supports providing study milestones for subject's age determination that ImmPort does not support. If "Age Event" = Other, this field specifies the age event (free text). Otherwise, leave this column blank. |
| Subject Phenotype | Optional | Text, max 200 characters Metadata column JSON: subjectPhenotype (string) | The subject phenotype captures key aspects of the subject's disposition for the study. Enter a description of the subject. |
| Subject Location | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Text, max 50 characters Controlled vocabulary — value must be one of lk_subject_location Metadata column JSON: subjectLocation (enum) | A list of subject locations is available. Please choose from the drop down list. |
| Ethnicity | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Text, max 50 characters Controlled vocabulary — value must be one of lk_ethnicity Metadata column JSON: ethnicity (enum) | A list of preferred terms is available. Please choose from the drop down list. |
| Race | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) | Text, max 50 characters Controlled vocabulary — value must be one of lk_race Metadata column JSON: race (enum) | A list of preferred terms is available. Please choose from the drop down list. |
| Race Specify | Conditionally required when you are defining a new Subject in this row (rather than referencing an existing one) and Race = "other" | Text, max 1000 characters Metadata column JSON: raceSpecify (string) | This column supports providing subject race descriptions that ImmPort does not support. If Race='Other', the race should be specified, otherwise leave blank. |
| Description | Optional | Text, max 4000 characters Metadata column JSON: description (string) | The subject description may be used to augment the arm or cohort based description of a subject. |
| Arm Or Cohort ID | Required | Text, max 100 characters Metadata column JSON: armOrCohortId (string) | A subject may be assigned to a single arm within a study. When subjects are initially uploaded to ImmPort, they may be assigned to a single study's arm. Please enter either a study arm or cohort user defined ID or ImmPort accession. When subjects are initially uploaded to ImmPort, they may be assigned to a single study's arm. |
| Result Separator Column | Optional | Metadata column JSON: resultSeparatorColumn (string) | This pseudo column separates meta data from results. This pseudo column separates the results (lab tests) from the lab test 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. |
| Exposure Process Reported | Required | Text, max 100 characters Preferred vocabulary — reported value is kept; a preferred term from lk_exposure_process is filled in when it matches Result data column JSON: exposureProcessReported (enum) | This identifies the type of process through which a host is exposed and the type of evidence for that exposure to have happened, which are tightly intertwined. This is the only element of the four that is always mandatory. Please select an exposure process from the list provided if the process matches yours or enter a exposure process if there is not an appropriate one provided. This exposure process is visible when the result is shared. The value provided by the user is further checked against the pref mapping table lk_exposure_process_pref_map. |
| Exposure Material Reported | Conditionally required when Exposure Process Reported = "administering substance in vivo ; occurrence of asymptomatic infection ; environmental exposure to endemic/ubiquitous agent without evidence for disease ; documented exposure without evidence for disease ; exposure with existing immune reactivity without evidence for disease ; exposure to substance without evidence for disease ; infectious challenge ; transplantation or transfusion ; vaccination ; occurrence of infectious disease ; occurrence of allergy" | Text, max 200 characters Preferred vocabulary — reported value is kept; a preferred term from lk_exposure_material is filled in when it matches Result data column JSON: exposureMaterialReported (enum) | This describes what substance(s) the host is exposed to and/or develops immune reactions to as part of the exposure process. Please select an exposure material from the list provided if the exposure material matches yours or enter a exposure material if there is not an appropriate one provided. This exposure material is visible when the result is shared. The value provided by the user is further checked against the pref mapping table lk_exposure_material_pref_map. |
| Exposure Material ID | Conditionally required when Exposure Process Reported = "administering substance in vivo ; occurrence of asymptomatic infection ; environmental exposure to endemic/ubiquitous agent without evidence for disease ; documented exposure without evidence for disease ; exposure with existing immune reactivity without evidence for disease ; exposure to substance without evidence for disease ; infectious challenge ; transplantation or transfusion ; vaccination ; occurrence of infectious disease ; occurrence of allergy" and Exposure Material Reported does not match a recognized preferred term | Text, max 100 characters Result data column JSON: exposureMaterialId (string) | The NCBI or Vaccine Ontology ID associated with the exposure material. If the Exposure Material Reported is not a preferred value, then the Exposure Material ID must be provided. If the Exposure Material Reported is a preferred value, then the Exposure Material ID will be automatically be the ID associated with the preferred value and user will NOT need to supply this ID. |
| Disease Reported | Conditionally required when Exposure Process Reported = "occurrence of autoimmune disease ; occurrence of cancer ; occurrence of disease ; occurrence of infectious disease ; occurrence of allergy" | Text, max 550 characters Preferred vocabulary — reported value is kept; a preferred term from lk_disease is filled in when it matches Result data column JSON: diseaseReported (enum) | This indicates the specific disease of the host associated with the exposure. Please select a disease from the list provided if the disease matches yours or enter a disease if there is not an appropriate one provided. This disease is visible when the result is shared. The Value provide by the user is further checked against the pref mapping table lk_study_condition_pref_mappng. |
| Disease Ontology ID | Conditionally required when Exposure Process Reported = "infectious challenge" and Disease Reported is provided and Disease Reported does not match a recognized preferred term OR Exposure Process Reported = "occurrence of autoimmune disease ; occurrence of cancer ; occurrence of disease ; occurrence of infectious disease ; occurrence of allergy" and Disease Reported does not match a recognized preferred term | Text, max 100 characters Result data column JSON: diseaseOntologyId (string) | The NCBI Disease Ontology ID associated with the disease. If the Disease Reported is not a preferred value, then the Disease Ontology ID must be provided. If the disease is a preferred value, then the Disease Ontology ID will be the DOID associated with the preferred value. |
| Disease Stage Reported | Conditionally required when Exposure Process Reported = "occurrence of autoimmune disease ; occurrence of cancer ; occurrence of disease ; occurrence of infectious disease ; occurrence of allergy" | Text, max 100 characters Preferred vocabulary — reported value is kept; a preferred term from lk_disease_stage is filled in when it matches Result data column JSON: diseaseStageReported (enum) | This provides a broad classification of how the disease has progressed. Please select a disease stage from the list provided if the disease stage matches yours or enter a disease stage if there is not an appropriate one provided. This disease stage is visible when the result is shared. |