Skip to content

Upload Order and Dependencies

Templates refer to each other by user-defined ID. A subject refers to an arm, a sample refers to a subject, a result refers to a sample. A record can only refer to something ImmPort already knows about, so referenced records must be uploaded first, or in the same package (rule R-08).

How templates depend on each other

Arrows point from a template to the templates that refer to it.

flowchart LR
    P[protocols] --> S[basic_study_design]
    S --> SUB[subjects]
    SUB --> CLIN[clinical data]
    SUB --> ES[experimentSamples]
    T[treatments] --> ES
    R[reagents] --> ES
    P --> ES
    ES --> RES[results]

basic_study_design defines the study, its arms and planned visits. Subjects are subjectHumans or subjectAnimals. Clinical data is interventions, adverseEvents, assessments and labTests. Each assay has its own reagents.* and experimentSamples.* templates; experiment samples can also define biosamples and experiments.

Same package or separate uploads?

You have two ways to satisfy the dependencies:

  • Put the templates in the same package. ImmPort processes the templates inside a package in a fixed loading order (protocols and reagents first, results last). The order of files inside the .zip doesn't matter.
  • Upload in separate packages, in dependency order. Each package can refer to records loaded by earlier packages in the same workspace.

Some groups must go in one package. For every assay, the treatments, reagents and experiment samples templates belong together (rule R-10). The assay workflows mark these groups.

The typical sequence

flowchart LR
    A[Register study] --> B[Subjects] --> C[Interventions] --> D[Adverse events] --> E[Assessments] --> F[Lab tests] --> G[Assays]
    classDef optional stroke-dasharray: 5 4
    class C,D,E,F,G optional

Dashed steps are only needed if your study has that kind of data.

The same sequence as a list:

  1. Register the study in the Study Registration Wizard or with basic_study_design + protocols.
  2. Subjects: subjectHumans or subjectAnimals.
  3. Interventions and concomitant medications, if any: interventions.
  4. Adverse events, if any: adverseEvents.
  5. Non-sample results such as questionnaires or medical history, if any: assessments.
  6. Clinical lab tests, if any: labTests.
  7. Assay data: follow the workflow for each assay.

Not sure what you need?

The Template Finder turns your answers to these questions into a checklist. Reading the ImmPort data model from left to right also gives roughly the upload order. If your study doesn't fit this pattern, ask the ImmPort Helpdesk.