Type object
Schema URL https://catalog.lintel.tools/schemas/schemastore/linkml-metamodel/latest.json
Source https://w3id.org/linkml/meta.schema.json

Validate with Lintel

npx @lintel/lintel check
Type: object

A collection of definitions that make up a schema or a data model.

Properties

id string required

The official schema URI

name string | null required

a unique name for the schema that is both human-readable and consists of only characters from the NCName set

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

bindings array | null

A collection of enum bindings that specify how a slot can be bound to a permissible value from an enumeration. LinkML provides enums to allow string values to be restricted to one of a set of permissible values (specified statically or dynamically). Enum bindings allow enums to be bound to any object, including complex nested objects. For example, given a (generic) class Concept with slots id and label, it may be desirable to restrict the values the id takes on in a given context. For example, a HumanSample class may have a slot for representing sample site, with a range of concept, but the values of that slot may be restricted to concepts from a particular branch of an anatomy ontology.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

classes Record<string, ClassDefinition__identifier_optional | null>

An index to the collection of all class definitions in the schema

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
default_curi_maps array | null

ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes and inline prefix variables

default_prefix string | null

The prefix that is used for all elements within a schema

default_range string | null

default slot range to be used if range element is omitted from a slot definition

definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

emit_prefixes array | null

a list of Curie prefixes that are used in the representation of instances of the model. All prefixes in this list are added to the prefix sections of the target models.

enums Record<string, EnumDefinition__identifier_optional | null>

An index to the collection of all enum definitions in the schema

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

generation_date string | null

date and time that the schema was loaded/generated

format=date-time
id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

imports array | null

A list of schemas that are to be included in this schema

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
license string | null

license for the schema

local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

metamodel_version string | null

Version of the metamodel used to load the schema

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

prefixes Record<string, Prefix__identifier_optional | string>

A collection of prefix expansions that specify how CURIEs can be expanded to URIs

rank integer | null

the relative order in which the element occurs, lower values are given precedence

see_also array | null

A list of related entities or URLs that may be of relevance

settings Record<string, Setting__identifier_optional | string>

A collection of global variable settings

slot_names_unique boolean | null

if true then induced/mangled slot names are not created for class_usage and attributes

slots Record<string, SlotDefinition__identifier_optional | null>

An index to the collection of all slot definitions in the schema

source string | null

A related resource from which the element is derived.

source_file string | null

name, uri or description of the source of the schema

source_file_date string | null

modification date of the source of the schema

format=date-time
source_file_size integer | null

size in bytes of the source of the schema

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

subsets Record<string, SubsetDefinition__identifier_optional | null>

An index to the collection of all subset definitions in the schema

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

types Record<string, TypeDefinition__identifier_optional | null>

An index to the collection of all type definitions in the schema

version string | null

particular version of schema

Definitions

AliasPredicateEnum string

permissible values for the relationship between an element and an alias

AltDescription object

an attributed description

description string required

text of an attributed description

source string | null required

the source of an attributed description

AltDescription__identifier_optional object

an attributed description

description string required

text of an attributed description

source string | null

the source of an attributed description

Annotation object

a tag/value pair with the semantics of OWL Annotation

tag string required

a tag associated with an extension

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

Annotation__identifier_optional object

a tag/value pair with the semantics of OWL Annotation

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

tag string

a tag associated with an extension

AnonymousClassExpression object
aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

is_a string | null

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

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

slot_conditions Record<string, SlotDefinition__identifier_optional | null>

expresses constraints on a group of slots for a class expression

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

AnonymousEnumExpression object

An enum_expression that is not named

code_set string | null

the identifier of an enumeration code set.

code_set_tag string | null

the version tag of the enumeration code set

code_set_version string | null

the version identifier of the enumeration code set

concepts array | null

A list of identifiers that are used to construct a set of permissible values

include array | null

An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set

inherits array | null

An enum definition that is used as the basis to create a new enum

matches MatchQuery | null

Specifies a match query that is used to calculate the list of permissible values

minus array | null

An enum expression that yields a list of permissible values that are to be subtracted from the enum

permissible_values Record<string, PermissibleValue__identifier_optional | null>

A list of possible values for a slot range

pv_formula string

The formula used to generate the set of permissible values from the code_set values

Values: "CODE" "CURIE" "URI" "FHIR_CODING" "LABEL"
reachable_from ReachabilityQuery | null

Specifies a query for obtaining a list of permissible values based on graph reachability

AnonymousSlotExpression object
aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_members AnonymousSlotExpression | null

the value of the slot is multivalued with all members satisfying the condition

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

array ArrayExpression | null

coerces the value of the slot into an array and defines the dimensions of that array

bindings array | null

A collection of enum bindings that specify how a slot can be bound to a permissible value from an enumeration. LinkML provides enums to allow string values to be restricted to one of a set of permissible values (specified statically or dynamically). Enum bindings allow enums to be bound to any object, including complex nested objects. For example, given a (generic) class Concept with slots id and label, it may be desirable to restrict the values the id takes on in a given context. For example, a HumanSample class may have a slot for representing sample site, with a range of concept, but the values of that slot may be restricted to concepts from a particular branch of an anatomy ontology.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

enum_range EnumExpression | null

An inlined enumeration

equals_expression string | null

the value of the slot must equal the value of the evaluated expression

equals_number integer | null

the slot must have range of a number and the value of the slot must equal the specified value

equals_string string | null

the slot must have range string and the value of the slot must equal the specified value

equals_string_in array | null

the slot must have range string and the value of the slot must equal one of the specified values

exact_cardinality integer | null

the exact number of entries for a multivalued slot

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

has_member AnonymousSlotExpression | null

the value of the slot is multivalued with at least one member satisfying the condition

implicit_prefix string | null

Causes the slot value to be interpreted as a uriorcurie after prefixing with this string

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

inlined boolean | null

True means that keyed or identified slot appears in an outer structure by value. False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.

inlined_as_list boolean | null

True means that an inlined slot is represented as a list of range instances. False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

maximum_cardinality integer | null

the maximum number of entries for a multivalued slot

maximum_value Anything | null

For ordinal ranges, the value must be equal to or lower than this

minimum_cardinality integer | null

