1. Which Data Submission Templates do you need?
    Please contact us by email at BISC_Helpdesk@niaid.nih.gov.
    The User Guide is a reference you can use to determine which templates need to be completed.
  2. Complete the templates that are needed.
    Note: Please save spreadsheet .xls templates as tab delimited .txt files.
  3. Create a .zip file that contains the files you want to submit (e.g. results, protocols, bioSamples template, experimentSamples template, etc.).
  4. Please check that you are using the latest version of the ImmPort data transfer templates.
ImmPort Research Data Class Purpose Spreadsheet Template Required Data to Complete Metadata Form Latest Version/
Date Available
Basic Study Describes a study in terms of title, goals, endpoints, criteria for study participation, subject grouping (arms or cohorts), personel, planned visits or encounters and protocols using a single worksheet.
A study design should be uploaded first.
basic_study_design.xls
basic_study_design.txt
  • Study User Defined ID
  • Title
  • Description
  • Endpoints
  • Actual Start Date
  • Inclusion and Exclusion Criteria
  • Arms or Cohorts
  • Personnel
  • Period
  • Planned Visit
  • Protocol
October 2014
Basic Study Design Optional Describes a study in terms of title, goals, endpoints, criteria for study participation, subject grouping (arms or cohorts), personel, planned visits or encounters and protocols using a single worksheet.
A study design should be uploaded first.
basic_study_design_optional.xls
basic_study_design_optional.txt
  • Study File Name
  • Description
  • File Type
  • Link Name
  • Link Value
  • Study ID
  • Pubmed ID
  • Pubmed Title
  • Journal
October 2014
Protocols Lists the protocols associated with the study, subjects, samples, and experiments being submitted. Protocols may be PDF files, Word documents, excel or other file types. protocols.xls
protocols.txt
  • Protocol User Defined ID
  • Protocol File Name
October 2014
Subjects Subjects may be patients or animals from which samples are taken for analysis. Two .xls templates (one for human and one for animal subjects) are available for recording subject information. There is one .xml file that can be used for human and animal subjects. In these files, treatment protocols used on the subjects can also be listed as well as many other details. subjectsHuman.xls
subjectsAnimal.xls
subjectsHuman.txt
subjectsAnimal.txt
Human
  • User Defined ID
  • Protocol
  • Gender
  • Age
  • Age Unit
  • Age Event
  • Ethnicity
  • Race
  • Phenotype
  • Study Arm or Cohort
  • Population
Animal
  • User Defined ID
  • Species Name
  • Strain Name
  • Protocol
  • Gender
  • Age
  • Age Unit
  • Age Event
  • Phenotype
  • Study Arm or Cohort
October 2014
Biological Samples Used to describe the types of samples taken from subjects or cell culture and processed for the experiment (i.e. organs, tissue, blood, plasma, cell culture name, etc.) and protocols used in the experiment. Other details about the samples can also be listed. bioSamples.xls
bioSamples.txt
  • Biological Sample User Defined ID
  • Sample Type
  • Subject
  • Protocol
  • Study
  • Planned Visit
  • Study Time Collected
  • Study Time Event
October 2014
Experiments Describes the type of experiment, measurement technique and links to protocols used in the experiment. experiments.xls
experiments.txt
  • Experiment User Defined ID
  • Experiment Name
  • Purpose
  • Measurement Technique
  • Protocol
October 2014
Reagent Sets Captures detailed information about the reagents used in an experiment. Since different analysis platforms employ very different reagents, the reagents.xls file contains several tabs for entering platform specific details of the reagents that were used. Reagent_Sets.xls
Reagent_Sets.txt
  • Reagent User Defined ID
  • Reagent Set Components ID
  • Description
  • Name
  • Type Name
October 2014
Reagents Other Captures detailed information about the reagents used in an experiment. Since different analysis platforms employ very different reagents, the reagents.xls file contains several tabs for entering platform specific details of the reagents that were used. reagents.Other.xls
reagents.Other.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
Reagents Sequencing Captures detailed information about the reagents used in an experiment. Since different analysis platforms employ very different reagents, the reagents.xls file contains several tabs for entering platform specific details of the reagents that were used. reagents.Sequencing.xls
reagents.Sequencing.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
Sample Treatments Captures information about the treatments applied in vitro to experiment samples or biological samples. Three types of treatments are supported: amount of agent, duration, and temperature. treatments.xls
treatments.txt
  • Treatment User Defined ID
  • Treatment Name
  • Treatment?
  • Treatment Specific Details
