Class: Entity

Anything that exists, has existed, or will exist.

classDiagram class Entity Element <|-- Entity Entity <|-- InformationEntity Entity <|-- Activity Entity <|-- Agent Entity <|-- Proposition Entity : description Entity : extensions Entity --|> Extension : extensions Entity : id Entity : identifiers Entity : label Entity : recordMetadata Entity --|> RecordMetadata : recordMetadata Entity : type Entity : urls Entity : xrefs

Inheritance

Element
- Entity

Slots

Name	Cardinality and Range	Description	Inheritance
id	1..1 Identifier	The logical identifier of the entity in the system of record, e.g. a UUID. This 'id' is unique within a given system. The identified entity may have a different 'id' in a different system.	direct
identifiers	0..* Identifier	A business identifier or accession number for the entity, typically as provided by an external system or authority, that is globally unique and persists across implementing systems.	direct
label	0..1 String	A primary name for the Entity.	direct
urls	0..* Url	The URL/web address of a digital resource representing the entity, or providing information about it.	direct
xrefs	0..* String	Cross-references to database identifier(s) representing the same (or a closely related) entity or concept as the Entity.	direct
recordMetadata	0..1 RecordMetadata	A reusable structure that encapsulates provenance metadata about the present record/data object (as opposed to provenance information about the real world entity this record/data object represents).	direct
type	1..1 Class	The schema class that is instantiated by the data object. Must be the name of a class from the VA schema.	Element
description	0..1 String	A free text description of the Element.	Element
extensions	0..* Extension	A key-value data structure that allows definition of custom fields to capture information not directly supported by the VA specification.	Element

Usages

used by	used in	type	used
StudyResult	focus	range	Entity
Activity	input	range	Entity
Activity	output	range	Entity
Contribution	input	range	Entity
Contribution	output	range	Entity

Comments

Entity is the ancestorof all Core and Domain Entity classes in the model, which inherit attributes holding identifiers and other general metadata like labels, xrefs, urls, descriptions.

Aliases

Thing

Identifier and Mapping Information

Schema Source

from schema: https://w3id.org/ga4gh-va-core-im

Mappings

Mapping Type	Mapped Value
self	vacoreim:Entity
native	vacoreim:Entity

LinkML Source

Direct

name: Entity
description: Anything that exists, has existed, or will exist.
title: Entity
comments:
- Entity is the ancestorof all Core and Domain Entity classes in the model, which
  inherit attributes holding identifiers and other general metadata like labels, xrefs,
  urls, descriptions.
from_schema: https://w3id.org/ga4gh-va-core-im
aliases:
- Thing
is_a: Element
slots:
- id
- identifiers
- label
- urls
- xrefs
- recordMetadata
slot_usage:
  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. The identified entity may
      have a different 'id' in a different system.
    comments:
    - FHIR naming conventions are followed here, where an 'id' field holds logical
      identifiers which are unique only within a given system, and an 'identifier'
      field holds business identifiers, which are globally unique and used to connect
      entities and share content across systems.
    multivalued: false
    domain_of:
    - Entity
    range: Identifier
    required: true
  identifiers:
    name: identifiers
    description: A business identifier or accession number for the entity, typically
      as provided by an external system or authority, that is globally unique and
      persists across implementing systems.
    comments:
    - FHIR naming conventions are followed here, where an 'id' field holds logical
      identifiers which are unique only within a given system, and an 'identifier'
      field holds business identifiers, which are globally unique and used to connect
      entities and share content across systems.
    multivalued: true
    domain_of:
    - Entity
    range: Identifier
    required: false
  label:
    name: label
    description: A primary name for the Entity.
    multivalued: false
    domain_of:
    - Entity
    - Coding
    range: string
    required: false
  urls:
    name: urls
    description: The URL/web address of a digital resource representing the entity,
      or providing information about it.
    comments:
    - This attribute is meant to point directly to locations on the web where more
      information about the Entity can be found.
    multivalued: true
    domain_of:
    - Entity
    range: Url
    required: false
  xrefs:
    name: xrefs
    description: Cross-references to database identifier(s) representing the same
      (or a closely related) entity or concept as the Entity.
    comments:
    - Preferred values for this field are CURIEs or URLs for database records - so
      the system that provisioned the identifier is clear.
    multivalued: true
    domain_of:
    - Entity
    range: string
    required: false
  recordMetadata:
    name: recordMetadata
    description: A reusable structure that encapsulates provenance metadata about
      the present record/data object  (as opposed to provenance information about
      the real world entity this record/data object represents).
    comments:
    - Record-level metadata applies to a specific concrete encoding/serialization
      of information (e.g as a record in a specific knowlegebase, or an online digital
      resource). A RecordMetadata object can capture when, how, and by whom a specific
      record was generated or modified; what upstream resources it was derived/retrieved
      from; and record-level administrative information such as versioning and system
      / lifecycle status.
    multivalued: false
    domain_of:
    - Entity
    range: RecordMetadata
    required: false

Induced

name: Entity
description: Anything that exists, has existed, or will exist.
title: Entity
comments:
- Entity is the ancestorof all Core and Domain Entity classes in the model, which
  inherit attributes holding identifiers and other general metadata like labels, xrefs,
  urls, descriptions.