the minimum number of entries for a multivalued slot

minimum_value Anything | null

For ordinal ranges, the value must be equal to or higher than this

modified_by string | null

agent that modified the element

multivalued boolean | null

true means that slot can have more than one value and should be represented using a list or collection structure.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

pattern string | null

the string value of the slot must conform to this regular expression expressed in the string

range string | null

defines the type of the object of the slot. Given the following slot definition S1: domain: C1 range: C2 the declaration X: S1: Y

implicitly asserts Y is an instance of C2

range_expression AnonymousClassExpression | null

A range that is described as a boolean expression combining existing ranges

rank integer | null

the relative order in which the element occurs, lower values are given precedence

recommended boolean | null

true means that the slot should be present in instances of the class definition, but this is not required

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

required boolean | null

true means that the slot must be present in instances of the class definition

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

structured_pattern PatternExpression | null

the string value of the slot must conform to the regular expression in the pattern expression

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

unit UnitOfMeasure | null

an encoding of a unit

value_presence string

enumeration of conditions by which a slot value should be set

Values: "UNCOMMITTED" "PRESENT" "ABSENT"
AnonymousTypeExpression object

A type expression that is not a top-level named type definition. Used for nesting.

all_of array | null

holds if all of the expressions hold

any_of array | null

holds if at least one of the expressions hold

equals_number integer | null

the slot must have range of a number and the value of the slot must equal the specified value

equals_string string | null

the slot must have range string and the value of the slot must equal the specified value

equals_string_in array | null

the slot must have range string and the value of the slot must equal one of the specified values

exactly_one_of array | null

holds if only one of the expressions hold

implicit_prefix string | null

Causes the slot value to be interpreted as a uriorcurie after prefixing with this string

maximum_value Anything | null

For ordinal ranges, the value must be equal to or lower than this

minimum_value Anything | null

For ordinal ranges, the value must be equal to or higher than this

none_of array | null

holds if none of the expressions hold

pattern string | null

the string value of the slot must conform to this regular expression expressed in the string

structured_pattern PatternExpression | null

the string value of the slot must conform to the regular expression in the pattern expression

unit UnitOfMeasure | null

an encoding of a unit

AnyValue null | boolean | object | number | string
Anything null | boolean | object | number | string
ArrayExpression object

defines the dimensions of an array

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

dimensions array | null

definitions of each axis in the array

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exact_number_dimensions integer | null

exact number of dimensions in the array

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

maximum_number_dimensions integer | boolean | null

maximum number of dimensions in the array, or False if explicitly no maximum. If this is unset, and an explicit list of dimensions are passed using dimensions, then this is interpreted as a closed list and the maximum_number_dimensions is the length of the dimensions list, unless this value is set to False

minimum_number_dimensions integer | null

minimum number of dimensions in the array

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

ClassDefinition object

an element whose instances are complex objects that may have slot-value assignments

name string required

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.

abstract boolean | null

Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

alias string | null

the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

apply_to array | null

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.

attributes Record<string, SlotDefinition__identifier_optional | null>

Inline definition of slots

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

children_are_mutually_disjoint boolean | null

If true then all direct is_a children are mutually disjoint and share no instances in common

class_uri string | null

URI of the class 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

classification_rules array | null

The collection of classification rules that apply to all members of this class. Classification rules allow for automatically assigning the instantiated type of an instance.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
defining_slots array | null

The combination of is a plus defining slots form a genus-differentia definition, or the set of necessary and sufficient conditions that can be transformed into an OWL equivalence axiom

definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

disjoint_with array | null

Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

extra_slots ExtraSlotsExpression | null

How a class instance handles extra data not specified in the class definition. Note that this does not define the constraints that are placed on additional slots defined by inheriting classes.

Possible values:

  • allowed: true - allow all additional data
  • allowed: false (or allowed: or allowed: null while range_expression is null) - forbid all additional data (default)
  • range_expression: ... - allow additional data if it matches the slot expression (see examples)
from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

is_a string | null

A primary parent class from which inheritable metaslots are propagated

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

mixin boolean | null

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.

mixins array | null

A collection of secondary parent mixin classes from which inheritable metaslots are propagated

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

represents_relationship boolean | null

true if this class represents a relationship rather than an entity

rules array | null

the collection of rules that apply to all members of this class

see_also array | null

A list of related entities or URLs that may be of relevance

slot_conditions Record<string, SlotDefinition__identifier_optional | null>

expresses constraints on a group of slots for a class expression

slot_names_unique boolean | null

if true then induced/mangled slot names are not created for class_usage and attributes

slot_usage Record<string, SlotDefinition__identifier_optional | null>

the refinement of a slot in the context of the containing class definition.

slots array | null

collection of slot names that are applicable to a class

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

subclass_of string | null

DEPRECATED -- rdfs:subClassOf to be emitted in OWL generation

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

tree_root boolean | null

Indicates that this is the Container class which forms the root of the serialized document structure in tree serializations

union_of array | null

indicates that the domain element consists exactly of the members of the element in the range.

unique_keys Record<string, UniqueKey__identifier_optional | string[]>

A collection of named unique keys for this class. Unique keys may be singular or compound.

values_from array | null

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.

ClassDefinition__identifier_optional object

an element whose instances are complex objects that may have slot-value assignments

abstract boolean | null

Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

alias string | null

the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

apply_to array | null

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.

attributes Record<string, SlotDefinition__identifier_optional | null>

Inline definition of slots

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

children_are_mutually_disjoint boolean | null

If true then all direct is_a children are mutually disjoint and share no instances in common

class_uri string | null

URI of the class 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

classification_rules array | null

The collection of classification rules that apply to all members of this class. Classification rules allow for automatically assigning the instantiated type of an instance.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
defining_slots array | null

The combination of is a plus defining slots form a genus-differentia definition, or the set of necessary and sufficient conditions that can be transformed into an OWL equivalence axiom

definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

disjoint_with array | null

Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

extra_slots ExtraSlotsExpression | null

How a class instance handles extra data not specified in the class definition. Note that this does not define the constraints that are placed on additional slots defined by inheriting classes.

