This page is part of the FHIR Specification (v3.3.0: R4 Ballot 2). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
Clinical Genomics Work Group | Maturity Level: 1 | Trial Use | Compartments: Not linked to any defined compartments |
Detailed Descriptions for the elements in the Sequence resource.
Sequence | |
Element Id | Sequence |
Definition | Raw data describing a biological sequence. |
Control | 1..1 |
Summary | true |
Invariants | Defined on this element seq-3: Only 0 and 1 are valid for coordinateSystem (expression : coordinateSystem = 1 or coordinateSystem = 0, xpath: count(f:coordinateSystem[@value=0 and @value=1]) = 1) |
Sequence.identifier | |
Element Id | Sequence.identifier |
Definition | A unique identifier for this particular sequence instance. This is a FHIR-defined id. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Allows sequences to be distinguished and referenced. |
Summary | true |
Sequence.type | |
Element Id | Sequence.type |
Definition | Amino Acid Sequence/ DNA Sequence / RNA Sequence. |
Control | 0..1 |
Terminology Binding | sequenceType (Example) |
Type | code |
Summary | true |
Sequence.coordinateSystem | |
Element Id | Sequence.coordinateSystem |
Definition | Whether the sequence is numbered starting at 0 (0-based numbering or coordinates, inclusive start, exclusive end) or starting at 1 (1-based numbering, inclusive start and inclusive end). |
Control | 1..1 |
Type | integer |
Summary | true |
Sequence.patient | |
Element Id | Sequence.patient |
Definition | The patient whose sequencing results are described by this resource. |
Control | 0..1 |
Type | Reference(Patient) |
Summary | true |
Sequence.specimen | |
Element Id | Sequence.specimen |
Definition | Specimen used for sequencing. |
Control | 0..1 |
Type | Reference(Specimen) |
Summary | true |
Sequence.device | |
Element Id | Sequence.device |
Definition | The method for sequencing, for example, chip information. |
Control | 0..1 |
Type | Reference(Device) |
Summary | true |
Sequence.performer | |
Element Id | Sequence.performer |
Definition | The organization or lab that should be responsible for this result. |
Control | 0..1 |
Type | Reference(Organization) |
Summary | true |
Sequence.quantity | |
Element Id | Sequence.quantity |
Definition | The number of copies of the seqeunce of interest. (RNASeq). |
Control | 0..1 |
Type | Quantity |
Summary | true |
Sequence.referenceSeq | |
Element Id | Sequence.referenceSeq |
Definition | A sequence that is used as a reference to describe variants that are present in a sequence analyzed. |
Control | 0..1 |
Summary | true |
Invariants | Defined on this element seq-5: GenomeBuild and chromosome must be both contained if either one of them is contained (expression : (chromosome.empty() and genomeBuild.empty()) or (chromosome.exists() and genomeBuild.exists()), xpath: (exists(f:chromosome) and exists(f:genomeBuild)) or (not(exists(f:chromosome)) and not(exists(f:genomeBuild)))) seq-6: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString; (expression : (genomeBuild.count()+referenceSeqId.count()+ referenceSeqPointer.count()+ referenceSeqString.count()) = 1, xpath: count(f:genomeBuild)+count(f:referenceSeqId)+count(f:referenceSeqPointer)+count(f:referenceSeqString)=1) |
Sequence.referenceSeq.chromosome | |
Element Id | Sequence.referenceSeq.chromosome |
Definition | Structural unit composed of a nucleic acid molecule which controls its own replication through the interaction of specific proteins at one or more origins of replication (SO:0000340 ). |
Control | 0..1 |
Terminology Binding | chromosome-human (Example) |
Type | CodeableConcept |
Summary | true |
Sequence.referenceSeq.genomeBuild | |
Element Id | Sequence.referenceSeq.genomeBuild |
Definition | The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'. Version number must be included if a versioned release of a primary build was used. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.referenceSeq.orientation | |
Element Id | Sequence.referenceSeq.orientation |
Definition | A relative reference to a DNA strand based on gene orientation. The strand that contains the open reading frame of the gene is the "sense" strand, and the opposite complementary strand is the "antisense" strand. |
Control | 0..1 |
Terminology Binding | orientationType (Required) |
Type | code |
Summary | true |
Sequence.referenceSeq.referenceSeqId | |
Element Id | Sequence.referenceSeq.referenceSeqId |
Definition | Reference identifier of reference sequence submitted to NCBI. It must match the type in the Sequence.type field. For example, the prefix, “NG_” identifies reference sequence for genes, “NM_” for messenger RNA transcripts, and “NP_” for amino acid sequences. |
Control | 0..1 |
Terminology Binding | ENSEMBL (Example) |
Type | CodeableConcept |
Summary | true |
Sequence.referenceSeq.referenceSeqPointer | |
Element Id | Sequence.referenceSeq.referenceSeqPointer |
Definition | A Pointer to another Sequence entity as reference sequence. |
Control | 0..1 |
Type | Reference(Sequence) |
Summary | true |
Sequence.referenceSeq.referenceSeqString | |
Element Id | Sequence.referenceSeq.referenceSeqString |
Definition | A string like "ACGT". |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.referenceSeq.strand | |
Element Id | Sequence.referenceSeq.strand |
Definition | An absolute reference to a strand. The Watson strand is the strand whose 5'-end is on the short arm of the chromosome, and the Crick strand as the one whose 5'-end is on the long arm. |
Control | 0..1 |
Terminology Binding | strandType (Required) |
Type | code |
Summary | true |
Sequence.referenceSeq.windowStart | |
Element Id | Sequence.referenceSeq.windowStart |
Definition | Start position of the window on the reference sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive. |
Control | 1..1 |
Type | integer |
Summary | true |
Sequence.referenceSeq.windowEnd | |
Element Id | Sequence.referenceSeq.windowEnd |
Definition | End position of the window on the reference sequence. If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position. |
Control | 1..1 |
Type | integer |
Summary | true |
Sequence.variant | |
Element Id | Sequence.variant |
Definition | The definition of variant here originates from Sequence ontology (variant_of ). This element can represent amino acid or nucleic sequence change(including insertion,deletion,SNP,etc.) It can represent some complex mutation or segment variation with the assist of CIGAR string. |
Control | 0..* |
Summary | true |
Sequence.variant.start | |
Element Id | Sequence.variant.start |
Definition | Start position of the variant on the reference sequence.If the coordinate system is either 0-based or 1-based, then start position is inclusive. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.variant.end | |
Element Id | Sequence.variant.end |
Definition | End position of the variant on the reference sequence.If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.variant.observedAllele | |
Element Id | Sequence.variant.observedAllele |
Definition | An allele is one of a set of coexisting sequence variants of a gene (SO:0001023 ). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the observed sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.variant.referenceAllele | |
Element Id | Sequence.variant.referenceAllele |
Definition | An allele is one of a set of coexisting sequence variants of a gene (SO:0001023 ). Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the reference sequence. When the sequence type is DNA, it should be the sequence on the positive (+) strand. This will lay in the range between variant.start and variant.end. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.variant.cigar | |
Element Id | Sequence.variant.cigar |
Definition | Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation here . |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.variant.variantPointer | |
Element Id | Sequence.variant.variantPointer |
Definition | A pointer to an Observation containing variant information. |
Control | 0..1 |
Type | Reference(Observation) |
Summary | true |
Sequence.observedSeq | |
Element Id | Sequence.observedSeq |
Definition | Sequence that was observed. It is the result marked by referenceSeq along with variant records on referenceSeq. This shall starts from referenceSeq.windowStart and end by referenceSeq.windowEnd. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.quality | |
Element Id | Sequence.quality |
Definition | An experimental feature attribute that defines the quality of the feature in a quantitative way, such as a phred quality score (SO:0001686 ). |
Control | 0..* |
Summary | true |
Sequence.quality.type | |
Element Id | Sequence.quality.type |
Definition | INDEL / SNP / Undefined variant. |
Control | 1..1 |
Terminology Binding | qualityType (Required) |
Type | code |
Summary | true |
Sequence.quality.standardSequence | |
Element Id | Sequence.quality.standardSequence |
Definition | Gold standard sequence used for comparing against. |
Control | 0..1 |
Terminology Binding | FDA-StandardSequence (Example) |
Type | CodeableConcept |
Summary | true |
Sequence.quality.start | |
Element Id | Sequence.quality.start |
Definition | Start position of the sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.quality.end | |
Element Id | Sequence.quality.end |
Definition | End position of the sequence.If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.quality.score | |
Element Id | Sequence.quality.score |
Definition | The score of an experimentally derived feature such as a p-value (SO:0001685 ). |
Control | 0..1 |
Type | Quantity |
Summary | true |
Sequence.quality.method | |
Element Id | Sequence.quality.method |
Definition | Which method is used to get sequence quality. |
Control | 0..1 |
Terminology Binding | FDA-Method (Example) |
Type | CodeableConcept |
Summary | true |
Sequence.quality.truthTP | |
Element Id | Sequence.quality.truthTP |
Definition | True positives, from the perspective of the truth data, i.e. the number of sites in the Truth Call Set for which there are paths through the Query Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event. |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.queryTP | |
Element Id | Sequence.quality.queryTP |
Definition | True positives, from the perspective of the query data, i.e. the number of sites in the Query Call Set for which there are paths through the Truth Call Set that are consistent with all of the alleles at this site, and for which there is an accurate genotype call for the event. |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.truthFN | |
Element Id | Sequence.quality.truthFN |
Definition | False negatives, i.e. the number of sites in the Truth Call Set for which there is no path through the Query Call Set that is consistent with all of the alleles at this site, or sites for which there is an inaccurate genotype call for the event. Sites with correct variant but incorrect genotype are counted here. |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.queryFP | |
Element Id | Sequence.quality.queryFP |
Definition | False positives, i.e. the number of sites in the Query Call Set for which there is no path through the Truth Call Set that is consistent with this site. Sites with correct variant but incorrect genotype are counted here. |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.gtFP | |
Element Id | Sequence.quality.gtFP |
Definition | The number of false positives where the non-REF alleles in the Truth and Query Call Sets match (i.e. cases where the truth is 1/1 and the query is 0/1 or similar). |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.precision | |
Element Id | Sequence.quality.precision |
Definition | QUERY.TP / (QUERY.TP + QUERY.FP). |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.recall | |
Element Id | Sequence.quality.recall |
Definition | TRUTH.TP / (TRUTH.TP + TRUTH.FN). |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.fScore | |
Element Id | Sequence.quality.fScore |
Definition | Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall). |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.quality.roc | |
Element Id | Sequence.quality.roc |
Definition | Receiver Operator Characteristic (ROC) Curve to give sensitivity/specificity tradeoff. |
Control | 0..1 |
Summary | true |
Sequence.quality.roc.score | |
Element Id | Sequence.quality.roc.score |
Definition | Invidual data point representing the GQ (genotype quality) score threshold. |
Control | 0..* |
Type | integer |
Summary | true |
Sequence.quality.roc.numTP | |
Element Id | Sequence.quality.roc.numTP |
Definition | The number of true positives if the GQ score threshold was set to "score" field value. |
Control | 0..* |
Type | integer |
Summary | true |
Sequence.quality.roc.numFP | |
Element Id | Sequence.quality.roc.numFP |
Definition | The number of false positives if the GQ score threshold was set to "score" field value. |
Control | 0..* |
Type | integer |
Summary | true |
Sequence.quality.roc.numFN | |
Element Id | Sequence.quality.roc.numFN |
Definition | The number of false negatives if the GQ score threshold was set to "score" field value. |
Control | 0..* |
Type | integer |
Summary | true |
Sequence.quality.roc.precision | |
Element Id | Sequence.quality.roc.precision |
Definition | Calculated precision if the GQ score threshold was set to "score" field value. |
Control | 0..* |
Type | decimal |
Summary | true |
Sequence.quality.roc.sensitivity | |
Element Id | Sequence.quality.roc.sensitivity |
Definition | Calculated sensitivity if the GQ score threshold was set to "score" field value. |
Control | 0..* |
Type | decimal |
Summary | true |
Sequence.quality.roc.fMeasure | |
Element Id | Sequence.quality.roc.fMeasure |
Definition | Calculated fScore if the GQ score threshold was set to "score" field value. |
Control | 0..* |
Type | decimal |
Summary | true |
Sequence.readCoverage | |
Element Id | Sequence.readCoverage |
Definition | Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.repository | |
Element Id | Sequence.repository |
Definition | Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq. |
Control | 0..* |
Summary | true |
Sequence.repository.type | |
Element Id | Sequence.repository.type |
Definition | Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource. |
Control | 1..1 |
Terminology Binding | repositoryType (Required) |
Type | code |
Summary | true |
Sequence.repository.url | |
Element Id | Sequence.repository.url |
Definition | URI of an external repository which contains further details about the genetics data. |
Control | 0..1 |
Type | uri |
Summary | true |
Sequence.repository.name | |
Element Id | Sequence.repository.name |
Definition | URI of an external repository which contains further details about the genetics data. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.repository.datasetId | |
Element Id | Sequence.repository.datasetId |
Definition | Id of the variant in this external repository. The server will understand how to use this id to call for more info about datasets in external repository. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.repository.variantsetId | |
Element Id | Sequence.repository.variantsetId |
Definition | Id of the variantset in this external repository. The server will understand how to use this id to call for more info about variantsets in external repository. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.repository.readsetId | |
Element Id | Sequence.repository.readsetId |
Definition | Id of the read in this external repository. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.pointer | |
Element Id | Sequence.pointer |
Definition | Pointer to next atomic sequence which at most contains one variant. |
Control | 0..* |
Type | Reference(Sequence) |
Summary | true |
Sequence.structureVariant | |
Element Id | Sequence.structureVariant |
Definition | Information about chromosome structure variation. |
Control | 0..* |
Summary | true |
Sequence.structureVariant.precision | |
Element Id | Sequence.structureVariant.precision |
Definition | Identify the exact boundaries of variant sequences. Each type of structure variant requires the DNA duplex to be broken and rejoined, and this creates a new sequence of bases at the rejoined sites, known as breakpoints or boundaries. |
Control | 0..1 |
Type | string |
Summary | true |
Sequence.structureVariant.reportedaCGHRatio | |
Element Id | Sequence.structureVariant.reportedaCGHRatio |
Definition | Structural Variant reported aCGH ratio. |
Control | 0..1 |
Type | decimal |
Summary | true |
Sequence.structureVariant.length | |
Element Id | Sequence.structureVariant.length |
Definition | Length of the variant choromosome. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.structureVariant.outer | |
Element Id | Sequence.structureVariant.outer |
Definition | Structural variant outer. |
Control | 0..1 |
Summary | true |
Sequence.structureVariant.outer.start | |
Element Id | Sequence.structureVariant.outer.start |
Definition | Structural Variant Outer Start.If the coordinate system is either 0-based or 1-based, then start position is inclusive. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.structureVariant.outer.end | |
Element Id | Sequence.structureVariant.outer.end |
Definition | Structural Variant Outer End. If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.structureVariant.inner | |
Element Id | Sequence.structureVariant.inner |
Definition | Structural variant inner. |
Control | 0..1 |
Summary | true |
Sequence.structureVariant.inner.start | |
Element Id | Sequence.structureVariant.inner.start |
Definition | Structural Variant Inner Start.If the coordinate system is either 0-based or 1-based, then start position is inclusive. |
Control | 0..1 |
Type | integer |
Summary | true |
Sequence.structureVariant.inner.end | |
Element Id | Sequence.structureVariant.inner.end |
Definition | Structural Variant Inner End. If the coordinate system is 0-based then end is is exclusive and does not include the last position. If the coordinate system is 1-base, then end is inclusive and includes the last position. |
Control | 0..1 |
Type | integer |
Summary | true |