Class: Study Arm (StudyArm)

A planned pathway assigned to the subject as they progress through the study, usually referred to by a name that reflects one or more treatments, exposures, and/or controls included in the path.

URI: https://example.org/usdm/v4/linkml/StudyArm

 classDiagram
    class StudyArm
    click StudyArm href "../../classes/StudyArm/"
      StudyArm : dataOriginDescription

      StudyArm : dataOriginType





        StudyArm --> "1" Code : dataOriginType
        click Code href "../../classes/Code/"



      StudyArm : description

      StudyArm : extensionAttributes





        StudyArm --> "*" ExtensionAttribute : extensionAttributes
        click ExtensionAttribute href "../../classes/ExtensionAttribute/"



      StudyArm : id

      StudyArm : label

      StudyArm : name

      StudyArm : notes





        StudyArm --> "*" CommentAnnotation : notes
        click CommentAnnotation href "../../classes/CommentAnnotation/"



      StudyArm : populationIds





        StudyArm --> "*" PopulationDefinition : populationIds
        click PopulationDefinition href "../../classes/PopulationDefinition/"



      StudyArm : type





        StudyArm --> "1" Code : type
        click Code href "../../classes/Code/"

Class Properties

Property Value
Class URI usdm:StudyArm

Slots

Name Cardinality and Range Description Inheritance
id 1
string		 direct
name 1
string		 The literal identifier (i.e., distinctive designation) of the study arm. direct
label 0..1
string		 The short descriptive designation for the study arm. direct
description 0..1
string		 A narrative representation of the study arm. direct
type 1
Code		 A characterization or classification of the study arm. direct
dataOriginType 1
Code		 A characterization or classification of the study arm with respect to where the study arm data originates. direct
dataOriginDescription 1
string		 The textual representation of the study arm data origin. direct
notes *
CommentAnnotation		 A brief written record relevant to the study arm. direct
populationIds *
PopulationDefinition		 A USDM relationship between the StudyArm and PopulationDefinition classes which identifies the set of populations associated with the study arm. direct
extensionAttributes *
ExtensionAttribute		 direct

Usages

used by used in type used
InterventionalStudyDesign arms range StudyArm
ObservationalStudyDesign arms range StudyArm
StudyCell armId range StudyArm
StudyDesign arms range StudyArm

Identifier and Mapping Information

Schema Source

  • from schema: https://example.org/usdm/v4/linkml

Mappings

Mapping Type Mapped Value
self https://example.org/usdm/v4/linkml/StudyArm
native https://example.org/usdm/v4/linkml/StudyArm
exact ncit:C174447

LinkML Source

Direct

name: StudyArm
description: A planned pathway assigned to the subject as they progress through the
  study, usually referred to by a name that reflects one or more treatments, exposures,
  and/or controls included in the path.