Possible values:

  • allowed: true - allow all additional data
  • allowed: false (or allowed: or allowed: null while range_expression is null) - forbid all additional data (default)
  • range_expression: ... - allow additional data if it matches the slot expression (see examples)
from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

is_a string | null

A primary parent class from which inheritable metaslots are propagated

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

mixin boolean | null

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.

mixins array | null

A collection of secondary parent mixin classes from which inheritable metaslots are propagated

modified_by string | null

agent that modified the element

name string

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.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

represents_relationship boolean | null

true if this class represents a relationship rather than an entity

rules array | null

the collection of rules that apply to all members of this class

see_also array | null

A list of related entities or URLs that may be of relevance

slot_conditions Record<string, SlotDefinition__identifier_optional | null>

expresses constraints on a group of slots for a class expression

slot_names_unique boolean | null

if true then induced/mangled slot names are not created for class_usage and attributes

slot_usage Record<string, SlotDefinition__identifier_optional | null>

the refinement of a slot in the context of the containing class definition.

slots array | null

collection of slot names that are applicable to a class

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

subclass_of string | null

DEPRECATED -- rdfs:subClassOf to be emitted in OWL generation

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

tree_root boolean | null

Indicates that this is the Container class which forms the root of the serialized document structure in tree serializations

union_of array | null

indicates that the domain element consists exactly of the members of the element in the range.

unique_keys Record<string, UniqueKey__identifier_optional | string[]>

A collection of named unique keys for this class. Unique keys may be singular or compound.

values_from array | null

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.

ClassRule object

A rule that applies to instances of a class

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

bidirectional boolean | null

in addition to preconditions entailing postconditions, the postconditions entail the preconditions

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deactivated boolean | null

a deactivated rule is not executed by the rules engine

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

elseconditions AnonymousClassExpression | null

an expression that must hold for an instance of the class, if the preconditions no not hold

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

open_world boolean | null

if true, the the postconditions may be omitted in instance data, but it is valid for an inference engine to add these

postconditions AnonymousClassExpression | null

an expression that must hold for an instance of the class, if the preconditions hold

preconditions AnonymousClassExpression | null

an expression that must hold in order for the rule to be applicable to an instance

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

DimensionExpression object

defines one of the dimensions of an array

alias string | null

the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_cardinality integer | null

the exact number of entries for a multivalued slot

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

maximum_cardinality integer | null

the maximum number of entries for a multivalued slot

minimum_cardinality integer | null

the minimum number of entries for a multivalued slot

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

EnumBinding object

A binding of a slot or a class to a permissible value from an enumeration.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

binds_value_of string | null

A path to a slot that is being bound to a permissible value from an enumeration.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

obligation_level string

The level of obligation or recommendation strength for a metadata element

Values: "REQUIRED" "RECOMMENDED" "OPTIONAL" "EXAMPLE" "DISCOURAGED"
pv_formula string

The formula used to generate the set of permissible values from the code_set values

Values: "CODE" "CURIE" "URI" "FHIR_CODING" "LABEL"
range string | null

defines the type of the object of the slot. Given the following slot definition S1: domain: C1 range: C2 the declaration X: S1: Y

implicitly asserts Y is an instance of C2

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

EnumDefinition object

an element whose instances must be drawn from a specified set of permissible values

name string required

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.

abstract boolean | null

Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

apply_to array | null

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.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

code_set string | null

the identifier of an enumeration code set.

code_set_tag string | null

the version tag of the enumeration code set

code_set_version string | null

the version identifier of the enumeration code set

comments array | null

notes and comments about an element intended primarily for external consumption

concepts array | null

A list of identifiers that are used to construct a set of permissible values

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

enum_uri string | null

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

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

include array | null

An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set

inherits array | null

An enum definition that is used as the basis to create a new enum

instantiates array | null

An element in another schema which this element instantiates.

is_a string | null

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

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

matches MatchQuery | null

Specifies a match query that is used to calculate the list of permissible values

minus array | null

An enum expression that yields a list of permissible values that are to be subtracted from the enum

mixin boolean | null

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.

mixins array | null

A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

permissible_values Record<string, PermissibleValue__identifier_optional | null>

A list of possible values for a slot range

pv_formula string

The formula used to generate the set of permissible values from the code_set values

Values: "CODE" "CURIE" "URI" "FHIR_CODING" "LABEL"
rank integer | null

the relative order in which the element occurs, lower values are given precedence

reachable_from ReachabilityQuery | null

Specifies a query for obtaining a list of permissible values based on graph reachability

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

values_from array | null

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.

EnumDefinition__identifier_optional object

an element whose instances must be drawn from a specified set of permissible values

abstract boolean | null

Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

apply_to array | null

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.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

code_set string | null

the identifier of an enumeration code set.

code_set_tag string | null

the version tag of the enumeration code set

code_set_version string | null

the version identifier of the enumeration code set

comments array | null

notes and comments about an element intended primarily for external consumption

concepts array | null

A list of identifiers that are used to construct a set of permissible values

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

enum_uri string | null

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

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

include array | null

An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set

inherits array | null

An enum definition that is used as the basis to create a new enum

instantiates array | null

An element in another schema which this element instantiates.

is_a string | null

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

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

matches MatchQuery | null

Specifies a match query that is used to calculate the list of permissible values

minus array | null

An enum expression that yields a list of permissible values that are to be subtracted from the enum

mixin boolean | null

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.

mixins array | null

A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.

modified_by string | null

agent that modified the element

name string

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.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

permissible_values Record<string, PermissibleValue__identifier_optional | null>

A list of possible values for a slot range

pv_formula string

The formula used to generate the set of permissible values from the code_set values

Values: "CODE" "CURIE" "URI" "FHIR_CODING" "LABEL"
rank integer | null

the relative order in which the element occurs, lower values are given precedence

reachable_from ReachabilityQuery | null

Specifies a query for obtaining a list of permissible values based on graph reachability

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

values_from array | null

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.

EnumExpression object

An expression that constrains the range of a slot

code_set string | null

the identifier of an enumeration code set.

code_set_tag string | null

the version tag of the enumeration code set

code_set_version string | null

the version identifier of the enumeration code set

concepts array | null

A list of identifiers that are used to construct a set of permissible values

include array | null

