Template Catalog
All ImmPort submission templates (version 3.37). Click a template name to see its fields, or download it as Excel (.xlsx), tab-delimited text (.txt) or JSON schema.
Not sure which ones you need? Try the Template Finder.
| Template | Purpose | Category | Download |
|---|---|---|---|
Basic Study Designbasic_study_design.txt |
Registers a study: title, goals, eligibility criteria, arms or cohorts, personnel, planned visits and protocols. Upload this first (or use the Study Registration Wizard). | Study | xlsxtxtjson |
Protocolsprotocols.txt |
Lists the protocol documents (PDF, Word, Excel, …) that studies, subjects, lab tests and experiments refer to. | Study | xlsxtxtjson |
Study Design Editstudy_design_edit.txt |
Updates a registered study: adds files, publications and links, or links existing subjects to another study's arms. | Study | xlsxtxtjson |
Subjects – HumansubjectHumans.txt |
Defines human subjects (demographics, immune exposure) and assigns each one to an arm or cohort. | Subjects | xlsxtxtjson |
Subjects – AnimalsubjectAnimals.txt |
Defines animal subjects (species, strain, demographics) and assigns each one to an arm or cohort. | Subjects | xlsxtxtjson |
Immune ExposureimmuneExposure.txt |
Records how existing subjects were exposed (vaccination, infection, …) and the evidence for it. | Subjects | xlsxtxtjson |
Interventionsinterventions.txt |
Study interventions, concomitant medications and substance use for each subject. | Clinical | xlsxtxtjson |
Adverse EventsadverseEvents.txt |
Adverse events recorded for subjects, with severity, outcome and relation to treatment. | Clinical | xlsxtxtjson |
Assessmentsassessments.txt |
Non-sample results such as questionnaires and medical history. Panels and components go in one file. | Clinical | xlsxtxtjson |
Assessment Panelsassessmentpanel.txt |
Defines assessment panels on their own. Most studies use the combined Assessments template instead. | Clinical | xlsxtxtjson |
Assessment Componentsassessmentcomponent.txt |
Defines assessment components on their own. Most studies use the combined Assessments template instead. | Clinical | xlsxtxtjson |
Lab TestslabTests.txt |
Clinical lab test panels, tests and results in one file. | Clinical | xlsxtxtjson |
Lab Test Panels legacylabTestPanels.txt |
Defines lab test panels on their own. Prefer the combined Lab Tests template. | Clinical | xlsxtxtjson |
Lab Test Results legacylabTest_Results.txt |
Reports lab test results on their own. Prefer the combined Lab Tests template. | Clinical | xlsxtxtjson |
Biological Samples legacybioSamples.txt |
Defines samples taken from subjects. Samples can also be defined inside experiment sample templates. | Samples & experiments | xlsxtxtjson |
Experiments legacyexperiments.txt |
Defines experiments and measurement techniques. Experiments can also be defined inside experiment sample templates. | Samples & experiments | xlsxtxtjson |
Treatmentstreatments.txt |
In-vitro treatments applied to samples (amount, duration, temperature). Part of every assay workflow. | Samples & experiments | xlsxtxtjson |
Reagent SetsReagent_Sets.txt |
Groups reagents that are always used together, so samples can refer to the set. | Reagents | xlsxtxtjson |
Public RepositoriespublicRepositories.txt |
Links experiment samples to accessions in GEO, SRA or other public repositories. | Results | xlsxtxtjson |
Reagents – Arrayreagents.Array.txt |
Reagents and assay platform used in Array experiments. | Reagents | xlsxtxtjson |
Reagents – CyTOFreagents.CyTOF.txt |
Reagents and assay platform used in CyTOF experiments. | Reagents | xlsxtxtjson |
Reagents – ELISAreagents.ELISA.txt |
Reagents and assay platform used in ELISA experiments. | Reagents | xlsxtxtjson |
Reagents – ELISPOTreagents.ELISPOT.txt |
Reagents and assay platform used in ELISPOT experiments. | Reagents | xlsxtxtjson |
Reagents – Flow Cytometryreagents.Flow_Cytometry.txt |
Reagents and assay platform used in Flow Cytometry experiments. | Reagents | xlsxtxtjson |
Reagents – HAIreagents.HAI.txt |
Reagents and assay platform used in HAI experiments. | Reagents | xlsxtxtjson |
Reagents – HLA Typingreagents.HLA_Typing.txt |
Reagents and assay platform used in HLA Typing experiments. | Reagents | xlsxtxtjson |
Reagents – KIR Typingreagents.KIR_Typing.txt |
Reagents and assay platform used in KIR Typing experiments. | Reagents | xlsxtxtjson |
Reagents – MBAAreagents.MBAA.txt |
Reagents and assay platform used in MBAA experiments. | Reagents | xlsxtxtjson |
Reagents – Neutralizing Antibody Titerreagents.Neutralizing_Antibody_Titer.txt |
Reagents and assay platform used in Neutralizing Antibody Titer experiments. | Reagents | xlsxtxtjson |
Reagents – Otherreagents.Other.txt |
Reagents and assay platform used in image histology, metabolomics and other experiments. | Reagents | xlsxtxtjson |
Reagents – PCRreagents.PCR.txt |
Reagents and assay platform used in PCR experiments. | Reagents | xlsxtxtjson |
Reagents – Sequencingreagents.Sequencing.txt |
Reagents and assay platform used in Sequencing experiments. | Reagents | xlsxtxtjson |
Reagents – Virus Neutralizationreagents.Virus_Neutralization.txt |
Reagents and assay platform used in Virus Neutralization experiments. | Reagents | xlsxtxtjson |
Experiment Samples – CyTOFexperimentSamples.CYTOF.txt |
Experiment samples for CyTOF: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – ELISAexperimentSamples.ELISA.txt |
Experiment samples for ELISA: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
Experiment Samples – ELISPOTexperimentSamples.ELISPOT.txt |
Experiment samples for ELISPOT: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
Experiment Samples – Flow CytometryexperimentSamples.Flow_Cytometry.txt |
Experiment samples for Flow Cytometry: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – Gene Expression ArrayexperimentSamples.Gene_Expression_Array.txt |
Experiment samples for Gene Expression Array: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – Genotyping ArrayexperimentSamples.Genotyping_Array.txt |
Experiment samples for Genotyping Array: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – HAIexperimentSamples.HAI.txt |
Experiment samples for HAI: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
Experiment Samples – HLA TypingexperimentSamples.HLA.txt |
Experiment samples for HLA Typing: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – Image HistologyexperimentSamples.Image_Histology.txt |
Experiment samples for Image Histology: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – KIR TypingexperimentSamples.KIR.txt |
Experiment samples for KIR Typing: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – Mass Spec – MetabolomicsexperimentSamples.Mass_Spectrometry_Metabolomics.txt |
Experiment samples for Mass Spec – Metabolomics: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – Mass Spec – ProteomicsexperimentSamples.Mass_Spectrometry_Proteomics.txt |
Experiment samples for Mass Spec – Proteomics: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – MBAAexperimentSamples.MBAA.txt |
Experiment samples for MBAA: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – Neutralizing Antibody TiterexperimentSamples.Neutralizing_Antibody_Titer.txt |
Experiment samples for Neutralizing Antibody Titer: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
Experiment Samples – Other assayexperimentSamples.Other.txt |
Experiment samples for Other assay: links each sample to its biosample, experiment, reagents and treatments. | Experiment samples | xlsxtxtjson |
Experiment Samples – qRT-PCRexperimentSamples.QRT-PCR.txt |
Experiment samples for qRT-PCR: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
Experiment Samples – RNA SequencingexperimentSamples.RNA_Sequencing.txt |
Experiment samples for RNA Sequencing: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
Experiment Samples – Virus NeutralizationexperimentSamples.Virus_Neutralization.txt |
Experiment samples for Virus Neutralization: links each sample to its biosample, experiment, reagents and treatments. Has optional result columns. | Experiment samples | xlsxtxtjson |
CyTOF Derived DataCyTOF_Derived_data.txt |
Cell population statistics derived from CyTOF data. | Results | xlsxtxtjson |
Flow Cytometry Derived DataFCM_Derived_data.txt |
Cell population statistics derived from flow cytometry data. | Results | xlsxtxtjson |
ELISA ResultsELISA_Results.txt |
ELISA results, if you did not put them in the experiment samples file. | Results | xlsxtxtjson |
ELISPOT ResultsELISPOT_Results.txt |
ELISPOT results, if you did not put them in the experiment samples file. | Results | xlsxtxtjson |
HAI ResultsHAI_Results.txt |
HAI titers, if you did not put them in the experiment samples file. | Results | xlsxtxtjson |
HLA Typing ResultsHLA_Typing.txt |
Structured HLA typing results (alleles per locus). | Results | xlsxtxtjson |
KIR Typing ResultsKIR_Typing.txt |
Structured KIR typing results (genes and haplotypes). | Results | xlsxtxtjson |
Metabolomics ResultsMass_Spectrometry_Metabolomic_Results.txt |
Structured metabolomics mass spectrometry results. | Results | xlsxtxtjson |
Proteomics ResultsMass_Spectrometry_Proteomic_Results.txt |
Structured proteomics mass spectrometry results. | Results | xlsxtxtjson |
MBAA ResultsMBAA_Results.txt |
Structured MBAA results (MFI and concentrations). | Results | xlsxtxtjson |
Control SamplescontrolSamples.txt |
MBAA control samples and their results. | Results | xlsxtxtjson |
Standard CurvesstandardCurves.txt |
MBAA standard curves and their results. | Results | xlsxtxtjson |
qRT-PCR ResultsPCR_Results.txt |
qRT-PCR results, if you did not put them in the experiment samples file. | Results | xlsxtxtjson |
RNA-Seq ResultsRNA_SEQ_Results.txt |
Transcript-level RNA sequencing results, if you did not put them in the experiment samples file. | Results | xlsxtxtjson |
Virus Neutralization ResultsVirus_Neutralization_Results.txt |
Neutralizing titers from serum dilution series, if not in the experiment samples file. | Results | xlsxtxtjson |
legacy templates still work, but a newer combined template covers the same data.
Working with templates
- Fill in the Excel version. It has dropdown lists for controlled vocabulary and comments on each column header with the expected type and length.
- Upload as
.xlsx, tab-delimited.txtor.json. Don't use the old.xlsformat. Include each template only once, in one format (rule R-06). - Keep the file names. File names aren't case-sensitive, but a browser may add a suffix such as
(1)when you download a template. ImmPort then won't recognize the file. - Leave the fixed rows alone. Don't edit the first row (template name and Schema Version), the column header row, or section headers (rule R-04).
- Keep every column, even ones you leave empty (rule R-05).
Each template's field page shows what is required, conditionally required or optional, and the type and allowed values of every column. See How to read the template documentation. Allowed values for dropdown fields are listed in the lookup tables, such as lk_species and lk_sample_type.
Related pages
- JSON templates: how to submit templates as JSON.
- Version history: what changed in template version 3.37.
- Example packages: complete, filled-in packages to copy from.
- Common Data Elements: ImmPort maps template fields to NIH-endorsed CDEs. You don't need to do anything for this.