October 2014
Mass cytrometry Reagents Captures detailed information about the reagents used in a Mass cytometry experiment. reagents.Mass_Cytometry.xls
reagents.Mass_Cytometry.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
  • Analyte Name
  • Detector Name
  • Reporter Name
October 2014
CYTOF Assays Captures the samples, reagents, and results from an CYTOF experiment. experimentSamples.
CYTOF.xls

experimentSamples.
CYTOF.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • Result file
October 2014
ELISA Reagents Captures detailed information about the reagents used in an ELISA experiment. reagents.ELISA.xls
reagents.ELISA.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
  • Analyte Name
October 2014
ELISA Assays Captures the samples, reagents, and results from an ELISA experiment. experimentSamples.
ELISA.xls

experimentSamples.
ELISA.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
  • Result file
October 2014
ELISPOT Reagents Captures detailed information about the reagents used in an ELISPOT experiment. reagents.ELISPOT.xls
reagents.ELISPOT.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
  • Analyte Name
October 2014
ELISPOT Assays Captures the samples, reagents, and results from an ELISPOT experiment. experimentSamples.
ELISPOT.xls

experimentSamples.
ELISPOT.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • Result file
  • ImmPort Template?
October 2014
Flow Cytometry Reagents Captures detailed information about the reagents used in an Flow Cytometry experiment. reagents.Flow_Cytometry.xls
reagents.Flow_Cytometry.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
  • Analyte Name
  • Detector Name
  • Reporter Name
October 2014
Flow Cytometry Assays Captures the samples, reagents, and results from a Flow Cytometry experiment. experimentSamples.
Flow_Cytometry.xls

experimentSamples.
Flow_Cytometry.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • FCS Result file
  • FCS Compensation/Control file(s)
October 2014
flow Textfiles A form to describe flow text files in a structure that can be interpreted by ImmPort to facilitate searching and display of results. flowTextFiles.xls
flowTextFiles.txt
  • Preferred Display Name
October 2014
Gene Expression Reagents Captures detailed information about the reagents used in a Gene Expression experiment. reagents.Gene_Expression_Array.xls
reagents.Gene_Expression_Array.xls
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
Gene Expression Assays Captures the samples, reagents, and results from a Gene Expression experiment. experimentSamples.Gene_Expression.xls
experimentSamples.Gene_Expression.txt
  • Experiment Sample User ID
  • Experiment ID
  • Biological Sample ID
  • Reagent
  • Treatment
  • Repository Name
  • Repository Accession
October 2014
Genotyping Reagents Captures detailed information about the reagents used in a Genotyping experiment. reagents.Genotyping_Array.xls
reagents.Genotyping_Array.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
Genotyping Assays Captures the samples, reagents, and results from a Genotyping experiment. experimentSamples.Genotyping.xls
experimentSamples.Genotyping.txt
  • Experiment Sample User ID
  • Experiment ID
  • Biological Sample ID
  • Reagent
  • Treatment
  • Repository Name
  • Repository Accession
October 2014
Hemaglutinnation Inhibition Reagents Captures detailed information about the reagents used in a HAI experiment. reagents.HAI.xls
reagents.HAI.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
Hemaglutinnation Inhibition Assays Captures the samples, reagents, and results from a HAI experiment. experimentSamples.HAI.xls
experimentSamples.HAI.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
  • Result file
October 2014
Image Histology Captures the samples, reagents, and results from a Image Histology experiment. experimentSamples.
Image_Histology.xls

experimentSamples.
Image_Histology.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • Result file
October 2014
Mass spectrometry Assays Captures the samples, reagents, and results from a mass spectrometry experiment. experimentSamples.
Mass_Spectrometry.xls

experimentSamples.
Mass_Spectrometry.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • Result file
October 2014
MBAA Reagents Captures detailed information about the reagents used in a MBAA experiment. reagents.MBAA.xls
reagents.MBAA.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
  • Analyte Name
October 2014
Multiplex Bead Array Assays (MBAA) Assays Captures the samples, reagents, treatments, and results from a MBAA experiment. experimentSamples.MBAA.xls
experimentSamples.MBAA.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
  • Assay ID
  • Dilution Factor
October 2014
Control Samples A form to describe control samples in a structure that can be interpreted by ImmPort to facilitate searching and display of results. controlSamples.xls
controlSamples.txt
  • Control Sample User Defined ID
  • Experiment
  • Source
  • Catalog ID
  • Dilution Factor
  • Assay ID
  • ImmPort Template?
