Ga4ghIdentifiableObject

Trial Use

May change in future releases. See Maturity Model.

Abstract Class — not instantiated directly; concrete subclasses inherit its attributes.

Computational Definition

An object for which a GA4GH computed identifier can be created.

Information Model

Some Ga4ghIdentifiableObject attributes are inherited from Entity.

Field

Flags

Type

Limits

Description

id

string

0..1

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 an object from another.

type

string

1..1

The name of the class that is instantiated by a data object representing the Entity.

name

string

0..1

A primary name for the entity.

description

string

0..1

A free-text description of the Entity.

aliases

⋮

string

0..m

Alternative name(s) for the Entity.

extensions

⋮

Extension

0..m

A list of extensions to the Entity, that allow for capture of information not directly supported by elements defined in the model.

digest

string

0..1

A sha512t24u digest created using the VRS Computed Identifier algorithm.

Inherits: Entity

Subclasses: Location, Variation