Class: Entity (Entity)
Anything that exists, has existed, or will exist.
Comments
- Entity is the root class of the 'gks-common' core information model. All common classes that have ids and other general metadata like label, description, type, or extensions descend from this class and inherit its attributes.
URI: sepio_linkml:Entity
Inheritance
Slots
Direct slots
The 'logical' identifier of the entity in the system of record, e.g. a UUID. This 'id' is unique within a given system, but may or may not be globally unique outside the system. It is used within a system to reference one object from another.
Implementation Guidance
* Note that it is common for implementers to create their own internal logical ids - typically a serially or randomly generated value like a UUID that is assigned to the data object as it is created in a system. But an implementer may choose to reuse an existing, globally unique id from an external system or authority for this purpose (e.g. an HGNC id for a Gene object) - as long as it is unique within the implementing system, and can be used to reference the identified object in this context.identifiers --> String [*]
A globally-unique 'business' identifier or accession number for the real-world entity represented by a data object. These are typically assigned by an external system or authority, and used to connect entities and share content across different systems.
Implementation Guidance
* Preferred values for this attribute are CURIEs or URIs - so the system that provisioned the identifier is clear.* A given real world entity - e.g. a genetic variant - may have many business identifiers defined by different systems, which can be captured in the "identifiers" property to indicate that they represent the same thing.
The name of the class that is instantiated by a data object representing the Entity.
Implementation Guidance
* MUST be the label of a concrete class from the data model.A primary name for the Entity.
alternativeLabels --> String [*]
Alternative name(s) for the Entity.
description --> String [0..1]
A free text description of the Entity.
extensions --> Extension [*]
A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.
Implementation Guidance
* Extension objects have a key-value data structure that allows definition of custom fields in the data itself. Extensions are not expected to be natively understood, but may be used for pre-negotiated exchange of message attributes between systems.Usages
Identifier and Mapping Information
Schema Source
- from schema: https://w3id.org/sepio-framework/sepio-linkml
Mappings
Mapping Type | Mapped Value |
---|---|
self | sepio_linkml:Entity |
native | sepio_linkml:Entity |
LinkML Source
Direct
name: Entity
description: Anything that exists, has existed, or will exist.
title: Entity
comments:
- Entity is the root class of the 'gks-common' core information model. All common
classes that have ids and other general metadata like label, description, type,
or extensions descend from this class and inherit its attributes.
from_schema: https://w3id.org/sepio-framework/sepio-linkml
status: Draft
attributes:
id:
name: id
description: The 'logical' identifier of the entity in the system of record, e.g.
a UUID. This 'id' is unique within a given system, but may or may not be globally
unique outside the system. It is used within a system to reference one object
from another.
comments:
- Note that it is common for implementers to create their own internal logical
ids - typically a serially or randomly generated value like a UUID that is assigned
to the data object as it is created in a system. But an implementer may choose
to reuse an existing, globally unique id from an external system or authority
for this purpose (e.g. an HGNC id for a Gene object) - as long as it is unique
within the implementing system, and can be used to reference the identified
object in this context.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
domain_of:
- Entity
range: string
required: true
multivalued: false
identifiers:
name: identifiers
description: A globally-unique 'business' identifier or accession number for the
real-world entity represented by a data object. These are typically assigned
by an external system or authority, and used to connect entities and share content
across different systems.
comments:
- Preferred values for this attribute are CURIEs or URIs - so the system that
provisioned the identifier is clear.
- A given real world entity - e.g. a genetic variant - may have many business
identifiers defined by different systems, which can be captured in the "identifiers"
property to indicate that they represent the same thing.
from_schema: https://w3id.org/sepio-model
status: Informative
rank: 1000
domain_of:
- Entity
range: string
required: false
multivalued: true
type:
name: type
description: The name of the class that is instantiated by a data object representing
the Entity.
comments:
- MUST be the label of a concrete class from the data model.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
domain_of:
- Entity
range: string
required: true
multivalued: false
label:
name: label
description: A primary name for the Entity.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
domain_of:
- Entity
- Coding
range: string
required: false
multivalued: false
alternativeLabels:
name: alternativeLabels
description: Alternative name(s) for the Entity.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
domain_of:
- Entity
range: string
required: false
multivalued: true
description:
name: description
description: A free text description of the Entity.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
domain_of:
- Entity
range: string
required: false
multivalued: false
extensions:
name: extensions
description: A list of extensions to the Entity, that allow for capture of information
not directly supported by elements defined in the model.
comments:
- Extension objects have a key-value data structure that allows definition of
custom fields in the data itself. Extensions are not expected to be natively
understood, but may be used for pre-negotiated exchange of message attributes
between systems.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
domain_of:
- Entity
range: Extension
required: false
multivalued: true
Induced
name: Entity
description: Anything that exists, has existed, or will exist.
title: Entity
comments:
- Entity is the root class of the 'gks-common' core information model. All common
classes that have ids and other general metadata like label, description, type,
or extensions descend from this class and inherit its attributes.
from_schema: https://w3id.org/sepio-framework/sepio-linkml
status: Draft
attributes:
id:
name: id
description: The 'logical' identifier of the entity in the system of record, e.g.
a UUID. This 'id' is unique within a given system, but may or may not be globally
unique outside the system. It is used within a system to reference one object
from another.
comments:
- Note that it is common for implementers to create their own internal logical
ids - typically a serially or randomly generated value like a UUID that is assigned
to the data object as it is created in a system. But an implementer may choose
to reuse an existing, globally unique id from an external system or authority
for this purpose (e.g. an HGNC id for a Gene object) - as long as it is unique
within the implementing system, and can be used to reference the identified
object in this context.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
alias: id
owner: Entity
domain_of:
- Entity
range: string
required: true
multivalued: false
identifiers:
name: identifiers
description: A globally-unique 'business' identifier or accession number for the
real-world entity represented by a data object. These are typically assigned
by an external system or authority, and used to connect entities and share content
across different systems.
comments:
- Preferred values for this attribute are CURIEs or URIs - so the system that
provisioned the identifier is clear.
- A given real world entity - e.g. a genetic variant - may have many business
identifiers defined by different systems, which can be captured in the "identifiers"
property to indicate that they represent the same thing.
from_schema: https://w3id.org/sepio-model
status: Informative
rank: 1000
alias: identifiers
owner: Entity
domain_of:
- Entity
range: string
required: false
multivalued: true
type:
name: type
description: The name of the class that is instantiated by a data object representing
the Entity.
comments:
- MUST be the label of a concrete class from the data model.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
alias: type
owner: Entity
domain_of:
- Entity
range: string
required: true
multivalued: false
label:
name: label
description: A primary name for the Entity.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
alias: label
owner: Entity
domain_of:
- Entity
- Coding
range: string
required: false
multivalued: false
alternativeLabels:
name: alternativeLabels
description: Alternative name(s) for the Entity.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
alias: alternativeLabels
owner: Entity
domain_of:
- Entity
range: string
required: false
multivalued: true
description:
name: description
description: A free text description of the Entity.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
alias: description
owner: Entity
domain_of:
- Entity
range: string
required: false
multivalued: false
extensions:
name: extensions
description: A list of extensions to the Entity, that allow for capture of information
not directly supported by elements defined in the model.
comments:
- Extension objects have a key-value data structure that allows definition of
custom fields in the data itself. Extensions are not expected to be natively
understood, but may be used for pre-negotiated exchange of message attributes
between systems.
from_schema: https://w3id.org/sepio-model
status: Draft
rank: 1000
alias: extensions
owner: Entity
domain_of:
- Entity
range: Extension
required: false
multivalued: true