October 2014
Standard Curve A form to describe a standard curve in a structure that can be interpreted by ImmPort to facilitate searching and display of results. standardCurves.xls
standardCurves.txt
  • Standard Curve User-Defined ID
  • Experiment
  • Formula
  • Analyte Name
  • Assay ID
  • Lower Limit
  • Lower Limit Unit
  • Upper Limit
  • Upper Limit Unit
  • ImmPort Template?
October 2014
Neutralizing Antibody Titer Assays Captures the samples, reagents, and results from aN eutralizing Antibody Titer experiment. The literature uses a number of terms to describe similar assay methods and ImmPort employs some of these assay names. experimentSamples.
Neutralizing_Antibody_Titer.xls

experimentSamples.
Neutralizing_Antibody_Titer.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
October 2014
Virus Neutralization Reagents Captures detailed information about the reagents used in a MBAA experiment. reagents.
Virus_Neutralization.xls

reagents.
Virus_Neutralization.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
Virus Neutralization Assays Captures the samples, reagents, and results from a Virus Neutralization Titration Series experiment. The literature uses a number of terms to describe similar assay methods and ImmPort employs some of these assay names. experimentSamples.
Virus_Neutralization.xls

experimentSamples.
Virus_Neutralization.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
October 2014
PCR Reagents Captures detailed information about the reagents used in a PCR experiment. reagents.
PCR.xls

reagents.
PCR.txt
  • Reagent User Defined ID
  • Manufacturer
  • Catalog Number
October 2014
qRT-PCR Assays Captures the samples, reagents, and results from a quantitative PCR experiment. experimentSamples.QRT-PCR.xls experimentSamples.QRT-PCR.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
October 2014
Other Assays Captures the samples, reagents, and results from an experiment type not characterized by ImmPort. experimentSamples.Other.xls
experimentSamples.Other.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • Result file
October 2014

HLA Typing System Templates Purpose Spreadsheet Template Required Data to Complete Metadata Form Latest Version/
Date Available
HLA Typing Reagents Captures detailed information about the reagents used in a HLA typing experiment. reagents.HLA_Typing_System.xls
reagents.HLA_Typing_System.txt
  • HLA Typing System User-Defined ID
  • Locus Genotyped
  • Exons/Intron Interrogated
  • Typing System Manufacturer
  • Typing System Version
  • Typing Method
  • HLA Typing Date
  • Last Pertinent Who Report/Update
October 2014
HLA Typing Assays Captures the samples, reagents, and results from a HLA typing experiment. experimentSamples.HLA.xls
experimentSamples.HLA.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
October 2014
HLA Typing System Features Describes the nucleotide or protein features typed by HLA typing platform. HLA_Typing_System_
Features.xls

HLA_Typing_System_
Features.txt
  • HLA Typing System User Defined ID
  • Locus Genotyped
  • Feature Name
  • Feature Sequence
  • Start Position
  • Nucleotide/Peptide
  • Feature Location
  • Feature Type
October 2014
HLA Typing System Allele Ambiguity Describes whether a HLA typing system can type an allele unambiguously or not. Allows alleles to be grouped if they are ambiguously typed. HLA_Typing_System_
Allele_Ambiguity.xls

HLA_Typing_System_
Allele_Ambiguity.txt
  • HLA Typing System
  • Locus Genotyped
  • Allele Name
  • Ambiguous/Unambiguous Status
October 2014

KIR Typing System Templates Purpose Spreadsheet Template Required Data to Complete Metadata Form Latest Version/
Date Available
KIR Typing Reagents Captures detailed information about the reagents used in a HLA typing experiment. reagents.KIR_Typing_System.xls
reagents.KIR_Typing_System.txt
  • KIR Typing System User-Defined ID
  • Locus Genotyped
  • Reagent Type
  • Exons/Intron Interrogated
  • Primer/Probe Sequence
  • Allele(s) Detected
  • Last Pertinent IPD KIR Database Nomenclature Release
  • KIR Typing Date
  • Typing System Manufacturer
  • Typing System Version
October 2014
KIR Assays Captures the samples, reagents, and results from a KIR typing experiment. experimentSamples.KIR.xls
experimentSamples.KIR.txt
  • Experiment Sample User Defined ID
  • Experiment
  • Reagent
  • Biological Sample
  • Treatment
  • ImmPort Template?
October 2014
KIR Typing System Allele Ambiguity Describes whether a KIR typing system can type an allele unambiguously or not. Allows alleles to be grouped if they are ambiguously typed. KIR_Typing_System_
Allele_Ambiguity.xls

