Data Model Libraries
    Preparing search index...

    Class EffectEvidenceSynthesisResultsByExposureComponent

    EffectEvidenceSynthesisResultsByExposureComponent Class

    FHIR Specification

    • Short: What was the result per exposure?
    • Definition: A description of the results for each exposure considered in the effect estimate.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    EffectEvidenceSynthesis.resultsByExposure.description Element

    FHIR Specification

    • Short: Description of results by exposure
    • Definition: Human-readable summary of results by exposure state.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    exposureStateEnum: ExposureStateEnum

    FHIR CodeSystem: ExposureState

    exposureState?: EnumCodeType

    EffectEvidenceSynthesis.resultsByExposure.exposureState Element

    FHIR Specification

    • Short: exposure | exposure-alternative
    • Definition: Whether these results are for the exposure state or alternative exposure state.
    • FHIR Type: code
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    CodeSystem Enumeration: ExposureStateEnum

    variantState?: CodeableConcept

    EffectEvidenceSynthesis.resultsByExposure.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
    riskEvidenceSynthesis: null | Reference

    EffectEvidenceSynthesis.resultsByExposure.riskEvidenceSynthesis Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR EffectEvidenceSynthesisResultsByExposureComponent

      • OptionaloptSourceField: string

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

      Returns undefined | EffectEvidenceSynthesisResultsByExposureComponent

      EffectEvidenceSynthesisResultsByExposureComponent data model or undefined for EffectEvidenceSynthesisResultsByExposureComponent

      JsonError if the provided JSON is not a valid JSON object

    • Assigns the provided RiskEvidenceSynthesis object value to the riskEvidenceSynthesis property.

      Parameters

      • value: undefined | null | Reference

        the riskEvidenceSynthesis object value

      Returns this

      this

      @ReferenceTargets('EffectEvidenceSynthesis.resultsByExposure.riskEvidenceSynthesis', ['RiskEvidenceSynthesis',])

      InvalidTypeError for invalid data type or reference value

    • 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