immuneexposure
| Name | immuneExposure.txt |
| JSON File Name | immuneExposure.json |
| Type | single |
| Schema Version | 3.37 |
| Description | The subjectHuman and subjectAnimals templates define and annotate the subjects in studies with respect to immune exposure. The Immune Exposure template updates the subjects previously defined in studies with respect to immune exposure. |
| Download | ⬇️ immuneExposure.xlsx ⬇️ immuneExposure.txt ⬇️ immuneExposure.json This top-level schema references companion files (e.g. immuneExposure.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 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 for the reported immune exposure. |
| Arm Or Cohort ID | Required | Text, max 15 characters Reference — must already exist (in this package or the workspace) as a arm_or_cohortJSON: 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. |
| 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 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 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 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 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 provided by the user is further checked against the pref mapping table lk_exposure_material_pref_map. 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 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 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. |