Class: SubsetDefinition
an element that can be used to group other metamodel elements
classDiagram
class SubsetDefinition
Element <|-- SubsetDefinition
SubsetDefinition : aliases
SubsetDefinition : alt_descriptions
SubsetDefinition --> alt_description : alt_descriptions
SubsetDefinition : annotations
SubsetDefinition --> annotation : annotations
SubsetDefinition : broad_mappings
SubsetDefinition : categories
SubsetDefinition : close_mappings
SubsetDefinition : comments
SubsetDefinition : conforms_to
SubsetDefinition : contributors
SubsetDefinition : created_by
SubsetDefinition : created_on
SubsetDefinition : definition_uri
SubsetDefinition : deprecated
SubsetDefinition : deprecated_element_has_exact_replacement
SubsetDefinition : deprecated_element_has_possible_replacement
SubsetDefinition : description
SubsetDefinition : exact_mappings
SubsetDefinition : examples
SubsetDefinition --> example : examples
SubsetDefinition : extensions
SubsetDefinition --> extension : extensions
SubsetDefinition : from_schema
SubsetDefinition : id_prefixes
SubsetDefinition : id_prefixes_are_closed
SubsetDefinition : implements
SubsetDefinition : imported_from
SubsetDefinition : in_language
SubsetDefinition : in_subset
SubsetDefinition --> subset_definition : in_subset
SubsetDefinition : instantiates
SubsetDefinition : keywords
SubsetDefinition : last_updated_on
SubsetDefinition : local_names
SubsetDefinition --> local_name : local_names
SubsetDefinition : mappings
SubsetDefinition : modified_by
SubsetDefinition : name
SubsetDefinition : narrow_mappings
SubsetDefinition : notes
SubsetDefinition : rank
SubsetDefinition : related_mappings
SubsetDefinition : see_also
SubsetDefinition : source
SubsetDefinition : status
SubsetDefinition : structured_aliases
SubsetDefinition --> structured_alias : structured_aliases
SubsetDefinition : title
SubsetDefinition : todos
Inheritance
- Element [ Extensible Annotatable CommonMetadata]
- SubsetDefinition
Slots
| Name | Cardinality and Range | Description | Inheritance |
|---|---|---|---|
| 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
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/linkml/meta
Mappings
| Mapping Type | Mapped Value |
|---|---|
| self | linkml:SubsetDefinition |
| native | linkml:SubsetDefinition |
LinkML Source
Direct
name: subset_definition
description: an element that can be used to group other metamodel elements
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 6
is_a: element
Induced
name: subset_definition
description: an element that can be used to group other metamodel elements
in_subset:
- SpecificationSubset
- BasicSubset
from_schema: https://w3id.org/linkml/meta
rank: 6
is_a: element
attributes:
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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_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: subset_definition
domain_of:
- common_metadata
range: string