ts_ids_core.schema.semantic.concept module

This module contains the definition of the Concept class which is used when the value(s) of a field are drawn from a controlled vocabulary.

Example:

class Species(Concept):

pass

species = Species(

canonical_id=”http://purl.obolibrary.org/obo/NCIT_C45247”, canonical_term=”Mus musculus”, user_facing_display=”Mouse”,

)

Model Concept

Bases: IdsElement

A concept is a semantic entity (e.g. from a controlled vocabulary) with a unique identifier.

Show JSON schema

{
   "description": "A concept is a semantic entity (e.g. from a controlled vocabulary) with a unique identifier.",
   "type": "object",
   "properties": {
      "canonical_id": {
         "description": "Unique identifier, often a URI assigned to a concept.",
         "type": [
            "string",
            "null"
         ]
      },
      "canonical_term": {
         "description": "Preferred label or name of concept.",
         "type": [
            "string",
            "null"
         ]
      },
      "user_facing_display": {
         "description": "User facing display of the concept.",
         "type": [
            "string",
            "null"
         ]
      }
   },
   "additionalProperties": false
}

Validators:

• all_abstract_fields_implemented » all fields

field canonical_id: Nullable[str]

Unique identifier, often a URI assigned to a concept.

field canonical_term: Nullable[str]

Preferred label or name of concept.

field user_facing_display: Nullable[str]

User facing display of the concept.