Data Model Libraries
    Preparing search index...

    Class RiskEvidenceSynthesisRiskEstimateComponent

    RiskEvidenceSynthesisRiskEstimateComponent Class

    FHIR Specification

    • Short: What was the estimated risk
    • Definition: The estimated risk of the outcome.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    description?: StringType

    RiskEvidenceSynthesis.riskEstimate.description Element

    FHIR Specification

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

    RiskEvidenceSynthesis.riskEstimate.type Element

    FHIR Specification

    • Short: Type of risk estimate
    • Definition: Examples include proportion and mean.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    value?: DecimalType

    RiskEvidenceSynthesis.riskEstimate.value Element

    FHIR Specification

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

    RiskEvidenceSynthesis.riskEstimate.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
    denominatorCount?: IntegerType

    RiskEvidenceSynthesis.riskEstimate.denominatorCount Element

    FHIR Specification

    • Short: Sample size for group measured
    • Definition: The sample size for the group that was measured for this risk estimate.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    numeratorCount?: IntegerType

    RiskEvidenceSynthesis.riskEstimate.numeratorCount Element

    FHIR Specification

    • Short: Number with the outcome
    • Definition: The number of group members with the outcome of interest.
    • FHIR Type: integer
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    RiskEvidenceSynthesis.riskEstimate.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 RiskEvidenceSynthesisRiskEstimateComponent JSON to instantiate the RiskEvidenceSynthesisRiskEstimateComponent data model.

      Parameters

      • sourceJson: Value

        JSON representing FHIR RiskEvidenceSynthesisRiskEstimateComponent

      • OptionaloptSourceField: string

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

      Returns undefined | RiskEvidenceSynthesisRiskEstimateComponent

      RiskEvidenceSynthesisRiskEstimateComponent data model or undefined for RiskEvidenceSynthesisRiskEstimateComponent

      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