Class: CodeListItem

Defines an individual member value of a codelist. It may include a display value in the child Decode element

URI: odm:CodeListItem

erDiagram
CodeListItem {
    valueType codedValue  
    decimal rank  
    YesOnly other  
    positiveInteger orderNumber  
    YesOnly extendedValue  
}
Alias {
    text context  
    text name  
}
Coding {
    text code  
    uriorcurie system  
    text systemName  
    text systemVersion  
    text label  
    uriorcurie href  
    uriorcurie ref  
    text commentOID  
}
Decode {

}
TranslatedText {
    languageType language  
    text type  
    contentType content  
}
Description {

}
CommentDef {
    oid OID  
}
DocumentRef {
    oid leafID  
}

CodeListItem ||--|o CommentDef : "commentOID"
CodeListItem ||--|o Description : "description"
CodeListItem ||--|o Decode : "decode"
CodeListItem ||--}o Coding : "coding"
CodeListItem ||--}o Alias : "alias"
Decode ||--}o TranslatedText : "translatedText"
Description ||--}o TranslatedText : "translatedText"
CommentDef ||--|o Description : "description"
CommentDef ||--}o DocumentRef : "documentRef"
DocumentRef ||--}o PDFPageRef : "pDFPageRef"

Slots

Name Cardinality* and Range Description Inheritance
codedValue 1..1
valueType		 Value of the codelist item (as it would occur in clinical data). direct
rank 0..1
decimal		 Numeric significance of the CodeListItem relative to others in the CodeList. ... direct
other 0..1
YesOnly		 Flag to indicate that the term represents "other" content. direct
orderNumber 0..1
positiveInteger		 Ordering on the CodeListItems (within a containing CodeListItem) for use when... direct
extendedValue 0..1
YesOnly		 direct
commentOID 0..1
CommentDef		 Reference to a CommentDef . direct
description 0..1
Description		 Description reference: A free-text description of the containing metadata com... direct
decode 0..1
Decode		 Decode reference: The displayed value relating to the CodeListItem/@CodedValu... direct
coding 0..*
Coding		 Coding reference: Coding references a symbol from a defined code system. It u... direct
alias 0..*
Alias		 Alias reference: An Alias provides an additional name for an element. The Con... direct

* See LinkML documentation for cardinality definitions.

Usages

used by used in type used
CodeList codeListItem range CodeListItem

See Also

Identifier and Mapping Information

Schema Source

  • from schema: http://www.cdisc.org/ns/odm/v2.0

Mappings

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

LinkML Source

Direct

name: CodeListItem
description: Defines an individual member value of a codelist. It may include a display
  value in the child Decode element
from_schema: http://www.cdisc.org/ns/odm/v2.0
see_also:
- https://wiki.cdisc.org/display/PUB/CodeListItem
rank: 1000
slots:
- codedValue
- rank
- other
- orderNumber
- extendedValue
- commentOID
- description
- decode
- coding
- alias
slot_usage:
  codedValue:
    name: codedValue
    description: Value of the codelist item (as it would occur in clinical data).
    comments:
    - 'Required

      range: text'
    domain_of:
    - CodeListItem
    range: valueType
    required: true
  rank:
    name: rank
    description: Numeric significance of the CodeListItem relative to others in the
      CodeList. The Rank attribute may be used where the relative value corresponding
      to an enumeration cannot or should not be determined by its lexical order. For
      example, if you have a list of enumerated text values including "Low", "Medium",
      and "High" and wish to assign these relative numeric values 1, 2, and 3 respectively,
      you should include a Rank attribute for each CodeListItem defined. Without the
      applied rank attribute, the normal lexical ordering would be "High", "Low",
      and "Medium".
    comments:
    - 'Optional

      range: float'
    domain_of:
    - CodeListItem
    range: decimal
  other:
    name: other
    description: Flag to indicate that the term represents "other" content.
    comments:
    - 'Optional

      range: (Yes)'
    domain_of:
    - ItemRef
    - CodeListItem
    range: YesOnly
  orderNumber:
    name: orderNumber
    description: Ordering on the CodeListItems (within a containing CodeListItem)
      for use whenever a list of Items is presented to a user. The ordering does not
      imply anything about event scheduling, time ordering, or data correctness.
    comments:
    - 'Optional

      range: integer'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    - CodeListItem
    - Parameter
    - ReturnValue
    - StudyEndPointRef
    range: positiveInteger
  extendedValue:
    name: extendedValue
    domain_of:
    - CodeListItem
    range: YesOnly
  commentOID:
    name: commentOID
    description: Reference to a CommentDef .
    comments:
    - 'Optional

      range: oidref'
    domain_of:
    - MetaDataVersion
    - Standard
    - WhereClauseDef
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - Coding
    range: CommentDef
  description:
    name: description
    domain_of:
    - Study
    - MetaDataVersion
    - ValueListDef
    - StudyEventGroupRef
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - Origin
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - CommentDef
    - Protocol
    - StudyStructure
    - TrialPhase
    - StudyIndication
    - StudyIntervention
    - StudyObjective
    - StudyEndPoint
    - StudyTargetPopulation
    - StudyEstimand
    - IntercurrentEvent
    - SummaryMeasure
    - Arm
    - Epoch
    - TransitionTimingConstraint
    - AbsoluteTimingConstraint
    - RelativeTimingConstraint
    - DurationTimingConstraint
    - WorkflowDef
    - Criterion
    - Organization
    - Location
    - ODMFileMetadata
    range: Description
    maximum_cardinality: 1
  decode:
    name: decode
    domain_of:
    - CodeListItem
    range: Decode
    maximum_cardinality: 1
  coding:
    name: coding
    multivalued: true
    domain_of:
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - Origin
    - SourceItems
    - SourceItem
    - ItemDef
    - CodeList
    - CodeListItem
    - StudyIndication
    - StudyIntervention
    - StudyTargetPopulation
    - StudyParameter
    - ParameterValue
    - Criterion
    - Annotation
    range: Coding
    inlined: true
    inlined_as_list: true
  alias:
    name: alias
    multivalued: true
    domain_of:
    - StudyEventDef
    - ItemGroupDef
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - Protocol
    range: Alias
    inlined: true
    inlined_as_list: true
