Individual exercise
Have participants read the FAIR Cookbook’s Introducing the FAIR Principles to get an idea of what the FAIR principles entail.
This lesson plan will help to better understand what ontologies and vocabularies are, how they relate to the FAIR principles, and why they are important for research.
This lesson plan will help to better understand what ontologies and vocabularies are, how they relate to the FAIR principles, and why they are important for research. At the end of this lesson, participants will be able to define and distinguish ontologies and vocabularies, understand how they are used in repositories, explain their role in metadata organisation, use ontology lookup services, and evaluate the process of creating an ontology or vocabulary.
Ontologies and vocabularies enhance standardisation and foster a shared understanding between people and machines, thereby increasing the semantic interoperability of digital resources. By providing a common framework for organising knowledge, they promote the discovery of relevant scientific information, improve data mining and analysis, and support the development of intelligent systems.
Provide a clear overview of what ontologies and vocabularies are, how they differ, and why they matter for structuring and enriching metadata, using examples tailored to the audience’s domain (e.g., biology, social sciences, cultural heritage). Explain how ontologies support consistency, interoperability, and meaningful metadata. The lecture should explain semantic heterogeneity and show examples of how vocabularies and ontologies solve it.
1. Why metadata needs semantic structure - short explanation of why metadata alone is not enough
2. Semantic heterogeneity
3. From vocabulary to ontology - increasing structure increases machine interpretability of data
4. How to find and explore vocabularies/ontologies - prepare the learners for the practical activities
Additional resources: W3C Best practices for publishing vocabularies, OBO Best practices
The workshop can be adapted to different audience levels. The following three routes vary in depth, technical complexity, and learning focus. Educators may select the route that best matches the participants’ experience level and available time.
Target audience: Early career researchers, PhD students, research support staff
Focus: Understanding how ontologies can be accessed programmatically and why persistent identifiers are important for semantic interoperability.
Outcome emphasis: Primarily Understanding ★, light Application ★★
Suggested duration: 60–90 minutes
Ontology lookup services allow researchers to find standardised concepts and identifiers that describe data consistently across systems.
Instead of manually browsing ontology portals, these services can also be accessed programmatically using an API (Application Programming Interface).
An API enables software systems to communicate with each other in a structured way. The BioPortal API allows users to send search queries and retrieve ontology concepts, their definitions, and their persistent identifiers.
Request URI
Example search query: http://data.bioontology.org/search?q=diabetes
The parameter q=diabetes instructs the API to search for ontology concepts related to the term diabetes.
Headers
The BioPortal API requires an authentication header containing the user’s API key:
Authorization: apikey YOUR_API_KEY
The API key identifies the user and allows controlled access to the service.
Response format
The API returns results in JSON (JavaScript Object Notation), a structured data format commonly used for exchanging data between systems.
Below is a simplified example of a result returned for the query “diabetes”:
{ “collection”: [ { “prefLabel”: “Diabetes mellitus”, “@id”: “http://purl.bioontology.org/ontology/SNOMEDCT/73211009”, “definition”: [ “A metabolic disease characterised by hyperglycaemia resulting from defects in insulin secretion, insulin action, or both.” ], “ontology”: “SNOMEDCT” } ] }
Key elements in the JSON response include:
| Field | Meaning |
|---|---|
| prefLabel | Preferred human-readable name of the concept |
| @id | Persistent identifier (URI) for the ontology concept |
| definition | Formal description of the concept |
| ontology | Source ontology providing the concept |
The URI is the most important element for semantic interoperability.
Instead of storing free-text descriptions such as “diabetes”, datasets can store the URI:
http://purl.bioontology.org/ontology/SNOMEDCT/73211009
This ensures that the concept’s meaning remains consistent, unambiguous, and machine-interpretable across systems.
Figure X – BioPortal API Workflow
Caption: Programmatic access to ontology terms enables scalable semantic annotation.
The instructor demonstrates a simple API request.
Example:
curl -X GET “http://data.bioontology.org/search?q=diabetes” -H “Authorization: apikey YOUR_API_KEY”
Participants observe the returned JSON response and identify key elements such as:
Discussion questions:
Participants perform ontology searches using one of the following tools:
Participants search for several terms such as:
For each concept they identify:
Participants record results in a table:
| Term | Preferred Label | Ontology | URI | | —- | ————— | ——– | — |
Practical exercise – dataset annotation (20 min)
Participants annotate a simple dataset using ontology identifiers.
Example dataset:
| ID | Diagnosis |
|---|---|
| 1 | diabetes |
| 2 | asthma |
| 3 | hypertension |
Task:
Result:
| ID | Diagnosis | Ontology_URI | | – | ——— | ————- |
Discussion questions:
The discussion should emphasise validation, documentation, and governance of ontology mappings.
Target audience: Data stewards, research software engineers, and experienced researchers
Focus: Applying ontology lookup workflows and analysing how semantic identifiers can be integrated into research data pipelines.
Outcome emphasis: Application ★★, Analysis ★★, some Evaluation ★★★
Suggested duration: 2–2.5 hours
Brief overview of semantic interoperability and the role of shared vocabularies.
Explain how ontology APIs support:
Participants experiment with ontology searches using the BioPortal API.
Example query:
curl -X GET “http://data.bioontology.org/search?q=diabetes” -H “Authorization: apikey YOUR_API_KEY”
Participants explore:
Example: http://data.bioontology.org/search?q=diabetes\&ontologies=SNOMEDCT
Participants analyse differences between ontologies and discuss concept ambiguity.
Participants run a Python script to retrieve ontology identifiers.
Example:
import requests
API_KEY = "YOUR_API_KEY"
url = "http://data.bioontology.org/search"
params = {
"q": "diabetes",
"ontologies": "SNOMEDCT"
}
headers = {
"Authorization": f"apikey {API_KEY}"
}
response = requests.get(url, params=params, headers=headers)
data = response.json()
for result in data["collection"]:
print("Label:", result["prefLabel"])
print("URI:", result["@id"])
Participants modify the script to query different concepts.
Participants annotate a dataset using ontology URIs retrieved via the API.
They compare results and discuss differences in ontology selection.
Discussion topics:
Target audience: Senior data stewards, infrastructure architects, interoperability specialists
Focus: Evaluating ontology lookup strategies and designing scalable semantic annotation workflows.
Outcome emphasis: Evaluation and strategic reasoning ★★★
Suggested duration: Half-day workshop
Discuss challenges of implementing semantic interoperability at scale.
Topics include:
Participants explore advanced BioPortal API usage:
Participants design a conceptual workflow integrating ontology lookup into a data pipeline.
Example workflow:
Dataset → Concept extraction → BioPortal API query → URI retrieval → Semantic annotation → Data integration
Groups propose validation and documentation steps.
Participants discuss governance questions such as:
Participants reflect on trade-offs between:
11 activities · 260 min total · grouped by phase
Have participants read the FAIR Cookbook’s Introducing the FAIR Principles to get an idea of what the FAIR principles entail.
There should also be an activity to ensure learners are familiar with metadata, since it is not addressed in this lesson plan.
</sup>
Present what ontologies and vocabularies are, how they differ, and why they matter for structuring and enriching metadata. Show how semantic heterogeneity arises and demonstrate how vocabularies and ontologies address it.
</sup>
Demonstrate how to look up ontology terms using an ontology lookup platform (e.g., OLS, BioPortal), showing preferred labels, URIs, and ontology sources.
</sup>
In pairs or trios, have participants search for relevant ontology terms for their extracted concepts across multiple ontology platforms and compare the results.
</sup>
Using selected concepts, groups identify essential terms in their domain, resolve duplicates, clarify definitions, and group terms into a structured vocabulary.
</sup>
Ask participants to link their vocabulary terms to existing ontology concepts using URIs or identifiers where available.
</sup>
Provide small datasets with different terminologies and have groups harmonise them by mapping terms to shared ontology identifiers.
</sup>
Invite participants to reflect on how ontology use could influence their own research workflows or metadata practices.
</sup>
</sup>
Facilitate a discussion about challenges in selecting ontology terms, semantic ambiguity, and gaps in existing vocabularies.
No separate task summary is stored yet. The activity agenda above is the current source for trainer actions.
Aktau A, van Ulzen N, Konrad A, Tamana S, Gai L. Data vocabularies and ontologies. Version 1.0. FAIR Lesson Plan Handbook [Internet]. 2026. Available from: https://doi.org/10.5072/zenodo.627845