Class: Parameter

A variable element that describes an input used in a formal expression

erDiagram
Parameter {
    DataType dataType  
    string value  
    string defaultValue  
    stringList items  
    boolean required  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
Coding {
    string code  
    string decode  
    string codeSystem  
    string codeSystemVersion  
    AliasPredicate aliasType  
}
Condition {
    string implementsCondition  
    LogicalOperator operator  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
    boolean mandatory  
    string purpose  
    datetime lastUpdated  
    string owner  
    string wasDerivedFrom  
}
SiteOrSponsorComment {
    string text  
    OriginSource sourceType  
    string source  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
    boolean mandatory  
    string purpose  
    datetime lastUpdated  
    string owner  
    string wasDerivedFrom  
}
Comment {
    string text  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
    boolean mandatory  
    string purpose  
    datetime lastUpdated  
    string owner  
    string wasDerivedFrom  
}
FormalExpression {
    string context  
    string expression  
    string returnType  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
RangeCheck {
    Comparator comparator  
    stringList checkValues  
    string item  
    SoftHard softHard  
    LogicalOperator operator  
}
WhereClause {
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
    boolean mandatory  
    string purpose  
    datetime lastUpdated  
    string owner  
    string wasDerivedFrom  
}
ConceptProperty {
    integer minOccurs  
    integer maxOccurs  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
    boolean mandatory  
    string purpose  
    datetime lastUpdated  
    string owner  
    string wasDerivedFrom  
}
CodeList {
    DataType dataType  
    string formatName  
    string version  
    string href  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
    boolean mandatory  
    string purpose  
    datetime lastUpdated  
    string owner  
    string wasDerivedFrom  
}

Parameter ||--}o CodeList : "codeList"
Parameter ||--}o ConceptProperty : "conceptProperty"
Parameter ||--}o WhereClause : "applicableWhen"
Parameter ||--}o Condition : "conditions"
Parameter ||--}o Coding : "coding"
Condition ||--}o RangeCheck : "rangeChecks"
Condition ||--}o FormalExpression : "expressions"
Condition ||--}o Condition : "conditions"
Condition ||--}o Coding : "coding"
Condition ||--}o Comment : "comments"
Condition ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
SiteOrSponsorComment ||--}o Coding : "coding"
SiteOrSponsorComment ||--}o Comment : "comments"
SiteOrSponsorComment ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
Comment ||--}o DocumentReference : "documents"
Comment ||--}o Coding : "coding"
Comment ||--}o Comment : "comments"
Comment ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
FormalExpression ||--}o Parameter : "parameters"
FormalExpression ||--|o ReturnValue : "returnValue"
FormalExpression ||--}o Resource : "externalCodeLibs"
FormalExpression ||--}o Coding : "coding"
RangeCheck ||--}o FormalExpression : "expressions"
WhereClause ||--}o Condition : "conditions"
WhereClause ||--}o Coding : "coding"
WhereClause ||--}o Comment : "comments"
WhereClause ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
ConceptProperty ||--|o CodeList : "codeList"
ConceptProperty ||--}o Coding : "coding"
ConceptProperty ||--}o Comment : "comments"
ConceptProperty ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
CodeList ||--}o CodeListItem : "codeListItems"
CodeList ||--|o Resource : "externalCodeList"
CodeList ||--}o Coding : "coding"
CodeList ||--}o Comment : "comments"
CodeList ||--}o SiteOrSponsorComment : "siteOrSponsorComments"

Inheritance

IdentifiableElement [ Identifiable Labelled]
- Parameter

Slots

Name	Cardinality and Range	Description	Inheritance
dataType	0..1 DataType	The data type of the parameter.	direct
codeList	* CodeList	A list of allowed values for the parameter.	direct
value	0..1 String	A specific bound value for the parameter.	direct
defaultValue	0..1 String	A default value for the parameter.	direct
items	* String or Item or Dimension or Measure or DataAttribute	A list of item dependencies for the parameter.	direct
conceptProperty	* ConceptProperty	Reference to a specific concept property that this parameter represents or modifies.	direct
applicableWhen	* WhereClause	References to different situations that define when this parameter is applicable or required in the containing expression. Multiple whereClauses are combined with OR logic: the parameter applies if ANY referenced WhereClause matches. Within each WhereClause, conditions are combined with AND logic. Example: applicableWhen: ["WC.ADULT", "WC.PEDIATRIC"] means the parameter is needed when (all conditions in WC.ADULT are true) OR (all conditions in WC.PEDIATRIC are true).	direct
conditions	* Condition	Validation conditions that constrain this parameter's value beyond controlled terminology. Multiple conditions are combined with AND logic: all must be satisfied. Use these for parameter validation rules, distinct from applicableWhen which determines if the parameter is needed at all. Example: A parameter AGE might have conditions ensuring it's >= 0 and <= 120. or conditions might make up part of a componsed expression.	direct
required	0..1 Boolean	Indicates whether this parameter must be provided when the containing expression is evaluated (technical constraint).	direct
OID	1 String	Local identifier within this study/context. Use CDISC OID format for regulatory submissions, or simple strings for internal use.	Identifiable
uuid	0..1 String	Universal unique identifier	Identifiable
name	0..1 String	Short name or identifier, used for field names	Labelled
description	0..1 String or String or TranslatedText	Detailed description, shown in tooltips	Labelled
coding	* Coding	Semantic tags for this element	Labelled
label	0..1 String or String or TranslatedText	Human-readable label, shown in UIs	Labelled
aliases	* String or String or TranslatedText	Alternative name or identifier	Labelled

