Data Model Libraries
    Preparing search index...

    Class EvidenceVariableDefinitionComponent

    EvidenceVariableDefinitionComponent Class

    FHIR Specification

    • Short: Evidence variable such as population, exposure, or outcome
    • Definition: Evidence variable such as population, exposure, or outcome.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: MarkdownType

    Evidence.variableDefinition.description Element

    FHIR Specification

    • Short: A text description or summary of the variable
    • Definition: A text description or summary of the variable.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    note?: Annotation[]

    Evidence.variableDefinition.note Element

    FHIR Specification

    • Short: Footnotes and/or explanatory notes
    • Definition: Footnotes and/or explanatory notes.
    • FHIR Type: Annotation
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    variableRole: null | CodeableConcept

    Evidence.variableDefinition.variableRole Element

    FHIR Specification

    • Short: population | subpopulation | exposure | referenceExposure | measuredVariable | confounder
    • Definition: population | subpopulation | exposure | referenceExposure | measuredVariable | confounder.
    • FHIR Type: CodeableConcept
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: true
    observed?: Reference

    Evidence.variableDefinition.observed Element

    FHIR Specification

    intended?: Reference

    Evidence.variableDefinition.intended Element

    FHIR Specification

    directnessMatch?: CodeableConcept

    Evidence.variableDefinition.directnessMatch Element

    FHIR Specification

    • Short: low | moderate | high | exact
    • Definition: Indication of quality of match between intended variable to actual variable.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EvidenceVariableDefinitionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EvidenceVariableDefinitionComponent

      EvidenceVariableDefinitionComponent data model or undefined for EvidenceVariableDefinitionComponent

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