An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set

inherits array | null

An enum definition that is used as the basis to create a new enum

matches MatchQuery | null

Specifies a match query that is used to calculate the list of permissible values

minus array | null

An enum expression that yields a list of permissible values that are to be subtracted from the enum

permissible_values Record<string, PermissibleValue__identifier_optional | null>

A list of possible values for a slot range

pv_formula string

The formula used to generate the set of permissible values from the code_set values

Values: "CODE" "CURIE" "URI" "FHIR_CODING" "LABEL"
reachable_from ReachabilityQuery | null

Specifies a query for obtaining a list of permissible values based on graph reachability

Example object

usage example and description

description string | null

description of what the value is doing

object Anything | null

direct object representation of the example

value string | null

example value

Extension object

a tag/value pair used to add non-model information to an entry

tag string required

a tag associated with an extension

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

Extension__identifier_optional object

a tag/value pair used to add non-model information to an entry

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

tag string

a tag associated with an extension

ExtraSlotsExpression object

An expression that defines how to handle additional data in an instance of class beyond the slots/attributes defined for that class. See extra_slots for usage examples.

allowed boolean | null

Whether or not something is allowed. Usage defined by context.

range_expression AnonymousClassExpression | null

A range that is described as a boolean expression combining existing ranges

ImportExpression object

an expression describing an import

import_from string required
aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

import_as string | null
import_map Record<string, Setting__identifier_optional | string>
imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

LocalName object

an attributed label

local_name_source string | null required

the ncname of the source of the name

local_name_value string required

a name assigned to an element in a given ontology

LocalName__identifier_optional object

an attributed label

local_name_value string required

a name assigned to an element in a given ontology

local_name_source string | null

the ncname of the source of the name

MatchQuery object

A query that is used on an enum expression to dynamically obtain a set of permissivle values via a query that matches on properties of the external concepts.

identifier_pattern string | null

A regular expression that is used to obtain a set of identifiers from a source_ontology to construct a set of permissible values

source_ontology string | null

An ontology or vocabulary or terminology that is used in a query to obtain a set of permissible values

ObligationLevelEnum string

The level of obligation or recommendation strength for a metadata element

PathExpression object

An expression that describes an abstract path from an object to another through a sequence of slot lookups

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

followed_by PathExpression | null

in a sequential list, this indicates the next member

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

range_expression AnonymousClassExpression | null

A range that is described as a boolean expression combining existing ranges

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

reversed boolean | null

true if the slot is to be inversed

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

traverse string | null

the slot to traverse

PatternExpression object

a regular expression pattern used to evaluate conformance of a string

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

interpolated boolean | null

if true then the pattern is first string interpolated

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

partial_match boolean | null

if not true then the pattern must match the whole string, as if enclosed in ^...$

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

syntax string | null

the string value of the slot must conform to this regular expression expressed in the string. May be interpolated.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

PermissibleValue object

a permissible value, accompanied by intended text and an optional mapping to a concept URI

text string | null required

The actual permissible value itself

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

is_a string | null

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

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

meaning string | null

the value meaning of a permissible value

mixins array | null

A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

unit UnitOfMeasure | null

an encoding of a unit

PermissibleValue__identifier_optional object

a permissible value, accompanied by intended text and an optional mapping to a concept URI

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

is_a string | null

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

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

meaning string | null

the value meaning of a permissible value

mixins array | null

A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

text string | null

The actual permissible value itself

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

unit UnitOfMeasure | null

an encoding of a unit

Prefix object

prefix URI tuple

prefix_prefix string | null required

The prefix components of a prefix expansions. This is the part that appears before the colon in a CURIE.

prefix_reference string required

The namespace to which a prefix expands to.

Prefix__identifier_optional object

prefix URI tuple

prefix_reference string required

The namespace to which a prefix expands to.

prefix_prefix string | null

The prefix components of a prefix expansions. This is the part that appears before the colon in a CURIE.

PresenceEnum string

enumeration of conditions by which a slot value should be set

PvFormulaOptions string

The formula used to generate the set of permissible values from the code_set values

ReachabilityQuery object

A query that is used on an enum expression to dynamically obtain a set of permissible values via walking from a set of source nodes to a set of descendants or ancestors over a set of relationship types.

include_self boolean | null

True if the query is reflexive

is_direct boolean | null

True if the reachability query should only include directly related nodes, if False then include also transitively connected

relationship_types array | null

A list of relationship types (properties) that are used in a reachability query

source_nodes array | null

A list of nodes that are used in the reachability query

source_ontology string | null

An ontology or vocabulary or terminology that is used in a query to obtain a set of permissible values

traverse_up boolean | null

True if the direction of the reachability query is reversed and ancestors are retrieved

RelationalRoleEnum string

enumeration of roles a slot on a relationship class can play

SchemaDefinition object

A collection of definitions that make up a schema or a data model.

id string required

The official schema URI

name string | null required

a unique name for the schema that is both human-readable and consists of only characters from the NCName set

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

bindings array | null

A collection of enum bindings that specify how a slot can be bound to a permissible value from an enumeration. LinkML provides enums to allow string values to be restricted to one of a set of permissible values (specified statically or dynamically). Enum bindings allow enums to be bound to any object, including complex nested objects. For example, given a (generic) class Concept with slots id and label, it may be desirable to restrict the values the id takes on in a given context. For example, a HumanSample class may have a slot for representing sample site, with a range of concept, but the values of that slot may be restricted to concepts from a particular branch of an anatomy ontology.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

classes Record<string, ClassDefinition__identifier_optional | null>

An index to the collection of all class definitions in the schema

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
default_curi_maps array | null

ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes and inline prefix variables

default_prefix string | null

The prefix that is used for all elements within a schema

default_range string | null

default slot range to be used if range element is omitted from a slot definition

definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

emit_prefixes array | null

a list of Curie prefixes that are used in the representation of instances of the model. All prefixes in this list are added to the prefix sections of the target models.

enums Record<string, EnumDefinition__identifier_optional | null>

An index to the collection of all enum definitions in the schema

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

generation_date string | null

date and time that the schema was loaded/generated

format=date-time
id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

imports array | null

A list of schemas that are to be included in this schema

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
license string | null

