Skip to content
common-domain-model

Class: CodeListIdentification

A type to identify the version of a codelist

URI: common_domain_model:CodeListIdentification

 classDiagram
    class CodeListIdentification
    click CodeListIdentification href "../CodeListIdentification/"
      CodeListIdentification : canonicalUri
        
      CodeListIdentification : canonicalVersionUri
        
      CodeListIdentification : codeShortId
        
      CodeListIdentification : description
        
      CodeListIdentification : locationUri
        
      CodeListIdentification : publicationDate
        
      CodeListIdentification : shortName
        
      CodeListIdentification : version

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
description 0..1
string		 A description of the code list, e direct
version 1
string		 The the most recent version of the codelist, eg direct
publicationDate 0..1
string		 The most recent date the code list was published, e direct
shortName 1
string		 A short name (without whitespace) for the code list, e direct
codeShortId 0..1
string		 The name of the code list, e direct
canonicalUri 1
string		 Canonical URI which uniquely identifies all versions (collectively) of the re… direct
canonicalVersionUri 0..1
string		 Canonical URI which uniquely identifies a specific version of the referenced … direct
locationUri 0..1
string		 Suggested retrieval location for this version, in genericode format direct

Usages

Section titled “Usages”
used by used in type used
CodeList identification range CodeListIdentification

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:CodeListIdentification
native common_domain_model:CodeListIdentification

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: CodeListIdentification
description: A type to identify the version of a codelist
from_schema: https://w3id.org/lmodel/common-domain-model
slots:
- description
- version
slot_usage:
  description:
    name: description
    description: A description of the code list, e.g. A list of codes identifying
      business centers
    range: string
  version:
    name: version
    description: The the most recent version of the codelist, eg. 9-1
    range: string
    required: true
attributes:
  publicationDate:
    name: publicationDate
    description: The most recent date the code list was published, e.g. 2021-10-05
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    domain_of:
    - CodeListIdentification
    - ContractualDefinition
    - ContractualTermsSupplement
    - SettledEntityMatrix
    range: string
  shortName:
    name: shortName
    description: A short name (without whitespace) for the code list, e.g. businessCenterScheme
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    domain_of:
    - CodeListIdentification
    range: string
    required: true
  codeShortId:
    name: codeShortId
    description: The name of the code list, e.g. business-center
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    domain_of:
    - CodeListIdentification
    range: string
  canonicalUri:
    name: canonicalUri
    description: Canonical URI which uniquely identifies all versions (collectively)
      of the referenced code list. Must be an absolute URI. Must not be used as a
      de facto location URI.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    domain_of:
    - CodeListIdentification
    range: string
    required: true
  canonicalVersionUri:
    name: canonicalVersionUri
    description: Canonical URI which uniquely identifies a specific version of the
      referenced code list. Must be an absolute URI. Must not be used as a de facto
      location URI.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    domain_of:
    - CodeListIdentification
    range: string
  locationUri:
    name: locationUri
    description: Suggested retrieval location for this version, in genericode format.
      An application must signal an error to the user if a document retrieved using
      a LocationUri is not in genericode format.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    domain_of:
    - CodeListIdentification
    range: string

Induced

Section titled “Induced”
name: CodeListIdentification
description: A type to identify the version of a codelist
from_schema: https://w3id.org/lmodel/common-domain-model
slot_usage:
  description:
    name: description
    description: A description of the code list, e.g. A list of codes identifying
      business centers
    range: string
  version:
    name: version
    description: The the most recent version of the codelist, eg. 9-1
    range: string
    required: true
attributes:
  publicationDate:
    name: publicationDate
    description: The most recent date the code list was published, e.g. 2021-10-05
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    - ContractualDefinition
    - ContractualTermsSupplement
    - SettledEntityMatrix
    range: string
  shortName:
    name: shortName
    description: A short name (without whitespace) for the code list, e.g. businessCenterScheme
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    range: string
    required: true
  codeShortId:
    name: codeShortId
    description: The name of the code list, e.g. business-center
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    range: string
  canonicalUri:
    name: canonicalUri
    description: Canonical URI which uniquely identifies all versions (collectively)
      of the referenced code list. Must be an absolute URI. Must not be used as a
      de facto location URI.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    range: string
    required: true
  canonicalVersionUri:
    name: canonicalVersionUri
    description: Canonical URI which uniquely identifies a specific version of the
      referenced code list. Must be an absolute URI. Must not be used as a de facto
      location URI.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    range: string
  locationUri:
    name: locationUri
    description: Suggested retrieval location for this version, in genericode format.
      An application must signal an error to the user if a document retrieved using
      a LocationUri is not in genericode format.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_base_staticdata_codelist
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    range: string
  description:
    name: description
    description: A description of the code list, e.g. A list of codes identifying
      business centers
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - Commodity
    - TaxonomyClassification
    - CodeListIdentification
    - CodeValue
    - OtherIndex
    range: string
  version:
    name: version
    description: The the most recent version of the codelist, eg. 9-1
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CodeListIdentification
    domain_of:
    - CodeListIdentification
    - AssignedIdentifier
    - OtherAgreement
    range: string
    required: true