Data Model Libraries
    Preparing search index...

    Class EffectEvidenceSynthesisEffectEstimateComponent

    EffectEvidenceSynthesisEffectEstimateComponent Class

    FHIR Specification

    • Short: What was the estimated effect
    • Definition: The estimated effect of the exposure variant.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    EffectEvidenceSynthesis.effectEstimate.description Element

    FHIR Specification

    • Short: Description of effect estimate
    • Definition: Human-readable summary of effect estimate.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    EffectEvidenceSynthesis.effectEstimate.type Element

    FHIR Specification

    • Short: Type of efffect estimate
    • Definition: Examples include relative risk and mean difference.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    variantState?: CodeableConcept

    EffectEvidenceSynthesis.effectEstimate.variantState Element

    FHIR Specification

    • Short: Variant exposure states
    • Definition: Used to define variant exposure states such as low-risk state.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value?: DecimalType

    EffectEvidenceSynthesis.effectEstimate.value Element

    FHIR Specification

    • Short: Point estimate
    • Definition: The point estimate of the effect estimate.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    unitOfMeasure?: CodeableConcept

    EffectEvidenceSynthesis.effectEstimate.unitOfMeasure Element

    FHIR Specification

    • Short: What unit is the outcome described in?
    • Definition: Specifies the UCUM unit for the outcome.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    EffectEvidenceSynthesis.effectEstimate.precisionEstimate Element

    FHIR Specification

    • Short: How precise the estimate is
    • Definition: A description of the precision of the estimate for the effect.
    • FHIR Type: BackboneElement
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EffectEvidenceSynthesisEffectEstimateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EffectEvidenceSynthesisEffectEstimateComponent

      EffectEvidenceSynthesisEffectEstimateComponent data model or undefined for EffectEvidenceSynthesisEffectEstimateComponent

      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