Class: TypeMapping

name: type_mapping
description: Represents how a slot or type can be serialized to a format.
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 21
mixins:
- extensible
- annotatable
- common_metadata
slots:
- framework_key
- mapped_type
- string_serialization

name: type_mapping
description: Represents how a slot or type can be serialized to a format.
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 21
mixins:
- extensible
- annotatable
- common_metadata
attributes:
  framework_key:
    name: framework_key
    description: The name of a format that can be used to serialize LinkML data. The
      string value should be a code from the LinkML frameworks vocabulary, but this
      is not strictly enforced
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    key: true
    alias: framework
    owner: type_mapping
    domain_of:
    - type_mapping
    range: string
    required: true
  mapped_type:
    name: mapped_type
    description: type to coerce to
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    alias: type
    owner: type_mapping
    domain_of:
    - type_mapping
    range: type_definition
  string_serialization:
    name: string_serialization
    description: 'Used on a slot that stores the string serialization of the containing
      object. The syntax follows python formatted strings, with slot names enclosed
      in {}s. These are expanded using the values of those slots.

      We call the slot with the serialization the s-slot, the slots used in the {}s
      are v-slots. If both s-slots and v-slots are populated on an object then the
      value of the s-slot should correspond to the expansion.

      Implementations of frameworks may choose to use this property to either (a)
      PARSE: implement automated normalizations by parsing denormalized strings into
      complex objects (b) GENERARE: implement automated to_string labeling of complex
      objects

      For example, a Measurement class may have 3 fields: unit, value, and string_value.
      The string_value slot may have a string_serialization of {value}{unit} such
      that if unit=cm and value=2, the value of string_value shouldd be 2cm'
    in_subset:
    - SpecificationSubset
    from_schema: https://w3id.org/linkml/meta
    see_also:
    - https://github.com/linkml/issues/128
    rank: 1000
    domain: definition
    inherited: false
    alias: string_serialization
    owner: type_mapping
    domain_of:
    - definition
    - type_mapping
    range: string
  extensions:
    name: extensions
    description: a tag/text tuple attached to an arbitrary element
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: extensible
    multivalued: true
    alias: extensions
    owner: type_mapping
    domain_of:
    - extension
    - extensible
    range: extension
    inlined: true
  annotations:
    name: annotations
    description: a collection of tag/text tuples with the semantics of OWL Annotation
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    is_a: extensions
    domain: annotatable
    multivalued: true
    alias: annotations
    owner: type_mapping
    domain_of:
    - annotatable
    - annotation
    range: annotation
    inlined: true
  description:
    name: description
    description: a textual description of the element's purpose and use
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - definition
    exact_mappings:
    - dcterms:description
    - schema:description
    rank: 5
    domain: element
    slot_uri: skos:definition
    alias: description
    owner: type_mapping
    domain_of:
    - common_metadata
    - permissible_value
    range: string
    recommended: true
  alt_descriptions:
    name: alt_descriptions
    description: A sourced alternative description for an element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - alternate definitions
    rank: 1000
    domain: element
    multivalued: true
    alias: alt_descriptions
    owner: type_mapping
    domain_of:
    - common_metadata
    range: alt_description
    inlined: true
  title:
    name: title
    description: A concise human-readable display label for the element. The title
      should mirror the name, and should use ordinary textual punctuation.
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - long name
    rank: 3
    domain: element
    slot_uri: dcterms:title
    alias: title
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  deprecated:
    name: deprecated
    description: Description of why and when this element will no longer be used
    comments:
    - note that linkml does not use a boolean to indicate deprecation status - the
      presence of a string value in this field is sufficient to indicate deprecation.
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    close_mappings:
    - owl:deprecated
    rank: 1000
    domain: element
    alias: deprecated
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  todos:
    name: todos
    description: Outstanding issues that needs resolution
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    multivalued: true
    alias: todos
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  notes:
    name: notes
    description: editorial notes about an element intended primarily for internal
      consumption
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: skos:editorialNote
    multivalued: true
    alias: notes
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  comments:
    name: comments
    description: notes and comments about an element intended primarily for external
      consumption
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    exact_mappings:
    - rdfs:comment
    rank: 1000
    domain: element
    slot_uri: skos:note
    multivalued: true
    alias: comments
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  examples:
    name: examples
    description: example usages of an element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    close_mappings:
    - vann:example
    rank: 1000
    singular_name: example
    domain: element
    multivalued: true
    alias: examples
    owner: type_mapping
    domain_of:
    - common_metadata
    range: example
    inlined: true
  in_subset:
    name: in_subset
    description: used to indicate membership of a term in a defined subset of terms
      used for a particular domain or application.
    comments:
    - an example of use in the translator_minimal subset in the biolink model, holding
      the minimal set of predicates used in a translator knowledge graph
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: OIO:inSubset
    multivalued: true
    alias: in_subset
    owner: type_mapping
    domain_of:
    - common_metadata
    range: subset_definition
  from_schema:
    name: from_schema
    description: id of the schema that defined the element
    notes:
    - A stronger model would be range schema_definition, but this doesn't address
      the import model
    in_subset:
    - SpecificationSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: skos:inScheme
    readonly: supplied by the schema loader or schema view
    alias: from_schema
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uri
  imported_from:
    name: imported_from
    description: the imports entry that this element was derived from.  Empty means
      primary source
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    readonly: supplied by the schema loader or schema view
    alias: imported_from
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  source:
    name: source
    description: A related resource from which the element is derived.
    comments:
    - The described resource may be derived from the related resource in whole or
      in part
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - origin
    - derived from
    close_mappings:
    - prov:wasDerivedFrom
    - schema:isBasedOn
    rank: 1000
    domain: element
    slot_uri: dcterms:source
    alias: source
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  in_language:
    name: in_language
    conforms_to: https://www.rfc-editor.org/rfc/bcp/bcp47.txt
    description: the primary language used in the sources
    comments:
    - Recommended to use a string from IETF BCP 47
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    slot_uri: schema:inLanguage
    alias: in_language
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  see_also:
    name: see_also
    description: A list of related entities or URLs that may be of relevance
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: rdfs:seeAlso
    multivalued: true
    alias: see_also
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  deprecated element has exact replacement:
    name: deprecated element has exact replacement
    description: When an element is deprecated, it can be automatically replaced by
      this uri or curie
    from_schema: https://w3id.org/linkml/meta
    mappings:
    - IAO:0100001
    rank: 1000
    alias: deprecated_element_has_exact_replacement
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  deprecated element has possible replacement:
    name: deprecated element has possible replacement
    description: When an element is deprecated, it can be potentially replaced by
      this uri or curie
    from_schema: https://w3id.org/linkml/meta
    mappings:
    - OIO:consider
    rank: 1000
    alias: deprecated_element_has_possible_replacement
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  aliases:
    name: aliases
    description: Alternate names/labels for the element. These do not alter the semantics
      of the schema, but may be useful to support search and alignment.
    comments:
    - not be confused with the metaslot alias.
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - synonyms
    - alternate names
    - alternative labels
    - designations
    exact_mappings:
    - schema:alternateName
    rank: 1000
    domain: element
    slot_uri: skos:altLabel
    multivalued: true
    alias: aliases
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string
  structured_aliases:
    name: structured_aliases
    description: A list of structured_alias objects, used to provide aliases in conjunction
      with additional metadata.
    from_schema: https://w3id.org/linkml/meta
    see_also:
    - linkml:aliases
    rank: 1000
    slot_uri: skosxl:altLabel
    multivalued: true
    alias: structured_aliases
    owner: type_mapping
    domain_of:
    - common_metadata
    range: structured_alias
    inlined: true
  mappings:
    name: mappings
    description: A list of terms from different schemas or terminology systems that
      have comparable meaning. These may include terms that are precisely equivalent,
      broader or narrower in meaning, or otherwise semantically related but not equivalent
      from a strict ontological perspective.
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - xrefs
    - identifiers
    - alternate identifiers
    - alternate ids
    rank: 1000
    slot_uri: skos:mappingRelation
    multivalued: true
    alias: mappings
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  exact mappings:
    name: exact mappings
    description: A list of terms from different schemas or terminology systems that
      have identical meaning.
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    is_a: mappings
    slot_uri: skos:exactMatch
    multivalued: true
    inherited: false
    alias: exact_mappings
    owner: type_mapping
    domain_of:
    - common_metadata
    - UnitOfMeasure
    range: uriorcurie
  close mappings:
    name: close mappings
    description: A list of terms from different schemas or terminology systems that
      have close meaning.
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    is_a: mappings
    slot_uri: skos:closeMatch
    multivalued: true
    inherited: false
    alias: close_mappings
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  related mappings:
    name: related mappings
    description: A list of terms from different schemas or terminology systems that
      have related meaning.
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    is_a: mappings
    slot_uri: skos:relatedMatch
    multivalued: true
    inherited: false
    alias: related_mappings
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  narrow mappings:
    name: narrow mappings
    description: A list of terms from different schemas or terminology systems that
      have narrower meaning.
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    is_a: mappings
    slot_uri: skos:narrowMatch
    multivalued: true
    inherited: false
    alias: narrow_mappings
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  broad mappings:
    name: broad mappings
    description: A list of terms from different schemas or terminology systems that
      have broader meaning.
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    is_a: mappings
    slot_uri: skos:broadMatch
    multivalued: true
    inherited: false
    alias: broad_mappings
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  created_by:
    name: created_by
    description: agent that created the element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: pav:createdBy
    alias: created_by
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  contributors:
    name: contributors
    description: agent that contributed to the element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: dcterms:contributor
    multivalued: true
    alias: contributors
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  created_on:
    name: created_on
    description: time at which the element was created
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: pav:createdOn
    alias: created_on
    owner: type_mapping
    domain_of:
    - common_metadata
    range: datetime
  last_updated_on:
    name: last_updated_on
    description: time at which the element was last updated
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: pav:lastUpdatedOn
    alias: last_updated_on
    owner: type_mapping
    domain_of:
    - common_metadata
    range: datetime
  modified_by:
    name: modified_by
    description: agent that modified the element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    domain: element
    slot_uri: oslc:modifiedBy
    alias: modified_by
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  status:
    name: status
    description: status of the element
    examples:
    - value: bibo:draft
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    see_also:
    - https://www.hl7.org/fhir/valueset-publication-status.html
    - https://www.hl7.org/fhir/versions.html#std-process
    aliases:
    - workflow status
    rank: 1000
    domain: element
    slot_uri: bibo:status
    alias: status
    owner: type_mapping
    domain_of:
    - common_metadata
    range: uriorcurie
  rank:
    name: rank
    description: the relative order in which the element occurs, lower values are
      given precedence
    comments:
    - the rank of an element does not affect the semantics
    in_subset:
    - SpecificationSubset
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    aliases:
    - order
    - precedence
    - display order
    exact_mappings:
    - qudt:order
    - qb:order
    rank: 51
    slot_uri: sh:order
    alias: rank
    owner: type_mapping
    domain_of:
    - common_metadata
    - class_rule
    range: integer
  categories:
    name: categories
    description: Controlled terms used to categorize an element.
    comments:
    - if you wish to use uncontrolled terms or terms that lack identifiers then use
      the keywords element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    singular_name: category
    slot_uri: dcterms:subject
    multivalued: true
    alias: categories
    owner: type_mapping
    domain_of:
    - common_metadata
    - structured_alias
    range: uriorcurie
  keywords:
    name: keywords
    description: Keywords or tags used to describe the element
    in_subset:
    - BasicSubset
    from_schema: https://w3id.org/linkml/meta
    rank: 1000
    singular_name: keyword
    domain: element
    slot_uri: schema:keywords
    multivalued: true
    alias: keywords
    owner: type_mapping
    domain_of:
    - common_metadata
    range: string