MIRING
-
Each MIRING message must be identified with a (preferably universal) unique MIRING identifier (ID). For example, an ISO organization identifier (OID). This MIRING ID links information included in the message with additional information for that specimen (e.g., specimen ID) outside of the message.
-
As part of this element, Each MIRING message must include the following information:
A. Contact information for the MIRING generator for access queries
B. References to the location of the Platform Documentation (Element 6),
C. Availability status of the primary data (public or private) and, when permitted,
D. References to the Read Processing Documentation (Element 7), and Primary Data (Element 8) together or individually
-
The reference allele sequence database release version used for allele calling of each gene must be defined. e.g., IPD-KIR Database release version 2.5.0
-
Reference sequences applied in the genotyping must be explicitly defined in each genotyping report.
Identify any reference genome assembly (or a specific alternate assembly) sequence used with a specific Genome Reference Consortium (GRC) release version. Explicitly identify alternative reference (AltRef) alignments used. GRCh37.p13 (GRC human genome build 37 patch 13)/c6 and/or the reference allele sequences used with a reference allele sequence database (IMGT/HLA or IPD-KIR Database) release version and accession number. e.g., IMGT/HLA Database release version 3.17.0/HLA00001
Each reference sequence must be assigned a unique numerical identifier, ranging from 0 to n (# of reference sequences).
As applied in the MIRING message reference resources used must be categorized as being either:
(A) public and curated,
(B) public and uncurated,
(C) other (i.e., private) or
(D) unreferenced (no reference is available)
The genotype is the collection of all ambiguous alleles that are derived from the consensus sequence. All ambiguous alleles and ambiguous genotypes must be explicitly defined in the genotype.
The set of alleles used to generate the genotype is identified as Element 2.1.
Denote novel alleles in the genotype string by including a reference to the EMBL accession number in element 6.
This is not a “best guess” for a two-allele genotype call.
Use Genotype List (GL) String format (or comparable format), and provide a Uniform Resource Identifier (URI) when available.
GL Str: KIR3DL2*008/KIR3DL2*038+KIR3DL2*00701|KIR3DL2*027+KIR3DL2*016
URI: http://gl.immunogenomics.org/1.0/genotype-list/z
Report the consensus sequence generated from the primary read data by the analysis software, which serves as the basis for the genotype.
Format consensus sequences to identify any phase and/or ploidy information that has been generated by the NGS platform (see below). This requires dividing phased sequence that is aligned to multiple references into multiple blocks.
Describe consensus sequence blocks using the equivalent of FASTA format, with one sequence block for each reference sequence applied. Alternatively, quality scores for each base can be included as FASTQ format, using the same header format.
>0|0|1|1|0|0|0 CAGGAGCAGAGGGGTCAGGGCGAAGTCCCAGGGCCCCAGGCGTGGCTCTCAGGGTCTCAGGCCCCGAAGGCGGTGTATGGATTGGGGAGTCCCAGCCTTGGGGATTCCCCAACTCCGCAGTTTCTTTTCTCCCTCTCCCAACCTACGTAGGGTCCTTCATCCTGGATACTCACGACGCGGACCCAGTTCTCACTCCCATTGGGTGTCGGGTTTCCAGAGAAGCCAATCAGTGTCGTCGCGGTCGCTGTTCTAAAGTCCGCACGCACCCACCGGGACTCAG ATTCTCCCCAGACGCCGAGG
Use the following format for the consensus block descriptor:
The equivalent of a consensus descriptor line must be defined with seven elements.
A. SequenceBlockID
Number each sequence block from 0 to n; these block IDs must
increase in 5’ to 3’ order over all blocks
B. ReferenceID
This is the numerical reference sequence ID from Element 2.2; category D references identify the absence of reference sequence.
C. ReferenceCoordinate
Identify the position in the reference sequence (indexed from 0)
corresponding to the 1st position in the consensus block.
D. PhasingGroup
Identify all consensus blocks in phase using the lowest Sequence Block ID with common phase.
E. Ploidy
identify the ploidy number (1 to n) for each consensus block
F. ReferenceSequenceMatch
Identify if the consensus block sequence is an exact match to the applied reference (1) or not (0); in the case of 0, a VDF file would be expected (element 5) unless the reference category of the applied reference ID is D.
G. SequenceContinuity
Indicate if the consensus sequence is immediately adjacent (no sequence gaps) the preceeding consensus block in the same phasing group (1); if there is a sequence gap or there is no phase, this is 0.
Novel polymorphisms in consensus sequences (nucleotide polymorphisms not included in the reference allele sequence database) must be explicitly noted. Characterize novel substitutions (non-synonymous substitutions, indels, stop-codons, etc.) in novel sequences.
Define novel polymorphisms to relative to the reference allele sequence (defined in the consensus sequence ID block) for each locus as consistent with Variant Call Format (VCF). Include the consensus sequence block ID defined in Element 4 in the VCF metadata. Include an EMBL accession number in the VCF metadata.
FASTA formatted reference sequence (in IMGT/HLA Database) (not included in MIRING message -- shown as example only):
>HLA:HLA00001 A*01:01:01:01 1098 bp
ATGGCCGTCATGACGCCCCGAACCATCCTCCTGCTACTCTCGGGGGCCCTGGCCCTGACC
VCF file denoting novel polymorphic positions relative to the reference:
| ##CHROM | POS | ID | REF | ALT | QUAL | FILTER |
| 3.17.0/HLA00001 | 12 | 000001 | G | A | 29 | PASS |
| 3.17.0/HLA00001 | 23 | 000002 | C | A | 29 | PASS |
The specific details of the methodology and pertinent versions of the platform and instrument-dependent analysis software applied to obtain the unmapped reads and quality scores (Element 8: primary data) must be documented in a public fashion [e.g., in NCBI’s Genetic Testing Registry (GTR), or a peer-reviewed manuscript]. References to this documentation must be included in the message.
Relevant platform information to be deposited must include:
Instrument version, Instrument-dependent software version identifier(s),
Reagent versions and lot number, Sequence read lengths,
Expected amplicon/insert length, Reference sequences applied,
and sequence feature/region targeted.
Inclusion of primer target locations is optional.
Requires a parallel MIBBI identifying the Minimum Information for Documenting Immunogenomic NGS Genotyping.
The specific details of the instrument-indepenent processing of the primary data (Element 8) must be made available with the primary data.
e.g., instrument-independent analysis software version identifier(s), analysis software parameters used, details of the cutoff values and
reference sequences (**this must always be Element 2.1**) used to filter the data for read quality and/or mapping quality,
along with the final read depth obtained and a confidence score of the zygosity for the SNPs used to infer the final genotype.
Requires a parallel MIBBI identifying the Minimum Information for Documenting Immunogenomic NGS Genotyping.
Unmapped reads with quality scores, as generated by the instrument, must be retained and should be made available as the primary NGS data, when permitted. Adapter sequences may be excluded from the primary data. These primary data are accessory data, and can accessed using the MIRING ID.
In addition to these primary data, the MIRING message generator must maintain an archive of MIRING messages generated for these primary data, and the associated read identifiers. When the primary data are publically available (as defined in Element 1.2.C), the MIRING message generator must make this information available.
When permitted, Primary data should be made available as accessory data (e.g., deposited in the NCBI’s Sequence Read Archive) but are not included in the message; references to the availability status of the primary data must be included in the message (element 1).
Use formats equivalent to Sanger FASTQ format to report NGS primary data.