Class: CodeList

A value set that defines a discrete collection of permissible values for an item, corresponding to the ODM CodeList construct

URI: [odm:class/CodeList](https://cdisc.org/odm2/class/CodeList)

erDiagram
CodeList {
    string formatName  
    DataType dataType  
    string name  
    string description  
    string OID  
    stringList aliases  
    string href  
    boolean isNonStandard  
    string label  
    datetime lastUpdated  
    boolean mandatory  
    string owner  
    string purpose  
    string uuid  
    string version  
    string wasDerivedFrom  
}
CodeListItem {
    string description  
    string codedValue  
    string decode  
    boolean other  
    decimal weight  
    stringList aliases  
}
Coding {
    AliasPredicate aliasType  
    string code  
    string codeSystem  
    string codeSystemVersion  
    string decode  
}
Comment {
    string text  
    string name  
    string description  
    string OID  
    stringList aliases  
    string label  
    datetime lastUpdated  
    boolean mandatory  
    string owner  
    string purpose  
    string uuid  
    string wasDerivedFrom  
}
FormalExpression {
    string expression  
    string returnType  
    string context  
    string name  
    string description  
    string OID  
    stringList aliases  
    string label  
    string uuid  
}
Resource {
    string attribute  
    string resourceType  
    string name  
    string description  
    string OID  
    stringList aliases  
    string href  
    string label  
    string uuid  
    string version  
}
SiteOrSponsorComment {
    OriginSource sourceType  
    string source  
    string text  
    string name  
    string description  
    string OID  
    stringList aliases  
    string label  
    datetime lastUpdated  
    boolean mandatory  
    string owner  
    string purpose  
    string uuid  
    string wasDerivedFrom  
}
Standard {
    PublishingSet publishingSet  
    StandardStatus status  
    StandardType type  
    string version  
    StandardName name  
    string description  
    string OID  
    stringList aliases  
    string label  
    string uuid  
}

CodeList ||--|o Resource : "externalCodeList"
CodeList ||--|o Standard : "standard"
CodeList ||--}o CodeListItem : "codeListItems"
CodeList ||--}o Coding : "coding"
CodeList ||--}o Comment : "comments"
CodeList ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
CodeListItem ||--|o Coding : "coding"
Comment ||--}o Coding : "coding"
Comment ||--}o Comment : "comments"
Comment ||--}o DocumentReference : "documents"
Comment ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
FormalExpression ||--|o ReturnValue : "returnValue"
FormalExpression ||--}o Coding : "coding"
FormalExpression ||--}o Parameter : "parameters"
FormalExpression ||--}o Resource : "externalCodeLibs"
Resource ||--}o Coding : "coding"
Resource ||--}o FormalExpression : "selection"
SiteOrSponsorComment ||--}o Coding : "coding"
SiteOrSponsorComment ||--}o Comment : "comments"
SiteOrSponsorComment ||--}o SiteOrSponsorComment : "siteOrSponsorComments"
Standard ||--}o Coding : "coding"

