Skip to content

Class: CodeValue

A type to hold the value of the code in a codelist

URI: common_domain_model:CodeValue

 classDiagram
    class CodeValue
    click CodeValue href "../CodeValue/"
      CodeValue : deprecatedDate

      CodeValue : description

      CodeValue : effectiveDate

      CodeValue : source

      CodeValue : value

Slots

Name Cardinality and Range Description Inheritance
value 1
string		 The value of the code, e direct
description 0..1
string		 A description of the meaning of the code, e direct
source 0..1
string		 Where the code was defined,e direct
effectiveDate 0..1
date		 When the code became/becomes effective direct
deprecatedDate 0..1
date		 When the code ceased to be valid for new uses direct

Usages

used by used in type used
CodeList codes range CodeValue

In Subsets

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self common_domain_model:CodeValue
native common_domain_model:CodeValue
close fpml_5_10:CodeValue

LinkML Source

Direct

name: CodeValue
description: A type to hold the value of the code in a codelist
in_subset:
- cdm_base_staticdata_codelist
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:CodeValue
slots:
- value
- description
- source
- effectiveDate
- deprecatedDate
slot_usage:
  value:
    name: value
    description: The value of the code, e.g. USNY
    range: string
    required: true
  description:
    name: description
    description: A description of the meaning of the code, e.g. New York City, USA
  source:
    name: source
    description: Where the code was defined,e.g. ISDA, FpML, Bloomberg
    range: string
    required: false

Induced

name: CodeValue
description: A type to hold the value of the code in a codelist
in_subset:
- cdm_base_staticdata_codelist
from_schema: https://w3id.org/lmodel/common-domain-model
close_mappings:
- fpml_5_10:CodeValue
slot_usage:
  value:
    name: value
    description: The value of the code, e.g. USNY
    range: string
    required: true
  description:
    name: description
    description: A description of the meaning of the code, e.g. New York City, USA
  source:
    name: source
    description: Where the code was defined,e.g. ISDA, FpML, Bloomberg
    range: string
    required: false
attributes:
  value:
    name: value
    description: The value of the code, e.g. USNY
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CodeValue
    domain_of:
    - MeasureBase
    - Schedule
    - DatedValue
    - Taxonomy
    - TaxonomyClassification
    - CodeValue
    - AdjustmentFactor
    - AccrualFactor
    - DisputeResolution
    - OtherEligibleAndPostedSupport
    - CSAThresholdVariableSet
    - CSAMinimumTransferAmountVariableSet
    - MasterAgreementVariableSet
    range: string
    required: true
  description:
    name: description
    description: A description of the meaning of the code, e.g. New York City, USA
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:Commodity.description
    rank: 1000
    owner: CodeValue
    domain_of:
    - Commodity
    - TaxonomyClassification
    - CodeListIdentification
    - CodeValue
    - OtherIndex
    range: string
  source:
    name: source
    description: Where the code was defined,e.g. ISDA, FpML, Bloomberg
    from_schema: https://w3id.org/lmodel/common-domain-model
    rank: 1000
    owner: CodeValue
    domain_of:
    - ProductIdentifier
    - Taxonomy
    - CodeValue
    - Valuation
    range: string
    required: false
  effectiveDate:
    name: effectiveDate
    description: When the code became/becomes effective
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CodeValue.effectiveDate
    rank: 1000
    owner: CodeValue
    domain_of:
    - CodeValue
    - CounterpartyPositionBusinessEvent
    - IndexTransitionInstruction
    - StockSplitInstruction
    - ClosedState
    - EventInstruction
    - LegalAgreementBase
    - MinimumTransferAmountAmendment
    - TerminationCurrencyAmendment
    - PriceQuantity
    - FallbackRateParameters
    - CalculationPeriodDates
    - EconomicTerms
    - CancelableProvision
    range: date
  deprecatedDate:
    name: deprecatedDate
    description: When the code ceased to be valid for new uses
    from_schema: https://w3id.org/lmodel/common-domain-model
    close_mappings:
    - fpml_5_10:CodeValue.deprecatedDate
    rank: 1000
    owner: CodeValue
    domain_of:
    - CodeValue
    range: date