Class: EnumDefinition
an element whose instances must be drawn from a specified set of permissible values
classDiagram
class EnumDefinition
EnumExpression <|-- EnumDefinition
Definition <|-- EnumDefinition
EnumDefinition : abstract
EnumDefinition : aliases
EnumDefinition : alt_descriptions
EnumDefinition --> alt_description : alt_descriptions
EnumDefinition : annotations
EnumDefinition --> annotation : annotations
EnumDefinition : apply_to
EnumDefinition --> definition : apply_to
EnumDefinition : broad_mappings
EnumDefinition : categories
EnumDefinition : close_mappings
EnumDefinition : code_set
EnumDefinition : code_set_tag
EnumDefinition : code_set_version
EnumDefinition : comments
EnumDefinition : concepts
EnumDefinition : conforms_to
EnumDefinition : contributors
EnumDefinition : created_by
EnumDefinition : created_on
EnumDefinition : definition_uri
EnumDefinition : deprecated
EnumDefinition : deprecated_element_has_exact_replacement
EnumDefinition : deprecated_element_has_possible_replacement
EnumDefinition : description
EnumDefinition : enum_uri
EnumDefinition : exact_mappings
EnumDefinition : examples
EnumDefinition --> example : examples
EnumDefinition : extensions
EnumDefinition --> extension : extensions
EnumDefinition : from_schema
EnumDefinition : id_prefixes
EnumDefinition : id_prefixes_are_closed
EnumDefinition : implements
EnumDefinition : imported_from
EnumDefinition : in_language
EnumDefinition : in_subset
EnumDefinition --> subset_definition : in_subset
EnumDefinition : include
EnumDefinition --> anonymous_enum_expression : include
EnumDefinition : inherits
EnumDefinition --> enum_definition : inherits
EnumDefinition : instantiates
EnumDefinition : is_a
EnumDefinition --> definition : is_a
EnumDefinition : keywords
EnumDefinition : last_updated_on
EnumDefinition : local_names
EnumDefinition --> local_name : local_names
EnumDefinition : mappings
EnumDefinition : matches
EnumDefinition --> match_query : matches
EnumDefinition : minus
EnumDefinition --> anonymous_enum_expression : minus
EnumDefinition : mixin
EnumDefinition : mixins
EnumDefinition --> definition : mixins
EnumDefinition : modified_by
EnumDefinition : name
EnumDefinition : narrow_mappings
EnumDefinition : notes
EnumDefinition : permissible_values
EnumDefinition --> permissible_value : permissible_values
EnumDefinition : pv_formula
EnumDefinition --> pv_formula_options : pv_formula
EnumDefinition : rank
EnumDefinition : reachable_from
EnumDefinition --> reachability_query : reachable_from
EnumDefinition : related_mappings
EnumDefinition : see_also
EnumDefinition : source
EnumDefinition : status
EnumDefinition : string_serialization
EnumDefinition : structured_aliases
EnumDefinition --> structured_alias : structured_aliases
EnumDefinition : title
EnumDefinition : todos
EnumDefinition : values_from
Inheritance
- Element [ Extensible Annotatable CommonMetadata]
- Definition
- EnumDefinition [ EnumExpression]
- Definition
Slots
Name | Cardinality and Range | Description | Inheritance |
---|---|---|---|
enum_uri | 0..1 Uriorcurie |
URI of the enum that provides a semantic interpretation of the element in a l... | direct |
code_set | 0..1 Uriorcurie |
the identifier of an enumeration code set | EnumExpression |
code_set_tag | 0..1 String |
the version tag of the enumeration code set | EnumExpression |
code_set_version | 0..1 String |
the version identifier of the enumeration code set | EnumExpression |
pv_formula | 0..1 PvFormulaOptions |
Defines the specific formula to be used to generate the permissible values | EnumExpression |
permissible_values | 0..* PermissibleValue |
A list of possible values for a slot range | EnumExpression |
include | 0..* AnonymousEnumExpression |
An enum expression that yields a list of permissible values that are to be in... | EnumExpression |
minus | 0..* AnonymousEnumExpression |
An enum expression that yields a list of permissible values that are to be su... | EnumExpression |
inherits | 0..* EnumDefinition |
An enum definition that is used as the basis to create a new enum | EnumExpression |
reachable_from | 0..1 ReachabilityQuery |
Specifies a query for obtaining a list of permissible values based on graph r... | EnumExpression |
matches | 0..1 MatchQuery |
Specifies a match query that is used to calculate the list of permissible val... | EnumExpression |
concepts | 0..* Uriorcurie |
A list of identifiers that are used to construct a set of permissible values | EnumExpression |
is_a | 0..1 Definition |
A primary parent class or slot from which inheritable metaslots are propagate... | Definition |
abstract | 0..1 Boolean |
Indicates the class or slot cannot be directly instantiated and is intended f... | Definition |
mixin | 0..1 Boolean |
Indicates the class or slot is intended to be inherited from without being an... | Definition |
mixins | 0..* Definition |
A collection of secondary parent classes or slots from which inheritable meta... | Definition |
apply_to | 0..* Definition |
Used to extend class or slot definitions | Definition |
values_from | 0..* Uriorcurie |
The identifier of a "value set" -- a set of identifiers that form the possibl... | Definition |
string_serialization | 0..1 String |
Used on a slot that stores the string serialization of the containing object | Definition |
name | 1..1 String |
the unique name of the element within the context of the schema | Element |
id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform | Element |
id_prefixes_are_closed | 0..1 Boolean |
If true, then the id_prefixes slot is treated as being closed, and any use of... | Element |
definition_uri | 0..1 Uriorcurie |
The native URI of the element | Element |
local_names | 0..* LocalName |
Element | |
conforms_to | 0..1 String |
An established standard to which the element conforms | Element |
implements | 0..* Uriorcurie |
An element in another schema which this element conforms to | Element |
instantiates | 0..* Uriorcurie |
An element in another schema which this element instantiates | Element |
extensions | 0..* Extension |
a tag/text tuple attached to an arbitrary element | Extensible |
annotations | 0..* Annotation |
a collection of tag/text tuples with the semantics of OWL Annotation | Annotatable |
description | 0..1 recommended String |
a textual description of the element's purpose and use | CommonMetadata |
alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element | CommonMetadata |
title | 0..1 String |
A concise human-readable display label for the element | CommonMetadata |
deprecated | 0..1 String |
Description of why and when this element will no longer be used | CommonMetadata |
todos | 0..* String |
Outstanding issues that needs resolution | CommonMetadata |
notes | 0..* String |
editorial notes about an element intended primarily for internal consumption | CommonMetadata |
comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... | CommonMetadata |
examples | 0..* Example |
example usages of an element | CommonMetadata |
in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... | CommonMetadata |
from_schema | 0..1 Uri |
id of the schema that defined the element | CommonMetadata |
imported_from | 0..1 String |
the imports entry that this element was derived from | CommonMetadata |
source | 0..1 Uriorcurie |
A related resource from which the element is derived | CommonMetadata |
in_language | 0..1 String |
the primary language used in the sources | CommonMetadata |
see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance | CommonMetadata |
deprecated_element_has_exact_replacement | 0..1 Uriorcurie |
When an element is deprecated, it can be automatically replaced by this uri o... | CommonMetadata |
deprecated_element_has_possible_replacement | 0..1 Uriorcurie |
When an element is deprecated, it can be potentially replaced by this uri or ... | CommonMetadata |
aliases | 0..* String |
Alternate names/labels for the element | CommonMetadata |
structured_aliases | 0..* StructuredAlias |
A list of structured_alias objects, used to provide aliases in conjunction wi... | CommonMetadata |
mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have compa... | CommonMetadata |
exact_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have ident... | CommonMetadata |
close_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have close... | CommonMetadata |
related_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have relat... | CommonMetadata |
narrow_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have narro... | CommonMetadata |
broad_mappings | 0..* Uriorcurie |
A list of terms from different schemas or terminology systems that have broad... | CommonMetadata |
created_by | 0..1 Uriorcurie |
agent that created the element | CommonMetadata |
contributors | 0..* Uriorcurie |
agent that contributed to the element | CommonMetadata |
created_on | 0..1 Datetime |
time at which the element was created | CommonMetadata |
last_updated_on | 0..1 Datetime |
time at which the element was last updated | CommonMetadata |
modified_by | 0..1 Uriorcurie |
agent that modified the element | CommonMetadata |
status | 0..1 Uriorcurie |
status of the element | CommonMetadata |
rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... | CommonMetadata |
categories | 0..* Uriorcurie |
Controlled terms used to categorize an element | CommonMetadata |
keywords | 0..* String |
Keywords or tags used to describe the element | CommonMetadata |
Usages
used by | used in | type | used |
---|---|---|---|
SchemaDefinition | enums | range | EnumDefinition |
EnumExpression | inherits | range | EnumDefinition |
AnonymousEnumExpression | inherits | range | EnumDefinition |
EnumDefinition | enum_uri | domain | EnumDefinition |
EnumDefinition | inherits | range | EnumDefinition |
EnumBinding | range | range | EnumDefinition |
Aliases
- enum
- enumeration
- semantic enumeration
- value set
- term set
- concept set
- code set
- Terminology Value Set
- answer list
- value domain
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/linkml/meta
Mappings
Mapping Type | Mapped Value |
---|---|
self | linkml:EnumDefinition |
native | linkml:EnumDefinition |
exact | qb:HierarchicalCodeList, NCIT:C113497, cdisc:ValueDomain |
close | skos:ConceptScheme |
LinkML Source
Direct
name: enum_definition
description: an element whose instances must be drawn from a specified set of permissible
values
in_subset:
- SpecificationSubset
- BasicSubset
- RelationalModelProfile
- ObjectOrientedProfile
- OwlProfile
from_schema: https://w3id.org/linkml/meta
aliases:
- enum
- enumeration
- semantic enumeration
- value set
- term set
- concept set
- code set
- Terminology Value Set
- answer list
- value domain
exact_mappings:
- qb:HierarchicalCodeList
- NCIT:C113497
- cdisc:ValueDomain
close_mappings:
- skos:ConceptScheme
rank: 5
is_a: definition
mixins:
- enum_expression
slots:
- enum_uri
Induced
name: enum_definition
description: an element whose instances must be drawn from a specified set of permissible
values
in_subset:
- SpecificationSubset
- BasicSubset
- RelationalModelProfile
- ObjectOrientedProfile
- OwlProfile
from_schema: https://w3id.org/linkml/meta
aliases:
- enum
- enumeration
- semantic enumeration
- value set
- term set
- concept set
- code set
- Terminology Value Set
- answer list
- value domain
exact_mappings:
- qb:HierarchicalCodeList
- NCIT:C113497
- cdisc:ValueDomain
close_mappings:
- skos:ConceptScheme
rank: 5
is_a: definition
mixins:
- enum_expression
attributes:
enum_uri:
name: enum_uri
description: URI of the enum that provides a semantic interpretation of the element
in a linked data context. The URI may come from any namespace and may be shared
between schemas
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- public ID
rank: 1000
domain: enum_definition
ifabsent: class_curie
alias: enum_uri
owner: enum_definition
domain_of:
- enum_definition
range: uriorcurie
code_set:
name: code_set
description: the identifier of an enumeration code set.
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
alias: code_set
owner: enum_definition
domain_of:
- enum_expression
range: uriorcurie
code_set_tag:
name: code_set_tag
description: the version tag of the enumeration code set
comments:
- enum_expression cannot have both a code_set_tag and a code_set_version
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
alias: code_set_tag
owner: enum_definition
domain_of:
- enum_expression
range: string
code_set_version:
name: code_set_version
description: the version identifier of the enumeration code set
comments:
- we assume that version identifiers lexically sort in temporal order. Recommend
semver when possible
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
alias: code_set_version
owner: enum_definition
domain_of:
- enum_expression
range: string
pv_formula:
name: pv_formula
description: Defines the specific formula to be used to generate the permissible
values.
comments:
- you cannot have BOTH the permissible_values and permissible_value_formula tag
- code_set must be supplied for this to be valid
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
alias: pv_formula
owner: enum_definition
domain_of:
- enum_expression
- enum_binding
range: pv_formula_options
permissible_values:
name: permissible_values
description: A list of possible values for a slot range
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
aliases:
- coded values
exact_mappings:
- cdisc:PermissibleValue
rank: 1000
domain: enum_expression
multivalued: true
alias: permissible_values
owner: enum_definition
domain_of:
- enum_expression
range: permissible_value
inlined: true
include:
name: include
description: An enum expression that yields a list of permissible values that
are to be included, after subtracting the minus set
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
multivalued: true
alias: include
owner: enum_definition
domain_of:
- enum_expression
range: anonymous_enum_expression
minus:
name: minus
description: An enum expression that yields a list of permissible values that
are to be subtracted from the enum
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
multivalued: true
alias: minus
owner: enum_definition
domain_of:
- enum_expression
range: anonymous_enum_expression
inherits:
name: inherits
description: An enum definition that is used as the basis to create a new enum
comments:
- All permissible values for all inherited enums are copied to form the initial
seed set
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
multivalued: true
alias: inherits
owner: enum_definition
domain_of:
- enum_expression
range: enum_definition
reachable_from:
name: reachable_from
description: Specifies a query for obtaining a list of permissible values based
on graph reachability
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
alias: reachable_from
owner: enum_definition
domain_of:
- enum_expression
range: reachability_query
matches:
name: matches
description: Specifies a match query that is used to calculate the list of permissible
values
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
alias: matches
owner: enum_definition
domain_of:
- enum_expression
range: match_query
concepts:
name: concepts
description: A list of identifiers that are used to construct a set of permissible
values
in_subset:
- SpecificationSubset
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: enum_expression
multivalued: true
alias: concepts
owner: enum_definition
domain_of:
- enum_expression
range: uriorcurie
is_a:
name: is_a
description: A primary parent class or slot from which inheritable metaslots are
propagated from. While multiple inheritance is not allowed, mixins can be provided
effectively providing the same thing. The semantics are the same when translated
to formalisms that allow MI (e.g. RDFS/OWL). When translating to a SI framework
(e.g. java classes, python classes) then is a is used. When translating a framework
without polymorphism (e.g. json-schema, solr document schema) then is a and
mixins are recursively unfolded
in_subset:
- SpecificationSubset
- BasicSubset
- ObjectOrientedProfile
- OwlProfile
from_schema: https://w3id.org/linkml/meta
rank: 11
abstract: true
alias: is_a
owner: enum_definition
domain_of:
- definition
- anonymous_class_expression
- permissible_value
range: definition
abstract:
name: abstract
description: Indicates the class or slot cannot be directly instantiated and is
intended for grouping purposes.
in_subset:
- SpecificationSubset
- BasicSubset
- ObjectOrientedProfile
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: definition
alias: abstract
owner: enum_definition
domain_of:
- definition
range: boolean
mixin:
name: mixin
description: Indicates the class or slot is intended to be inherited from without
being an is_a parent. mixins should not be inherited from using is_a, except
by other mixins.
in_subset:
- SpecificationSubset
- BasicSubset
- ObjectOrientedProfile
from_schema: https://w3id.org/linkml/meta
see_also:
- https://en.wikipedia.org/wiki/Mixin
aliases:
- trait
rank: 1000
domain: definition
alias: mixin
owner: enum_definition
domain_of:
- definition
range: boolean
mixins:
name: mixins
description: A collection of secondary parent classes or slots from which inheritable
metaslots are propagated from.
comments:
- mixins act in the same way as parents (is_a). They allow a model to have a primary
strict hierarchy, while keeping the benefits of multiple inheritance
in_subset:
- SpecificationSubset
- BasicSubset
- ObjectOrientedProfile
- OwlProfile
from_schema: https://w3id.org/linkml/meta
see_also:
- https://en.wikipedia.org/wiki/Mixin
aliases:
- traits
rank: 13
multivalued: true
alias: mixins
owner: enum_definition
domain_of:
- definition
- permissible_value
range: definition
apply_to:
name: apply_to
description: Used to extend class or slot definitions. For example, if we have
a core schema where a gene has two slots for identifier and symbol, and we have
a specialized schema for my_organism where we wish to add a slot systematic_name,
we can avoid subclassing by defining a class gene_my_organism, adding the slot
to this class, and then adding an apply_to pointing to the gene class. The new
slot will be 'injected into' the gene class.
from_schema: https://w3id.org/linkml/meta
status: testing
rank: 1000
domain: definition
multivalued: true
alias: apply_to
owner: enum_definition
domain_of:
- definition
range: definition
values_from:
name: values_from
description: 'The identifier of a "value set" -- a set of identifiers that form
the possible values for the range of a slot. Note: this is different than ''subproperty_of''
in that ''subproperty_of'' is intended to be a single ontology term while ''values_from''
is the identifier of an entire value set. Additionally, this is different than
an enumeration in that in an enumeration, the values of the enumeration are
listed directly in the model itself. Setting this property on a slot does not
guarantee an expansion of the ontological hierarchy into an enumerated list
of possible values in every serialization of the model.'
from_schema: https://w3id.org/linkml/meta
status: testing
rank: 1000
domain: definition
multivalued: true
alias: values_from
owner: enum_definition
domain_of:
- definition
range: uriorcurie
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: enum_definition
domain_of:
- definition
- type_mapping
range: string
name:
name: name
description: the unique name of the element within the context of the schema. Name
is combined with the default prefix to form the globally unique subject of the
target class.
in_subset:
- SpecificationSubset
- OwlProfile
- MinimalSubset
- BasicSubset
- RelationalModelProfile
- ObjectOrientedProfile
from_schema: https://w3id.org/linkml/meta
see_also:
- https://en.wikipedia.org/wiki/Data_element_name
- https://linkml.io/linkml/faq/modeling.html#why-are-my-class-names-translated-to-camelcase
aliases:
- short name
- unique name
exact_mappings:
- schema:name
rank: 1
domain: element
slot_uri: rdfs:label
identifier: true
alias: name
owner: enum_definition
domain_of:
- element
range: string
required: true
id_prefixes:
name: id_prefixes
description: An allowed list of prefixes for which identifiers must conform. The
identifier of this class or slot must begin with the URIs referenced by this
prefix
comments:
- Order of elements may be used to indicate priority order
- If identifiers are treated as CURIEs, then the CURIE must start with one of
the indicated prefixes followed by `:` (_should_ start if the list is open)
- If identifiers are treated as URIs, then the URI string must start with the
expanded for of the prefix (_should_ start if the list is open)
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- https://github.com/linkml/linkml-model/issues/28
rank: 1000
domain: element
multivalued: true
alias: id_prefixes
owner: enum_definition
domain_of:
- element
range: ncname
id_prefixes_are_closed:
name: id_prefixes_are_closed
description: If true, then the id_prefixes slot is treated as being closed, and
any use of an id that does not have this prefix is considered a violation.
from_schema: https://w3id.org/linkml/meta
see_also:
- https://github.com/linkml/linkml/issues/194
rank: 1000
domain: element
alias: id_prefixes_are_closed
owner: enum_definition
domain_of:
- element
range: boolean
definition_uri:
name: definition_uri
description: The native URI of the element. This is always within the namespace
of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri
comments:
- Formed by combining the default_prefix with the normalized element name
from_schema: https://w3id.org/linkml/meta
see_also:
- linkml:class_uri
- linkml:slot_uri
rank: 1000
domain: element
readonly: filled in by the schema loader or schema view
alias: definition_uri
owner: enum_definition
domain_of:
- element
range: uriorcurie
local_names:
name: local_names
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
multivalued: true
alias: local_names
owner: enum_definition
domain_of:
- element
range: local_name
inlined: true
conforms_to:
name: conforms_to
description: An established standard to which the element conforms.
in_subset:
- BasicSubset
from_schema: https://w3id.org/linkml/meta
see_also:
- linkml:implements
rank: 1000
domain: element
slot_uri: dcterms:conformsTo
alias: conforms_to
owner: enum_definition
domain_of:
- element
range: string
implements:
name: implements
description: An element in another schema which this element conforms to. The
referenced element is not imported into the schema for the implementing element.
However, the referenced schema may be used to check conformance of the implementing
element.
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
multivalued: true
alias: implements
owner: enum_definition
domain_of:
- element
- permissible_value
range: uriorcurie
instantiates:
name: instantiates
description: An element in another schema which this element instantiates.
from_schema: https://w3id.org/linkml/meta
rank: 1000
domain: element
multivalued: true
alias: instantiates
owner: enum_definition
domain_of:
- element
- permissible_value
range: uriorcurie
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
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: enum_definition
domain_of:
- common_metadata
range: string