STU 3 Candidate

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

4.37.10.2.4 StructureDefinition: Consensus-sequence-block - Detailed Descriptions

Definitions for the consensus-sequence-block Profile.

Sequence(Consensus-sequence-block)
Definition

Variation and Sequence data.

Control0..*
TypeSequence
Sequence.id
Definition

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Control0..1
Typeid
Comments

The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.

Sequence.meta
Definition

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.

Control0..1
TypeMeta
Sequence.implicitRules
Definition

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.

Control0..1
Typeuri
Is Modifiertrue
Comments

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.

Sequence.language
Definition

The base language in which the resource is written.

Control0..1
BindingA human language.
The codes SHALL be taken from http://tools.ietf.org/html/bcp47
Typecode
Comments

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

Sequence.text
Definition

A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Control0..1 This element is affected by the following invariants: dom-1
TypeNarrative
Alternate Namesnarrative, html, xhtml, display
Comments

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.

Sequence.contained
Definition

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

Control0..*
TypeResource
Alternate Namesinline resources, anonymous resources, contained resources
Comments

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.

Sequence.extension
Definition

An Extension

Control0..*
TypeExtension
SlicingThis element introduces a set of slices. The slicing rules are:
  • unordered
  • Open
  • discriminators: url
Sequence.extension (http://hl7.org/fhir/StructureDefinition/sequence-consensus-sequence-blockPhaseSet)
Definition

A phase set identifier to associate different consensussequence-blocks.

Control0..1
TypeExtension (Extension Type: integer)
Sequence.extension (http://hl7.org/fhir/StructureDefinition/sequence-consensus-sequence-blockExpectedCopyNumber)
Definition

To indicated how many copies of the sequence block was expected.

Control0..1
TypeExtension (Extension Type: integer)
Sequence.extension (http://hl7.org/fhir/StructureDefinition/sequence-consensus-sequence-blockContinuity)
Definition

A continuity flag to indicate whether a gap exists between blocks.

Control0..1
TypeExtension (Extension Type: boolean)
Sequence.extension (http://hl7.org/fhir/StructureDefinition/sequence-consensus-sequence-blockStrand)
Definition

Strand.

Control0..1
TypeExtension (Extension Type: integer)
Sequence.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.type
Definition

Amino acid / cDNA transcript / RNA variation.

Control1..1
BindingType if a sequence -- DNA, RNA, or amino acid sequence
For example codes, see sequenceType
Typecode
Sequence.patient
Definition

The patient, or group of patients whose sequencing results are described by this resource.

Control0..1
TypeReference(Patient)
Sequence.specimen
Definition

Specimen used for sequencing.

Control0..1
TypeReference(Specimen)
Sequence.device
Definition

The method for sequencing, for example, chip information.

Control0..1
TypeReference(Device)
Sequence.quantity
Definition

Quantity of the sequence.

Control0..1
TypeQuantity
Sequence.species
Definition

The organism from which sample of the sequence was extracted. Supporting tests of human, viruses, and bacteria.

Control0..1
BindingSpecies of the organism from which the sequence was extracted
For example codes, see SNOMED CT Codes for species
TypeCodeableConcept
Sequence.referenceSeq
Definition

Reference Sequence. It can be described in two ways. One is provide the unique identifier of reference sequence submitted to NCBI. The start and end position of window on reference sequence should be defined. The other way is using genome build, chromosome number,and also the start, end position of window (this method is specifically for DNA reference sequence) .

Control0..*
TypeBackboneElement
Sequence.referenceSeq.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.referenceSeq.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.referenceSeq.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.referenceSeq.chromosome
Definition

The chromosome containing the genetic finding. The value set will be 1-22, X, Y when the species is human without chromosome abnormality. Otherwise, NCBI-Gene code system should be used.

Control0..1
BindingChromosome number for human
For example codes, see chromosome-human
TypeCodeableConcept
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.

Control0..1
Typestring
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.

Control1..1
BindingReference identifier
For example codes, see ENSEMBL
TypeCodeableConcept
Sequence.referenceSeq.referenceSeqPointer
Definition

A Pointer to another Sequence entity as refence sequence.

Control0..1
TypeReference(Sequence)
Sequence.referenceSeq.referenceSeqString
Definition

A Reference Sequence string.

Control0..1
Typestring
Sequence.referenceSeq.windowStart
Definition

0-based start position (inclusive) of the window on the reference sequence.

Control1..1
Typeinteger
Sequence.referenceSeq.windowEnd
Definition

0-based end position (exclusive) of the window on the reference sequence.

Control1..1
Typeinteger
Sequence.variation
Definition

Variation info in this sequence.

Control0..1
TypeBackboneElement
Sequence.variation.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.variation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.variation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.variation.start
Definition

0-based start position (inclusive) of the variation on the reference sequence.

Control0..1
Typeinteger
Sequence.variation.end
Definition

0-based end position (exclusive) of the variation on the reference sequence.

Control0..1
Typeinteger
Sequence.variation.observedAllele
Definition

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.

Control0..1
Typestring
Sequence.variation.referenceAllele
Definition

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.

Control0..1
Typestring
Sequence.variation.cigar
Definition

Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation here .

Control0..1
Typestring
Sequence.quality
Definition

Quality for sequence quality vary by platform reflecting differences in sequencing chemistry and digital processing.

Control0..*
TypeBackboneElement
Sequence.quality.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.quality.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.quality.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.quality.start
Definition

0-based start position (inclusive) of the sequence.

Control0..1
Typeinteger
Sequence.quality.end
Definition

0-based end position (exclusive) of the sequence.

Control0..1
Typeinteger
Sequence.quality.score
Definition

Quality score.

Control0..1
TypeQuantity
Sequence.quality.method
Definition

Method for quality.

Control0..1
Typestring
Sequence.allelicState
Definition

The level of occurrence of a single DNA Sequence Variation within a set of chromosomes. Heterozygous indicates the DNA Sequence Variation is only present in one of the two genes contained in homologous chromosomes. Homozygous indicates the DNA Sequence Variation is present in both genes contained in homologous chromosomes. Hemizygous indicates the DNA Sequence Variation exists in the only single copy of a gene in a non- homologous chromosome (the male X and Y chromosome are non-homologous). Hemiplasmic indicates that the DNA Sequence Variation is present in some but not all of the copies of mitochondrial DNA. Homoplasmic indicates that the DNA Sequence Variation is present in all of the copies of mitochondrial DNA.

Control0..1
BindingLOINC answer list for AllelicState
For example codes, see LOINC 53034-5 answerlist
TypeCodeableConcept
Sequence.allelicFrequency
Definition

Allele frequencies.

Control0..1
Typedecimal
Sequence.copyNumberEvent
Definition

Values: amplificaiton / deletion / LOH.

Control0..1
BindingCopy Number Event
For example codes, see CopyNumberEvent
TypeCodeableConcept
Sequence.readCoverage
Definition

Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence.

Control0..1
Typeinteger
Sequence.repository
Definition

Configurations of the external repository.

Control0..*
TypeBackboneElement
Sequence.repository.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.repository.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.repository.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.repository.url
Definition

URI of an external repository which contains further details about the genetics data.

Control0..1
Typeuri
Sequence.repository.name
Definition

URI of an external repository which contains further details about the genetics data.

Control0..1
Typestring
Sequence.repository.variantId
Definition

Id of the variation in this external repository.

Control0..1
Typestring
Sequence.repository.readId
Definition

Id of the read in this external repository.

Control0..1
Typestring
Sequence.pointer
Definition

Pointer to next atomic sequence which at most contains one variation.

Control0..*
TypeReference(Sequence)
Sequence.observedSeq
Definition

Observed Sequence.

Control0..1
Typestring
Sequence.observation
Definition

Analysis of the sequence.

Control0..1
TypeReference(Observation)
Sequence.structureVariation
Definition

Structural variant.

Control0..1
TypeBackboneElement
Sequence.structureVariation.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.structureVariation.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.structureVariation.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.structureVariation.precisionOfBoundaries
Definition

Precision of boundaries.

Control0..1
Typestring
Sequence.structureVariation.reportedaCGHRatio
Definition

Structural Variant reported aCGH ratio.

Control0..1
Typedecimal
Sequence.structureVariation.length
Definition

Structural Variant Length.

Control0..1
Typeinteger
Sequence.structureVariation.outer
Definition

Structural variant outer.

Control0..1
TypeBackboneElement
Sequence.structureVariation.outer.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.structureVariation.outer.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.structureVariation.outer.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.structureVariation.outer.start
Definition

Structural Variant Outer Start-End.

Control0..1
Typeinteger
Sequence.structureVariation.outer.end
Definition

Structural Variant Outer Start-End.

Control0..1
Typeinteger
Sequence.structureVariation.inner
Definition

Structural variant inner.

Control0..1
TypeBackboneElement
Sequence.structureVariation.inner.id
Definition

unique id for the element within a resource (for internal references).

Control0..1
Typeid
Sequence.structureVariation.inner.extension
Definition

May be used to represent additional information that is not part of the basic definition of the element. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.

Control0..*
TypeExtension
Alternate Namesextensions, user content
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.structureVariation.inner.modifierExtension
Definition

May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.

Control0..*
TypeExtension
Is Modifiertrue
Alternate Namesextensions, user content, modifiers
Comments

There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.

Sequence.structureVariation.inner.start
Definition

Structural Variant Inner Start-End.

Control0..1
Typeinteger
Sequence.structureVariation.inner.end
Definition

Structural Variant Inner Start-End.

Control0..1
Typeinteger