KIR_Typing_System_
Allele_Ambiguity.txt
  • KIR Typing System
  • Locus Genotyped
  • Allele Name
  • Ambiguous/Unambiguous Status
October 2014

ImmPort Results Templates Purpose Spreadsheet Template Required Data to Complete Form Latest Version/
Date Available
ELISA Derived and Interpreted Results A form to describe ELISA results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. ELISA_Results.xls
ELISA_Results.txt
  • Experiment Sample ID
  • Analyte
  • Calculated Concentration Value
  • Calculated Concentration Unit
  • Parent Specimen
October 2014
ELISPOT Derived and Interpreted Results A form to describe ELISPOT results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. ELISPOT_Results.xls
ELISPOT_Results.txt
  • Experiment Sample ID
  • Analyte
  • Number of Spots per Well
  • Base/Parent Population value
  • Base/Parent Population unit
  • Autogenerated Descriptive Phrase
October 2014
Flow Cytometry Derived and Interpreted Results A form to describe Flow Cytometry results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. FCM_Derived_data.xls
FCM_Derived_data.txt
  • Experiment Sample ID
  • Population Name
  • Population Definition
  • Population Cell Number
  • Population Cell Number Unit
  • Workspace File
October 2014
Flow Cytometry Assays Perl script and property file to make all files in a directory and its sub-directory unique. This is useful for editing control and compensation file names which may be repeated in different cytometer runs. makeFileNamesUnique.pl
makeFileNamesUnique.properties
December 2014
Flow Cytometry Assays Perl script for very large files (>100 Mb) that edits the binary data start and end tags in the fcs header to enable files to be processed by flowCore software. fixFcsHeaderDataCoords.pl
December 2014
Hemaglutinnation Inhibition Derived and Interpreted Results A form to describe HAI results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. HAI_Results.xls
HAI_Results.txt
  • Experiment Sample
  • Virus Strain
  • Titration Dilution Value
October 2014
HLA typing Derived and Intepreted Results A form to describe HLA typing results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. HLA_Typing.xls
HLA_Typing.txt
  • Experiment Sample ID
  • Population
October 2014
KIR typing summary- EBI format A form to describe KIR typing results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. KIR_Typing_Results_EBI_Results.xls
KIR_Typing_Results_EBI_Results.txt
  • Experiment Sample User Defined ID
  • Population
October 2014
KIR typing summary- column format A form to describe KIR typing results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. KIR_Typing_Results_Column.xls
KIR_Typing_Results_Column.txt
  • Experiment Sample User Defined ID
  • Population
October 2014
MBAA Derived and Interpreted Results A form to describe MBAA results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. MBAA_Results.xls
MBAA_Results.txt
  • Source ID
  • Assay ID
  • Analyte Name
  • Calculated Concentration Value
  • Calculated Concentration Unit
  • Mfi
October 2014
PCR Derived and Interpreted Results A form to describe PCR results in a structure that can be interpreted by ImmPort to facilitate searching and display of results. PCR_Results.xls
PCR_Results.txt
  • Experiment Sample
  • Entrez Gene ID
  • Threshold cycles (Ct)
October 2014
Virus Neutralization Titers Derived and Interpreted Results A form to describe the interpeted results of sample (e.g. serum) dilution series to quantitate the viral neutralizing activity of a sample. The Virus Neutralization Results capture the interpreted titer results in a commonly used format that can be interpreted by ImmPort to facilitate searching and display of results. Virus_Neutralization_Results.xls
  • Experiment Sample
  • Virus Strain
  • Titration Dilution Value
October 2014
Lab Test Captures the Lab Test User-Defined ID, Lab Panel ID, Biological Sample ID, Lab Test Name, Result Value and Result Unit for lab tests. labTests.xls
labTests.txt
  • Lab Test User Defined ID
  • Lab Panel ID
  • Biological Sample ID
  • Lab Test Name
  • Result Value
  • Result Unit
  • Lab Test
October 2014
Lab Test Panels Captures the Lab Panel Name, Study ID and Protocol ID for lab tests. labTestPanels.xls
labTestPanels.txt
  • Lab Test User Defined ID
  • Name
  • Study ID
  • Protocol ID
October 2014
Adverse Events Captures the adverse events reported during a study. adverseEvents.xls.xls
adverseEvents.xls.txt
  • Adverse Event User-Defined ID
  • Subject ID
  • Study ID
  • Name Reported
  • Severity
  • Outcome
  • Start Day
  • End Day
  • Relation to Study Treatment
October 2014


Need help? Please feel free to contact us by email at BISC_Helpdesk@niaid.nih.gov

Sponsored by: