Vocabularies
Store terms and definitions for validation and referential applications
Clinia's Terminology Module enables the creation and management of highly specific Vocabularies. These Vocabularies serve as structured repositories for storing and organizing lists of Concepts tailored to a particular domain or application.
Creating a Vocabulary
To create a vocabulary, you only need to provide three key pieces of information: the mandatory vocabulary-key
(specified via URL parameters) title
and description
.
{
"title": "<title>",
"description": "<description>"
}
Defining a new spoken-languages
vocabulary would look like:
{
"title": "Spoken Languages",
"description": "Define all the system-allowed spoken languages for the stored Providers"
}
For more details, see:Create a Vocabulary
Other Possible Operations
The Vocabularies endpoint also allows to:
- List all vocabularies
- Upsert a selected Vocabulary
- Delete a Vocabulary
- Bulk actions on the Vocabularies
Key Characteristics of a Vocabulary
- Domain-Specific:
The vocabulary should be tailored to the specific fields or systems being documented. An example of those could be UI translatable enumerable used in the Data Sources. - Standardized Language:
Ensures your vocabulary uses consistent designations for each term and its translations. - Cross-Referencing:
Vocabularies can be referred to in Field Validation, to allow for fields to be validated against all contained Concepts.
Updated 7 days ago
What’s Next