Data Model Libraries
    Preparing search index...

    Class MolecularSequenceRelativeEditComponent

    MolecularSequenceRelativeEditComponent Class

    FHIR Specification

    • Short: Changes in sequence from the starting sequence
    • Definition: Changes in sequence from the starting sequence.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    start?: IntegerType

    MolecularSequence.relative.edit.start Element

    FHIR Specification

    • Short: Start position of the edit on the starting sequence
    • Definition: Start position of the edit on the starting sequence. If the coordinate system is either 0-based or 1-based, then start position is inclusive.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    MolecularSequence.relative.edit.end Element

    FHIR Specification

    • Short: End position of the edit on the starting sequence
    • Definition: End position of the edit on the starting sequence. If the coordinate system is 0-based then end 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.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    replacementSequence?: StringType

    MolecularSequence.relative.edit.replacementSequence Element

    FHIR Specification

    • Short: Allele that was observed
    • Definition: Allele that was observed. 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    replacedSequence?: StringType

    MolecularSequence.relative.edit.replacedSequence Element

    FHIR Specification

    • Short: Allele in the starting sequence
    • Definition: Allele in the starting sequence. Nucleotide(s)/amino acids from start position of sequence to stop position of sequence on the positive (+) strand of the starting 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.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    Methods

    • Parse the provided MolecularSequenceRelativeEditComponent JSON to instantiate the MolecularSequenceRelativeEditComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR MolecularSequenceRelativeEditComponent

      • OptionaloptSourceField: string

        Optional data source field (e.g. <complexTypeName>.<complexTypeFieldName>); defaults to MolecularSequenceRelativeEditComponent

      Returns undefined | MolecularSequenceRelativeEditComponent

      MolecularSequenceRelativeEditComponent data model or undefined for MolecularSequenceRelativeEditComponent

      JsonError if the provided JSON is not a valid JSON object

    • Determines if the modifierExtension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the modifierExtension property exists and has any values.

      AssertionError for invalid url

    • Returns undefined | string

      the id property value

    • Assigns the provided value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid value

    • Returns boolean

      true if id exists and has a value; false otherwise

    • Determines if the extension property exists.

      Parameters

      • Optionalurl: string

        the url that identifies a specific Extension

      Returns boolean

      true if an Extension has the provided url; false otherwise

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Determines if the extension property exists.

      Parameters

      • url: string

        the url that identifies a specific Extension

      Returns undefined | IExtension

      an Extension having the provided url

      If the url is provided, determines if an Extension having the provided url exists. If the url is not provided, determines if the extension property exists and has any values.

      AssertionError for invalid url

    • Adds the provided Extension to the extension property array.

      Parameters

      • extension: undefined | IExtension

        the Extension value to add to the extension property array

      Returns this

      this

    • Removes the Extension having the provided url from the extension property array.

      Parameters

      • url: string

        the url that identifies a specific Extension to remove

      Returns void

      AssertionError for invalid url

    • Returns boolean

      true if and only if the data model has required fields (min cardinality > 0) and at least one of those required fields in the instance is empty; false otherwise

    • Returns boolean

      true if the instance is a FHIR complex or primitive datatype; false otherwise