## Inheritance * [GovernedElement](../classes/GovernedElement.md) [ [Identifiable](../classes/Identifiable.md) [Labelled](../classes/Labelled.md) [Governed](../classes/Governed.md)] * **CodeList** [ [Versioned](../classes/Versioned.md) [IsODMStandard](../classes/IsODMStandard.md)] ## Slots | Name | Cardinality and Range | Description | Inheritance | | --- | --- | --- | --- | | [dataType](../slots/dataType.md) | 0..1
[DataType](../enums/DataType.md) | The data type for the values in the code list | direct | | [formatName](../slots/formatName.md) | 0..1
[String](../types/String.md) | Name of a standard format definition | direct | | [codeListItems](../slots/codeListItems.md) | *
[CodeListItem](../classes/CodeListItem.md) | The individual values that make up this CodeList. The type of CodeListItem included determines its behaviour | direct | | [externalCodeList](../slots/externalCodeList.md) | 0..1
[Resource](../classes/Resource.md) | Reference to a code list that is defined externally to this study | direct | | [version](../slots/version.md) | 0..1
[String](../types/String.md) | The version of the external resources | [Versioned](../classes/Versioned.md) | | [href](../slots/href.md) | 0..1
[String](../types/String.md) | Machine-readable instructions to obtain the resource e.g. FHIR path, URL | [Versioned](../classes/Versioned.md) | | [standard](../slots/standard.md) | 0..1
[Standard](../classes/Standard.md) | Reference to the standard being implemented | [IsODMStandard](../classes/IsODMStandard.md) | | [isNonStandard](../slots/isNonStandard.md) | 0..1
[Boolean](../types/Boolean.md) | One or more members of this set are non-standard extensions | [IsODMStandard](../classes/IsODMStandard.md) | | [OID](../slots/OID.md) | 1
[String](../types/String.md) | Local identifier within this study/context. Use CDISC OID format for regulatory submissions, or simple strings for internal use. | [Identifiable](../classes/Identifiable.md) | | [uuid](../slots/uuid.md) | 0..1
[String](../types/String.md) | Universal unique identifier | [Identifiable](../classes/Identifiable.md) | | [name](../slots/name.md) | 0..1
[String](../types/String.md) | Short name or identifier, used for field names | [Labelled](../classes/Labelled.md) | | [description](../slots/description.md) | 0..1
[String](../types/String.md) or
[TranslatedText](../classes/TranslatedText.md) | Detailed description, shown in tooltips | [Labelled](../classes/Labelled.md) | | [coding](../slots/coding.md) | *
[Coding](../classes/Coding.md) | Semantic tags for this element | [Labelled](../classes/Labelled.md) | | [label](../slots/label.md) | 0..1
[String](../types/String.md) or
[TranslatedText](../classes/TranslatedText.md) | Human-readable label, shown in UIs | [Labelled](../classes/Labelled.md) | | [aliases](../slots/aliases.md) | *
[String](../types/String.md) or
[TranslatedText](../classes/TranslatedText.md) | Alternative name or identifier | [Labelled](../classes/Labelled.md) | | [mandatory](../slots/mandatory.md) | 0..1
[Boolean](../types/Boolean.md) | Is this element required? | [Governed](../classes/Governed.md) | | [comments](../slots/comments.md) | *
[Comment](../classes/Comment.md) | Comment on the element, such as a rationale for its inclusion or exclusion | [Governed](../classes/Governed.md) | | [siteOrSponsorComments](../slots/siteOrSponsorComments.md) | *
[SiteOrSponsorComment](../classes/SiteOrSponsorComment.md) | Comment on the element, such as a rationale for its inclusion or exclusion | [Governed](../classes/Governed.md) | | [purpose](../slots/purpose.md) | 0..1
[String](../types/String.md) or
[TranslatedText](../classes/TranslatedText.md) | Purpose or rationale for this data element | [Governed](../classes/Governed.md) | | [lastUpdated](../slots/lastUpdated.md) | 0..1
[Datetime](../types/Datetime.md) | When the resource was last updated | [Governed](../classes/Governed.md) | | [owner](../slots/owner.md) | 0..1
[String](../types/String.md) or
[User](../classes/User.md) or
[Organization](../classes/Organization.md) | Party responsible for this element | [Governed](../classes/Governed.md) | | [wasDerivedFrom](../slots/wasDerivedFrom.md) | 0..1
[String](../types/String.md) or
[Item](../classes/Item.md) or
[ItemGroup](../classes/ItemGroup.md) or
[MetaDataVersion](../classes/MetaDataVersion.md) or
[CodeList](../classes/CodeList.md) or
[ReifiedConcept](../classes/ReifiedConcept.md) or
[ConceptProperty](../classes/ConceptProperty.md) or
[Condition](../classes/Condition.md) or
[Method](../classes/Method.md) or
[NominalOccurrence](../classes/NominalOccurrence.md) or
[Dataflow](../classes/Dataflow.md) or
[CubeComponent](../classes/CubeComponent.md) or
[DataProduct](../classes/DataProduct.md) or
[ProvisionAgreement](../classes/ProvisionAgreement.md) | Reference to another item that this item implements or extends, e.g. a template Item definition. | [Governed](../classes/Governed.md) | ## Usages | used by | used in | type | used | | --- | --- | --- | --- | | [GovernedElement](../classes/GovernedElement.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Governed](../classes/Governed.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [IsODMItem](../classes/IsODMItem.md) | [roleCodeList](../slots/roleCodeList.md) | range | [CodeList](../classes/CodeList.md) | | [MetaDataVersion](../classes/MetaDataVersion.md) | [codeLists](../slots/codeLists.md) | range | [CodeList](../classes/CodeList.md) | | [MetaDataVersion](../classes/MetaDataVersion.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Item](../classes/Item.md) | [codeList](../slots/codeList.md) | range | [CodeList](../classes/CodeList.md) | | [Item](../classes/Item.md) | [roleCodeList](../slots/roleCodeList.md) | range | [CodeList](../classes/CodeList.md) | | [Item](../classes/Item.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [ItemGroup](../classes/ItemGroup.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [CodeList](../classes/CodeList.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Comment](../classes/Comment.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [ReifiedConcept](../classes/ReifiedConcept.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [ConceptProperty](../classes/ConceptProperty.md) | [codeList](../slots/codeList.md) | range | [CodeList](../classes/CodeList.md) | | [ConceptProperty](../classes/ConceptProperty.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [WhereClause](../classes/WhereClause.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Condition](../classes/Condition.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Method](../classes/Method.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Parameter](../classes/Parameter.md) | [codeList](../slots/codeList.md) | range | [CodeList](../classes/CodeList.md) | | [SiteOrSponsorComment](../classes/SiteOrSponsorComment.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [NominalOccurrence](../classes/NominalOccurrence.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [DataStructureDefinition](../classes/DataStructureDefinition.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Dataflow](../classes/Dataflow.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [CubeComponent](../classes/CubeComponent.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Measure](../classes/Measure.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Dimension](../classes/Dimension.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [DataAttribute](../classes/DataAttribute.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [DataProduct](../classes/DataProduct.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [ProvisionAgreement](../classes/ProvisionAgreement.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Analysis](../classes/Analysis.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | | [Display](../classes/Display.md) | [wasDerivedFrom](../slots/wasDerivedFrom.md) | any_of[range] | [CodeList](../classes/CodeList.md) | ## Identifier and Mapping Information ### Schema Source * from schema: https://cdisc.org/dds ## Mappings | Mapping Type | Mapped Value | | --- | --- | | self | odm:CodeList | | native | odm:CodeList | | exact | odm:CodeList, omop:Vocabulary, fhir:ValueSet | | narrow | sdmx:Codelist, sdmx:ValueList, sdmx:ConceptScheme | | related | usdm:BiomedicalConceptProperty/responseCodes | | close | skos:Collection, sdmx:ItemScheme, qb:codeList | ## LinkML Source ### Direct

