hla_typing

Name HLA_Typing.txt
JSON File Name HLA_Typing.json
Typemultiple
Schema Version 3.37
Description The HLA experiment sample template defines and annotates the assay results for a sample by linking sample, experiment, and results together.
Download ⬇️ HLA_Typing.xlsx

⬇️ HLA_Typing.txt

⬇️ HLA_Typing.json

This top-level schema references companion files (e.g. HLA_Typing.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.

At least one of HLA-A Allele 1, HLA-A Allele 2, HLA-B Allele 1, HLA-B Allele 2, HLA-C Allele 1, HLA-C Allele 2, HLA-DPA1 Allele 1, HLA-DPA1 Allele 2, HLA-DPB1 Allele 1, HLA-DPB1 Allele 2, HLA-DQA1 Allele 1, HLA-DQA1 Allele 2, HLA-DQB1 Allele 1, HLA-DQB1 Allele 2, HLA-DRB1 Allele 1, HLA-DRB1 Allele 2, HLA-DRB3 Allele 1, HLA-DRB3 Allele 2, HLA-DRB4 Allele 1, HLA-DRB4 Allele 2, HLA-DRB5 Allele 1, HLA-DRB5 Allele 2 is required when Expsample ID is provided.

Template ColumnRequirementType & ConstraintsDescription
Expsample IDRequiredText, max 15 characters
Reference — must already exist (in this package or the workspace) as a expsample
JSON: expsampleId (string)
The experiment sample identifier must be stored in ImmPort or in the experimentsamples.txt template.
Please enter either an experiment sample user defined ID or ImmPort accession.
Ancestral PopulationRequiredText, max 250 characters
Controlled vocabulary — value must be one of lk_ancestral_population
JSON: ancestralPopulation (array)
ImmPort recommends using population names as defined by the http://www.allelefrequencies.net site.
HLA-A Allele 1OptionalText, max 250 characters
JSON: hlaAAllele1 (string)
HLA-A Allele 2OptionalText, max 250 characters
JSON: hlaAAllele2 (string)
HLA-B Allele 1OptionalText, max 250 characters
JSON: hlaBAllele1 (string)
HLA-B Allele 2OptionalText, max 250 characters
JSON: hlaBAllele2 (string)
HLA-C Allele 1OptionalText, max 250 characters
JSON: hlaCAllele1 (string)
HLA-C Allele 2OptionalText, max 250 characters
JSON: hlaCAllele2 (string)
HLA-DPA1 Allele 1OptionalText, max 250 characters
JSON: hlaDpa1Allele1 (string)
HLA-DPA1 Allele 2OptionalText, max 250 characters
JSON: hlaDpa1Allele2 (string)
HLA-DPB1 Allele 1OptionalText, max 250 characters
JSON: hlaDpb1Allele1 (string)
HLA-DPB1 Allele 2OptionalText, max 250 characters
JSON: hlaDpb1Allele2 (string)
HLA-DQA1 Allele 1OptionalText, max 250 characters
JSON: hlaDqa1Allele1 (string)
HLA-DQA1 Allele 2OptionalText, max 250 characters
JSON: hlaDqa1Allele2 (string)
HLA-DQB1 Allele 1OptionalText, max 250 characters
JSON: hlaDqb1Allele1 (string)
HLA-DQB1 Allele 2OptionalText, max 250 characters
JSON: hlaDqb1Allele2 (string)
HLA-DRB1 Allele 1OptionalText, max 250 characters
JSON: hlaDrb1Allele1 (string)
HLA-DRB1 Allele 2OptionalText, max 250 characters
JSON: hlaDrb1Allele2 (string)
HLA-DRB3 Allele 1OptionalText, max 250 characters
JSON: hlaDrb3Allele1 (string)
HLA-DRB3 Allele 2OptionalText, max 250 characters
JSON: hlaDrb3Allele2 (string)
HLA-DRB4 Allele 1OptionalText, max 250 characters
JSON: hlaDrb4Allele1 (string)
HLA-DRB4 Allele 2OptionalText, max 250 characters
JSON: hlaDrb4Allele2 (string)
HLA-DRB5 Allele 1OptionalText, max 250 characters
JSON: hlaDrb5Allele1 (string)
HLA-DRB5 Allele 2OptionalText, max 250 characters
JSON: hlaDrb5Allele2 (string)
CommentsOptionalText, max 500 characters
JSON: comments (string)
Comments captures additional descriptive information.