license for the schema

local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

metamodel_version string | null

Version of the metamodel used to load the schema

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

prefixes Record<string, Prefix__identifier_optional | string>

A collection of prefix expansions that specify how CURIEs can be expanded to URIs

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

settings Record<string, Setting__identifier_optional | string>

A collection of global variable settings

slot_names_unique boolean | null

if true then induced/mangled slot names are not created for class_usage and attributes

slots Record<string, SlotDefinition__identifier_optional | null>

An index to the collection of all slot definitions in the schema

source string | null

A related resource from which the element is derived.

source_file string | null

name, uri or description of the source of the schema

source_file_date string | null

modification date of the source of the schema

format=date-time
source_file_size integer | null

size in bytes of the source of the schema

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

subsets Record<string, SubsetDefinition__identifier_optional | null>

An index to the collection of all subset definitions in the schema

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

types Record<string, TypeDefinition__identifier_optional | null>

An index to the collection of all type definitions in the schema

version string | null

particular version of schema

Setting object

assignment of a key to a value

setting_key string | null required

the variable name for a setting

setting_value string required

The value assigned for a setting

Setting__identifier_optional object

assignment of a key to a value

setting_value string required

The value assigned for a setting

setting_key string | null

the variable name for a setting

SlotDefinition object

an element that describes how instances are related to other instances

name string required

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.

abstract boolean | null

Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

alias string | null

the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_members AnonymousSlotExpression | null

the value of the slot is multivalued with all members satisfying the condition

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

apply_to array | null

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.

array ArrayExpression | null

coerces the value of the slot into an array and defines the dimensions of that array

asymmetric boolean | null

If s is antisymmetric, and i.s=v where i is different from v, v.s cannot have value i

bindings array | null

A collection of enum bindings that specify how a slot can be bound to a permissible value from an enumeration. LinkML provides enums to allow string values to be restricted to one of a set of permissible values (specified statically or dynamically). Enum bindings allow enums to be bound to any object, including complex nested objects. For example, given a (generic) class Concept with slots id and label, it may be desirable to restrict the values the id takes on in a given context. For example, a HumanSample class may have a slot for representing sample site, with a range of concept, but the values of that slot may be restricted to concepts from a particular branch of an anatomy ontology.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

children_are_mutually_disjoint boolean | null

If true then all direct is_a children are mutually disjoint and share no instances in common

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

designates_type boolean | null

True means that the key slot(s) is used to determine the instantiation (types) relation between objects and a ClassDefinition

disjoint_with array | null

Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances

domain string | null

defines the type of the subject of the slot. Given the following slot definition S1: domain: C1 range: C2 the declaration X: S1: Y

implicitly asserts that X is an instance of C1

domain_of array | null

the class(es) that reference the slot in a "slots" or "slot_usage" context

enum_range EnumExpression | null

An inlined enumeration

equals_expression string | null

the value of the slot must equal the value of the evaluated expression

equals_number integer | null

the slot must have range of a number and the value of the slot must equal the specified value

equals_string string | null

the slot must have range string and the value of the slot must equal the specified value

equals_string_in array | null

the slot must have range string and the value of the slot must equal one of the specified values

exact_cardinality integer | null

the exact number of entries for a multivalued slot

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

has_member AnonymousSlotExpression | null

the value of the slot is multivalued with at least one member satisfying the condition

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

identifier boolean | null

True means that the key slot(s) uniquely identifies the elements. There can be at most one identifier or key per container

ifabsent string | null

function that provides a default value for the slot.

  • [Tt]rue -- boolean True
  • [Ff]alse -- boolean False
  • bnode -- blank node identifier
  • class_curie -- CURIE for the containing class
  • class_uri -- URI for the containing class
  • default_ns -- schema default namespace
  • default_range -- schema default range
  • int(value) -- integer value
  • slot_uri -- URI for the slot
  • slot_curie -- CURIE for the slot
  • string(value) -- string value
  • EnumName(PermissibleValue) -- enum value
implements array | null

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.

implicit_prefix string | null

Causes the slot value to be interpreted as a uriorcurie after prefixing with this string

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

inherited boolean | null

true means that the value of a slot is inherited by subclasses

inlined boolean | null

True means that keyed or identified slot appears in an outer structure by value. False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.

inlined_as_list boolean | null

True means that an inlined slot is represented as a list of range instances. False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.

instantiates array | null

An element in another schema which this element instantiates.

inverse string | null

indicates that any instance of d s r implies that there is also an instance of r s' d

irreflexive boolean | null

If s is irreflexive, then there exists no i such i.s=i

is_a string | null

A primary parent slot from which inheritable metaslots are propagated

is_class_field boolean | null

indicates that for any instance, i, the domain of this slot will include an assertion of i s range

is_grouping_slot boolean | null

true if this slot is a grouping slot

is_usage_slot boolean | null

True means that this slot was defined in a slot_usage situation

key boolean | null

True means that the key slot(s) uniquely identify the elements within a single container

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
list_elements_ordered boolean | null

If True, then the order of elements of a multivalued slot is guaranteed to be preserved. If False, the order may still be preserved but this is not guaranteed

list_elements_unique boolean | null

If True, then there must be no duplicates in the elements of a multivalued slot

local_names Record<string, LocalName__identifier_optional | string>
locally_reflexive boolean | null

If s is locally_reflexive, then i.s=i for all instances i where s is a class slot for the type of i

mappings array | null

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.

maximum_cardinality integer | null

the maximum number of entries for a multivalued slot

maximum_value Anything | null

For ordinal ranges, the value must be equal to or lower than this

minimum_cardinality integer | null

the minimum number of entries for a multivalued slot

minimum_value Anything | null

For ordinal ranges, the value must be equal to or higher than this

mixin boolean | null

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.

mixins array | null

A collection of secondary parent mixin slots from which inheritable metaslots are propagated

modified_by string | null

agent that modified the element

multivalued boolean | null

true means that slot can have more than one value and should be represented using a list or collection structure.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

owner string | null

the "owner" of the slot. It is the class if it appears in the slots list, otherwise the declaring slot

path_rule PathExpression | null

a rule for inferring a slot assignment based on evaluating a path through a sequence of slot assignments