name: CodeList
description: A value set that defines a discrete collection of permissible values
  for an item, corresponding to the ODM CodeList construct
from_schema: https://cdisc.org/dds
exact_mappings:
- odm:CodeList
- omop:Vocabulary
- fhir:ValueSet
close_mappings:
- skos:Collection
- sdmx:ItemScheme
- qb:codeList
related_mappings:
- usdm:BiomedicalConceptProperty/responseCodes
narrow_mappings:
- sdmx:Codelist
- sdmx:ValueList
- sdmx:ConceptScheme
is_a: GovernedElement
mixins:
- Versioned
- IsODMStandard
attributes:
  dataType:
    name: dataType
    description: The data type for the values in the code list
    from_schema: https://cdisc.org/dds
    domain_of:
    - Item
    - CodeList
    - Parameter
    - ReturnValue
    range: DataType
  formatName:
    name: formatName
    description: Name of a standard format definition
    from_schema: https://cdisc.org/dds
    rank: 1000
    domain_of:
    - CodeList
    range: string
  codeListItems:
    name: codeListItems
    description: The individual values that make up this CodeList. The type of CodeListItem
      included determines its behaviour
    from_schema: https://cdisc.org/dds
    rank: 1000
    domain_of:
    - CodeList
    range: CodeListItem
    multivalued: true
    inlined: true
    inlined_as_list: true
  externalCodeList:
    name: externalCodeList
    description: Reference to a code list that is defined externally to this study
    from_schema: https://cdisc.org/dds
    rank: 1000
    domain_of:
    - CodeList
    range: Resource

### Induced

name: CodeList
description: A value set that defines a discrete collection of permissible values
  for an item, corresponding to the ODM CodeList construct
