Data Model Libraries
    Preparing search index...

    MolecularSequence Class

    Representation of a molecular sequence.

    FHIR Specification

    • Short: Representation of a molecular sequence
    • Definition: Representation of a molecular sequence.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    Constructors

    Properties

    identifier?: Identifier[]

    MolecularSequence.identifier Element

    FHIR Specification

    • Short: Unique ID for this particular sequence
    • Definition: A unique identifier for this particular sequence instance.
    • Requirements: Allows sequences to be distinguished and referenced.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    sequenceTypeEnum: SequenceTypeEnum

    FHIR CodeSystem: SequenceType

    type_?: EnumCodeType

    MolecularSequence.type Element

    FHIR Specification

    • Short: aa | dna | rna
    • Definition: Amino Acid Sequence/ DNA Sequence / RNA Sequence.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true

    CodeSystem Enumeration: SequenceTypeEnum

    subject?: Reference

    MolecularSequence.subject Element

    FHIR Specification

    focus?: Reference[]

    MolecularSequence.focus Element

    FHIR Specification

    • Short: What the molecular sequence is about, when it is not about the subject of record
    • Definition: The actual focus of a molecular sequence when it is not the patient of record representing something or someone associated with the patient such as a spouse, parent, child, or sibling. For example, in trio testing, the subject would be the child (proband) and the focus would be the parent.
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    specimen?: Reference

    MolecularSequence.specimen Element

    FHIR Specification

    device?: Reference

    MolecularSequence.device Element

    FHIR Specification

    • Short: The method for sequencing
    • Definition: The method for sequencing, for example, chip information.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    performer?: Reference

    MolecularSequence.performer Element

    FHIR Specification

    • Short: Who should be responsible for test result
    • Definition: The organization or lab that should be responsible for this result.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    literal?: StringType

    MolecularSequence.literal Element

    FHIR Specification

    • Short: Sequence that was observed
    • Definition: Sequence that was observed.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    formatted?: Attachment[]

    MolecularSequence.formatted Element

    FHIR Specification

    • Short: Embedded file or a link (URL) which contains content to represent the sequence
    • Definition: Sequence that was observed as file content. Can be an actual file contents, or referenced by a URL to an external system.
    • FHIR Type: Attachment
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    MolecularSequence.relative Element

    FHIR Specification

    • Short: A sequence defined relative to another sequence
    • Definition: A sequence defined relative to another sequence.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR MolecularSequence

      • OptionaloptSourceField: string

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

      Returns undefined | MolecularSequence

      MolecularSequence data model or undefined for MolecularSequence

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided value to the text property.

      Parameters

      Returns this

      this

    • Returns boolean

      true if the text property exists and has a value; false otherwise

    • Assigns the provided Resource array value to the contained property.

      Parameters

      • value: undefined | IResource[]

        the contained array value

      Returns this

      this

    • Returns boolean

      true if the contained property exists and has a value; false otherwise

    • Assigns the provided array of Extension values to the extension property.

      Parameters

      • extension: undefined | IExtension[]

        array of Extensions

      Returns this

      this

    • 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

    • 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

    • 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

      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

    • Assigns the provided PrimitiveType value to the id property.

      Parameters

      • element: undefined | IdType

        the id value

      Returns this

      this

    • Returns undefined | string

      the id property value as a primitive value

    • Assigns the provided primitive value to the id property.

      Parameters

      • value: undefined | string

        the id value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the id property exists and has a value; false otherwise

    • Assigns the provided value to the meta property.

      Parameters

      • value: undefined | Meta

        the meta value

      Returns this

      this

    • Returns boolean

      true if the meta property exists and has a value; false otherwise

    • Assigns the provided primitive value to the implicitRules property.

      Parameters

      • value: undefined | string

        the implicitRules value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns undefined | string

      the language property value as a primitive value

    • Assigns the provided primitive value to the language property.

      Parameters

      • value: undefined | string

        the language value

      Returns this

      this

      PrimitiveTypeError for invalid primitive types

    • Returns boolean

      true if the language property exists and has a value; false otherwise

    • 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