Data Model Libraries
    Preparing search index...

    Class GenomicStudyAnalysisInputComponent

    GenomicStudyAnalysisInputComponent Class

    FHIR Specification

    • Short: Inputs for the analysis event
    • Definition: Inputs for the analysis event.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    file?: Reference

    GenomicStudy.analysis.input.file Element

    FHIR Specification

    GenomicStudy.analysis.input.type Element

    FHIR Specification

    • Short: Type of input data (e.g., BAM, CRAM, or FASTA)
    • Definition: Type of input data, e.g., BAM, CRAM, or FASTA.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    generatedBy?: IDataType

    GenomicStudy.analysis.input.generatedBy[x] Element

    @ChoiceDataTypesMeta('GenomicStudy.analysis.input.generatedBy[x]', ['Identifier','Reference',]

    FHIR Specification

    • Short: The analysis event or other GenomicStudy that generated this input file
    • Definition: The analysis event or other GenomicStudy that generated this input file.
    • FHIR Types: 'Identifier', 'Reference',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR GenomicStudyAnalysisInputComponent

      • OptionaloptSourceField: string

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

      Returns undefined | GenomicStudyAnalysisInputComponent

      GenomicStudyAnalysisInputComponent data model or undefined for GenomicStudyAnalysisInputComponent

      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