from_schema: https://w3id.org/ga4gh-va-core-im
aliases:
- Thing
is_a: Element
slot_usage:
  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. The identified entity may
      have a different 'id' in a different system.
    comments:
    - FHIR naming conventions are followed here, where an 'id' field holds logical
      identifiers which are unique only within a given system, and an 'identifier'
      field holds business identifiers, which are globally unique and used to connect
      entities and share content across systems.
    multivalued: false
    domain_of:
    - Entity
    range: Identifier
    required: true
  identifiers:
    name: identifiers
    description: A business identifier or accession number for the entity, typically
      as provided by an external system or authority, that is globally unique and
      persists across implementing systems.
    comments:
    - FHIR naming conventions are followed here, where an 'id' field holds logical
      identifiers which are unique only within a given system, and an 'identifier'
      field holds business identifiers, which are globally unique and used to connect
      entities and share content across systems.
    multivalued: true
    domain_of:
    - Entity
    range: Identifier
    required: false
  label:
    name: label
    description: A primary name for the Entity.
    multivalued: false
    domain_of:
    - Entity
    - Coding
    range: string
    required: false
  urls:
    name: urls
    description: The URL/web address of a digital resource representing the entity,
      or providing information about it.
    comments:
    - This attribute is meant to point directly to locations on the web where more
      information about the Entity can be found.
    multivalued: true
    domain_of:
    - Entity
    range: Url
    required: false
  xrefs:
    name: xrefs
    description: Cross-references to database identifier(s) representing the same
      (or a closely related) entity or concept as the Entity.
    comments:
    - Preferred values for this field are CURIEs or URLs for database records - so
      the system that provisioned the identifier is clear.
    multivalued: true
    domain_of:
    - Entity
    range: string
    required: false
  recordMetadata:
    name: recordMetadata
    description: A reusable structure that encapsulates provenance metadata about
      the present record/data object  (as opposed to provenance information about
      the real world entity this record/data object represents).
    comments:
    - Record-level metadata applies to a specific concrete encoding/serialization
      of information (e.g as a record in a specific knowlegebase, or an online digital
      resource). A RecordMetadata object can capture when, how, and by whom a specific
      record was generated or modified; what upstream resources it was derived/retrieved
      from; and record-level administrative information such as versioning and system
      / lifecycle status.
    multivalued: false
    domain_of:
    - Entity
    range: RecordMetadata
    required: false
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. The identified entity may
      have a different 'id' in a different system.
    comments:
    - FHIR naming conventions are followed here, where an 'id' field holds logical
      identifiers which are unique only within a given system, and an 'identifier'
      field holds business identifiers, which are globally unique and used to connect
      entities and share content across systems.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: id
    owner: Entity
    domain_of:
    - Entity
    range: Identifier
    required: true
  identifiers:
    name: identifiers
    description: A business identifier or accession number for the entity, typically
      as provided by an external system or authority, that is globally unique and
      persists across implementing systems.
    comments:
    - FHIR naming conventions are followed here, where an 'id' field holds logical
      identifiers which are unique only within a given system, and an 'identifier'
      field holds business identifiers, which are globally unique and used to connect
      entities and share content across systems.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: identifiers
    owner: Entity
    domain_of:
    - Entity
    range: Identifier
    required: false
  label:
    name: label
    description: A primary name for the Entity.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: label
    owner: Entity
    domain_of:
    - Entity
    - Coding
    range: string
    required: false
  urls:
    name: urls
    description: The URL/web address of a digital resource representing the entity,
      or providing information about it.
    comments:
    - This attribute is meant to point directly to locations on the web where more
      information about the Entity can be found.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: urls
    owner: Entity
    domain_of:
    - Entity
    range: Url
    required: false
  xrefs:
    name: xrefs
    description: Cross-references to database identifier(s) representing the same
      (or a closely related) entity or concept as the Entity.
    comments:
    - Preferred values for this field are CURIEs or URLs for database records - so
      the system that provisioned the identifier is clear.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: xrefs
    owner: Entity
    domain_of:
    - Entity
    range: string
    required: false
  recordMetadata:
    name: recordMetadata
    description: A reusable structure that encapsulates provenance metadata about
      the present record/data object  (as opposed to provenance information about
      the real world entity this record/data object represents).
    comments:
    - Record-level metadata applies to a specific concrete encoding/serialization
      of information (e.g as a record in a specific knowlegebase, or an online digital
      resource). A RecordMetadata object can capture when, how, and by whom a specific
      record was generated or modified; what upstream resources it was derived/retrieved
      from; and record-level administrative information such as versioning and system
      / lifecycle status.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: recordMetadata
    owner: Entity
    domain_of:
    - Entity
    range: RecordMetadata
    required: false
  type:
    name: type
    description: The schema class that is instantiated by the data object.  Must be
      the name of a class from the VA schema.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: type
    owner: Entity
    domain_of:
    - Element
    range: Class
    required: true
  description:
    name: description
    description: A free text description of the Element.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: false
    alias: description
    owner: Entity
    domain_of:
    - Element
    - Extension
    range: string
    required: false
  extensions:
    name: extensions
    description: A key-value data structure that allows definition of custom fields
      to capture information not directly supported by the VA specification.
    comments:
    - The VA-Spec provides  implementers the ability to extend any model elements
      with new attributes using this flexible Extension element.
    from_schema: https://w3id.org/ga4gh-va-core-im
    rank: 1000
    multivalued: true
    alias: extensions
    owner: Entity
    domain_of:
    - Element
    range: Extension
    required: false