Usages

used by	used in	type	used
FormalExpression	parameters	range	Parameter

Identifier and Mapping Information

Schema Source

from schema: https://cdisc.org/define-json

Mappings

Mapping Type	Mapped Value
self	odm:Parameter
native	odm:Parameter

LinkML Source

Direct

name: Parameter
description: A variable element that describes an input used in a formal expression
from_schema: https://cdisc.org/define-json
is_a: IdentifiableElement
attributes:
  dataType:
    name: dataType
    description: The data type of the parameter.
    from_schema: https://cdisc.org/define-json
    domain_of:
    - Item
    - CodeList
    - Parameter
    - ReturnValue
    range: DataType
  codeList:
    name: codeList
    description: A list of allowed values for the parameter.
    from_schema: https://cdisc.org/define-json
    domain_of:
    - Item
    - ConceptProperty
    - Parameter
    range: CodeList
    multivalued: true
  value:
    name: value
    description: A specific bound value for the parameter.
    from_schema: https://cdisc.org/define-json
    domain_of:
    - Translation
    - Parameter
    - Timing
    range: string
  defaultValue:
    name: defaultValue
    description: A default value for the parameter.
    from_schema: https://cdisc.org/define-json
    rank: 1000
    domain_of:
    - Parameter
    range: string
  items:
    name: items
    description: A list of item dependencies for the parameter.
    from_schema: https://cdisc.org/define-json
    domain_of:
    - MetaDataVersion
    - ItemGroup
    - Parameter
    multivalued: true
    inlined: false
    any_of:
    - range: Item
    - range: Dimension
    - range: Measure
    - range: DataAttribute
  conceptProperty:
    name: conceptProperty
    description: Reference to a specific concept property that this parameter represents
      or modifies.
    from_schema: https://cdisc.org/define-json
    domain_of:
    - Item
    - Parameter
    range: ConceptProperty
    multivalued: true
    inlined: false
  applicableWhen:
    name: applicableWhen
    description: 'References to different situations that define when this parameter  is
      applicable or required in the containing expression. Multiple whereClauses are
      combined with OR logic: the parameter applies  if ANY referenced WhereClause
      matches.

      Within each WhereClause, conditions are combined with AND logic. Example: applicableWhen:
      ["WC.ADULT", "WC.PEDIATRIC"] means the parameter  is needed when (all conditions
      in WC.ADULT are true) OR  (all conditions in WC.PEDIATRIC are true).'
    from_schema: https://cdisc.org/define-json
    domain_of:
    - Item
    - ItemGroup
    - Parameter
    - Analysis
    range: WhereClause
    multivalued: true
    inlined: false
  conditions:
    name: conditions
    description: 'Validation conditions that constrain this parameter''s value beyond
      controlled terminology. Multiple conditions are combined with AND logic: all
      must be satisfied. Use these for parameter validation rules, distinct from applicableWhen  which
      determines if the parameter is needed at all.

      Example: A parameter AGE might have conditions ensuring it''s >= 0 and <= 120.
      or conditions might make up part of a componsed expression.'
    from_schema: https://cdisc.org/define-json
    domain_of:
    - MetaDataVersion
    - WhereClause
    - Condition
    - Parameter
    range: Condition
    multivalued: true
    inlined: false
  required:
    name: required
    description: Indicates whether this parameter must be provided when the  containing
      expression is evaluated (technical constraint).
    from_schema: https://cdisc.org/define-json
    rank: 1000
    ifabsent: 'False'
    domain_of:
    - Parameter
    range: boolean

Induced

