OntologyClass

This element is used to represent classes (terms) from ontologies, and is used in many places throughout the Phenopacket standard. It is a simple, two element message that represents the identifier and the label of an ontology class.

The ID SHALL be a CURIE-style identifier e.g. HP:0100024, MP:0001284, UBERON:0001690, i.e., the primary key for the ontology class. The label should be the corresponding class name. The Phenopacket standard REQUIRES that the id and the label match in the original ontology. We note that occasionally, ontology maintainers change the primary label of a term.

Data model

Field Type Status Description
id string required A CURIE-style identifier e.g. HP:0001875
label string required A human-readable class name e.g. Neutropenia

Example

{
  "id": "HP:0001875",
  "label": "Neutropenia"
}

id

The ID of an OntologyClass element MUST take the form of a CURIE format. In order that the class is resolvable, it MUST reference the namespace prefix of a Resource named in the MetaData.

label

The the human-readable label for the concept. This MUST match the ID in the ontology referenced by the namespace prefix in a Resource named in the MetaData.