from_schema: https://cdisc.org/dds
exact_mappings:
- odm:CodeList
- omop:Vocabulary
- fhir:ValueSet
close_mappings:
- skos:Collection
- sdmx:ItemScheme
- qb:codeList
related_mappings:
- usdm:BiomedicalConceptProperty/responseCodes
narrow_mappings:
- sdmx:Codelist
- sdmx:ValueList
- sdmx:ConceptScheme
is_a: GovernedElement
mixins:
- Versioned
- IsODMStandard
attributes:
  dataType:
    name: dataType
    description: The data type for the values in the code list
    from_schema: https://cdisc.org/dds
    owner: CodeList
    domain_of:
    - Item
    - CodeList
    - Parameter
    - ReturnValue
    range: DataType
  formatName:
    name: formatName
    description: Name of a standard format definition
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - CodeList
    range: string
  codeListItems:
    name: codeListItems
    description: The individual values that make up this CodeList. The type of CodeListItem
      included determines its behaviour
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - CodeList
    range: CodeListItem
    multivalued: true
    inlined: true
    inlined_as_list: true
  externalCodeList:
    name: externalCodeList
    description: Reference to a code list that is defined externally to this study
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - CodeList
    range: Resource
  version:
    name: version
    description: The version of the external resources
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Versioned
    - Standard
    range: string
  href:
    name: href
    description: Machine-readable instructions to obtain the resource e.g. FHIR path,
      URL
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Versioned
    range: string
    required: false
  standard:
    name: standard
    description: Reference to the standard being implemented
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - IsODMStandard
    range: Standard
  isNonStandard:
    name: isNonStandard
    description: One or more members of this set are non-standard extensions
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - IsODMStandard
    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/dds
    rank: 1000
    identifier: true
    owner: CodeList
    domain_of:
    - Identifiable
    range: string
    required: true
  uuid:
    name: uuid
    description: Universal unique identifier
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Identifiable
    range: string
  name:
    name: name
    description: Short name or identifier, used for field names
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Labelled
    - DefClass
    - SubClass
    - Standard
    range: string
  description:
    name: description
    description: Detailed description, shown in tooltips
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    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/dds
    rank: 1000
    owner: CodeList
    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/dds
    exact_mappings:
    - skos:prefLabel
    rank: 1000
    owner: CodeList
    domain_of:
    - Labelled
    range: string
    any_of:
    - range: string
    - range: TranslatedText
  aliases:
    name: aliases
    description: Alternative name or identifier
    from_schema: https://cdisc.org/dds
    exact_mappings:
    - skos:altLabel
    rank: 1000
    owner: CodeList
    domain_of:
    - Labelled
    - CodeListItem
    range: string
    multivalued: true
    inlined: true
    inlined_as_list: true
    any_of:
    - range: string
    - range: TranslatedText
  mandatory:
    name: mandatory
    description: Is this element required?
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: boolean
  comments:
    name: comments
    description: Comment on the element, such as a rationale for its inclusion or
      exclusion
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: Comment
    multivalued: true
    inlined: false
  siteOrSponsorComments:
    name: siteOrSponsorComments
    description: Comment on the element, such as a rationale for its inclusion or
      exclusion
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: SiteOrSponsorComment
    multivalued: true
    inlined: false
  purpose:
    name: purpose
    description: Purpose or rationale for this data element
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: string
    any_of:
    - range: string
    - range: TranslatedText
  lastUpdated:
    name: lastUpdated
    description: When the resource was last updated
    from_schema: https://cdisc.org/dds
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: datetime
  owner:
    name: owner
    description: Party responsible for this element
    from_schema: https://cdisc.org/dds
    narrow_mappings:
    - prov:wasAttributedTo
    - prov:wasAssociatedBy
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: string
    any_of:
    - range: User
    - range: Organization
    - range: string
  wasDerivedFrom:
    name: wasDerivedFrom
    description: Reference to another item that this item implements or extends, e.g.
      a template Item definition.
    from_schema: https://cdisc.org/dds
    exact_mappings:
    - prov:wasDerivedFrom
    rank: 1000
    owner: CodeList
    domain_of:
    - Governed
    range: string
    any_of:
    - range: Item
    - range: ItemGroup
    - range: MetaDataVersion
    - range: CodeList
    - range: ReifiedConcept
    - range: ConceptProperty
    - range: Condition
    - range: Method
    - range: NominalOccurrence
    - range: Dataflow
    - range: CubeComponent
    - range: DataProduct
    - range: ProvisionAgreement

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