This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). 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: 0 | Compartments: Not linked to any defined compartments |
Raw data describing a biological sequence.
The Sequence resource is designed to describe an atomic sequence which contains more than one bases but has at most one variation. Atomic sequences can be connected by link element and they will lead to sequence graph. By this method, a sequence can be reported. Complete genetic sequence information, of which specific genetic variations are a part, is reported by reference to the GA4GH repository. Thus, the FHIR Sequence resource avoids large genomic payloads in a manner analogous to how the FHIR ImagingStudy resource references large images maintained in other systems. This resource contextualizes well established standards from the field of clinical genetics into the standards of healthcare (e.g. HGNC - HUGO Gene Nomenclature Committee's international standard for gene names, symbols, and identifiers).
This resource is designed to describe a sequence variation with clinical significance with information such as:
It is strongly encouraged to provide all available information in this resource for any reported variants, because receiving systems (e.g. discovery research, outcomes analysis, and public health reporting) may use this information to normalize variants over time or across sources. However, these data should not be used to dynamically correct/change variant representations for clinical use outside of the laboratory, due to insufficient information.
Implementers should be aware that semantic equivalency of results of genetic variants cannot be guaranteed unless there is an agreed upon standard between sending and receiving systems.
Focus of the resource is to provide data immediately relevant to clinical decision-making. Hence data such as precise read of DNA sequences and sequence alignment are not included; such data are nonetheless accessible through references to GA4GH (Global Alliance for Genomics and Health) API. The Sequence resource will be referenced by Observation to provide variant information. As clinical assessments/diagnosis of a patient are typically captured in the Condition resource or the ClinicalImpression resource, the Sequence resource can be referenced by the Condition resource to provide specific genetic data to support an assertions. This is analogous to how Condition references other resources, such as AllergyIntolerance, Procedure, and Questionnaire resources.
This resource is referenced by observation
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Sequence | Σ | DomainResource | Information about a biological sequence | |
identifier | Σ | 0..* | Identifier | Unique ID for this particular sequence |
type | Σ | 1..1 | code | AA | DNA | RNA sequenceType (Example) |
coordinateSystem | Σ | 1..1 | integer | Numbering used for sequence (0-based or 1-based) |
patient | Σ | 0..1 | Reference(Patient) | Who and/or what this is about |
specimen | Σ | 0..1 | Reference(Specimen) | Specimen used for sequencing |
device | Σ | 0..1 | Reference(Device) | The method for sequencing |
quantity | Σ | 0..1 | Quantity | Quantity of the sequence |
referenceSeq | Σ | 0..1 | BackboneElement | Reference sequence |
chromosome | Σ | 0..1 | CodeableConcept | Chromosome containing genetic finding chromosome-human (Example) |
genomeBuild | Σ | 0..1 | string | The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' |
referenceSeqId | Σ | 1..1 | CodeableConcept | Reference identifier ENSEMBL (Example) |
referenceSeqPointer | Σ | 0..1 | Reference(Sequence) | A Pointer to another Sequence entity as refence sequence |
referenceSeqString | Σ | 0..1 | string | A Reference Sequence string |
strand | Σ | 1..1 | integer | Strand of DNA |
windowStart | Σ | 1..1 | integer | Start position (inclusive) of the window on the reference sequence |
windowEnd | Σ | 1..1 | integer | End position (exclusive) of the window on the reference sequence |
variant | Σ | 0..* | BackboneElement | Sequence variant |
start | Σ | 0..1 | integer | Start position (inclusive) of the variant on the reference sequence |
end | Σ | 0..1 | integer | End position (exclusive) of the variant on the reference sequence |
observedAllele | Σ | 0..1 | string | Allele that was observed |
referenceAllele | Σ | 0..1 | string | Allele of reference sequence |
cigar | Σ | 0..1 | string | Extended CIGAR string for aligning the sequence with reference bases |
variantPointer | Σ | 0..1 | Reference(Observation) | Pointer to observed variant information |
observedSeq | Σ | 0..1 | string | Observed sequence |
quality | Σ | 0..* | BackboneElement | Sequence quality |
standardSequence | Σ | 0..1 | CodeableConcept | Standard sequence for comparison |
start | Σ | 0..1 | integer | Start position (inclusive) of the sequence |
end | Σ | 0..1 | integer | End position (exclusive) of the sequence |
score | Σ | 0..1 | Quantity | Quality score |
method | Σ | 0..1 | CodeableConcept | Method for quality |
truthTP | Σ | 0..1 | decimal | True positives from the perspective of the truth data |
queryTP | Σ | 0..1 | decimal | True positives from the perspective of the query data |
truthFN | Σ | 0..1 | decimal | False negatives |
queryFP | Σ | 0..1 | decimal | False positives |
gtFP | Σ | 0..1 | decimal | False positives where the non-REF alleles in the Truth and Query Call Sets match |
precision | Σ | 0..1 | decimal | Precision |
recall | Σ | 0..1 | decimal | Recall |
fScore | Σ | 0..1 | decimal | F-score |
readCoverage | Σ | 0..1 | integer | Average number of reads representing a given nucleotide in the reconstructed sequence |
repository | Σ | 0..* | BackboneElement | External repository |
url | Σ | 0..1 | uri | URI of the repository |
name | Σ | 0..1 | string | Name of the repository |
variantId | Σ | 0..1 | string | Id of the variant |
readId | Σ | 0..1 | string | Id of the read |
pointer | Σ | 0..* | Reference(Sequence) | Pointer to next atomic sequence |
structureVariant | Σ | 0..* | BackboneElement | |
precisionOfBoundaries | Σ | 0..1 | string | Precision of boundaries |
reportedaCGHRatio | Σ | 0..1 | decimal | Structural Variant reported aCGH ratio |
length | Σ | 0..1 | integer | Structural Variant Length |
outer | Σ | 0..1 | BackboneElement | |
start | Σ | 0..1 | integer | Structural Variant Outer Start-End |
end | Σ | 0..1 | integer | Structural Variant Outer Start-End |
inner | Σ | 0..1 | BackboneElement | |
start | Σ | 0..1 | integer | Structural Variant Inner Start-End |
end | Σ | 0..1 | integer | Structural Variant Inner Start-End |
Documentation for this format |
UML Diagram (Legend)
XML Template
<Sequence xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique ID for this particular sequence --></identifier> <type value="[code]"/><!-- 1..1 AA | DNA | RNA --> <coordinateSystem value="[integer]"/><!-- 1..1 Numbering used for sequence (0-based or 1-based) --> <patient><!-- 0..1 Reference(Patient) Who and/or what this is about --></patient> <specimen><!-- 0..1 Reference(Specimen) Specimen used for sequencing --></specimen> <device><!-- 0..1 Reference(Device) The method for sequencing --></device> <quantity><!-- 0..1 Quantity Quantity of the sequence --></quantity> <referenceSeq> <!-- 0..1 Reference sequence --> <chromosome><!-- 0..1 CodeableConcept Chromosome containing genetic finding --></chromosome> <genomeBuild value="[string]"/><!-- 0..1 The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' --> <referenceSeqId><!-- 1..1 CodeableConcept Reference identifier --></referenceSeqId> <referenceSeqPointer><!-- 0..1 Reference(Sequence) A Pointer to another Sequence entity as refence sequence --></referenceSeqPointer> <referenceSeqString value="[string]"/><!-- 0..1 A Reference Sequence string --> <strand value="[integer]"/><!-- 1..1 Strand of DNA --> <windowStart value="[integer]"/><!-- 1..1 Start position (inclusive) of the window on the reference sequence --> <windowEnd value="[integer]"/><!-- 1..1 End position (exclusive) of the window on the reference sequence --> </referenceSeq> <variant> <!-- 0..* Sequence variant --> <start value="[integer]"/><!-- 0..1 Start position (inclusive) of the variant on the reference sequence --> <end value="[integer]"/><!-- 0..1 End position (exclusive) of the variant on the reference sequence --> <observedAllele value="[string]"/><!-- 0..1 Allele that was observed --> <referenceAllele value="[string]"/><!-- 0..1 Allele of reference sequence --> <cigar value="[string]"/><!-- 0..1 Extended CIGAR string for aligning the sequence with reference bases --> <variantPointer><!-- 0..1 Reference(Observation) Pointer to observed variant information --></variantPointer> </variant> <observedSeq value="[string]"/><!-- 0..1 Observed sequence --> <quality> <!-- 0..* Sequence quality --> <standardSequence><!-- 0..1 CodeableConcept Standard sequence for comparison --></standardSequence> <start value="[integer]"/><!-- 0..1 Start position (inclusive) of the sequence --> <end value="[integer]"/><!-- 0..1 End position (exclusive) of the sequence --> <score><!-- 0..1 Quantity Quality score --></score> <method><!-- 0..1 CodeableConcept Method for quality --></method> <truthTP value="[decimal]"/><!-- 0..1 True positives from the perspective of the truth data --> <queryTP value="[decimal]"/><!-- 0..1 True positives from the perspective of the query data --> <truthFN value="[decimal]"/><!-- 0..1 False negatives --> <queryFP value="[decimal]"/><!-- 0..1 False positives --> <gtFP value="[decimal]"/><!-- 0..1 False positives where the non-REF alleles in the Truth and Query Call Sets match --> <precision value="[decimal]"/><!-- 0..1 Precision --> <recall value="[decimal]"/><!-- 0..1 Recall --> <fScore value="[decimal]"/><!-- 0..1 F-score --> </quality> <readCoverage value="[integer]"/><!-- 0..1 Average number of reads representing a given nucleotide in the reconstructed sequence --> <repository> <!-- 0..* External repository --> <url value="[uri]"/><!-- 0..1 URI of the repository --> <name value="[string]"/><!-- 0..1 Name of the repository --> <variantId value="[string]"/><!-- 0..1 Id of the variant --> <readId value="[string]"/><!-- 0..1 Id of the read --> </repository> <pointer><!-- 0..* Reference(Sequence) Pointer to next atomic sequence --></pointer> <structureVariant> <!-- 0..* --> <precisionOfBoundaries value="[string]"/><!-- 0..1 Precision of boundaries --> <reportedaCGHRatio value="[decimal]"/><!-- 0..1 Structural Variant reported aCGH ratio --> <length value="[integer]"/><!-- 0..1 Structural Variant Length --> <outer> <start value="[integer]"/><!-- 0..1 Structural Variant Outer Start-End --> <end value="[integer]"/><!-- 0..1 Structural Variant Outer Start-End --> </outer> <inner> <start value="[integer]"/><!-- 0..1 Structural Variant Inner Start-End --> <end value="[integer]"/><!-- 0..1 Structural Variant Inner Start-End --> </inner> </structureVariant> </Sequence>
JSON Template
{ "resourceType" : "Sequence", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Unique ID for this particular sequence "type" : "<code>", // R! AA | DNA | RNA "coordinateSystem" : <integer>, // R! Numbering used for sequence (0-based or 1-based) "patient" : { Reference(Patient) }, // Who and/or what this is about "specimen" : { Reference(Specimen) }, // Specimen used for sequencing "device" : { Reference(Device) }, // The method for sequencing "quantity" : { Quantity }, // Quantity of the sequence "referenceSeq" : { // Reference sequence "chromosome" : { CodeableConcept }, // Chromosome containing genetic finding "genomeBuild" : "<string>", // The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' "referenceSeqId" : { CodeableConcept }, // R! Reference identifier "referenceSeqPointer" : { Reference(Sequence) }, // A Pointer to another Sequence entity as refence sequence "referenceSeqString" : "<string>", // A Reference Sequence string "strand" : <integer>, // R! Strand of DNA "windowStart" : <integer>, // R! Start position (inclusive) of the window on the reference sequence "windowEnd" : <integer> // R! End position (exclusive) of the window on the reference sequence }, "variant" : [{ // Sequence variant "start" : <integer>, // Start position (inclusive) of the variant on the reference sequence "end" : <integer>, // End position (exclusive) of the variant on the reference sequence "observedAllele" : "<string>", // Allele that was observed "referenceAllele" : "<string>", // Allele of reference sequence "cigar" : "<string>", // Extended CIGAR string for aligning the sequence with reference bases "variantPointer" : { Reference(Observation) } // Pointer to observed variant information }], "observedSeq" : "<string>", // Observed sequence "quality" : [{ // Sequence quality "standardSequence" : { CodeableConcept }, // Standard sequence for comparison "start" : <integer>, // Start position (inclusive) of the sequence "end" : <integer>, // End position (exclusive) of the sequence "score" : { Quantity }, // Quality score "method" : { CodeableConcept }, // Method for quality "truthTP" : <decimal>, // True positives from the perspective of the truth data "queryTP" : <decimal>, // True positives from the perspective of the query data "truthFN" : <decimal>, // False negatives "queryFP" : <decimal>, // False positives "gtFP" : <decimal>, // False positives where the non-REF alleles in the Truth and Query Call Sets match "precision" : <decimal>, // Precision "recall" : <decimal>, // Recall "fScore" : <decimal> // F-score }], "readCoverage" : <integer>, // Average number of reads representing a given nucleotide in the reconstructed sequence "repository" : [{ // External repository "url" : "<uri>", // URI of the repository "name" : "<string>", // Name of the repository "variantId" : "<string>", // Id of the variant "readId" : "<string>" // Id of the read }], "pointer" : [{ Reference(Sequence) }], // Pointer to next atomic sequence "structureVariant" : [{ // "precisionOfBoundaries" : "<string>", // Precision of boundaries "reportedaCGHRatio" : <decimal>, // Structural Variant reported aCGH ratio "length" : <integer>, // Structural Variant Length "outer" : { // "start" : <integer>, // Structural Variant Outer Start-End "end" : <integer> // Structural Variant Outer Start-End }, "inner" : { // "start" : <integer>, // Structural Variant Inner Start-End "end" : <integer> // Structural Variant Inner Start-End } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Sequence; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Sequence.identifier [ Identifier ], ... ; # 0..* Unique ID for this particular sequence fhir:Sequence.type [ code ]; # 1..1 AA | DNA | RNA fhir:Sequence.coordinateSystem [ integer ]; # 1..1 Numbering used for sequence (0-based or 1-based) fhir:Sequence.patient [ Reference(Patient) ]; # 0..1 Who and/or what this is about fhir:Sequence.specimen [ Reference(Specimen) ]; # 0..1 Specimen used for sequencing fhir:Sequence.device [ Reference(Device) ]; # 0..1 The method for sequencing fhir:Sequence.quantity [ Quantity ]; # 0..1 Quantity of the sequence fhir:Sequence.referenceSeq [ # 0..1 Reference sequence fhir:Sequence.referenceSeq.chromosome [ CodeableConcept ]; # 0..1 Chromosome containing genetic finding fhir:Sequence.referenceSeq.genomeBuild [ string ]; # 0..1 The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' fhir:Sequence.referenceSeq.referenceSeqId [ CodeableConcept ]; # 1..1 Reference identifier fhir:Sequence.referenceSeq.referenceSeqPointer [ Reference(Sequence) ]; # 0..1 A Pointer to another Sequence entity as refence sequence fhir:Sequence.referenceSeq.referenceSeqString [ string ]; # 0..1 A Reference Sequence string fhir:Sequence.referenceSeq.strand [ integer ]; # 1..1 Strand of DNA fhir:Sequence.referenceSeq.windowStart [ integer ]; # 1..1 Start position (inclusive) of the window on the reference sequence fhir:Sequence.referenceSeq.windowEnd [ integer ]; # 1..1 End position (exclusive) of the window on the reference sequence ]; fhir:Sequence.variant [ # 0..* Sequence variant fhir:Sequence.variant.start [ integer ]; # 0..1 Start position (inclusive) of the variant on the reference sequence fhir:Sequence.variant.end [ integer ]; # 0..1 End position (exclusive) of the variant on the reference sequence fhir:Sequence.variant.observedAllele [ string ]; # 0..1 Allele that was observed fhir:Sequence.variant.referenceAllele [ string ]; # 0..1 Allele of reference sequence fhir:Sequence.variant.cigar [ string ]; # 0..1 Extended CIGAR string for aligning the sequence with reference bases fhir:Sequence.variant.variantPointer [ Reference(Observation) ]; # 0..1 Pointer to observed variant information ], ...; fhir:Sequence.observedSeq [ string ]; # 0..1 Observed sequence fhir:Sequence.quality [ # 0..* Sequence quality fhir:Sequence.quality.standardSequence [ CodeableConcept ]; # 0..1 Standard sequence for comparison fhir:Sequence.quality.start [ integer ]; # 0..1 Start position (inclusive) of the sequence fhir:Sequence.quality.end [ integer ]; # 0..1 End position (exclusive) of the sequence fhir:Sequence.quality.score [ Quantity ]; # 0..1 Quality score fhir:Sequence.quality.method [ CodeableConcept ]; # 0..1 Method for quality fhir:Sequence.quality.truthTP [ decimal ]; # 0..1 True positives from the perspective of the truth data fhir:Sequence.quality.queryTP [ decimal ]; # 0..1 True positives from the perspective of the query data fhir:Sequence.quality.truthFN [ decimal ]; # 0..1 False negatives fhir:Sequence.quality.queryFP [ decimal ]; # 0..1 False positives fhir:Sequence.quality.gtFP [ decimal ]; # 0..1 False positives where the non-REF alleles in the Truth and Query Call Sets match fhir:Sequence.quality.precision [ decimal ]; # 0..1 Precision fhir:Sequence.quality.recall [ decimal ]; # 0..1 Recall fhir:Sequence.quality.fScore [ decimal ]; # 0..1 F-score ], ...; fhir:Sequence.readCoverage [ integer ]; # 0..1 Average number of reads representing a given nucleotide in the reconstructed sequence fhir:Sequence.repository [ # 0..* External repository fhir:Sequence.repository.url [ uri ]; # 0..1 URI of the repository fhir:Sequence.repository.name [ string ]; # 0..1 Name of the repository fhir:Sequence.repository.variantId [ string ]; # 0..1 Id of the variant fhir:Sequence.repository.readId [ string ]; # 0..1 Id of the read ], ...; fhir:Sequence.pointer [ Reference(Sequence) ], ... ; # 0..* Pointer to next atomic sequence fhir:Sequence.structureVariant [ # 0..* fhir:Sequence.structureVariant.precisionOfBoundaries [ string ]; # 0..1 Precision of boundaries fhir:Sequence.structureVariant.reportedaCGHRatio [ decimal ]; # 0..1 Structural Variant reported aCGH ratio fhir:Sequence.structureVariant.length [ integer ]; # 0..1 Structural Variant Length fhir:Sequence.structureVariant.outer [ # 0..1 fhir:Sequence.structureVariant.outer.start [ integer ]; # 0..1 Structural Variant Outer Start-End fhir:Sequence.structureVariant.outer.end [ integer ]; # 0..1 Structural Variant Outer Start-End ]; fhir:Sequence.structureVariant.inner [ # 0..1 fhir:Sequence.structureVariant.inner.start [ integer ]; # 0..1 Structural Variant Inner Start-End fhir:Sequence.structureVariant.inner.end [ integer ]; # 0..1 Structural Variant Inner Start-End ]; ], ...; ]
Changes since DSTU2
This resource did not exist in Release 2
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Sequence | Σ | DomainResource | Information about a biological sequence | |
identifier | Σ | 0..* | Identifier | Unique ID for this particular sequence |
type | Σ | 1..1 | code | AA | DNA | RNA sequenceType (Example) |
coordinateSystem | Σ | 1..1 | integer | Numbering used for sequence (0-based or 1-based) |
patient | Σ | 0..1 | Reference(Patient) | Who and/or what this is about |
specimen | Σ | 0..1 | Reference(Specimen) | Specimen used for sequencing |
device | Σ | 0..1 | Reference(Device) | The method for sequencing |
quantity | Σ | 0..1 | Quantity | Quantity of the sequence |
referenceSeq | Σ | 0..1 | BackboneElement | Reference sequence |
chromosome | Σ | 0..1 | CodeableConcept | Chromosome containing genetic finding chromosome-human (Example) |
genomeBuild | Σ | 0..1 | string | The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' |
referenceSeqId | Σ | 1..1 | CodeableConcept | Reference identifier ENSEMBL (Example) |
referenceSeqPointer | Σ | 0..1 | Reference(Sequence) | A Pointer to another Sequence entity as refence sequence |
referenceSeqString | Σ | 0..1 | string | A Reference Sequence string |
strand | Σ | 1..1 | integer | Strand of DNA |
windowStart | Σ | 1..1 | integer | Start position (inclusive) of the window on the reference sequence |
windowEnd | Σ | 1..1 | integer | End position (exclusive) of the window on the reference sequence |
variant | Σ | 0..* | BackboneElement | Sequence variant |
start | Σ | 0..1 | integer | Start position (inclusive) of the variant on the reference sequence |
end | Σ | 0..1 | integer | End position (exclusive) of the variant on the reference sequence |
observedAllele | Σ | 0..1 | string | Allele that was observed |
referenceAllele | Σ | 0..1 | string | Allele of reference sequence |
cigar | Σ | 0..1 | string | Extended CIGAR string for aligning the sequence with reference bases |
variantPointer | Σ | 0..1 | Reference(Observation) | Pointer to observed variant information |
observedSeq | Σ | 0..1 | string | Observed sequence |
quality | Σ | 0..* | BackboneElement | Sequence quality |
standardSequence | Σ | 0..1 | CodeableConcept | Standard sequence for comparison |
start | Σ | 0..1 | integer | Start position (inclusive) of the sequence |
end | Σ | 0..1 | integer | End position (exclusive) of the sequence |
score | Σ | 0..1 | Quantity | Quality score |
method | Σ | 0..1 | CodeableConcept | Method for quality |
truthTP | Σ | 0..1 | decimal | True positives from the perspective of the truth data |
queryTP | Σ | 0..1 | decimal | True positives from the perspective of the query data |
truthFN | Σ | 0..1 | decimal | False negatives |
queryFP | Σ | 0..1 | decimal | False positives |
gtFP | Σ | 0..1 | decimal | False positives where the non-REF alleles in the Truth and Query Call Sets match |
precision | Σ | 0..1 | decimal | Precision |
recall | Σ | 0..1 | decimal | Recall |
fScore | Σ | 0..1 | decimal | F-score |
readCoverage | Σ | 0..1 | integer | Average number of reads representing a given nucleotide in the reconstructed sequence |
repository | Σ | 0..* | BackboneElement | External repository |
url | Σ | 0..1 | uri | URI of the repository |
name | Σ | 0..1 | string | Name of the repository |
variantId | Σ | 0..1 | string | Id of the variant |
readId | Σ | 0..1 | string | Id of the read |
pointer | Σ | 0..* | Reference(Sequence) | Pointer to next atomic sequence |
structureVariant | Σ | 0..* | BackboneElement | |
precisionOfBoundaries | Σ | 0..1 | string | Precision of boundaries |
reportedaCGHRatio | Σ | 0..1 | decimal | Structural Variant reported aCGH ratio |
length | Σ | 0..1 | integer | Structural Variant Length |
outer | Σ | 0..1 | BackboneElement | |
start | Σ | 0..1 | integer | Structural Variant Outer Start-End |
end | Σ | 0..1 | integer | Structural Variant Outer Start-End |
inner | Σ | 0..1 | BackboneElement | |
start | Σ | 0..1 | integer | Structural Variant Inner Start-End |
end | Σ | 0..1 | integer | Structural Variant Inner Start-End |
Documentation for this format |
XML Template
<Sequence xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier Unique ID for this particular sequence --></identifier> <type value="[code]"/><!-- 1..1 AA | DNA | RNA --> <coordinateSystem value="[integer]"/><!-- 1..1 Numbering used for sequence (0-based or 1-based) --> <patient><!-- 0..1 Reference(Patient) Who and/or what this is about --></patient> <specimen><!-- 0..1 Reference(Specimen) Specimen used for sequencing --></specimen> <device><!-- 0..1 Reference(Device) The method for sequencing --></device> <quantity><!-- 0..1 Quantity Quantity of the sequence --></quantity> <referenceSeq> <!-- 0..1 Reference sequence --> <chromosome><!-- 0..1 CodeableConcept Chromosome containing genetic finding --></chromosome> <genomeBuild value="[string]"/><!-- 0..1 The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' --> <referenceSeqId><!-- 1..1 CodeableConcept Reference identifier --></referenceSeqId> <referenceSeqPointer><!-- 0..1 Reference(Sequence) A Pointer to another Sequence entity as refence sequence --></referenceSeqPointer> <referenceSeqString value="[string]"/><!-- 0..1 A Reference Sequence string --> <strand value="[integer]"/><!-- 1..1 Strand of DNA --> <windowStart value="[integer]"/><!-- 1..1 Start position (inclusive) of the window on the reference sequence --> <windowEnd value="[integer]"/><!-- 1..1 End position (exclusive) of the window on the reference sequence --> </referenceSeq> <variant> <!-- 0..* Sequence variant --> <start value="[integer]"/><!-- 0..1 Start position (inclusive) of the variant on the reference sequence --> <end value="[integer]"/><!-- 0..1 End position (exclusive) of the variant on the reference sequence --> <observedAllele value="[string]"/><!-- 0..1 Allele that was observed --> <referenceAllele value="[string]"/><!-- 0..1 Allele of reference sequence --> <cigar value="[string]"/><!-- 0..1 Extended CIGAR string for aligning the sequence with reference bases --> <variantPointer><!-- 0..1 Reference(Observation) Pointer to observed variant information --></variantPointer> </variant> <observedSeq value="[string]"/><!-- 0..1 Observed sequence --> <quality> <!-- 0..* Sequence quality --> <standardSequence><!-- 0..1 CodeableConcept Standard sequence for comparison --></standardSequence> <start value="[integer]"/><!-- 0..1 Start position (inclusive) of the sequence --> <end value="[integer]"/><!-- 0..1 End position (exclusive) of the sequence --> <score><!-- 0..1 Quantity Quality score --></score> <method><!-- 0..1 CodeableConcept Method for quality --></method> <truthTP value="[decimal]"/><!-- 0..1 True positives from the perspective of the truth data --> <queryTP value="[decimal]"/><!-- 0..1 True positives from the perspective of the query data --> <truthFN value="[decimal]"/><!-- 0..1 False negatives --> <queryFP value="[decimal]"/><!-- 0..1 False positives --> <gtFP value="[decimal]"/><!-- 0..1 False positives where the non-REF alleles in the Truth and Query Call Sets match --> <precision value="[decimal]"/><!-- 0..1 Precision --> <recall value="[decimal]"/><!-- 0..1 Recall --> <fScore value="[decimal]"/><!-- 0..1 F-score --> </quality> <readCoverage value="[integer]"/><!-- 0..1 Average number of reads representing a given nucleotide in the reconstructed sequence --> <repository> <!-- 0..* External repository --> <url value="[uri]"/><!-- 0..1 URI of the repository --> <name value="[string]"/><!-- 0..1 Name of the repository --> <variantId value="[string]"/><!-- 0..1 Id of the variant --> <readId value="[string]"/><!-- 0..1 Id of the read --> </repository> <pointer><!-- 0..* Reference(Sequence) Pointer to next atomic sequence --></pointer> <structureVariant> <!-- 0..* --> <precisionOfBoundaries value="[string]"/><!-- 0..1 Precision of boundaries --> <reportedaCGHRatio value="[decimal]"/><!-- 0..1 Structural Variant reported aCGH ratio --> <length value="[integer]"/><!-- 0..1 Structural Variant Length --> <outer> <start value="[integer]"/><!-- 0..1 Structural Variant Outer Start-End --> <end value="[integer]"/><!-- 0..1 Structural Variant Outer Start-End --> </outer> <inner> <start value="[integer]"/><!-- 0..1 Structural Variant Inner Start-End --> <end value="[integer]"/><!-- 0..1 Structural Variant Inner Start-End --> </inner> </structureVariant> </Sequence>
JSON Template
{ "resourceType" : "Sequence", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // Unique ID for this particular sequence "type" : "<code>", // R! AA | DNA | RNA "coordinateSystem" : <integer>, // R! Numbering used for sequence (0-based or 1-based) "patient" : { Reference(Patient) }, // Who and/or what this is about "specimen" : { Reference(Specimen) }, // Specimen used for sequencing "device" : { Reference(Device) }, // The method for sequencing "quantity" : { Quantity }, // Quantity of the sequence "referenceSeq" : { // Reference sequence "chromosome" : { CodeableConcept }, // Chromosome containing genetic finding "genomeBuild" : "<string>", // The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' "referenceSeqId" : { CodeableConcept }, // R! Reference identifier "referenceSeqPointer" : { Reference(Sequence) }, // A Pointer to another Sequence entity as refence sequence "referenceSeqString" : "<string>", // A Reference Sequence string "strand" : <integer>, // R! Strand of DNA "windowStart" : <integer>, // R! Start position (inclusive) of the window on the reference sequence "windowEnd" : <integer> // R! End position (exclusive) of the window on the reference sequence }, "variant" : [{ // Sequence variant "start" : <integer>, // Start position (inclusive) of the variant on the reference sequence "end" : <integer>, // End position (exclusive) of the variant on the reference sequence "observedAllele" : "<string>", // Allele that was observed "referenceAllele" : "<string>", // Allele of reference sequence "cigar" : "<string>", // Extended CIGAR string for aligning the sequence with reference bases "variantPointer" : { Reference(Observation) } // Pointer to observed variant information }], "observedSeq" : "<string>", // Observed sequence "quality" : [{ // Sequence quality "standardSequence" : { CodeableConcept }, // Standard sequence for comparison "start" : <integer>, // Start position (inclusive) of the sequence "end" : <integer>, // End position (exclusive) of the sequence "score" : { Quantity }, // Quality score "method" : { CodeableConcept }, // Method for quality "truthTP" : <decimal>, // True positives from the perspective of the truth data "queryTP" : <decimal>, // True positives from the perspective of the query data "truthFN" : <decimal>, // False negatives "queryFP" : <decimal>, // False positives "gtFP" : <decimal>, // False positives where the non-REF alleles in the Truth and Query Call Sets match "precision" : <decimal>, // Precision "recall" : <decimal>, // Recall "fScore" : <decimal> // F-score }], "readCoverage" : <integer>, // Average number of reads representing a given nucleotide in the reconstructed sequence "repository" : [{ // External repository "url" : "<uri>", // URI of the repository "name" : "<string>", // Name of the repository "variantId" : "<string>", // Id of the variant "readId" : "<string>" // Id of the read }], "pointer" : [{ Reference(Sequence) }], // Pointer to next atomic sequence "structureVariant" : [{ // "precisionOfBoundaries" : "<string>", // Precision of boundaries "reportedaCGHRatio" : <decimal>, // Structural Variant reported aCGH ratio "length" : <integer>, // Structural Variant Length "outer" : { // "start" : <integer>, // Structural Variant Outer Start-End "end" : <integer> // Structural Variant Outer Start-End }, "inner" : { // "start" : <integer>, // Structural Variant Inner Start-End "end" : <integer> // Structural Variant Inner Start-End } }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ a fhir:Sequence; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:Sequence.identifier [ Identifier ], ... ; # 0..* Unique ID for this particular sequence fhir:Sequence.type [ code ]; # 1..1 AA | DNA | RNA fhir:Sequence.coordinateSystem [ integer ]; # 1..1 Numbering used for sequence (0-based or 1-based) fhir:Sequence.patient [ Reference(Patient) ]; # 0..1 Who and/or what this is about fhir:Sequence.specimen [ Reference(Specimen) ]; # 0..1 Specimen used for sequencing fhir:Sequence.device [ Reference(Device) ]; # 0..1 The method for sequencing fhir:Sequence.quantity [ Quantity ]; # 0..1 Quantity of the sequence fhir:Sequence.referenceSeq [ # 0..1 Reference sequence fhir:Sequence.referenceSeq.chromosome [ CodeableConcept ]; # 0..1 Chromosome containing genetic finding fhir:Sequence.referenceSeq.genomeBuild [ string ]; # 0..1 The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' fhir:Sequence.referenceSeq.referenceSeqId [ CodeableConcept ]; # 1..1 Reference identifier fhir:Sequence.referenceSeq.referenceSeqPointer [ Reference(Sequence) ]; # 0..1 A Pointer to another Sequence entity as refence sequence fhir:Sequence.referenceSeq.referenceSeqString [ string ]; # 0..1 A Reference Sequence string fhir:Sequence.referenceSeq.strand [ integer ]; # 1..1 Strand of DNA fhir:Sequence.referenceSeq.windowStart [ integer ]; # 1..1 Start position (inclusive) of the window on the reference sequence fhir:Sequence.referenceSeq.windowEnd [ integer ]; # 1..1 End position (exclusive) of the window on the reference sequence ]; fhir:Sequence.variant [ # 0..* Sequence variant fhir:Sequence.variant.start [ integer ]; # 0..1 Start position (inclusive) of the variant on the reference sequence fhir:Sequence.variant.end [ integer ]; # 0..1 End position (exclusive) of the variant on the reference sequence fhir:Sequence.variant.observedAllele [ string ]; # 0..1 Allele that was observed fhir:Sequence.variant.referenceAllele [ string ]; # 0..1 Allele of reference sequence fhir:Sequence.variant.cigar [ string ]; # 0..1 Extended CIGAR string for aligning the sequence with reference bases fhir:Sequence.variant.variantPointer [ Reference(Observation) ]; # 0..1 Pointer to observed variant information ], ...; fhir:Sequence.observedSeq [ string ]; # 0..1 Observed sequence fhir:Sequence.quality [ # 0..* Sequence quality fhir:Sequence.quality.standardSequence [ CodeableConcept ]; # 0..1 Standard sequence for comparison fhir:Sequence.quality.start [ integer ]; # 0..1 Start position (inclusive) of the sequence fhir:Sequence.quality.end [ integer ]; # 0..1 End position (exclusive) of the sequence fhir:Sequence.quality.score [ Quantity ]; # 0..1 Quality score fhir:Sequence.quality.method [ CodeableConcept ]; # 0..1 Method for quality fhir:Sequence.quality.truthTP [ decimal ]; # 0..1 True positives from the perspective of the truth data fhir:Sequence.quality.queryTP [ decimal ]; # 0..1 True positives from the perspective of the query data fhir:Sequence.quality.truthFN [ decimal ]; # 0..1 False negatives fhir:Sequence.quality.queryFP [ decimal ]; # 0..1 False positives fhir:Sequence.quality.gtFP [ decimal ]; # 0..1 False positives where the non-REF alleles in the Truth and Query Call Sets match fhir:Sequence.quality.precision [ decimal ]; # 0..1 Precision fhir:Sequence.quality.recall [ decimal ]; # 0..1 Recall fhir:Sequence.quality.fScore [ decimal ]; # 0..1 F-score ], ...; fhir:Sequence.readCoverage [ integer ]; # 0..1 Average number of reads representing a given nucleotide in the reconstructed sequence fhir:Sequence.repository [ # 0..* External repository fhir:Sequence.repository.url [ uri ]; # 0..1 URI of the repository fhir:Sequence.repository.name [ string ]; # 0..1 Name of the repository fhir:Sequence.repository.variantId [ string ]; # 0..1 Id of the variant fhir:Sequence.repository.readId [ string ]; # 0..1 Id of the read ], ...; fhir:Sequence.pointer [ Reference(Sequence) ], ... ; # 0..* Pointer to next atomic sequence fhir:Sequence.structureVariant [ # 0..* fhir:Sequence.structureVariant.precisionOfBoundaries [ string ]; # 0..1 Precision of boundaries fhir:Sequence.structureVariant.reportedaCGHRatio [ decimal ]; # 0..1 Structural Variant reported aCGH ratio fhir:Sequence.structureVariant.length [ integer ]; # 0..1 Structural Variant Length fhir:Sequence.structureVariant.outer [ # 0..1 fhir:Sequence.structureVariant.outer.start [ integer ]; # 0..1 Structural Variant Outer Start-End fhir:Sequence.structureVariant.outer.end [ integer ]; # 0..1 Structural Variant Outer Start-End ]; fhir:Sequence.structureVariant.inner [ # 0..1 fhir:Sequence.structureVariant.inner.start [ integer ]; # 0..1 Structural Variant Inner Start-End fhir:Sequence.structureVariant.inner.end [ integer ]; # 0..1 Structural Variant Inner Start-End ]; ], ...; ]
Changes since DSTU2
This resource did not exist in Release 2
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
Path | Definition | Type | Reference |
---|---|---|---|
Sequence.type | Type if a sequence -- DNA, RNA, or amino acid sequence | Example | sequenceType |
Sequence.referenceSeq.chromosome | Chromosome number for human | Example | chromosome-human |
Sequence.referenceSeq.referenceSeqId | Reference identifier | Example | ENSEMBL |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
chromosome | token | Chromosome of the sequence | Sequence.referenceSeq.chromosome |
coordinate | composite | Genomic coordinate of the sequence. For example, a search for sequence in region 1:123-345 can be represented as `coordinate=1$lt345$gt123` | |
end | number | End position (0-based exclusive) of the sequence | Sequence.variant.end |
patient | reference | The subject that the observation is about | Sequence.patient (Patient) |
start | number | Start position (0-based inclusive) of the sequence | Sequence.variant.start |
type | token | The type of the variant: Amino acid / cDNA transcript / RNA variant. | Sequence.type |