Data Model Libraries
    Preparing search index...

    Class ResearchStudyOutcomeMeasureComponent

    ResearchStudyOutcomeMeasureComponent Class

    FHIR Specification

    • Short: A variable measured during the study
    • Definition: An "outcome measure", "endpoint", "effect measure" or "measure of effect" is a specific measurement or observation used to quantify the effect of experimental variables on the participants in a study, or for observational studies, to describe patterns of diseases or traits or associations with exposures, risk factors or treatment.
    • Comment: A study may have multiple distinct outcome measures that can be used to assess the overall goal for a study. The goal of a study is in the objective whereas the metric by which the goal is assessed is the outcomeMeasure. Examples: Time to Local Recurrence (TLR), Disease-free Survival (DFS), 30 Day Mortality, Systolic BP

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    name?: StringType

    FHIR Specification

    • Short: Label for the outcome
    • Definition: Label for the outcome.
    • FHIR Type: string
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    type_?: CodeableConcept[]

    ResearchStudy.outcomeMeasure.type Element

    FHIR Specification

    • Short: primary | secondary | exploratory
    • Definition: The parameter or characteristic being assessed as one of the values by which the study is assessed.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ResearchStudy.outcomeMeasure.description Element

    FHIR Specification

    • Short: Description of the outcome
    • Definition: Description of the outcome.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    reference?: Reference

    ResearchStudy.outcomeMeasure.reference Element

    FHIR Specification

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchStudyOutcomeMeasureComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchStudyOutcomeMeasureComponent

      ResearchStudyOutcomeMeasureComponent data model or undefined for ResearchStudyOutcomeMeasureComponent

      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