FHIR Osiris Implementation Guide
2.1.0 - ci-build

FHIR Osiris Implementation Guide - Local Development build (v2.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

Resource Profile: Annotation Reference

Official URL: https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/StructureDefinition/annotation-reference Version: 2.1.0
Draft as of 2024-03-21 Computable Name: AnnotationReference

The annotation reference profile indicates the reference genome / pfam domain / database used to generate the Annotation instance linked.

Usage:

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from MolecularSequence

NameFlagsCard.TypeDescription & Constraintsdoco
.. MolecularSequence 0..*MolecularSequenceInformation about a biological sequence
... coordinateSystem 1..1integerBase number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Required Pattern: 0
... patient S0..1Reference(Oncology Patient)Who and/or what this is about
... referenceSeq
.... orientation S0..1codeDNA strand orientation
.... referenceSeqId S1..1CodeableConceptType of the referenced annotation
Binding: Reference Type Value Set (extensible)
.... repository:reference-db 1..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... type 1..1codedirectlink | openapi | login | oauth | other
Required Pattern: other
..... name S1..1stringReference database name
..... datasetId S1..1stringIdentifier of the annotation in the database
.... repository:pfam-domain S0..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... type 1..1codedirectlink | openapi | login | oauth | other
Required Pattern: directlink
..... url 0..1uriURI of the repository
Required Pattern: http://pfam.xfam.org/
..... name 0..1stringRepository's name
Required Pattern: pfam
..... datasetId S0..1stringPfam ID
..... readsetId S0..1stringPfam domain name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MolecularSequence.referenceSeq.referenceSeqIdextensibleReferenceType
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/ReferenceType
from this IG
NameFlagsCard.TypeDescription & Constraintsdoco
.. MolecularSequence C0..*MolecularSequenceInformation about a biological sequence
msq-3: Only 0 and 1 are valid for coordinateSystem
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... coordinateSystem Σ1..1integerBase number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Required Pattern: 0
... referenceSeq ΣC0..1BackboneElementA sequence used as reference
msq-6: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;
msq-5: GenomeBuild and chromosome must be both contained if either one of them is contained
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... orientation SΣ0..1codeDNA strand orientation
Binding: orientationType (required): Type for orientation.

.... referenceSeqId SΣ1..1CodeableConceptType of the referenced annotation
Binding: Reference Type Value Set (extensible)
... Slices for repository Σ1..*BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
Slice: Unordered, Open by pattern:type
.... repository:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.

.... repository:reference-db Σ1..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: other
..... name SΣ1..1stringReference database name
..... datasetId SΣ1..1stringIdentifier of the annotation in the database
.... repository:pfam-domain SΣ0..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: directlink
..... url Σ0..1uriURI of the repository
Required Pattern: http://pfam.xfam.org/
..... name Σ0..1stringRepository's name
Required Pattern: pfam
..... datasetId SΣ0..1stringPfam ID
..... readsetId SΣ0..1stringPfam domain name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MolecularSequence.referenceSeq.orientationrequiredorientationType
http://hl7.org/fhir/ValueSet/orientation-type|4.0.1
from the FHIR Standard
MolecularSequence.referenceSeq.referenceSeqIdextensibleReferenceType
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/ReferenceType
from this IG
MolecularSequence.repository.typerequiredrepositoryType
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:reference-db.typerequiredPattern: other
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:pfam-domain.typerequiredPattern: directlink
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
NameFlagsCard.TypeDescription & Constraintsdoco
.. MolecularSequence C0..*MolecularSequenceInformation about a biological sequence
msq-3: Only 0 and 1 are valid for coordinateSystem
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*IdentifierUnique ID for this particular sequence. This is a FHIR-defined id
... type Σ0..1codeaa | dna | rna
Binding: sequenceType (required): Type if a sequence -- DNA, RNA, or amino acid sequence.

... coordinateSystem Σ1..1integerBase number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Required Pattern: 0
... patient SΣC0..1Reference(Oncology Patient)Who and/or what this is about
ref-1: SHALL have a contained resource if a local reference is provided
... specimen ΣC0..1Reference(Specimen)Specimen used for sequencing
ref-1: SHALL have a contained resource if a local reference is provided
... device ΣC0..1Reference(Device)The method for sequencing
ref-1: SHALL have a contained resource if a local reference is provided
... performer ΣC0..1Reference(Organization)Who should be responsible for test result
ref-1: SHALL have a contained resource if a local reference is provided
... quantity ΣC0..1QuantityThe number of copies of the sequence of interest. (RNASeq)
qty-3: If a code for the unit is present, the system SHALL also be present
... referenceSeq ΣC0..1BackboneElementA sequence used as reference
msq-6: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;
msq-5: GenomeBuild and chromosome must be both contained if either one of them is contained
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... chromosome Σ0..1CodeableConceptChromosome containing genetic finding
Binding: chromosome-human (example): Chromosome number for human.

.... genomeBuild Σ0..1stringThe Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'
.... orientation SΣ0..1codeDNA strand orientation
Binding: orientationType (required): Type for orientation.

.... referenceSeqId SΣ1..1CodeableConceptType of the referenced annotation
Binding: Reference Type Value Set (extensible)
.... referenceSeqPointer ΣC0..1Reference(MolecularSequence)A pointer to another MolecularSequence entity as reference sequence
ref-1: SHALL have a contained resource if a local reference is provided
.... referenceSeqString Σ0..1stringA string to represent reference sequence
.... strand Σ0..1codewatson | crick
Binding: strandType (required): Type for strand.

.... windowStart Σ0..1integerStart position of the window on the reference sequence
.... windowEnd Σ0..1integerEnd position of the window on the reference sequence
... variant Σ0..*BackboneElementVariant in sequence
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... start Σ0..1integerStart position of the variant on the reference sequence
.... end Σ0..1integerEnd position of the variant on the reference sequence
.... observedAllele Σ0..1stringAllele that was observed
.... referenceAllele Σ0..1stringAllele in the reference sequence
.... cigar Σ0..1stringExtended CIGAR string for aligning the sequence with reference bases
.... variantPointer ΣC0..1Reference(Observation)Pointer to observed variant information
ref-1: SHALL have a contained resource if a local reference is provided
... observedSeq Σ0..1stringSequence that was observed
... quality Σ0..*BackboneElementAn set of value as quality of sequence
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codeindel | snp | unknown
Binding: qualityType (required): Type for quality report.

.... standardSequence Σ0..1CodeableConceptStandard sequence for comparison
Binding: FDA-StandardSequence (example): Reference identifier of the sequence that used to mark the quality of tested samples.

.... start Σ0..1integerStart position of the sequence
.... end Σ0..1integerEnd position of the sequence
.... score ΣC0..1QuantityQuality score for the comparison
qty-3: If a code for the unit is present, the system SHALL also be present
.... method Σ0..1CodeableConceptMethod to get quality
Binding: FDA-Method (example): The method used to evaluate the numerical quality of the observed sequence.

.... truthTP Σ0..1decimalTrue positives from the perspective of the truth data
.... queryTP Σ0..1decimalTrue positives from the perspective of the query data
.... truthFN Σ0..1decimalFalse negatives
.... queryFP Σ0..1decimalFalse positives
.... gtFP Σ0..1decimalFalse positives where the non-REF alleles in the Truth and Query Call Sets match
.... precision Σ0..1decimalPrecision of comparison
.... recall Σ0..1decimalRecall of comparison
.... fScore Σ0..1decimalF-score
.... roc Σ0..1BackboneElementReceiver Operator Characteristic (ROC) Curve
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... score Σ0..*integerGenotype quality score
..... numTP Σ0..*integerRoc score true positive numbers
..... numFP Σ0..*integerRoc score false positive numbers
..... numFN Σ0..*integerRoc score false negative numbers
..... precision Σ0..*decimalPrecision of the GQ score
..... sensitivity Σ0..*decimalSensitivity of the GQ score
..... fMeasure Σ0..*decimalFScore of the GQ score
... readCoverage Σ0..1integerAverage number of reads representing a given nucleotide in the reconstructed sequence
... Slices for repository Σ1..*BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
Slice: Unordered, Open by pattern:type
.... repository:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.

..... url Σ0..1uriURI of the repository
..... name Σ0..1stringRepository's name
..... datasetId Σ0..1stringId of the dataset that used to call for dataset in repository
..... variantsetId Σ0..1stringId of the variantset that used to call for variantset in repository
..... readsetId Σ0..1stringId of the read
.... repository:reference-db Σ1..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: other
..... url Σ0..1uriURI of the repository
..... name SΣ1..1stringReference database name
..... datasetId SΣ1..1stringIdentifier of the annotation in the database
..... variantsetId Σ0..1stringId of the variantset that used to call for variantset in repository
..... readsetId Σ0..1stringId of the read
.... repository:pfam-domain SΣ0..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: directlink
..... url Σ0..1uriURI of the repository
Required Pattern: http://pfam.xfam.org/
..... name Σ0..1stringRepository's name
Required Pattern: pfam
..... datasetId SΣ0..1stringPfam ID
..... variantsetId Σ0..1stringId of the variantset that used to call for variantset in repository
..... readsetId SΣ0..1stringPfam domain name
... pointer ΣC0..*Reference(MolecularSequence)Pointer to next atomic sequence
ref-1: SHALL have a contained resource if a local reference is provided
... structureVariant Σ0..*BackboneElementStructural variant
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... variantType Σ0..1CodeableConceptStructural variant change type
Binding: LOINC Answer List LL379-9|4.0.1 (required): DNA change type.

.... exact Σ0..1booleanDoes the structural variant have base pair resolution breakpoints?
.... length Σ0..1integerStructural variant length
.... outer Σ0..1BackboneElementStructural variant outer
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... start Σ0..1integerStructural variant outer start
..... end Σ0..1integerStructural variant outer end
.... inner Σ0..1BackboneElementStructural variant inner
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... start Σ0..1integerStructural variant inner start
..... end Σ0..1integerStructural variant inner end

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MolecularSequence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MolecularSequence.typerequiredsequenceType
http://hl7.org/fhir/ValueSet/sequence-type|4.0.1
from the FHIR Standard
MolecularSequence.referenceSeq.chromosomeexamplechromosome-human
http://hl7.org/fhir/ValueSet/chromosome-human
from the FHIR Standard
MolecularSequence.referenceSeq.orientationrequiredorientationType
http://hl7.org/fhir/ValueSet/orientation-type|4.0.1
from the FHIR Standard
MolecularSequence.referenceSeq.referenceSeqIdextensibleReferenceType
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/ReferenceType
from this IG
MolecularSequence.referenceSeq.strandrequiredstrandType
http://hl7.org/fhir/ValueSet/strand-type|4.0.1
from the FHIR Standard
MolecularSequence.quality.typerequiredqualityType
http://hl7.org/fhir/ValueSet/quality-type|4.0.1
from the FHIR Standard
MolecularSequence.quality.standardSequenceexampleFDA-StandardSequence (a valid code from https://precision.fda.gov/files/)
http://hl7.org/fhir/ValueSet/sequence-quality-standardSequence
from the FHIR Standard
MolecularSequence.quality.methodexampleFDA-Method
http://hl7.org/fhir/ValueSet/sequence-quality-method
from the FHIR Standard
MolecularSequence.repository.typerequiredrepositoryType
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:reference-db.typerequiredPattern: other
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:pfam-domain.typerequiredPattern: directlink
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.structureVariant.variantTyperequiredLOINC LL379-9|4.0.1
http://loinc.org/vs/LL379-9|4.0.1

This structure is derived from MolecularSequence

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MolecularSequence.repository is sliced based on the value of pattern:type

Differential View

This structure is derived from MolecularSequence

NameFlagsCard.TypeDescription & Constraintsdoco
.. MolecularSequence 0..*MolecularSequenceInformation about a biological sequence
... coordinateSystem 1..1integerBase number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Required Pattern: 0
... patient S0..1Reference(Oncology Patient)Who and/or what this is about
... referenceSeq
.... orientation S0..1codeDNA strand orientation
.... referenceSeqId S1..1CodeableConceptType of the referenced annotation
Binding: Reference Type Value Set (extensible)
.... repository:reference-db 1..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... type 1..1codedirectlink | openapi | login | oauth | other
Required Pattern: other
..... name S1..1stringReference database name
..... datasetId S1..1stringIdentifier of the annotation in the database
.... repository:pfam-domain S0..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... type 1..1codedirectlink | openapi | login | oauth | other
Required Pattern: directlink
..... url 0..1uriURI of the repository
Required Pattern: http://pfam.xfam.org/
..... name 0..1stringRepository's name
Required Pattern: pfam
..... datasetId S0..1stringPfam ID
..... readsetId S0..1stringPfam domain name

doco Documentation for this format

Terminology Bindings (Differential)

PathConformanceValueSetURI
MolecularSequence.referenceSeq.referenceSeqIdextensibleReferenceType
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/ReferenceType
from this IG

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MolecularSequence C0..*MolecularSequenceInformation about a biological sequence
msq-3: Only 0 and 1 are valid for coordinateSystem
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... coordinateSystem Σ1..1integerBase number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Required Pattern: 0
... referenceSeq ΣC0..1BackboneElementA sequence used as reference
msq-6: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;
msq-5: GenomeBuild and chromosome must be both contained if either one of them is contained
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... orientation SΣ0..1codeDNA strand orientation
Binding: orientationType (required): Type for orientation.

.... referenceSeqId SΣ1..1CodeableConceptType of the referenced annotation
Binding: Reference Type Value Set (extensible)
... Slices for repository Σ1..*BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
Slice: Unordered, Open by pattern:type
.... repository:All Slices Content/Rules for all slices
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.

.... repository:reference-db Σ1..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: other
..... name SΣ1..1stringReference database name
..... datasetId SΣ1..1stringIdentifier of the annotation in the database
.... repository:pfam-domain SΣ0..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: directlink
..... url Σ0..1uriURI of the repository
Required Pattern: http://pfam.xfam.org/
..... name Σ0..1stringRepository's name
Required Pattern: pfam
..... datasetId SΣ0..1stringPfam ID
..... readsetId SΣ0..1stringPfam domain name

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MolecularSequence.referenceSeq.orientationrequiredorientationType
http://hl7.org/fhir/ValueSet/orientation-type|4.0.1
from the FHIR Standard
MolecularSequence.referenceSeq.referenceSeqIdextensibleReferenceType
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/ReferenceType
from this IG
MolecularSequence.repository.typerequiredrepositoryType
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:reference-db.typerequiredPattern: other
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:pfam-domain.typerequiredPattern: directlink
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. MolecularSequence C0..*MolecularSequenceInformation about a biological sequence
msq-3: Only 0 and 1 are valid for coordinateSystem
... id Σ0..1idLogical id of this artifact
... meta Σ0..1MetaMetadata about the resource
... implicitRules ?!Σ0..1uriA set of rules under which this content was created
... text 0..1NarrativeText summary of the resource, for human interpretation
... contained 0..*ResourceContained, inline Resources
... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
... modifierExtension ?!N0..*ExtensionExtensions that cannot be ignored
Slice: Unordered, Open by value:url
... identifier Σ0..*IdentifierUnique ID for this particular sequence. This is a FHIR-defined id
... type Σ0..1codeaa | dna | rna
Binding: sequenceType (required): Type if a sequence -- DNA, RNA, or amino acid sequence.

... coordinateSystem Σ1..1integerBase number of coordinate system (0 for 0-based numbering or coordinates, inclusive start, exclusive end, 1 for 1-based numbering, inclusive start, inclusive end)
Required Pattern: 0
... patient SΣC0..1Reference(Oncology Patient)Who and/or what this is about
ref-1: SHALL have a contained resource if a local reference is provided
... specimen ΣC0..1Reference(Specimen)Specimen used for sequencing
ref-1: SHALL have a contained resource if a local reference is provided
... device ΣC0..1Reference(Device)The method for sequencing
ref-1: SHALL have a contained resource if a local reference is provided
... performer ΣC0..1Reference(Organization)Who should be responsible for test result
ref-1: SHALL have a contained resource if a local reference is provided
... quantity ΣC0..1QuantityThe number of copies of the sequence of interest. (RNASeq)
qty-3: If a code for the unit is present, the system SHALL also be present
... referenceSeq ΣC0..1BackboneElementA sequence used as reference
msq-6: Have and only have one of the following elements in referenceSeq : 1. genomeBuild ; 2 referenceSeqId; 3. referenceSeqPointer; 4. referenceSeqString;
msq-5: GenomeBuild and chromosome must be both contained if either one of them is contained
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... chromosome Σ0..1CodeableConceptChromosome containing genetic finding
Binding: chromosome-human (example): Chromosome number for human.

.... genomeBuild Σ0..1stringThe Genome Build used for reference, following GRCh build versions e.g. 'GRCh 37'
.... orientation SΣ0..1codeDNA strand orientation
Binding: orientationType (required): Type for orientation.

.... referenceSeqId SΣ1..1CodeableConceptType of the referenced annotation
Binding: Reference Type Value Set (extensible)
.... referenceSeqPointer ΣC0..1Reference(MolecularSequence)A pointer to another MolecularSequence entity as reference sequence
ref-1: SHALL have a contained resource if a local reference is provided
.... referenceSeqString Σ0..1stringA string to represent reference sequence
.... strand Σ0..1codewatson | crick
Binding: strandType (required): Type for strand.

.... windowStart Σ0..1integerStart position of the window on the reference sequence
.... windowEnd Σ0..1integerEnd position of the window on the reference sequence
... variant Σ0..*BackboneElementVariant in sequence
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... start Σ0..1integerStart position of the variant on the reference sequence
.... end Σ0..1integerEnd position of the variant on the reference sequence
.... observedAllele Σ0..1stringAllele that was observed
.... referenceAllele Σ0..1stringAllele in the reference sequence
.... cigar Σ0..1stringExtended CIGAR string for aligning the sequence with reference bases
.... variantPointer ΣC0..1Reference(Observation)Pointer to observed variant information
ref-1: SHALL have a contained resource if a local reference is provided
... observedSeq Σ0..1stringSequence that was observed
... quality Σ0..*BackboneElementAn set of value as quality of sequence
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... type Σ1..1codeindel | snp | unknown
Binding: qualityType (required): Type for quality report.

.... standardSequence Σ0..1CodeableConceptStandard sequence for comparison
Binding: FDA-StandardSequence (example): Reference identifier of the sequence that used to mark the quality of tested samples.

.... start Σ0..1integerStart position of the sequence
.... end Σ0..1integerEnd position of the sequence
.... score ΣC0..1QuantityQuality score for the comparison
qty-3: If a code for the unit is present, the system SHALL also be present
.... method Σ0..1CodeableConceptMethod to get quality
Binding: FDA-Method (example): The method used to evaluate the numerical quality of the observed sequence.

.... truthTP Σ0..1decimalTrue positives from the perspective of the truth data
.... queryTP Σ0..1decimalTrue positives from the perspective of the query data
.... truthFN Σ0..1decimalFalse negatives
.... queryFP Σ0..1decimalFalse positives
.... gtFP Σ0..1decimalFalse positives where the non-REF alleles in the Truth and Query Call Sets match
.... precision Σ0..1decimalPrecision of comparison
.... recall Σ0..1decimalRecall of comparison
.... fScore Σ0..1decimalF-score
.... roc Σ0..1BackboneElementReceiver Operator Characteristic (ROC) Curve
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... score Σ0..*integerGenotype quality score
..... numTP Σ0..*integerRoc score true positive numbers
..... numFP Σ0..*integerRoc score false positive numbers
..... numFN Σ0..*integerRoc score false negative numbers
..... precision Σ0..*decimalPrecision of the GQ score
..... sensitivity Σ0..*decimalSensitivity of the GQ score
..... fMeasure Σ0..*decimalFScore of the GQ score
... readCoverage Σ0..1integerAverage number of reads representing a given nucleotide in the reconstructed sequence
... Slices for repository Σ1..*BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
Slice: Unordered, Open by pattern:type
.... repository:All Slices Content/Rules for all slices
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.

..... url Σ0..1uriURI of the repository
..... name Σ0..1stringRepository's name
..... datasetId Σ0..1stringId of the dataset that used to call for dataset in repository
..... variantsetId Σ0..1stringId of the variantset that used to call for variantset in repository
..... readsetId Σ0..1stringId of the read
.... repository:reference-db Σ1..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: other
..... url Σ0..1uriURI of the repository
..... name SΣ1..1stringReference database name
..... datasetId SΣ1..1stringIdentifier of the annotation in the database
..... variantsetId Σ0..1stringId of the variantset that used to call for variantset in repository
..... readsetId Σ0..1stringId of the read
.... repository:pfam-domain SΣ0..1BackboneElementExternal repository which contains detailed report related with observedSeq in this resource
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... type Σ1..1codedirectlink | openapi | login | oauth | other
Binding: repositoryType (required): Type for access of external URI.


Required Pattern: directlink
..... url Σ0..1uriURI of the repository
Required Pattern: http://pfam.xfam.org/
..... name Σ0..1stringRepository's name
Required Pattern: pfam
..... datasetId SΣ0..1stringPfam ID
..... variantsetId Σ0..1stringId of the variantset that used to call for variantset in repository
..... readsetId SΣ0..1stringPfam domain name
... pointer ΣC0..*Reference(MolecularSequence)Pointer to next atomic sequence
ref-1: SHALL have a contained resource if a local reference is provided
... structureVariant Σ0..*BackboneElementStructural variant
.... id 0..1stringUnique id for inter-element referencing
.... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... variantType Σ0..1CodeableConceptStructural variant change type
Binding: LOINC Answer List LL379-9|4.0.1 (required): DNA change type.

.... exact Σ0..1booleanDoes the structural variant have base pair resolution breakpoints?
.... length Σ0..1integerStructural variant length
.... outer Σ0..1BackboneElementStructural variant outer
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... start Σ0..1integerStructural variant outer start
..... end Σ0..1integerStructural variant outer end
.... inner Σ0..1BackboneElementStructural variant inner
..... id 0..1stringUnique id for inter-element referencing
..... extension N0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... start Σ0..1integerStructural variant inner start
..... end Σ0..1integerStructural variant inner end

doco Documentation for this format

Terminology Bindings

PathConformanceValueSet / CodeURI
MolecularSequence.languagepreferredCommonLanguages
Additional Bindings Purpose
AllLanguages Max Binding
http://hl7.org/fhir/ValueSet/languages
from the FHIR Standard
MolecularSequence.typerequiredsequenceType
http://hl7.org/fhir/ValueSet/sequence-type|4.0.1
from the FHIR Standard
MolecularSequence.referenceSeq.chromosomeexamplechromosome-human
http://hl7.org/fhir/ValueSet/chromosome-human
from the FHIR Standard
MolecularSequence.referenceSeq.orientationrequiredorientationType
http://hl7.org/fhir/ValueSet/orientation-type|4.0.1
from the FHIR Standard
MolecularSequence.referenceSeq.referenceSeqIdextensibleReferenceType
https://build.fhir.org/ig/arkhn/arkhn-ig-osiris/ValueSet/ReferenceType
from this IG
MolecularSequence.referenceSeq.strandrequiredstrandType
http://hl7.org/fhir/ValueSet/strand-type|4.0.1
from the FHIR Standard
MolecularSequence.quality.typerequiredqualityType
http://hl7.org/fhir/ValueSet/quality-type|4.0.1
from the FHIR Standard
MolecularSequence.quality.standardSequenceexampleFDA-StandardSequence (a valid code from https://precision.fda.gov/files/)
http://hl7.org/fhir/ValueSet/sequence-quality-standardSequence
from the FHIR Standard
MolecularSequence.quality.methodexampleFDA-Method
http://hl7.org/fhir/ValueSet/sequence-quality-method
from the FHIR Standard
MolecularSequence.repository.typerequiredrepositoryType
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:reference-db.typerequiredPattern: other
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.repository:pfam-domain.typerequiredPattern: directlink
http://hl7.org/fhir/ValueSet/repository-type|4.0.1
from the FHIR Standard
MolecularSequence.structureVariant.variantTyperequiredLOINC LL379-9|4.0.1
http://loinc.org/vs/LL379-9|4.0.1

This structure is derived from MolecularSequence

Summary

Mandatory: 4 elements (1 nested mandatory element)
Must-Support: 8 elements

Structures

This structure refers to these other structures:

Slices

This structure defines the following Slices:

  • The element MolecularSequence.repository is sliced based on the value of pattern:type

 

Other representations of profile: CSV, Excel, Schematron