name: Parameter
description: A variable element that describes an input used in a formal expression
from_schema: https://cdisc.org/define-json
is_a: IdentifiableElement
attributes:
  dataType:
    name: dataType
    description: The data type of the parameter.
    from_schema: https://cdisc.org/define-json
    alias: dataType
    owner: Parameter
    domain_of:
    - Item
    - CodeList
    - Parameter
    - ReturnValue
    range: DataType
  codeList:
    name: codeList
    description: A list of allowed values for the parameter.
    from_schema: https://cdisc.org/define-json
    alias: codeList
    owner: Parameter
    domain_of:
    - Item
    - ConceptProperty
    - Parameter
    range: CodeList
    multivalued: true
  value:
    name: value
    description: A specific bound value for the parameter.
    from_schema: https://cdisc.org/define-json
    alias: value
    owner: Parameter
    domain_of:
    - Translation
    - Parameter
    - Timing
    range: string
  defaultValue:
    name: defaultValue
    description: A default value for the parameter.
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: defaultValue
    owner: Parameter
    domain_of:
    - Parameter
    range: string
  items:
    name: items
    description: A list of item dependencies for the parameter.
    from_schema: https://cdisc.org/define-json
    alias: items
    owner: Parameter
    domain_of:
    - MetaDataVersion
    - ItemGroup
    - Parameter
    multivalued: true
    inlined: false
    any_of:
    - range: Item
    - range: Dimension
    - range: Measure
    - range: DataAttribute
  conceptProperty:
    name: conceptProperty
    description: Reference to a specific concept property that this parameter represents
      or modifies.
    from_schema: https://cdisc.org/define-json
    alias: conceptProperty
    owner: Parameter
    domain_of:
    - Item
    - Parameter
    range: ConceptProperty
    multivalued: true
    inlined: false
  applicableWhen:
    name: applicableWhen
    description: 'References to different situations that define when this parameter  is
      applicable or required in the containing expression. Multiple whereClauses are
      combined with OR logic: the parameter applies  if ANY referenced WhereClause
      matches.

      Within each WhereClause, conditions are combined with AND logic. Example: applicableWhen:
      ["WC.ADULT", "WC.PEDIATRIC"] means the parameter  is needed when (all conditions
      in WC.ADULT are true) OR  (all conditions in WC.PEDIATRIC are true).'
    from_schema: https://cdisc.org/define-json
    alias: applicableWhen
    owner: Parameter
    domain_of:
    - Item
    - ItemGroup
    - Parameter
    - Analysis
    range: WhereClause
    multivalued: true
    inlined: false
  conditions:
    name: conditions
    description: 'Validation conditions that constrain this parameter''s value beyond
      controlled terminology. Multiple conditions are combined with AND logic: all
      must be satisfied. Use these for parameter validation rules, distinct from applicableWhen  which
      determines if the parameter is needed at all.

      Example: A parameter AGE might have conditions ensuring it''s >= 0 and <= 120.
      or conditions might make up part of a componsed expression.'
    from_schema: https://cdisc.org/define-json
    alias: conditions
    owner: Parameter
    domain_of:
    - MetaDataVersion
    - WhereClause
    - Condition
    - Parameter
    range: Condition
    multivalued: true
    inlined: false
  required:
    name: required
    description: Indicates whether this parameter must be provided when the  containing
      expression is evaluated (technical constraint).
    from_schema: https://cdisc.org/define-json
    rank: 1000
    ifabsent: 'False'
    alias: required
    owner: Parameter
    domain_of:
    - Parameter
    range: boolean
  OID:
    name: OID
    description: Local identifier within this study/context. Use CDISC OID format
      for regulatory submissions, or simple strings for internal use.
    from_schema: https://cdisc.org/define-json
    rank: 1000
    identifier: true
    alias: OID
    owner: Parameter
    domain_of:
    - Identifiable
    range: string
    required: true
    pattern: ^[A-Za-z][A-Za-z0-9._-]*$
  uuid:
    name: uuid
    description: Universal unique identifier
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: uuid
    owner: Parameter
    domain_of:
    - Identifiable
    range: string
  name:
    name: name
    description: Short name or identifier, used for field names
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: name
    owner: Parameter
    domain_of:
    - Labelled
    - Standard
    range: string
  description:
    name: description
    description: Detailed description, shown in tooltips
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: description
    owner: Parameter
    domain_of:
    - Labelled
    - CodeListItem
    range: string
    any_of:
    - range: string
    - range: TranslatedText
  coding:
    name: coding
    description: Semantic tags for this element
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: coding
    owner: Parameter
    domain_of:
    - Labelled
    - CodeListItem
    - SourceItem
    range: Coding
    multivalued: true
    inlined: true
    inlined_as_list: true
  label:
    name: label
    description: Human-readable label, shown in UIs
    from_schema: https://cdisc.org/define-json
    exact_mappings:
    - skos:prefLabel
    rank: 1000
    alias: label
    owner: Parameter
    domain_of:
    - Labelled
    range: string
    any_of:
    - range: string
    - range: TranslatedText
  aliases:
    name: aliases
    description: Alternative name or identifier
    from_schema: https://cdisc.org/define-json
    exact_mappings:
    - skos:altLabel
    rank: 1000
    alias: aliases
    owner: Parameter
    domain_of:
    - Labelled
    - CodeListItem
    range: string
    multivalued: true
    inlined: true
    inlined_as_list: true
    any_of:
    - range: string
    - range: TranslatedText

Keys	Action
`?`	Open this help
`n`	Next page
`p`	Previous page
`s`	Search