Subset: BasicSubset
An extension of MinimalSubset that avoids advanced constructs and can be implemented by a broad variety of tools.
__
This subset roughly corresponds to the union of most standard constructs used in relational datamodel modeling,
object oriented modeling, and simple JSON-style modeling, while avoiding more advanced constructs from these languages.
__
It is often possible to translate from a more expressive schema to a BasicSubset schema, through a schema derivation
process
URI: BasicSubset
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/linkml/meta
Classes in subset
| Class | Description |
|---|---|
| SchemaDefinition | A collection of definitions that make up a schema or a data model |
| ClassDefinition | an element whose instances are complex objects that may have slot-value assig... |
| SlotDefinition | an element that describes how instances are related to other instances |
| TypeDefinition | an element that whose instances are atomic scalar values that can be mapped t... |
| EnumDefinition | an element whose instances must be drawn from a specified set of permissible ... |
| SubsetDefinition | an element that can be used to group other metamodel elements |
| Prefix | prefix URI tuple |
| PermissibleValue | a permissible value, accompanied by intended text and an optional mapping to ... |
| UniqueKey | a collection of slots whose values uniquely identify an instance of a class |
| CommonMetadata | Generic metadata shared across definitions |
| Element | A named element in the model |
| Definition | abstract base class for core metaclasses |
| Example | usage example and description |
| AltDescription | an attributed description |
SchemaDefinition
A collection of definitions that make up a schema or a data model.
| Name | Cardinality and Range | Description |
|---|---|---|
| id | 1..1 Uri |
The official schema URI |
| name | 1..1 Ncname |
a unique name for the schema that is both human-readable and consists of only... identifier |
| classes | 0..* ClassDefinition |
An index to the collection of all class definitions in the schema |
| title | 0..1 String |
A concise human-readable display label for the element |
| slot_definitions | 0..* SlotDefinition |
An index to the collection of all slot definitions in the schema |
| enums | 0..* EnumDefinition |
An index to the collection of all enum definitions in the schema |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| types | 0..* TypeDefinition |
An index to the collection of all type definitions in the schema |
| subsets | 0..* SubsetDefinition |
An index to the collection of all subset definitions in the schema |
| prefixes | 0..* Prefix |
A collection of prefix expansions that specify how CURIEs can be expanded to ... |
| default_prefix | 0..1 String |
The prefix that is used for all elements within a schema |
| default_range | 0..1 TypeDefinition |
default slot range to be used if range element is omitted from a slot definit... |
| imports | 0..* Uriorcurie |
A list of schemas that are to be included in this schema |
| license | 0..1 String |
license for the schema |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| version | 0..1 String |
particular version of schema |
| default_curi_maps | 0..* String |
ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes... |
| metamodel_version | 0..1 String |
Version of the metamodel used to load the schema |
| source_file | 0..1 String |
name, uri or description of the source of the schema |
| source_file_date | 0..1 Datetime |
modification date of the source of the schema |
| source_file_size | 0..1 Integer |
size in bytes of the source of the schema |
| generation_date | 0..1 Datetime |
date and time that the schema was loaded/generated |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
ClassDefinition
an element whose instances are complex objects that may have slot-value assignments
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| class_uri | 0..1 Uriorcurie |
URI of the class that provides a semantic interpretation of the element in a ... |
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| is_a | 0..1 ClassDefinition |
A primary parent class from which inheritable metaslots are propagated |
| mixins | 0..* ClassDefinition |
A collection of secondary parent mixin classes from which inheritable metaslo... |
| slots | 0..* SlotDefinition |
collection of slot names that are applicable to a class |
| slot_usage | 0..* SlotDefinition |
the refinement of a slot in the context of the containing class definition |
| attributes | 0..* SlotDefinition |
Inline definition of slots |
| tree_root | 0..1 Boolean |
Indicates that this is the Container class which forms the root of the serial... |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| unique_keys | 0..* UniqueKey |
A collection of named unique keys for this class |
| abstract | 0..1 Boolean |
Indicates the class or slot cannot be directly instantiated and is intended f... |
| mixin | 0..1 Boolean |
Indicates the class or slot is intended to be inherited from without being an... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
SlotDefinition
an element that describes how instances are related to other instances
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| slot_uri | 0..1 Uriorcurie |
URI of the class that provides a semantic interpretation of the slot in a lin... |
| title | 0..1 String |
A concise human-readable display label for the element |
| identifier | 0..1 Boolean |
True means that the key slot(s) uniquely identifies the elements |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| multivalued | 0..1 Boolean |
true means that slot can have more than one value and should be represented u... |
| required | 0..1 Boolean |
true means that the slot must be present in instances of the class definition |
| recommended | 0..1 Boolean |
true means that the slot should be present in instances of the class definiti... |
| is_a | 0..1 SlotDefinition |
A primary parent slot from which inheritable metaslots are propagated |
| mixins | 0..* SlotDefinition |
A collection of secondary parent mixin slots from which inheritable metaslots... |
| inlined | 0..1 Boolean |
True means that keyed or identified slot appears in an outer structure by val... |
| inlined_as_list | 0..1 Boolean |
True means that an inlined slot is represented as a list of range instances |
| pattern | 0..1 String |
the string value of the slot must conform to this regular expression expresse... |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| singular_name | 0..1 String |
a name that is used in the singular form |
| key | 0..1 Boolean |
True means that the key slot(s) uniquely identify the elements within a singl... |
| slot_group | 0..1 SlotDefinition |
allows for grouping of related slots into a grouping slot that serves the rol... |
| is_grouping_slot | 0..1 Boolean |
true if this slot is a grouping slot |
| range | 0..1 Element |
defines the type of the object of the slot |
| minimum_value | 0..1 Integer |
for slots with ranges of type number, the value must be equal to or higher th... |
| maximum_value | 0..1 Integer |
for slots with ranges of type number, the value must be equal to or lowe than... |
| abstract | 0..1 Boolean |
Indicates the class or slot cannot be directly instantiated and is intended f... |
| mixin | 0..1 Boolean |
Indicates the class or slot is intended to be inherited from without being an... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
TypeDefinition
an element that whose instances are atomic scalar values that can be mapped to primitive types
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| type_uri | 0..1 Uriorcurie |
The uri that defines the possible values for the type definition |
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| typeof | 0..1 TypeDefinition |
A parent type from which type properties are inherited |
| base | 0..1 String |
python base type in the LinkML runtime that implements this type definition |
| repr | 0..1 String |
the name of the python object that implements this type definition |
| pattern | 0..1 String |
the string value of the slot must conform to this regular expression expresse... |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| minimum_value | 0..1 Integer |
for slots with ranges of type number, the value must be equal to or higher th... |
| maximum_value | 0..1 Integer |
for slots with ranges of type number, the value must be equal to or lowe than... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
EnumDefinition
an element whose instances must be drawn from a specified set of permissible values
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| is_a | 0..1 Definition |
A primary parent class or slot from which inheritable metaslots are propagate... |
| mixins | 0..* Definition |
A collection of secondary parent classes or slots from which inheritable meta... |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| enum_uri | 0..1 Uriorcurie |
URI of the enum that provides a semantic interpretation of the element in a l... |
| code_set | 0..1 Uriorcurie |
the identifier of an enumeration code set |
| code_set_tag | 0..1 String |
the version tag of the enumeration code set |
| code_set_version | 0..1 String |
the version identifier of the enumeration code set |
| pv_formula | 0..1 PvFormulaOptions |
Defines the specific formula to be used to generate the permissible values |
| permissible_values | 0..* PermissibleValue |
A list of possible values for a slot range |
| abstract | 0..1 Boolean |
Indicates the class or slot cannot be directly instantiated and is intended f... |
| mixin | 0..1 Boolean |
Indicates the class or slot is intended to be inherited from without being an... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
SubsetDefinition
an element that can be used to group other metamodel elements
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
Prefix
prefix URI tuple
| Name | Cardinality and Range | Description |
|---|---|---|
| prefix_prefix | 1..1 Ncname |
The prefix components of a prefix expansions |
| prefix_reference | 1..1 Uri |
The namespace to which a prefix expands to |
PermissibleValue
a permissible value, accompanied by intended text and an optional mapping to a concept URI
| Name | Cardinality and Range | Description |
|---|---|---|
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| text | 1..1 String |
The actual permissible value itself identifier |
| meaning | 0..1 Uriorcurie |
the value meaning of a permissible value |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
UniqueKey
a collection of slots whose values uniquely identify an instance of a class
| Name | Cardinality and Range | Description |
|---|---|---|
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| unique_key_name | 1..1 String |
name of the unique key |
| unique_key_slots | 1..* SlotDefinition |
list of slot names that form a key |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
CommonMetadata
Generic metadata shared across definitions
| Name | Cardinality and Range | Description |
|---|---|---|
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
Element
A named element in the model
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
Definition
abstract base class for core metaclasses
| Name | Cardinality and Range | Description |
|---|---|---|
| name | 1..1 String |
the unique name of the element within the context of the schema identifier |
| title | 0..1 String |
A concise human-readable display label for the element |
| description | 0..1 recommended String |
a textual description of the element's purpose and use |
| is_a | 0..1 Definition |
A primary parent class or slot from which inheritable metaslots are propagate... |
| mixins | 0..* Definition |
A collection of secondary parent classes or slots from which inheritable meta... |
| rank | 0..1 Integer |
the relative order in which the element occurs, lower values are given preced... |
| abstract | 0..1 Boolean |
Indicates the class or slot cannot be directly instantiated and is intended f... |
| mixin | 0..1 Boolean |
Indicates the class or slot is intended to be inherited from without being an... |
| id_prefixes | 0..* Ncname |
An allowed list of prefixes for which identifiers must conform |
| conforms_to | 0..1 String |
An established standard to which the element conforms |
| alt_descriptions | 0..* AltDescription |
A sourced alternative description for an element |
| deprecated | 0..1 String |
Description of why and when this element will no longer be used |
| todos | 0..* String |
Outstanding issues that needs resolution |
| notes | 0..* String |
editorial notes about an element intended primarily for internal consumption |
| comments | 0..* String |
notes and comments about an element intended primarily for external consumpti... |
| examples | 0..* Example |
example usages of an element |
| in_subset | 0..* SubsetDefinition |
used to indicate membership of a term in a defined subset of terms used for a... |
| source | 0..1 Uriorcurie |
A related resource from which the element is derived |
| see_also | 0..* Uriorcurie |
A list of related entities or URLs that may be of relevance |
| aliases | 0..* String |
Alternate names/labels for the element |
| created_by | 0..1 Uriorcurie |
agent that created the element |
| contributors | 0..* Uriorcurie |
agent that contributed to the element |
| created_on | 0..1 Datetime |
time at which the element was created |
| last_updated_on | 0..1 Datetime |
time at which the element was last updated |
| modified_by | 0..1 Uriorcurie |
agent that modified the element |
| status | 0..1 Uriorcurie |
status of the element |
| categories | 0..* Uriorcurie |
Controlled terms used to categorize an element |
| keywords | 0..* String |
Keywords or tags used to describe the element |
Example
usage example and description
| Name | Cardinality and Range | Description |
|---|---|---|
| value | 0..1 String |
example value |
| value_description | 0..1 String |
description of what the value is doing |
| value_object | 0..1 Anything |
direct object representation of the example |
AltDescription
an attributed description
| Name | Cardinality and Range | Description |
|---|---|---|
| alt_description_source | 1..1 String |
the source of an attributed description |
| alt_description_text | 1..1 String |
text of an attributed description |
Slots in subset
| Slot | Description |
|---|---|
| id | The official schema URI |
| name | the unique name of the element within the context of the schema |
| prefix_prefix | The prefix components of a prefix expansions |
| class_uri | URI of the class that provides a semantic interpretation of the element in a ... |
| slot_uri | URI of the class that provides a semantic interpretation of the slot in a lin... |
| type_uri | The uri that defines the possible values for the type definition |
| prefix_reference | The namespace to which a prefix expands to |
| title | A concise human-readable display label for the element |
| classes | An index to the collection of all class definitions in the schema |
| slot_definitions | An index to the collection of all slot definitions in the schema |
| description | a textual description of the element's purpose and use |
| enums | An index to the collection of all enum definitions in the schema |
| identifier | True means that the key slot(s) uniquely identifies the elements |
| types | An index to the collection of all type definitions in the schema |
| multivalued | true means that slot can have more than one value and should be represented u... |
| typeof | A parent type from which type properties are inherited |
| subsets | An index to the collection of all subset definitions in the schema |
| required | true means that the slot must be present in instances of the class definition |
| base | python base type in the LinkML runtime that implements this type definition |
| recommended | true means that the slot should be present in instances of the class definiti... |
| repr | the name of the python object that implements this type definition |
| prefixes | A collection of prefix expansions that specify how CURIEs can be expanded to ... |
| is_a | A primary parent class or slot from which inheritable metaslots are propagate... |
| default_prefix | The prefix that is used for all elements within a schema |
| mixins | A collection of secondary parent classes or slots from which inheritable meta... |
| default_range | default slot range to be used if range element is omitted from a slot definit... |
| slots | collection of slot names that are applicable to a class |
| text | The actual permissible value itself |
| imports | A list of schemas that are to be included in this schema |
| meaning | the value meaning of a permissible value |
| slot_usage | the refinement of a slot in the context of the containing class definition |
| inlined | True means that keyed or identified slot appears in an outer structure by val... |
| inlined_as_list | True means that an inlined slot is represented as a list of range instances |
| attributes | Inline definition of slots |
| license | license for the schema |
| tree_root | Indicates that this is the Container class which forms the root of the serial... |
| pattern | the string value of the slot must conform to this regular expression expresse... |
| rank | the relative order in which the element occurs, lower values are given preced... |
| conforms_to | An established standard to which the element conforms |
| categories | Controlled terms used to categorize an element |
| keywords | Keywords or tags used to describe the element |
| id_prefixes | An allowed list of prefixes for which identifiers must conform |
| aliases | Alternate names/labels for the element |
| deprecated | Description of why and when this element will no longer be used |
| todos | Outstanding issues that needs resolution |
| notes | editorial notes about an element intended primarily for internal consumption |
| comments | notes and comments about an element intended primarily for external consumpti... |
| in_subset | used to indicate membership of a term in a defined subset of terms used for a... |
| see_also | A list of related entities or URLs that may be of relevance |
| owned_by | agent that owns or is the steward of the element |
| created_by | agent that created the element |
| contributors | agent that contributed to the element |
| created_on | time at which the element was created |
| last_updated_on | time at which the element was last updated |
| modified_by | agent that modified the element |
| status | status of the element |
| source | A related resource from which the element is derived |
| publisher | An entity responsible for making the resource available |
| abstract | Indicates the class or slot cannot be directly instantiated and is intended f... |
| mixin | Indicates the class or slot is intended to be inherited from without being an... |
| code_set | the identifier of an enumeration code set |
| code_set_version | the version identifier of the enumeration code set |
| code_set_tag | the version tag of the enumeration code set |
| pv_formula | Defines the specific formula to be used to generate the permissible values |
| permissible_values | A list of possible values for a slot range |
| enum_uri | URI of the enum that provides a semantic interpretation of the element in a l... |
| version | particular version of schema |
| default_curi_maps | ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes... |
| metamodel_version | Version of the metamodel used to load the schema |
| source_file | name, uri or description of the source of the schema |
| source_file_date | modification date of the source of the schema |
| source_file_size | size in bytes of the source of the schema |
| generation_date | date and time that the schema was loaded/generated |
| unique_keys | A collection of named unique keys for this class |
| unique_key_name | name of the unique key |
| unique_key_slots | list of slot names that form a key |
| range | defines the type of the object of the slot |
| singular_name | a name that is used in the singular form |
| key | True means that the key slot(s) uniquely identify the elements within a singl... |
| minimum_value | for slots with ranges of type number, the value must be equal to or higher th... |
| maximum_value | for slots with ranges of type number, the value must be equal to or lowe than... |
| alt_description_text | text of an attributed description |
| alt_description_source | the source of an attributed description |
| alt_descriptions | A sourced alternative description for an element |
| value | example value |
| value_description | description of what the value is doing |
| value_object | direct object representation of the example |
| examples | example usages of an element |
| slot_group | allows for grouping of related slots into a grouping slot that serves the rol... |
| is_grouping_slot | true if this slot is a grouping slot |
Enumerations in subset
| Enumeration | Description |
|---|---|
| PvFormulaOptions | The formula used to generate the set of permissible values from the code_set ... |