pattern string | null

the string value of the slot must conform to this regular expression expressed in the string

range string | null

defines the type of the object of the slot. Given the following slot definition S1: domain: C1 range: C2 the declaration X: S1: Y

implicitly asserts Y is an instance of C2

range_expression AnonymousClassExpression | null

A range that is described as a boolean expression combining existing ranges

rank integer | null

the relative order in which the element occurs, lower values are given precedence

readonly string | null

If present, slot is read only. Text explains why

recommended boolean | null

true means that the slot should be present in instances of the class definition, but this is not required

reflexive boolean | null

If s is reflexive, then i.s=i for all instances i

reflexive_transitive_form_of string | null

transitive_form_of including the reflexive case

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

relational_role string

enumeration of roles a slot on a relationship class can play

Values: "SUBJECT" "OBJECT" "PREDICATE" "NODE" "OTHER_ROLE"
required boolean | null

true means that the slot must be present in instances of the class definition

role string | null

a textual descriptor that indicates the role played by the slot range

see_also array | null

A list of related entities or URLs that may be of relevance

shared boolean | null

If True, then the relationship between the slot domain and range is many to one or many to many

singular_name string | null

a name that is used in the singular form

slot_group string | null

allows for grouping of related slots into a grouping slot that serves the role of a group

slot_uri string | null

URI of the class that provides a semantic interpretation of the slot in a linked data context. The URI may come from any namespace and may be shared between schemas.

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

structured_pattern PatternExpression | null

the string value of the slot must conform to the regular expression in the pattern expression

subproperty_of string | null

Ontology property which this slot is a subproperty of. Note: 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.

symmetric boolean | null

If s is symmetric, and i.s=v, then v.s=i

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

transitive boolean | null

If s is transitive, and i.s=z, and s.s=j, then i.s=j

transitive_form_of string | null

If s transitive_form_of d, then (1) s holds whenever d holds (2) s is transitive (3) d holds whenever s holds and there are no intermediates, and s is not reflexive

type_mappings Record<string, TypeMapping__identifier_optional | null>

A collection of type mappings that specify how a slot's range should be mapped or serialized in different frameworks

union_of array | null

indicates that the domain element consists exactly of the members of the element in the range.

unit UnitOfMeasure | null

an encoding of a unit

usage_slot_name string | null

The name of the slot referenced in the slot_usage

value_presence string

enumeration of conditions by which a slot value should be set

Values: "UNCOMMITTED" "PRESENT" "ABSENT"
values_from array | null

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.

SlotDefinition__identifier_optional object

an element that describes how instances are related to other instances

abstract boolean | null

Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

alias string | null

the name used for a slot in the context of its owning class. If present, this is used instead of the actual slot name.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_members AnonymousSlotExpression | null

the value of the slot is multivalued with all members satisfying the condition

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

apply_to array | null

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.

array ArrayExpression | null

coerces the value of the slot into an array and defines the dimensions of that array

asymmetric boolean | null

If s is antisymmetric, and i.s=v where i is different from v, v.s cannot have value i

bindings array | null

A collection of enum bindings that specify how a slot can be bound to a permissible value from an enumeration. LinkML provides enums to allow string values to be restricted to one of a set of permissible values (specified statically or dynamically). Enum bindings allow enums to be bound to any object, including complex nested objects. For example, given a (generic) class Concept with slots id and label, it may be desirable to restrict the values the id takes on in a given context. For example, a HumanSample class may have a slot for representing sample site, with a range of concept, but the values of that slot may be restricted to concepts from a particular branch of an anatomy ontology.

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

children_are_mutually_disjoint boolean | null

If true then all direct is_a children are mutually disjoint and share no instances in common

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

designates_type boolean | null

True means that the key slot(s) is used to determine the instantiation (types) relation between objects and a ClassDefinition

disjoint_with array | null

Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances

domain string | null

defines the type of the subject of the slot. Given the following slot definition S1: domain: C1 range: C2 the declaration X: S1: Y

implicitly asserts that X is an instance of C1

domain_of array | null

the class(es) that reference the slot in a "slots" or "slot_usage" context

enum_range EnumExpression | null

An inlined enumeration

equals_expression string | null

the value of the slot must equal the value of the evaluated expression

equals_number integer | null

the slot must have range of a number and the value of the slot must equal the specified value

equals_string string | null

the slot must have range string and the value of the slot must equal the specified value

equals_string_in array | null

the slot must have range string and the value of the slot must equal one of the specified values

exact_cardinality integer | null

the exact number of entries for a multivalued slot

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

has_member AnonymousSlotExpression | null

the value of the slot is multivalued with at least one member satisfying the condition

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

identifier boolean | null

True means that the key slot(s) uniquely identifies the elements. There can be at most one identifier or key per container

ifabsent string | null

function that provides a default value for the slot.

  • [Tt]rue -- boolean True
  • [Ff]alse -- boolean False
  • bnode -- blank node identifier
  • class_curie -- CURIE for the containing class
  • class_uri -- URI for the containing class
  • default_ns -- schema default namespace
  • default_range -- schema default range
  • int(value) -- integer value
  • slot_uri -- URI for the slot
  • slot_curie -- CURIE for the slot
  • string(value) -- string value
  • EnumName(PermissibleValue) -- enum value
implements array | null

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.

implicit_prefix string | null

Causes the slot value to be interpreted as a uriorcurie after prefixing with this string

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

inherited boolean | null

true means that the value of a slot is inherited by subclasses

inlined boolean | null

True means that keyed or identified slot appears in an outer structure by value. False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.

inlined_as_list boolean | null

True means that an inlined slot is represented as a list of range instances. False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.

instantiates array | null

An element in another schema which this element instantiates.

inverse string | null

indicates that any instance of d s r implies that there is also an instance of r s' d

irreflexive boolean | null

If s is irreflexive, then there exists no i such i.s=i

is_a string | null

A primary parent slot from which inheritable metaslots are propagated

is_class_field boolean | null

indicates that for any instance, i, the domain of this slot will include an assertion of i s range

is_grouping_slot boolean | null

true if this slot is a grouping slot

is_usage_slot boolean | null

