Skip to content

Commit 3ff13da

Browse files
gtsuenggtsueng
committed
Updated DefinedTerm and added first draft of DefinedTermSet
1 parent bdc8ba6 commit 3ff13da

File tree

3 files changed

+534
-0
lines changed

3 files changed

+534
-0
lines changed

‎DefinedTerm/jsonld/DefinedTerm_v0.2-DRAFT.json‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
{
2+
"@context": {
3+
"schema": "http://schema.org/",
4+
"rdf": "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
5+
"rdfs": "http://www.w3.org/2000/01/rdf-schema#",
6+
"bioschemasdrafts": "https://discovery.biothings.io/view/DefinedTerm/",
7+
"owl": "http://www.w3.org/2002/07/owl/"
8+
},
9+
"@graph": [
10+
{
11+
"@id": "bioschemasdrafts:DefinedTerm",
12+
"@type": "rdfs:Class",
13+
"rdfs:comment": "A word, name, acronym, phrase, etc. with a formal definition. Use the name property for the term being defined, use termCode if the term has an alpha-numeric code allocated, use description to provide the definition of the term. This Bioschemas profile specifically helps reusing terms from terminology and ontology services. Version 0.2-DRAFT. <h3>Summary of Changes</h3> Changes since v0.1 <ul>Include DefinedTermSet profile as expected type for the 'inDefinedTermSet' property.</li></ul>",
14+
"rdfs:label": "DefinedTerm",
15+
"rdfs:subClassOf": {
16+
"@id": "schema:DefinedTerm"
17+
},
18+
"$validation": {
19+
"$schema": "http://json-schema.org/draft-07/schema#",
20+
"type": "object",
21+
"properties": {
22+
"termCode": {
23+
"description": "A code that identifies this DefinedTerm within a DefinedTermSet",
24+
"type": "string",
25+
"owl:cardinality": "one"
26+
},
27+
"inDefinedTermSet": {
28+
"description": "A DefinedTermSet that contains this term.",
29+
"$ref": "#/definitions/definedtermset",
30+
"owl:cardinality": "one"
31+
},
32+
"description": {
33+
"description": "A description of the item.",
34+
"type": "string",
35+
"owl:cardinality": "one"
36+
},
37+
"identifier": {
38+
"description": "The identifier property represents any kind of identifier for any kind of [[Thing]], such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as textual strings or as URL (URI) links. See [background notes](/docs/datamodel.html#identifierBg) for more details.\n ",
39+
"type": "string",
40+
"owl:cardinality": "one"
41+
},
42+
"name": {
43+
"description": "The name of the item.",
44+
"type": "string",
45+
"owl:cardinality": "one"
46+
},
47+
"sameAs": {
48+
"description": "URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Wikidata entry, or official website.",
49+
"owl:cardinality": "many"
50+
},
51+
"url": {
52+
"description": "URL of the item.",
53+
"oneOf": [
54+
{
55+
"type": "string",
56+
"format": "uri"
57+
},
58+
{
59+
"type": "array",
60+
"items": {
61+
"type": "string",
62+
"format": "uri"
63+
}
64+
}
65+
],
66+
"owl:cardinality": "many"
67+
}
68+
},
69+
"required": [
70+
"inDefinedTermSet"
71+
],
72+
"recommended": [
73+
"termCode",
74+
"sameAs",
75+
"name"
76+
],
77+
"optional": [
78+
"description"
79+
],
80+
"definitions": {
81+
"definedtermset": {
82+
"@type": "DefinedTermSet",
83+
"type": "object",
84+
"properties": {
85+
"url": {
86+
"type": "string",
87+
"format": "uri"
88+
},
89+
"name": {
90+
"type": "string"
91+
},
92+
"license": {
93+
"type": "string"
94+
},
95+
"version": {
96+
"type": "string"
97+
}
98+
},
99+
"required": ["url"]
100+
}
101+
}
102+
},
103+
"schemaVersion": [
104+
"https://schema.org/docs/releases.html#v23.0"
105+
]
106+
}
107+
]
108+
}

‎DefinedTermSet/README.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Profile for DefinedTerm and DefinedTermSet
2+
3+
The two SchemaOrg types DefinedTerm and DefinedTermSet
4+
are allowed in many places as property values.
5+
6+
In e.g. the life-sciences, there are a number of controlled vocabularies
7+
and ontologies, which are often used as source of the DefinedTerms.
8+
Many of the, can be browsed and accessed through terminology and lookup services or portals.
9+
10+
For linked data applications it is sufficient for an entity
11+
with `@type="DefinedTermSet"` to link to an `@id` pointing to the IRI
12+
of the referenced ontology.
13+
14+
In other cases, more information is needed to search and view defined term information
15+
without having to lookup external resources. E.g., a domain-specific search engine
16+
can create faceted search based on the `name` property, like e.g. done in TeSS.
17+
Aforementioned terminology services also offer linking and query interfaces
18+
beyond IRIs as parameters.
19+
20+
Another possible use of a conformant `DefinedTermSet`
21+
is to enable creating hyperlinks to other web resources, e.g.
22+
https://bio.tools/t?inputDataFormatID=%22format_3244%22
23+
or provide tool-tips if the `description` is provided.
24+
25+
Some typical OBO ontologies can be taken as inspiration of properties that should be
26+
required or recommended in a Bioschema DefinedTermSet profile. We also provide
27+
some mapping information between properties of `DefinedTermSet`
28+
and those from OBO, OWL and SKOS, following work in https://doi.org/10.1186/2041-1480-2-S1-S3.
29+
30+
It is not intended to duplicate the content and expressivity
31+
of powerful ontology representations and serialisations like OWL or RDF.

0 commit comments

Comments
 (0)