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

erDiagram
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  
}
Comment {
    string text  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
Coding {
    string code  
    string decode  
    string codeSystem  
    string codeSystemVersion  
    AliasPredicate aliasType  
}
DocumentReference {
    string title  
    string leafID  
    integerList pages  
    string relationship  
    string version  
    string href  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
Resource {
    string resourceType  
    string attribute  
    string version  
    string href  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
FormalExpression {
    string context  
    string expression  
    string returnType  
    string OID  
    string uuid  
    string name  
    string description  
    string label  
    stringList aliases  
}
CodeListItem {
    string codedValue  
    string decode  
    string description  
    stringList aliases  
    decimal weight  
    boolean other  
}

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

Inheritance

GovernedElement [ Identifiable Labelled Governed]
- CodeList [ Versioned]

Slots

Name	Cardinality and Range	Description	Inheritance
dataType	0..1 DataType	The data type for the values in the code list	direct
formatName	0..1 String	Name of a standard format definition	direct
codeListItems	* CodeListItem	The individual values that make up this CodeList. The type of CodeListItem included determines its behaviour	direct
externalCodeList	0..1 Resource	Reference to a code list that is defined externally to this study	direct
version	0..1 String	The version of the external resources	Versioned
href	0..1 String	Machine-readable instructions to obtain the resource e.g. FHIR path, URL	Versioned
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
mandatory	0..1 Boolean	Is this element required?	Governed
comments	* Comment	Comment on the element, such as a rationale for its inclusion or exclusion	Governed
siteOrSponsorComments	* Comment	Comment on the element, such as a rationale for its inclusion or exclusion	Governed
purpose	0..1 String or String or TranslatedText	Purpose or rationale for this data element	Governed
lastUpdated	0..1 Datetime	When the resource was last updated	Governed
owner	0..1 String or User or Organization or String	Party responsible for this element	Governed
wasDerivedFrom	0..1 String or Item or ItemGroup or MetaDataVersion or CodeList or ReifiedConcept or ConceptProperty or Condition or Method or NominalOccurrence or Dataflow or CubeComponent or DataProduct or ProvisionAgreement	Reference to another item that this item implements or extends, e.g. a template Item definition.	Governed

Usages

used by	used in	type	used
GovernedElement	wasDerivedFrom	any_of[range]	CodeList
Governed	wasDerivedFrom	any_of[range]	CodeList
IsODMItem	roleCodeList	range	CodeList
MetaDataVersion	codeLists	range	CodeList
MetaDataVersion	wasDerivedFrom	any_of[range]	CodeList
Item	codeList	range	CodeList
Item	roleCodeList	range	CodeList
Item	wasDerivedFrom	any_of[range]	CodeList
ItemGroup	wasDerivedFrom	any_of[range]	CodeList
CodeList	wasDerivedFrom	any_of[range]	CodeList
ReifiedConcept	wasDerivedFrom	any_of[range]	CodeList
ConceptProperty	codeList	range	CodeList
ConceptProperty	wasDerivedFrom	any_of[range]	CodeList
Condition	wasDerivedFrom	any_of[range]	CodeList
Method	wasDerivedFrom	any_of[range]	CodeList
Parameter	codeList	range	CodeList
SiteOrSponsorComment	wasDerivedFrom	any_of[range]	CodeList
NominalOccurrence	wasDerivedFrom	any_of[range]	CodeList
DataStructureDefinition	wasDerivedFrom	any_of[range]	CodeList
Dataflow	wasDerivedFrom	any_of[range]	CodeList
CubeComponent	wasDerivedFrom	any_of[range]	CodeList
Measure	wasDerivedFrom	any_of[range]	CodeList
Dimension	wasDerivedFrom	any_of[range]	CodeList
DataAttribute	wasDerivedFrom	any_of[range]	CodeList
DataProduct	wasDerivedFrom	any_of[range]	CodeList
ProvisionAgreement	wasDerivedFrom	any_of[range]	CodeList

Identifier and Mapping Information

Schema Source

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

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/define-json
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
attributes:
  dataType:
    name: dataType
    description: The data type for the values in the code list
    from_schema: https://cdisc.org/define-json
    domain_of:
    - Item
    - CodeList
    - Parameter
    - ReturnValue
    range: DataType
  formatName:
    name: formatName
    description: Name of a standard format definition
    from_schema: https://cdisc.org/define-json
    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/define-json
    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/define-json
    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/define-json
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
attributes:
  dataType:
    name: dataType
    description: The data type for the values in the code list
    from_schema: https://cdisc.org/define-json
    alias: dataType
    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/define-json
    rank: 1000
    alias: formatName
    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/define-json
    rank: 1000
    alias: codeListItems
    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/define-json
    rank: 1000
    alias: externalCodeList
    owner: CodeList
    domain_of:
    - CodeList
    range: Resource
  version:
    name: version
    description: The version of the external resources
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: version
    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/define-json
    rank: 1000
    alias: href
    owner: CodeList
    domain_of:
    - Versioned
    range: string
    required: false
  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: CodeList
    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: CodeList
    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: CodeList
    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: 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/define-json
    rank: 1000
    alias: coding
    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/define-json
    exact_mappings:
    - skos:prefLabel
    rank: 1000
    alias: label
    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/define-json
    exact_mappings:
    - skos:altLabel
    rank: 1000
    alias: aliases
    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/define-json
    rank: 1000
    alias: mandatory
    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/define-json
    rank: 1000
    alias: comments
    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/define-json
    rank: 1000
    alias: siteOrSponsorComments
    owner: CodeList
    domain_of:
    - Governed
    range: Comment
    multivalued: true
    inlined: false
  purpose:
    name: purpose
    description: Purpose or rationale for this data element
    from_schema: https://cdisc.org/define-json
    rank: 1000
    alias: purpose
    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/define-json
    rank: 1000
    alias: lastUpdated
    owner: CodeList
    domain_of:
    - Governed
    range: datetime
  owner:
    name: owner
    description: Party responsible for this element
    from_schema: https://cdisc.org/define-json
    narrow_mappings:
    - prov:wasAttributedTo
    - prov:wasAssociatedBy
    rank: 1000
    alias: owner
    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/define-json
    exact_mappings:
    - prov:wasDerivedFrom
    rank: 1000
    alias: wasDerivedFrom
    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