True means that this slot was defined in a slot_usage situation

key boolean | null

True means that the key slot(s) uniquely identify the elements within a single container

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
list_elements_ordered boolean | null

If True, then the order of elements of a multivalued slot is guaranteed to be preserved. If False, the order may still be preserved but this is not guaranteed

list_elements_unique boolean | null

If True, then there must be no duplicates in the elements of a multivalued slot

local_names Record<string, LocalName__identifier_optional | string>
locally_reflexive boolean | null

If s is locally_reflexive, then i.s=i for all instances i where s is a class slot for the type of i

mappings array | null

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.

maximum_cardinality integer | null

the maximum number of entries for a multivalued slot

maximum_value Anything | null

For ordinal ranges, the value must be equal to or lower than this

minimum_cardinality integer | null

the minimum number of entries for a multivalued slot

minimum_value Anything | null

For ordinal ranges, the value must be equal to or higher than this

mixin boolean | null

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.

mixins array | null

A collection of secondary parent mixin slots from which inheritable metaslots are propagated

modified_by string | null

agent that modified the element

multivalued boolean | null

true means that slot can have more than one value and should be represented using a list or collection structure.

name string

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.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

owner string | null

the "owner" of the slot. It is the class if it appears in the slots list, otherwise the declaring slot

path_rule PathExpression | null

a rule for inferring a slot assignment based on evaluating a path through a sequence of slot assignments

pattern string | null

the string value of the slot must conform to this regular expression expressed in the string

range string | null

defines the type of the object of the slot. Given the following slot definition S1: domain: C1 range: C2 the declaration X: S1: Y

implicitly asserts Y is an instance of C2

range_expression AnonymousClassExpression | null

A range that is described as a boolean expression combining existing ranges

rank integer | null

the relative order in which the element occurs, lower values are given precedence

readonly string | null

If present, slot is read only. Text explains why

recommended boolean | null

true means that the slot should be present in instances of the class definition, but this is not required

reflexive boolean | null

If s is reflexive, then i.s=i for all instances i

reflexive_transitive_form_of string | null

transitive_form_of including the reflexive case

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

relational_role string

enumeration of roles a slot on a relationship class can play

Values: "SUBJECT" "OBJECT" "PREDICATE" "NODE" "OTHER_ROLE"
required boolean | null

true means that the slot must be present in instances of the class definition

role string | null

a textual descriptor that indicates the role played by the slot range

see_also array | null

A list of related entities or URLs that may be of relevance

shared boolean | null

If True, then the relationship between the slot domain and range is many to one or many to many

singular_name string | null

a name that is used in the singular form

slot_group string | null

allows for grouping of related slots into a grouping slot that serves the role of a group

slot_uri string | null

URI of the class that provides a semantic interpretation of the slot in a linked data context. The URI may come from any namespace and may be shared between schemas.

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

structured_pattern PatternExpression | null

the string value of the slot must conform to the regular expression in the pattern expression

subproperty_of string | null

Ontology property which this slot is a subproperty of. Note: 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.

symmetric boolean | null

If s is symmetric, and i.s=v, then v.s=i

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

transitive boolean | null

If s is transitive, and i.s=z, and s.s=j, then i.s=j

transitive_form_of string | null

If s transitive_form_of d, then (1) s holds whenever d holds (2) s is transitive (3) d holds whenever s holds and there are no intermediates, and s is not reflexive

type_mappings Record<string, TypeMapping__identifier_optional | null>

A collection of type mappings that specify how a slot's range should be mapped or serialized in different frameworks

union_of array | null

indicates that the domain element consists exactly of the members of the element in the range.

unit UnitOfMeasure | null

an encoding of a unit

usage_slot_name string | null

The name of the slot referenced in the slot_usage

value_presence string

enumeration of conditions by which a slot value should be set

Values: "UNCOMMITTED" "PRESENT" "ABSENT"
values_from array | null

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.

StructuredAlias object

object that contains meta data about a synonym or alias including where it came from (source) and its scope (narrow, broad, etc.)

literal_form string required

The literal lexical form of a structured alias; i.e the actual alias value.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

The category or categories of an alias. This can be drawn from any relevant vocabulary

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contexts array | null

The context in which an alias should be applied

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

predicate string

permissible values for the relationship between an element and an alias

Values: "EXACT_SYNONYM" "RELATED_SYNONYM" "BROAD_SYNONYM" "NARROW_SYNONYM"
rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

SubsetDefinition object

an element that can be used to group other metamodel elements

name string required

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.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

SubsetDefinition__identifier_optional object

an element that can be used to group other metamodel elements

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

modified_by string | null

agent that modified the element

name string

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.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

TypeDefinition object

an element that whose instances are atomic scalar values that can be mapped to primitive types

name string required

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.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

base string | null

python base type in the LinkML runtime that implements this type definition

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

equals_number integer | null

the slot must have range of a number and the value of the slot must equal the specified value

equals_string string | null

the slot must have range string and the value of the slot must equal the specified value

equals_string_in array | null

the slot must have range string and the value of the slot must equal one of the specified values

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

implicit_prefix string | null

Causes the slot value to be interpreted as a uriorcurie after prefixing with this string

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

maximum_value Anything | null

For ordinal ranges, the value must be equal to or lower than this

minimum_value Anything | null

For ordinal ranges, the value must be equal to or higher than this

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

pattern string | null

the string value of the slot must conform to this regular expression expressed in the string

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

repr string | null

the name of the python object that implements this type definition

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

structured_pattern PatternExpression | null

the string value of the slot must conform to the regular expression in the pattern expression

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

typeof string | null

A parent type from which type properties are inherited

union_of array | null

indicates that the domain element consists exactly of the members of the element in the range.

unit UnitOfMeasure | null

an encoding of a unit

uri string | null

The uri that defines the possible values for the type definition

TypeDefinition__identifier_optional object

an element that whose instances are atomic scalar values that can be mapped to primitive types

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

all_of array | null

holds if all of the expressions hold

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

any_of array | null

holds if at least one of the expressions hold

base string | null

python base type in the LinkML runtime that implements this type definition

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

conforms_to string | null

An established standard to which the element conforms.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
definition_uri string | null

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

deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

