Data Model Libraries
    Preparing search index...

    RiskAssessmentPredictionComponent Class

    FHIR Specification

    • Short: Outcome predicted
    • Definition: Describes the expected outcome for the subject.
    • Comment: Multiple repetitions can be used to identify the same type of outcome in different timeframes as well as different types of outcomes.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    outcome?: CodeableConcept

    RiskAssessment.prediction.outcome Element

    FHIR Specification

    • Short: Possible outcome for the subject
    • Definition: One of the potential outcomes for the patient (e.g. remission, death, a particular condition).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    probability?: IDataType

    RiskAssessment.prediction.probability[x] Element

    @ChoiceDataTypesMeta('RiskAssessment.prediction.probability[x]', ['decimal','Range',]

    FHIR Specification

    • Short: Likelihood of specified outcome
    • Definition: Indicates how likely the outcome is (in the specified timeframe).
    • Comment: If range is used, it represents the lower and upper bounds of certainty; e.g. 40-60% Decimal values are expressed as percentages as well (max = 100).
    • FHIR Types: 'decimal', 'Range',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    qualitativeRisk?: CodeableConcept

    RiskAssessment.prediction.qualitativeRisk Element

    FHIR Specification

    • Short: Likelihood of specified outcome as a qualitative value
    • Definition: Indicates how likely the outcome is (in the specified timeframe), expressed as a qualitative value (e.g. low, medium, or high).
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    relativeRisk?: DecimalType

    RiskAssessment.prediction.relativeRisk Element

    FHIR Specification

    • Short: Relative likelihood
    • Definition: Indicates the risk for this particular subject (with their specific characteristics) divided by the risk of the population in general. (Numbers greater than 1 = higher risk than the population, numbers less than 1 = lower risk.).
    • Requirements: Absolute risk is less meaningful than relative risk.
    • FHIR Type: decimal
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    when?: IDataType

    RiskAssessment.prediction.when[x] Element

    @ChoiceDataTypesMeta('RiskAssessment.prediction.when[x]', ['Period','Range',]

    FHIR Specification

    • Short: Timeframe or age range
    • Definition: Indicates the period of time or age range of the subject to which the specified probability applies.
    • Comment: If not specified, the risk applies "over the subject's lifespan".
    • FHIR Types: 'Period', 'Range',
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    rationale?: StringType

    RiskAssessment.prediction.rationale Element

    FHIR Specification

    • Short: Explanation of prediction
    • Definition: Additional information explaining the basis for the prediction.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR RiskAssessmentPredictionComponent

      • OptionaloptSourceField: string

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

      Returns undefined | RiskAssessmentPredictionComponent

      RiskAssessmentPredictionComponent data model or undefined for RiskAssessmentPredictionComponent

      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