Data Model Libraries
    Preparing search index...

    Class ResearchStudyComparisonGroupComponent

    ResearchStudyComparisonGroupComponent Class

    FHIR Specification

    • Short: Defined path through the study for a subject
    • Definition: Describes an expected event or sequence of events for one of the subjects of a study. E.g. for a living subject: exposure to drug A, wash-out, exposure to drug B, wash-out, follow-up. E.g. for a stability study: {store sample from lot A at 25 degrees for 1 month}, {store sample from lot A at 40 degrees for 1 month}.
    • Comment: In many clinical trials this is refered to as the ARM of the study, but such a term is not used in other sorts of trials even when there is a comparison between two or more groups.

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    linkId?: IdType

    ResearchStudy.comparisonGroup.linkId Element

    FHIR Specification

    • Short: Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily
    • Definition: Allows the comparisonGroup for the study and the comparisonGroup for the subject to be linked easily.
    • FHIR Type: id
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    name: null | StringType

    FHIR Specification

    • Short: Label for study comparisonGroup
    • Definition: Unique, human-readable label for this comparisonGroup of the study.
    • FHIR Type: string
    • Cardinality: 1..1
    • isModifier: false
    • isSummary: false

    ResearchStudy.comparisonGroup.type Element

    FHIR Specification

    • Short: Categorization of study comparisonGroup
    • Definition: Categorization of study comparisonGroup, e.g. experimental, active comparator, placebo comparater.
    • FHIR Type: CodeableConcept
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    description?: MarkdownType

    ResearchStudy.comparisonGroup.description Element

    FHIR Specification

    • Short: Short explanation of study path
    • Definition: A succinct description of the path through the study that would be followed by a subject adhering to this comparisonGroup.
    • FHIR Type: markdown
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false
    intendedExposure?: Reference[]

    ResearchStudy.comparisonGroup.intendedExposure Element

    FHIR Specification

    • Short: Interventions or exposures in this comparisonGroup or cohort
    • Definition: Interventions or exposures in this comparisonGroup or cohort.
    • Requirements: this is necessary for ClinicalTrials.gov use which relates 1 to many interventions to comparisonGroups (aka arms)
    • FHIR Type: Reference
    • Cardinality: 0..*
    • isModifier: false
    • isSummary: false
    observedGroup?: Reference

    ResearchStudy.comparisonGroup.observedGroup Element

    FHIR Specification

    • Short: Group of participants who were enrolled in study comparisonGroup
    • Definition: Group of participants who were enrolled in study comparisonGroup.
    • Requirements: This is necessary to relate comparisonGroups to actual groups
    • FHIR Type: Reference
    • Cardinality: 0..1
    • isModifier: false
    • isSummary: false

    Methods

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

      Parameters

      • sourceJson: Value

        JSON representing FHIR ResearchStudyComparisonGroupComponent

      • OptionaloptSourceField: string

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

      Returns undefined | ResearchStudyComparisonGroupComponent

      ResearchStudyComparisonGroupComponent data model or undefined for ResearchStudyComparisonGroupComponent

      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 the instance is a FHIR complex or primitive datatype; false otherwise