class_uri: odm:CodeListItem

Induced

name: CodeListItem
description: Defines an individual member value of a codelist. It may include a display
  value in the child Decode element
from_schema: http://www.cdisc.org/ns/odm/v2.0
see_also:
- https://wiki.cdisc.org/display/PUB/CodeListItem
rank: 1000
slot_usage:
  codedValue:
    name: codedValue
    description: Value of the codelist item (as it would occur in clinical data).
    comments:
    - 'Required

      range: text'
    domain_of:
    - CodeListItem
    range: valueType
    required: true
  rank:
    name: rank
    description: Numeric significance of the CodeListItem relative to others in the
      CodeList. The Rank attribute may be used where the relative value corresponding
      to an enumeration cannot or should not be determined by its lexical order. For
      example, if you have a list of enumerated text values including "Low", "Medium",
      and "High" and wish to assign these relative numeric values 1, 2, and 3 respectively,
      you should include a Rank attribute for each CodeListItem defined. Without the
      applied rank attribute, the normal lexical ordering would be "High", "Low",
      and "Medium".
    comments:
    - 'Optional

      range: float'
    domain_of:
    - CodeListItem
    range: decimal
  other:
    name: other
    description: Flag to indicate that the term represents "other" content.
    comments:
    - 'Optional

      range: (Yes)'
    domain_of:
    - ItemRef
    - CodeListItem
    range: YesOnly
  orderNumber:
    name: orderNumber
    description: Ordering on the CodeListItems (within a containing CodeListItem)
      for use whenever a list of Items is presented to a user. The ordering does not
      imply anything about event scheduling, time ordering, or data correctness.
    comments:
    - 'Optional

      range: integer'
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    - CodeListItem
    - Parameter
    - ReturnValue
    - StudyEndPointRef
    range: positiveInteger
  extendedValue:
    name: extendedValue
    domain_of:
    - CodeListItem
    range: YesOnly
  commentOID:
    name: commentOID
    description: Reference to a CommentDef .
    comments:
    - 'Optional

      range: oidref'
    domain_of:
    - MetaDataVersion
    - Standard
    - WhereClauseDef
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - Coding
    range: CommentDef
  description:
    name: description
    domain_of:
    - Study
    - MetaDataVersion
    - ValueListDef
    - StudyEventGroupRef
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - Origin
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - CommentDef
    - Protocol
    - StudyStructure
    - TrialPhase
    - StudyIndication
    - StudyIntervention
    - StudyObjective
    - StudyEndPoint
    - StudyTargetPopulation
    - StudyEstimand
    - IntercurrentEvent
    - SummaryMeasure
    - Arm
    - Epoch
    - TransitionTimingConstraint
    - AbsoluteTimingConstraint
    - RelativeTimingConstraint
    - DurationTimingConstraint
    - WorkflowDef
    - Criterion
    - Organization
    - Location
    - ODMFileMetadata
    range: Description
    maximum_cardinality: 1
  decode:
    name: decode
    domain_of:
    - CodeListItem
    range: Decode
    maximum_cardinality: 1
  coding:
    name: coding
    multivalued: true
    domain_of:
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - Origin
    - SourceItems
    - SourceItem
    - ItemDef
    - CodeList
    - CodeListItem
    - StudyIndication
    - StudyIntervention
    - StudyTargetPopulation
    - StudyParameter
    - ParameterValue
    - Criterion
    - Annotation
    range: Coding
    inlined: true
    inlined_as_list: true
  alias:
    name: alias
    multivalued: true
    domain_of:
    - StudyEventDef
    - ItemGroupDef
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - Protocol
    range: Alias
    inlined: true
    inlined_as_list: true
