Skip to content

Latest commit

 

History

History
164 lines (88 loc) · 11.1 KB

File metadata and controls

164 lines (88 loc) · 11.1 KB

EGA individual metadata schema Schema

https://raw.githubusercontent.com/EbiEga/ega-metadata-schema/main/schemas/EGA.individual.json

Metadata schema used by the European Genome-phenome Archive (EGA) to validate its individual metadata object. This object is intended to contain metadata about the individual, also known as the sample donor or subject of study. An individual is defined as a person that participates in an experiment or from which a material sample was derived. Further details can be found in the EGA-metadata-schema GitHub repository (https://github.com/EbiEga/ega-metadata-schema/tree/main/schemas) and EGA-archive website (https://ega-archive.org/)

Abstract Extensible Status Identifiable Custom Properties Additional Properties Access Restrictions Defined In
Can be instantiated No Unknown status No Forbidden Forbidden none EGA.individual.json

EGA individual metadata schema Type

object (EGA individual metadata schema)

EGA individual metadata schema Properties

Property Type Required Nullable Defined by
objectId Merged Required cannot be null EGA individual metadata schema
schemaDescriptor object Optional cannot be null EGA individual metadata schema
organismDescriptor object Required cannot be null EGA individual metadata schema
minimalPublicAttributes Merged Required cannot be null EGA individual metadata schema
individualRelationships array Optional cannot be null EGA individual metadata schema
individualAttributes array Optional cannot be null EGA individual metadata schema

objectId

Node containing the main identifiers of the object (e.g. alias, centerName...), inherited from the common definitions. #! We extend the core object (objectCoreId) by adding a pattern check based on this schema's nature: a individual (by using EGAIndividualIdPattern)

objectId

objectId Type

object (Object's IDs block)

all of

schemaDescriptor

This node is intended to be used to describe the schemas and standards that a JSON document was based on. For instance, if a sample.json document was created to be validated against EGA.sample.json schema version 1.0.0, such information should be reflected in this block. This way, both a human and a machine can interpret and validate the JSON document efficiently, without the need of guessing versions.

schemaDescriptor

schemaDescriptor Type

object (Schema descriptor)

organismDescriptor

This property describes the material entity the sample consists in. That is, an individual living system, such as animal, plant, bacteria or virus, that is capable of replicating or reproducing, growth and maintenance in the right environment. An organism may be unicellular or, like humans, made up of many billions of cells divided into specialized tissues and organs. This node is of special interest in case the provenance of the sample is not human (e.g. microbiota taken from a donor). Unless stated otherwise, given the nature of the EGA, it is expected to be of human provenance.

organismDescriptor

organismDescriptor Type

object (Organism [OBI:0100026] descriptor block)

minimalPublicAttributes

Among all attributes describing an individual, some may contain identifiable metadata and thus must be private. Nevertheless, there are three/four required attributes (even if they are unknown): subject id, biological sex, phenotypicAbnormalities and/or diseases. These shall be displayed and queryable on our portal. In the case of a healthy individual (with no phenotypic abnormalities nor diseases), the 'phenotypicAbnormalities' and 'diseases' arrays will contain a reference to 'Unaffected' [NCIT:C94232]. Do take into account the 'excluded' property of each 'disease' or 'phenotypicAbnormality' in order to evaluate it correctly, since logic negation can be provided using that property.

minimalPublicAttributes

minimalPublicAttributes Type

object (Minimal public attributes describing an individual)

any of

individualRelationships

Comprises metadata (e.g. Source or Target) of a directional association between two entities. This relationships node contains all the possible relationships between metadata objects, both outside of (e.g. a viral sample from BioSamples being linked to a blood sample within the EGA) and within (e.g. a sample being linked to an individual) the EGA.

individualRelationships

individualRelationships Type

an array of merged types (Details)

individualRelationships Constraints

minimum number of items: the minimum number of items for this array is: 1

unique items: all items in this array must be unique. Duplicates are not allowed.

individualAttributes

Custom attributes of an individual: reusable attributes to encode tag-value pairs (e.g. Tag being 'age' and its Value '30') with optional units (e.g. 'years'). Its properties are inherited from the common-definitions.json schema.

individualAttributes

individualAttributes Type

object[] (Custom attribute of an object)

individualAttributes Constraints

minimum number of items: the minimum number of items for this array is: 1

unique items: all items in this array must be unique. Duplicates are not allowed.