Extensions for Using Data Elements from FHIR R4 in FHIR STU3 - Downloaded Version null See the Directory of published versions
| Page standards status: Trial-use | Maturity Level: 0 |
Definitions for the profile-MolecularSequence-for-Sequence resource profile.
Guidance on how to interpret the contents of this table can be foundhere
| 0. Sequence | |
| Definition | Raw data describing a biological sequence. |
| Short | Information about a biological sequence |
| Control | 0..* |
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())seq-3: Only 0 and 1 are valid for coordinateSystem ( coordinateSystem = 1 or coordinateSystem = 0)dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty()) dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative (contained.text.empty()) dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated (contained.meta.versionId.empty() and contained.meta.lastUpdated.empty()) dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource (contained.where(('#'+id in %resource.descendants().reference).not()).empty()) seq-3: Only 0 and 1 are valid for coordinateSystem (coordinateSystem = 1 or coordinateSystem = 0) |
| 2. 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. |
| Short | A set of rules under which this content was created |
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. |
| Control | 0..1 |
| Type | uri |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
| 4. Sequence.extension | |
| Definition | An Extension May be used to represent additional information that is not part of the basic definition of the resource. 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. |
| Short | ExtensionAdditional Content defined by implementations |
| 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. |
| Control | 0..* |
| Type | Extension |
| Alternate Names | extensions, user content |
| Slicing | This element introduces a set of slices on Sequence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 6. Sequence.extension:structureVariant | |
| Slice Name | structureVariant |
| Definition | R4: |
| Short | R4: Structural variant (new) |
| Comments | Element |
| Control | 0..* This element is affected by the following invariants: ele-1 |
| Type | Extension(R4: Structural variant (new)) (Complex Extension) |
| Is Modifier | false |
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) |
| 8. 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. |
| Short | Extensions that cannot be ignored |
| 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. |
| Control | 0..* |
| Type | Extension |
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR |
| Alternate Names | extensions, user content |
| 10. 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). |
| Short | Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end) |
| Control | 1..1 |
| Type | integer |
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension |
| Summary | true |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Sequence | |
| 2. Sequence.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Sequence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 4. Sequence.extension:structureVariant | |
| Slice Name | structureVariant |
| Definition | R4: |
| Short | R4: Structural variant (new) |
| Comments | Element |
| Control | 0..* |
| Type | Extension(R4: Structural variant (new)) (Complex Extension) |
| 6. Sequence.type | |
| 8. Sequence.type.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Sequence.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 10. Sequence.type.extension:type | |
| Slice Name | type |
| Definition | R4: |
| Short | R4: type |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: type) (Extension Type: code) |
| 12. Sequence.referenceSeq | |
| 14. Sequence.referenceSeq.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Sequence.referenceSeq.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 16. Sequence.referenceSeq.extension:orientation | |
| Slice Name | orientation |
| Definition | R4: |
| Short | R4: sense | antisense (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: sense | antisense (new)) (Extension Type: code) |
| 18. Sequence.referenceSeq.strand | |
| 20. Sequence.referenceSeq.strand.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Sequence.referenceSeq.strand.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 22. Sequence.referenceSeq.strand.extension:strand | |
| Slice Name | strand |
| Definition | R4: |
| Short | R4: watson | crick additional types |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: watson | crick additional types) (Extension Type: code) |
| 24. Sequence.quality | |
| 26. Sequence.quality.extension | |
| Control | 0..* |
| Slicing | This element introduces a set of slices on Sequence.quality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: |
| 28. Sequence.quality.extension:roc | |
| Slice Name | roc |
| Definition | R4: |
| Short | R4: Receiver Operator Characteristic (ROC) Curve (new) |
| Comments | Element |
| Control | 0..1 |
| Type | Extension(R4: Receiver Operator Characteristic (ROC) Curve (new)) (Complex Extension) |
Guidance on how to interpret the contents of this table can be foundhere
| 0. Sequence | |||||
| Definition | Raw data describing a biological sequence. | ||||
| Short | Information about a biological sequence | ||||
| Control | 0..* | ||||
| Invariants | dom-2: If the resource is contained in another resource, it SHALL NOT contain nested Resources (contained.contained.empty())dom-1: If the resource is contained in another resource, it SHALL NOT contain any narrative ( contained.text.empty())dom-4: If a resource is contained in another resource, it SHALL NOT have a meta.versionId or a meta.lastUpdated ( contained.meta.versionId.empty() and contained.meta.lastUpdated.empty())dom-3: If the resource is contained in another resource, it SHALL be referred to from elsewhere in the resource ( contained.where(('#'+id in %resource.descendants().reference).not()).empty())seq-3: Only 0 and 1 are valid for coordinateSystem ( coordinateSystem = 1 or coordinateSystem = 0) | ||||
| 2. Sequence.id | |||||
| Definition | The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. | ||||
| Short | Logical id of this artifact | ||||
| 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. | ||||
| Control | 0..1 | ||||
| Type | id | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 4. 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. | ||||
| Short | Metadata about the resource | ||||
| Control | 0..1 | ||||
| Type | Meta | ||||
| Summary | true | ||||
| 6. 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. | ||||
| Short | A set of rules under which this content was created | ||||
| 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. This element is labelled as a modifier because the implicit rules may provide additional knowledge about the resource that modifies it's meaning or interpretation. | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 8. Sequence.language | |||||
| Definition | The base language in which the resource is written. | ||||
| Short | Language of the resource content | ||||
| 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). | ||||
| Control | 0..1 | ||||
| Binding | Unless not suitable, these codes SHALL be taken from Common Languages (extensible to http://hl7.org/fhir/ValueSet/languages|3.0.2)A human language.
| ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| 10. 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. | ||||
| Short | Text summary of the resource, for human interpretation | ||||
| Comments | Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded in formation is added later. | ||||
| Control | 0..1 This element is affected by the following invariants: dom-1 | ||||
| Type | Narrative | ||||
| Alternate Names | narrative, html, xhtml, display | ||||
| 12. 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. | ||||
| Short | Contained, inline 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. | ||||
| Control | 0..* | ||||
| Type | Resource | ||||
| Alternate Names | inline resources, anonymous resources, contained resources | ||||
| 14. Sequence.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Sequence.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 16. Sequence.extension:structureVariant | |||||
| Slice Name | structureVariant | ||||
| Definition | R4: | ||||
| Short | R4: Structural variant (new) | ||||
| Comments | Element | ||||
| Control | 0..* This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Structural variant (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 18. 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Alternate Names | extensions, user content | ||||
| 20. Sequence.identifier | |||||
| Definition | A unique identifier for this particular sequence instance. This is a FHIR-defined id. | ||||
| Short | Unique ID for this particular sequence. This is a FHIR-defined id | ||||
| Note | This is a business identifier, not a resource identifier (see discussion) | ||||
| Control | 0..* | ||||
| Type | Identifier | ||||
| Summary | true | ||||
| Requirements | Allows sequences to be distinguished and referenced. | ||||
| 22. Sequence.type | |||||
| Definition | Amino Acid Sequence/ DNA Sequence / RNA Sequence. | ||||
| Short | aa | dna | rna | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see sequenceType (example to http://hl7.org/fhir/ValueSet/sequence-type|3.0.2)Type if a sequence -- DNA, RNA, or amino acid sequence | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 24. Sequence.type.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 26. Sequence.type.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Sequence.type.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 28. Sequence.type.extension:type | |||||
| Slice Name | type | ||||
| Definition | R4: | ||||
| Short | R4: type | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: type) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 30. Sequence.type.value | |||||
| Definition | Primitive value for code | ||||
| Short | Primitive value for code | ||||
| Control | 0..1 | ||||
| Type | code | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 32. 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). | ||||
| Short | Base number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end) | ||||
| Control | 1..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 34. Sequence.patient | |||||
| Definition | The patient whose sequencing results are described by this resource. | ||||
| Short | Who and/or what this is about | ||||
| Control | 0..1 | ||||
| Type | Reference(Patient) | ||||
| Summary | true | ||||
| 36. Sequence.specimen | |||||
| Definition | Specimen used for sequencing. | ||||
| Short | Specimen used for sequencing | ||||
| Control | 0..1 | ||||
| Type | Reference(Specimen) | ||||
| Summary | true | ||||
| 38. Sequence.device | |||||
| Definition | The method for sequencing, for example, chip information. | ||||
| Short | The method for sequencing | ||||
| Control | 0..1 | ||||
| Type | Reference(Device) | ||||
| Summary | true | ||||
| 40. Sequence.performer | |||||
| Definition | The organization or lab that should be responsible for this result. | ||||
| Short | Who should be responsible for test result | ||||
| Control | 0..1 | ||||
| Type | Reference(Organization) | ||||
| Summary | true | ||||
| 42. Sequence.quantity | |||||
| Definition | The number of copies of the seqeunce of interest. (RNASeq). | ||||
| Short | The number of copies of the seqeunce of interest. (RNASeq) | ||||
| Control | 0..1 | ||||
| Type | Quantity | ||||
| Summary | true | ||||
| 44. Sequence.referenceSeq | |||||
| Definition | A sequence that is used as a reference to describe variants that are present in a sequence analyzed. | ||||
| Short | A sequence used as reference | ||||
| Control | 0..1 | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))seq-4: Only +1 and -1 are valid for strand ( strand.empty() or strand = 1 or strand = -1)seq-5: GenomeBuild and chromosome must be both contained if either one of them is contained ( (chromosome.empty() and genomeBuild.empty()) or (chromosome.exists() and genomeBuild.exists()))seq-6: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString; ( (genomeBuild.count()+referenceSeqId.count()+ referenceSeqPointer.count()+ referenceSeqString.count()) = 1) | ||||
| 46. Sequence.referenceSeq.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 48. Sequence.referenceSeq.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Sequence.referenceSeq.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 50. Sequence.referenceSeq.extension:orientation | |||||
| Slice Name | orientation | ||||
| Definition | R4: | ||||
| Short | R4: sense | antisense (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: sense | antisense (new)) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 52. 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 54. 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). | ||||
| Short | Chromosome containing genetic finding | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see chromosome-human (example to http://hl7.org/fhir/ValueSet/chromosome-human|3.0.2)Chromosome number for human | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 56. 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. | ||||
| Short | The Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37' | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 58. 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. | ||||
| Short | Reference identifier | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see ENSEMBL (example to http://hl7.org/fhir/ValueSet/sequence-referenceSeq|3.0.2)Reference identifier | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 60. Sequence.referenceSeq.referenceSeqPointer | |||||
| Definition | A Pointer to another Sequence entity as reference sequence. | ||||
| Short | A Pointer to another Sequence entity as reference sequence | ||||
| Control | 0..1 | ||||
| Type | Reference(Sequence) | ||||
| Summary | true | ||||
| 62. Sequence.referenceSeq.referenceSeqString | |||||
| Definition | A string like "ACGT". | ||||
| Short | A string to represent reference sequence | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 64. Sequence.referenceSeq.strand | |||||
| Definition | Directionality of DNA sequence. Available values are "1" for the plus strand (5' to 3')/Watson/Sense/positive and "-1" for the minus strand(3' to 5')/Crick/Antisense/negative. | ||||
| Short | Directionality of DNA ( +1/-1) | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 66. Sequence.referenceSeq.strand.id | |||||
| Definition | unique id for the element within a resource (for internal references) | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 68. Sequence.referenceSeq.strand.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Sequence.referenceSeq.strand.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 70. Sequence.referenceSeq.strand.extension:strand | |||||
| Slice Name | strand | ||||
| Definition | R4: | ||||
| Short | R4: watson | crick additional types | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: watson | crick additional types) (Extension Type: code) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 72. Sequence.referenceSeq.strand.value | |||||
| Definition | The actual value | ||||
| Short | Primitive value for integer | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| Min Value | -2147483648 | ||||
| Max Value | 2147483647 | ||||
| 74. 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. | ||||
| Short | Start position of the window on the reference sequence | ||||
| Control | 1..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 76. 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. | ||||
| Short | End position of the window on the reference sequence | ||||
| Control | 1..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 78. 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. | ||||
| Short | Variant in sequence | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 80. Sequence.variant.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 82. Sequence.variant.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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 84. Sequence.variant.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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 86. 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. | ||||
| Short | Start position of the variant on the reference sequence | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 88. 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. | ||||
| Short | End position of the variant on the reference sequence | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 90. 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. | ||||
| Short | Allele that was observed | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 92. 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. | ||||
| Short | Allele in the reference sequence | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 94. Sequence.variant.cigar | |||||
| Definition | Extended CIGAR string for aligning the sequence with reference bases. See detailed documentation here. | ||||
| Short | Extended CIGAR string for aligning the sequence with reference bases | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 96. Sequence.variant.variantPointer | |||||
| Definition | A pointer to an Observation containing variant information. | ||||
| Short | Pointer to observed variant information | ||||
| Control | 0..1 | ||||
| Type | Reference(Observation) | ||||
| Summary | true | ||||
| 98. 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. | ||||
| Short | Sequence that was observed | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 100. 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). | ||||
| Short | An set of value as quality of sequence | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 102. Sequence.quality.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 104. Sequence.quality.extension | |||||
| Definition | An Extension | ||||
| Short | Extension | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Slicing | This element introduces a set of slices on Sequence.quality.extension. The slices areUnordered and Open, and can be differentiated using the following discriminators: | ||||
| 106. Sequence.quality.extension:roc | |||||
| Slice Name | roc | ||||
| Definition | R4: | ||||
| Short | R4: Receiver Operator Characteristic (ROC) Curve (new) | ||||
| Comments | Element | ||||
| Control | 0..1 This element is affected by the following invariants: ele-1 | ||||
| Type | Extension(R4: Receiver Operator Characteristic (ROC) Curve (new)) (Complex Extension) | ||||
| Is Modifier | false | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count()))ext-1: Must have either extensions or value[x], not both ( extension.exists() != value.exists()) | ||||
| 108. 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 110. Sequence.quality.type | |||||
| Definition | INDEL / SNP / Undefined variant. | ||||
| Short | indel | snp | unknown | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from qualityType (required to http://hl7.org/fhir/ValueSet/quality-type|3.0.2)Type for quality report | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 112. Sequence.quality.standardSequence | |||||
| Definition | Gold standard sequence used for comparing against. | ||||
| Short | Standard sequence for comparison | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see FDA-StandardSequence (example to http://hl7.org/fhir/ValueSet/sequence-quality-standardSequence|3.0.2)Reference identifier of the sequence that used to mark the quality of tested samples. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 114. 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. | ||||
| Short | Start position of the sequence | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 116. 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. | ||||
| Short | End position of the sequence | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 118. Sequence.quality.score | |||||
| Definition | The score of an experimentally derived feature such as a p-value (SO:0001685). | ||||
| Short | Quality score for the comparison | ||||
| Control | 0..1 | ||||
| Type | Quantity | ||||
| Summary | true | ||||
| 120. Sequence.quality.method | |||||
| Definition | Which method is used to get sequence quality. | ||||
| Short | Method to get quality | ||||
| Control | 0..1 | ||||
| Binding | For example codes, see FDA-Method (example to http://hl7.org/fhir/ValueSet/sequence-quality-method|3.0.2)The method used to evaluate the numerical quality of the observed sequence. | ||||
| Type | CodeableConcept | ||||
| Summary | true | ||||
| 122. 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. | ||||
| Short | True positives from the perspective of the truth data | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 124. 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. | ||||
| Short | True positives from the perspective of the query data | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 126. 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. | ||||
| Short | False negatives | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 128. 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. | ||||
| Short | False positives | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 130. 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). | ||||
| Short | False positives where the non-REF alleles in the Truth and Query Call Sets match | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 132. Sequence.quality.precision | |||||
| Definition | QUERY.TP / (QUERY.TP + QUERY.FP). | ||||
| Short | Precision of comparison | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 134. Sequence.quality.recall | |||||
| Definition | TRUTH.TP / (TRUTH.TP + TRUTH.FN). | ||||
| Short | Recall of comparison | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 136. Sequence.quality.fScore | |||||
| Definition | Harmonic mean of Recall and Precision, computed as: 2 * precision * recall / (precision + recall). | ||||
| Short | F-score | ||||
| Control | 0..1 | ||||
| Type | decimal | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 138. Sequence.readCoverage | |||||
| Definition | Coverage (read depth or depth) is the average number of reads representing a given nucleotide in the reconstructed sequence. | ||||
| Short | Average number of reads representing a given nucleotide in the reconstructed sequence | ||||
| Control | 0..1 | ||||
| Type | integer | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 140. Sequence.repository | |||||
| Definition | Configurations of the external repository. The repository shall store target's observedSeq or records related with target's observedSeq. | ||||
| Short | External repository which contains detailed report related with observedSeq in this resource | ||||
| Control | 0..* | ||||
| Type | BackboneElement | ||||
| Summary | true | ||||
| Invariants | ele-1: All FHIR elements must have a @value or children (hasValue() | (children().count() > id.count())) | ||||
| 142. Sequence.repository.id | |||||
| Definition | unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||
| Short | xml:id (or equivalent in JSON) | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| XML Format | In the XML format, this property is represented as an attribute. | ||||
| 144. 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. | ||||
| Short | Additional Content defined by implementations | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Alternate Names | extensions, user content | ||||
| 146. 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. | ||||
| Short | Extensions that cannot be ignored | ||||
| 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. | ||||
| Control | 0..* | ||||
| Type | Extension | ||||
| Is Modifier | true because No Modifier Reason provideed in previous versions of FHIR | ||||
| Summary | true | ||||
| Alternate Names | extensions, user content, modifiers | ||||
| 148. Sequence.repository.type | |||||
| Definition | Click and see / RESTful API / Need login to see / RESTful API with authentication / Other ways to see resource. | ||||
| Short | directlink | openapi | login | oauth | other | ||||
| Control | 1..1 | ||||
| Binding | The codes SHALL be taken from repositoryType (required to http://hl7.org/fhir/ValueSet/repository-type|3.0.2)Type for access of external URI | ||||
| Type | code | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 150. Sequence.repository.url | |||||
| Definition | URI of an external repository which contains further details about the genetics data. | ||||
| Short | URI of the repository | ||||
| Control | 0..1 | ||||
| Type | uri | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 152. Sequence.repository.name | |||||
| Definition | URI of an external repository which contains further details about the genetics data. | ||||
| Short | Repository's name | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 154. 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. | ||||
| Short | Id of the dataset that used to call for dataset in repository | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 156. 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. | ||||
| Short | Id of the variantset that used to call for variantset in repository | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 158. Sequence.repository.readsetId | |||||
| Definition | Id of the read in this external repository. | ||||
| Short | Id of the read | ||||
| Control | 0..1 | ||||
| Type | string | ||||
| Primitive Value | This primitive element may be present, or absent, or replaced by an extension | ||||
| Summary | true | ||||
| 160. Sequence.pointer | |||||
| Definition | Pointer to next atomic sequence which at most contains one variant. | ||||
| Short | Pointer to next atomic sequence | ||||
| Control | 0..* | ||||
| Type | Reference(Sequence) | ||||
| Summary | true | ||||