attributes:
  codedValue:
    name: codedValue
    description: Value of the codelist item (as it would occur in clinical data).
    comments:
    - 'Required

      range: text'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: codedValue
    owner: CodeListItem
    domain_of:
    - CodeListItem
    range: valueType
    required: true
  rank:
    name: rank
    description: Numeric significance of the CodeListItem relative to others in the
      CodeList. The Rank attribute may be used where the relative value corresponding
      to an enumeration cannot or should not be determined by its lexical order. For
      example, if you have a list of enumerated text values including "Low", "Medium",
      and "High" and wish to assign these relative numeric values 1, 2, and 3 respectively,
      you should include a Rank attribute for each CodeListItem defined. Without the
      applied rank attribute, the normal lexical ordering would be "High", "Low",
      and "Medium".
    comments:
    - 'Optional

      range: float'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: rank
    owner: CodeListItem
    domain_of:
    - CodeListItem
    range: decimal
  other:
    name: other
    description: Flag to indicate that the term represents "other" content.
    comments:
    - 'Optional

      range: (Yes)'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: other
    owner: CodeListItem
    domain_of:
    - ItemRef
    - CodeListItem
    range: YesOnly
  orderNumber:
    name: orderNumber
    description: Ordering on the CodeListItems (within a containing CodeListItem)
      for use whenever a list of Items is presented to a user. The ordering does not
      imply anything about event scheduling, time ordering, or data correctness.
    comments:
    - 'Optional

      range: integer'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: orderNumber
    owner: CodeListItem
    domain_of:
    - StudyEventGroupRef
    - StudyEventRef
    - ItemGroupRef
    - ItemRef
    - CodeListItem
    - Parameter
    - ReturnValue
    - StudyEndPointRef
    range: positiveInteger
  extendedValue:
    name: extendedValue
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: extendedValue
    owner: CodeListItem
    domain_of:
    - CodeListItem
    range: YesOnly
  commentOID:
    name: commentOID
    description: Reference to a CommentDef .
    comments:
    - 'Optional

      range: oidref'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: commentOID
    owner: CodeListItem
    domain_of:
    - MetaDataVersion
    - Standard
    - WhereClauseDef
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - Coding
    range: CommentDef
  description:
    name: description
    description: 'Description reference: A free-text description of the containing
      metadata component, unless restricted by Business Rules.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: description
    owner: CodeListItem
    domain_of:
    - Study
    - MetaDataVersion
    - ValueListDef
    - StudyEventGroupRef
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - Origin
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - CommentDef
    - Protocol
    - StudyStructure
    - TrialPhase
    - StudyIndication
    - StudyIntervention
    - StudyObjective
    - StudyEndPoint
    - StudyTargetPopulation
    - StudyEstimand
    - IntercurrentEvent
    - SummaryMeasure
    - Arm
    - Epoch
    - TransitionTimingConstraint
    - AbsoluteTimingConstraint
    - RelativeTimingConstraint
    - DurationTimingConstraint
    - WorkflowDef
    - Criterion
    - Organization
    - Location
    - ODMFileMetadata
    range: Description
    maximum_cardinality: 1
  decode:
    name: decode
    description: 'Decode reference: The displayed value relating to the CodeListItem/@CodedValue.
      This is often a label corresponding to a short name or alpha-numeric code. The
      actual Decode text is provided in a TranslatedText element so that it can be
      provided in different languages on a case report form or tabular data summary.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    alias: decode
    owner: CodeListItem
    domain_of:
    - CodeListItem
    range: Decode
    maximum_cardinality: 1
  coding:
    name: coding
    description: 'Coding reference: Coding references a symbol from a defined code
      system. It uses a code defined in a terminology system to associate semantics
      with a given term, codelist, variable, or group of variables. The presence of
      a Coding element associates a meaning to its parent element. Including multiple
      Coding elements for a given parent indicates synonymous meanings provided by
      different code systems or code system versions.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    multivalued: true
    alias: coding
    owner: CodeListItem
    domain_of:
    - StudyEventGroupDef
    - StudyEventDef
    - ItemGroupDef
    - Origin
    - SourceItems
    - SourceItem
    - ItemDef
    - CodeList
    - CodeListItem
    - StudyIndication
    - StudyIntervention
    - StudyTargetPopulation
    - StudyParameter
    - ParameterValue
    - Criterion
    - Annotation
    range: Coding
    inlined: true
    inlined_as_list: true
  alias:
    name: alias
    description: 'Alias reference: An Alias provides an additional name for an element.
      The Context attribute specifies the application domain in which this additional
      name is relevant.'
    from_schema: http://www.cdisc.org/ns/odm/v2.0
    rank: 1000
    multivalued: true
    alias: alias
    owner: CodeListItem
    domain_of:
    - StudyEventDef
    - ItemGroupDef
    - ItemDef
    - CodeList
    - CodeListItem
    - MethodDef
    - ConditionDef
    - Protocol
    range: Alias
    inlined: true
    inlined_as_list: true
class_uri: odm:CodeListItem