equals_number integer | null

the slot must have range of a number and the value of the slot must equal the specified value

equals_string string | null

the slot must have range string and the value of the slot must equal the specified value

equals_string_in array | null

the slot must have range string and the value of the slot must equal one of the specified values

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

exactly_one_of array | null

holds if only one of the expressions hold

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

id_prefixes array | null

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

id_prefixes_are_closed boolean | null

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.

implements array | null

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.

implicit_prefix string | null

Causes the slot value to be interpreted as a uriorcurie after prefixing with this string

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

instantiates array | null

An element in another schema which this element instantiates.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
local_names Record<string, LocalName__identifier_optional | string>
mappings array | null

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.

maximum_value Anything | null

For ordinal ranges, the value must be equal to or lower than this

minimum_value Anything | null

For ordinal ranges, the value must be equal to or higher than this

modified_by string | null

agent that modified the element

name string

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.

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

none_of array | null

holds if none of the expressions hold

notes array | null

editorial notes about an element intended primarily for internal consumption

pattern string | null

the string value of the slot must conform to this regular expression expressed in the string

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

repr string | null

the name of the python object that implements this type definition

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

structured_pattern PatternExpression | null

the string value of the slot must conform to the regular expression in the pattern expression

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

typeof string | null

A parent type from which type properties are inherited

union_of array | null

indicates that the domain element consists exactly of the members of the element in the range.

unit UnitOfMeasure | null

an encoding of a unit

uri string | null

The uri that defines the possible values for the type definition

TypeMapping object

Represents how a slot or type can be serialized to a format.

framework string | null required

The name of a format that can be used to serialize LinkML data. The string value should be a code from the LinkML frameworks vocabulary, but this is not strictly enforced

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

type string | null

type to coerce to

TypeMapping__identifier_optional object

Represents how a slot or type can be serialized to a format.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

framework string | null

The name of a format that can be used to serialize LinkML data. The string value should be a code from the LinkML frameworks vocabulary, but this is not strictly enforced

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

string_serialization string | null

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) GENERATE: 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

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

type string | null

type to coerce to

UniqueKey object

a collection of slots whose values uniquely identify an instance of a class

unique_key_name string required

name of the unique key

unique_key_slots string[] required

list of slot names that form a key. The tuple formed from the values of all these slots should be unique.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

consider_nulls_inequal boolean | null

By default, None values are considered equal for the purposes of comparisons in determining uniqueness. Set this to true to treat missing values as per ANSI-SQL NULLs, i.e NULL=NULL is always False.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

UniqueKey__identifier_optional object

a collection of slots whose values uniquely identify an instance of a class

unique_key_slots string[] required

list of slot names that form a key. The tuple formed from the values of all these slots should be unique.

aliases array | null

Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.

alt_descriptions Record<string, AltDescription__identifier_optional | string>

A sourced alternative description for an element

annotations Record<string, Annotation__identifier_optional | AnyValue>

a collection of tag/text tuples with the semantics of OWL Annotation

broad_mappings array | null

A list of terms from different schemas or terminology systems that have broader meaning.

categories array | null

Controlled terms used to categorize an element.

close_mappings array | null

A list of terms from different schemas or terminology systems that have close meaning.

comments array | null

notes and comments about an element intended primarily for external consumption

consider_nulls_inequal boolean | null

By default, None values are considered equal for the purposes of comparisons in determining uniqueness. Set this to true to treat missing values as per ANSI-SQL NULLs, i.e NULL=NULL is always False.

contributors array | null

agent that contributed to the element

created_by string | null

agent that created the element

created_on string | null

time at which the element was created

format=date-time
deprecated string | null

Description of why and when this element will no longer be used

deprecated_element_has_exact_replacement string | null

When an element is deprecated, it can be automatically replaced by this uri or curie

deprecated_element_has_possible_replacement string | null

When an element is deprecated, it can be potentially replaced by this uri or curie

description string | null

a textual description of the element's purpose and use

exact_mappings array | null

A list of terms from different schemas or terminology systems that have identical meaning.

examples array | null

example usages of an element

extensions Record<string, Extension__identifier_optional | AnyValue>

a tag/text tuple attached to an arbitrary element

from_schema string | null

id of the schema that defined the element

imported_from string | null

the imports entry that this element was derived from. Empty means primary source

in_language string | null

the primary language used in the sources

in_subset array | null

used to indicate membership of a term in a defined subset of terms used for a particular domain or application.

keywords array | null

Keywords or tags used to describe the element

last_updated_on string | null

time at which the element was last updated

format=date-time
mappings array | null

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.

modified_by string | null

agent that modified the element

narrow_mappings array | null

A list of terms from different schemas or terminology systems that have narrower meaning.

notes array | null

editorial notes about an element intended primarily for internal consumption

rank integer | null

the relative order in which the element occurs, lower values are given precedence

related_mappings array | null

A list of terms from different schemas or terminology systems that have related meaning.

see_also array | null

A list of related entities or URLs that may be of relevance

source string | null

A related resource from which the element is derived.

status string | null

status of the element

structured_aliases array | null

A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.

title string | null

A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.

todos array | null

Outstanding issues that needs resolution

unique_key_name string

name of the unique key

UnitOfMeasure object

A unit of measure, or unit, is a particular quantity value that has been chosen as a scale for measuring other quantities the same kind (more generally of equivalent dimension).

abbreviation string | null

An abbreviation for a unit is a short ASCII string that is used in place of the full name for the unit in contexts where non-ASCII characters would be problematic, or where using the abbreviation will enhance readability. When a power of a base unit needs to be expressed, such as squares this can be done using abbreviations rather than symbols (source: qudt)

derivation string | null

Expression for deriving this unit from other units

descriptive_name string | null

the spelled out name of the unit, for example, meter

exact_mappings array | null

Used to link a unit to equivalent concepts in ontologies such as UO, SNOMED, OEM, OBOE, NCIT

has_quantity_kind string | null

Concept in a vocabulary or ontology that denotes the kind of quantity being measured, e.g. length

iec61360code string | null
symbol string | null

name of the unit encoded as a symbol

ucum_code string | null

associates a QUDT unit with its UCUM code (case-sensitive).