title: Study Arm
from_schema: https://example.org/usdm/v4/linkml
exact_mappings:
- ncit:C174447
rank: 1000
attributes:
  id:
    name: id
    from_schema: https://example.org/usdm/v4/linkml
    identifier: true
    domain_of:
    - Abbreviation
    - Activity
    - Address
    - AdministrableProduct
    - AdministrableProductProperty
    - Administration
    - AliasCode
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - Code
    - CommentAnnotation
    - ConditionAssignment
    - DocumentContentReference
    - Duration
    - EligibilityCriterion
    - Encounter
    - Estimand
    - ExtensionAttribute
    - ExtensionClass
    - GeographicScope
    - GovernanceDate
    - Identifier
    - Indication
    - Ingredient
    - Masking
    - MedicalDevice
    - NarrativeContent
    - NarrativeContentItem
    - Organization
    - ParameterMap
    - PersonName
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - QuantityRange
    - ResponseCode
    - ScheduleTimeline
    - ScheduleTimelineExit
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyAmendmentImpact
    - StudyAmendmentReason
    - StudyArm
    - StudyCell
    - StudyChange
    - StudyDefinitionDocument
    - StudyDefinitionDocumentVersion
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - StudyTitle
    - StudyVersion
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: true
  name:
    name: name
    description: The literal identifier (i.e., distinctive designation) of the study
      arm.
    title: Study Arm Name
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C170984
    domain_of:
    - Activity
    - AdministrableProduct
    - AdministrableProductProperty
    - Administration
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - EligibilityCriterion
    - Encounter
    - Estimand
    - GovernanceDate
    - Indication
    - MedicalDevice
    - NarrativeContent
    - NarrativeContentItem
    - Organization
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - ResponseCode
    - ScheduleTimeline
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyArm
    - StudyChange
    - StudyDefinitionDocument
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: true
  label:
    name: label
    description: The short descriptive designation for the study arm.
    title: Study Arm Label
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C172456
    domain_of:
    - Activity
    - AdministrableProduct
    - Administration
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - EligibilityCriterion
    - Encounter
    - Estimand
    - GovernanceDate
    - Indication
    - MedicalDevice
    - Organization
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - ResponseCode
    - ScheduleTimeline
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyArm
    - StudyChange
    - StudyDefinitionDocument
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: false
  description:
    name: description
    description: A narrative representation of the study arm.
    title: Study Arm Description
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C93728
    domain_of:
    - Activity
    - AdministrableProduct
    - Administration
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConceptCategory
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - EligibilityCriterion
    - Encounter
    - Estimand
    - GovernanceDate
    - Indication
    - MedicalDevice
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - ScheduleTimeline
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyArm
    - StudyChange
    - StudyDefinitionDocument
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: false
  type:
    name: type
    description: A characterization or classification of the study arm.
    title: Study Arm Type
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C172457
    domain_of:
    - AdministrableProductProperty
    - Encounter
    - GeographicScope
    - GovernanceDate
    - MedicalDeviceIdentifier
    - Organization
    - ReferenceIdentifier
    - StudyAmendmentImpact
    - StudyArm
    - StudyDefinitionDocument
    - StudyEpoch
    - StudyIntervention
    - StudyTitle
    - Timing
    range: Code
    required: true
    inlined: true
  dataOriginType:
    name: dataOriginType
    description: A characterization or classification of the study arm with respect
      to where the study arm data originates.
    title: Study Arm Data Origin Type
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C188829
    rank: 1000
    domain_of:
    - StudyArm
    range: Code
    required: true
    inlined: true
  dataOriginDescription:
    name: dataOriginDescription
    description: The textual representation of the study arm data origin.
    title: Study Arm Data Origin Description
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C188828
    rank: 1000
    domain_of:
    - StudyArm
    range: string
    required: true
  notes:
    name: notes
    description: A brief written record relevant to the study arm.
    title: Study Arm Notes
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C215515
    domain_of:
    - Abbreviation
    - Activity
    - AdministrableProduct
    - Administration
    - AnalysisPopulation
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - EligibilityCriterion
    - Encounter
    - Estimand
    - Indication
    - MedicalDevice
    - PopulationDefinition
    - Procedure
    - StudyAmendment
    - StudyAmendmentImpact
    - StudyArm
    - StudyDefinitionDocument
    - StudyDefinitionDocumentVersion
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudyVersion
    - SyntaxTemplate
    range: CommentAnnotation
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  populationIds:
    name: populationIds
    description: A USDM relationship between the StudyArm and PopulationDefinition
      classes which identifies the set of populations associated with the study arm.
    from_schema: https://example.org/usdm/v4/linkml
    rank: 1000
    domain_of:
    - StudyArm
    range: PopulationDefinition
    required: false
    multivalued: true
    inlined: false
  extensionAttributes:
    name: extensionAttributes
    from_schema: https://example.org/usdm/v4/linkml
    domain_of:
    - Abbreviation
    - Activity
    - Address
    - AdministrableProduct
    - AdministrableProductIdentifier
    - AdministrableProductProperty
    - Administration
    - AliasCode
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - Characteristic
    - Code
    - CommentAnnotation
    - Condition
    - ConditionAssignment
    - DocumentContentReference
    - Duration
    - EligibilityCriterion
    - EligibilityCriterionItem
    - Encounter
    - Endpoint
    - Estimand
    - ExtensionAttribute
    - ExtensionClass
    - GeographicScope
    - GovernanceDate
    - Indication
    - Ingredient
    - IntercurrentEvent
    - InterventionalStudyDesign
    - Masking
    - MedicalDevice
    - MedicalDeviceIdentifier
    - NarrativeContent
    - NarrativeContentItem
    - Objective
    - ObservationalStudyDesign
    - Organization
    - ParameterMap
    - PersonName
    - Procedure
    - ProductOrganizationRole
    - Quantity
    - Range
    - ReferenceIdentifier
    - ResponseCode
    - ScheduleTimeline
    - ScheduleTimelineExit
    - ScheduledActivityInstance
    - ScheduledDecisionInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyAmendmentImpact
    - StudyAmendmentReason
    - StudyArm
    - StudyCell
    - StudyChange
    - StudyCohort
    - StudyDefinitionDocument
    - StudyDefinitionDocumentVersion
    - StudyDesignPopulation
    - StudyElement
    - StudyEpoch
    - StudyIdentifier
    - StudyIntervention
    - StudyRole
    - StudySite
    - StudyTitle
    - StudyVersion
    - SubjectEnrollment
    - Substance
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: ExtensionAttribute
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
class_uri: usdm:StudyArm

