Data Model Libraries
    Preparing search index...

    GenomicStudy Class

    A set of analyses performed to analyze and generate genomic data.

    FHIR Specification

    • Short: Genomic Study
    • Definition: A GenomicStudy is a set of analyses performed to analyze and generate genomic data.
    • FHIR Version: 5.0.0

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    Methods

    parse getIdentifier setIdentifier addIdentifier hasIdentifier getStatusEnumType setStatusEnumType hasStatusEnumType getStatusElement setStatusElement hasStatusElement getStatus setStatus hasStatus getType setType addType hasType getSubject setSubject hasSubject getEncounter setEncounter hasEncounter getStartDateElement setStartDateElement hasStartDateElement getStartDate setStartDate hasStartDate getBasedOn setBasedOn addBasedOn hasBasedOn getReferrer setReferrer hasReferrer getInterpreter setInterpreter addInterpreter hasInterpreter getReason setReason addReason hasReason getInstantiatesCanonicalElement setInstantiatesCanonicalElement hasInstantiatesCanonicalElement getInstantiatesCanonical setInstantiatesCanonical hasInstantiatesCanonical getInstantiatesUriElement setInstantiatesUriElement hasInstantiatesUriElement getInstantiatesUri setInstantiatesUri hasInstantiatesUri getNote setNote addNote hasNote getDescriptionElement setDescriptionElement hasDescriptionElement getDescription setDescription hasDescription getAnalysis setAnalysis addAnalysis hasAnalysis fhirType isEmpty isRequiredFieldsEmpty copy toJSON getText setText hasText getContained setContained addContained hasContained getExtension setExtension hasExtension getExtensionByUrl addExtension removeExtension getModifierExtension setModifierExtension hasModifierExtension getModifierExtensionByUrl addModifierExtension removeModifierExtension resourceType getIdElement setIdElement hasIdElement getId setId hasId getMeta setMeta hasMeta getImplicitRulesElement setImplicitRulesElement hasImplicitRulesElement getImplicitRules setImplicitRules hasImplicitRules getLanguageElement setLanguageElement hasLanguageElement getLanguage setLanguage hasLanguage isResource isDataType isComplexDataType isPrimitive isBooleanPrimitive isStringPrimitive isNumberPrimitive isBigIntPrimitive isDateTimePrimitive copyValues initIdentifier initType initBasedOn initInterpreter initReason initNote initAnalysis

    Constructors

    Properties

    identifier?: Identifier[]

    GenomicStudy.identifier Element

    FHIR Specification

    • Short: Identifiers for this genomic study
    • Definition: Identifiers for this genomic study.
    • FHIR Type: Identifier
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    genomicstudyStatusEnum: GenomicstudyStatusEnum

    FHIR CodeSystem: GenomicstudyStatus

    status: null | EnumCodeType

    GenomicStudy.status Element

    FHIR Specification

    • Short: registered | available | cancelled | entered-in-error | unknown
    • Definition: The status of the genomic study.
    • FHIR Type: code
    • Cardinality: 1..1
    • isModifier: true
    • isModifierReason: This element is labeled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid
    • isSummary: true

    CodeSystem Enumeration: GenomicstudyStatusEnum

    type_?: CodeableConcept[]

    GenomicStudy.type Element

    FHIR Specification

    • Short: The type of the study (e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling)
    • Definition: The type of the study, e.g., Familial variant segregation, Functional variation detection, or Gene expression profiling.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: true
    subject: null | Reference

    GenomicStudy.subject Element

    FHIR Specification

    encounter?: Reference

    GenomicStudy.encounter Element

    FHIR Specification

    • Short: The healthcare event with which this genomics study is associated
    • Definition: The healthcare event with which this genomics study is associated.
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: true
    startDate?: DateTimeType

    GenomicStudy.startDate Element

    FHIR Specification

    • Short: When the genomic study was started
    • Definition: When the genomic study was started.
    • FHIR Type: dateTime
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    basedOn?: Reference[]

    GenomicStudy.basedOn Element

    FHIR Specification

    referrer?: Reference

    GenomicStudy.referrer Element

    FHIR Specification

    interpreter?: Reference[]

    GenomicStudy.interpreter Element

    FHIR Specification

    GenomicStudy.reason Element

    FHIR Specification

    instantiatesCanonical?: CanonicalType

    GenomicStudy.instantiatesCanonical Element

    FHIR Specification

    instantiatesUri?: UriType

    GenomicStudy.instantiatesUri Element

    FHIR Specification

    • Short: The URL pointing to an externally maintained protocol that describes the study
    • Definition: The URL pointing to an externally maintained protocol that describes the study.
    • FHIR Type: uri
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    GenomicStudy.note Element

    FHIR Specification

    • Short: Comments related to the genomic study
    • Definition: Comments related to the genomic study.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    GenomicStudy.description Element

    FHIR Specification

    • Short: Description of the genomic study
    • Definition: Description of the genomic study.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    GenomicStudy.analysis Element

    FHIR Specification

    • Short: Genomic Analysis Event
    • Definition: The details about a specific analysis that was performed in this GenomicStudy.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR GenomicStudy

      • OptionaloptSourceField: string

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

      Returns undefined | GenomicStudy

      GenomicStudy data model or undefined for GenomicStudy

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided Subject object value to the subject property.

      Parameters

      • value: undefined | null | Reference

        the subject object value

      Returns this

      this

      @ReferenceTargets('GenomicStudy.subject', ['Patient','Group','Substance','BiologicallyDerivedProduct','NutritionProduct',])

      InvalidTypeError for invalid data type or reference value

    • 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 the instance is a FHIR complex or primitive datatype; false otherwise