Induced

name: StudyArm
description: A planned pathway assigned to the subject as they progress through the
  study, usually referred to by a name that reflects one or more treatments, exposures,
  and/or controls included in the path.
title: Study Arm
from_schema: https://example.org/usdm/v4/linkml
exact_mappings:
- ncit:C174447
rank: 1000
attributes:
  id:
    name: id
    from_schema: https://example.org/usdm/v4/linkml
    identifier: true
    alias: id
    owner: StudyArm
    domain_of:
    - Abbreviation
    - Activity
    - Address
    - AdministrableProduct
    - AdministrableProductProperty
    - Administration
    - AliasCode
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - Code
    - CommentAnnotation
    - ConditionAssignment
    - DocumentContentReference
    - Duration
    - EligibilityCriterion
    - Encounter
    - Estimand
    - ExtensionAttribute
    - ExtensionClass
    - GeographicScope
    - GovernanceDate
    - Identifier
    - Indication
    - Ingredient
    - Masking
    - MedicalDevice
    - NarrativeContent
    - NarrativeContentItem
    - Organization
    - ParameterMap
    - PersonName
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - QuantityRange
    - ResponseCode
    - ScheduleTimeline
    - ScheduleTimelineExit
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyAmendmentImpact
    - StudyAmendmentReason
    - StudyArm
    - StudyCell
    - StudyChange
    - StudyDefinitionDocument
    - StudyDefinitionDocumentVersion
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - StudyTitle
    - StudyVersion
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: true
  name:
    name: name
    description: The literal identifier (i.e., distinctive designation) of the study
      arm.
    title: Study Arm Name
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C170984
    alias: name
    owner: StudyArm
    domain_of:
    - Activity
    - AdministrableProduct
    - AdministrableProductProperty
    - Administration
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - EligibilityCriterion
    - Encounter
    - Estimand
    - GovernanceDate
    - Indication
    - MedicalDevice
    - NarrativeContent
    - NarrativeContentItem
    - Organization
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - ResponseCode
    - ScheduleTimeline
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyArm
    - StudyChange
    - StudyDefinitionDocument
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: true
  label:
    name: label
    description: The short descriptive designation for the study arm.
    title: Study Arm Label
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C172456
    alias: label
    owner: StudyArm
    domain_of:
    - Activity
    - AdministrableProduct
    - Administration
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - EligibilityCriterion
    - Encounter
    - Estimand
    - GovernanceDate
    - Indication
    - MedicalDevice
    - Organization
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - ResponseCode
    - ScheduleTimeline
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyArm
    - StudyChange
    - StudyDefinitionDocument
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: false
  description:
    name: description
    description: A narrative representation of the study arm.
    title: Study Arm Description
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C93728
    alias: description
    owner: StudyArm
    domain_of:
    - Activity
    - AdministrableProduct
    - Administration
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConceptCategory
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - EligibilityCriterion
    - Encounter
    - Estimand
    - GovernanceDate
    - Indication
    - MedicalDevice
    - PopulationDefinition
    - Procedure
    - ProductOrganizationRole
    - ScheduleTimeline
    - ScheduledInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyArm
    - StudyChange
    - StudyDefinitionDocument
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudySite
    - SubjectEnrollment
    - Substance
    - SyntaxTemplate
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: string
    required: false
  type:
    name: type
    description: A characterization or classification of the study arm.
    title: Study Arm Type
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C172457
    alias: type
    owner: StudyArm
    domain_of:
    - AdministrableProductProperty
    - Encounter
    - GeographicScope
    - GovernanceDate
    - MedicalDeviceIdentifier
    - Organization
    - ReferenceIdentifier
    - StudyAmendmentImpact
    - StudyArm
    - StudyDefinitionDocument
    - StudyEpoch
    - StudyIntervention
    - StudyTitle
    - Timing
    range: Code
    required: true
    inlined: true
  dataOriginType:
    name: dataOriginType
    description: A characterization or classification of the study arm with respect
      to where the study arm data originates.
    title: Study Arm Data Origin Type
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C188829
    rank: 1000
    alias: dataOriginType
    owner: StudyArm
    domain_of:
    - StudyArm
    range: Code
    required: true
    inlined: true
  dataOriginDescription:
    name: dataOriginDescription
    description: The textual representation of the study arm data origin.
    title: Study Arm Data Origin Description
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C188828
    rank: 1000
    alias: dataOriginDescription
    owner: StudyArm
    domain_of:
    - StudyArm
    range: string
    required: true
  notes:
    name: notes
    description: A brief written record relevant to the study arm.
    title: Study Arm Notes
    from_schema: https://example.org/usdm/v4/linkml
    exact_mappings:
    - ncit:C215515
    alias: notes
    owner: StudyArm
    domain_of:
    - Abbreviation
    - Activity
    - AdministrableProduct
    - Administration
    - AnalysisPopulation
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - EligibilityCriterion
    - Encounter
    - Estimand
    - Indication
    - MedicalDevice
    - PopulationDefinition
    - Procedure
    - StudyAmendment
    - StudyAmendmentImpact
    - StudyArm
    - StudyDefinitionDocument
    - StudyDefinitionDocumentVersion
    - StudyDesign
    - StudyElement
    - StudyEpoch
    - StudyIntervention
    - StudyRole
    - StudyVersion
    - SyntaxTemplate
    range: CommentAnnotation
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
  populationIds:
    name: populationIds
    description: A USDM relationship between the StudyArm and PopulationDefinition
      classes which identifies the set of populations associated with the study arm.
    from_schema: https://example.org/usdm/v4/linkml
    rank: 1000
    alias: populationIds
    owner: StudyArm
    domain_of:
    - StudyArm
    range: PopulationDefinition
    required: false
    multivalued: true
    inlined: false
  extensionAttributes:
    name: extensionAttributes
    from_schema: https://example.org/usdm/v4/linkml
    alias: extensionAttributes
    owner: StudyArm
    domain_of:
    - Abbreviation
    - Activity
    - Address
    - AdministrableProduct
    - AdministrableProductIdentifier
    - AdministrableProductProperty
    - Administration
    - AliasCode
    - AnalysisPopulation
    - AssignedPerson
    - BiomedicalConcept
    - BiomedicalConceptCategory
    - BiomedicalConceptProperty
    - BiomedicalConceptSurrogate
    - BiospecimenRetention
    - Characteristic
    - Code
    - CommentAnnotation
    - Condition
    - ConditionAssignment
    - DocumentContentReference
    - Duration
    - EligibilityCriterion
    - EligibilityCriterionItem
    - Encounter
    - Endpoint
    - Estimand
    - ExtensionAttribute
    - ExtensionClass
    - GeographicScope
    - GovernanceDate
    - Indication
    - Ingredient
    - IntercurrentEvent
    - InterventionalStudyDesign
    - Masking
    - MedicalDevice
    - MedicalDeviceIdentifier
    - NarrativeContent
    - NarrativeContentItem
    - Objective
    - ObservationalStudyDesign
    - Organization
    - ParameterMap
    - PersonName
    - Procedure
    - ProductOrganizationRole
    - Quantity
    - Range
    - ReferenceIdentifier
    - ResponseCode
    - ScheduleTimeline
    - ScheduleTimelineExit
    - ScheduledActivityInstance
    - ScheduledDecisionInstance
    - Strength
    - Study
    - StudyAmendment
    - StudyAmendmentImpact
    - StudyAmendmentReason
    - StudyArm
    - StudyCell
    - StudyChange
    - StudyCohort
    - StudyDefinitionDocument
    - StudyDefinitionDocumentVersion
    - StudyDesignPopulation
    - StudyElement
    - StudyEpoch
    - StudyIdentifier
    - StudyIntervention
    - StudyRole
    - StudySite
    - StudyTitle
    - StudyVersion
    - SubjectEnrollment
    - Substance
    - SyntaxTemplateDictionary
    - Timing
    - TransitionRule
    range: ExtensionAttribute
    required: false
    multivalued: true
    inlined: true
    inlined_as_list: true
class_uri: usdm:StudyArm