Concepts

Terms contained in a Vocabulary

Concepts are the fundamental entries that represent specific terms, or entities within a vocabulary. Each concept encapsulates a unique piece of information and a related key-pair value list of terms used for translation in Clinia's UI.

Creating a Concept

The payload structure for creating a concept in a vocabulary consists of the following fields:

  • definition Symbol :
    A textual explanation or description of the concept’s meaning.
  • designation Object :
    A set of terms representing the concept in different languages or locales, provided as key-value pairs.
    • Key: A language or locale identifier (e.g., "en", "fr").
    • Value: The term corresponding to that language or locale.
  • code Code :
    A unique identifier for the concept within the vocabulary, ensuring no duplicates. This code is specific to the vocabulary and serves as a reference for the concept.
{
  "definition": "<definition>",
  "designation": { // List or key-pair value. This can include any language or locale
    "<language-key-1>": "<language-1-term>",
    "<language-key-2>": "<language-2-term>"
  },
  "code": "<unique-term-code>" // Unique inside the Vocabulary
}

One of the concepts that could be created in the examplespoken-languages vocabulary could look like:

{
  "definition": "English spoken-language",
  "designation": { 
    "en": "English",
    "fr": "Anglais",
    "es": "Inglés",
    // ...
  },
  "code": "lang-en"
}

For more details, see:Create a Concept in a Vocabulary

Multiple Operation Using the BULK Concept

A BULK endpoint is also available to send multiple concept operations (UPSERT, UPDATE, DELETE) at the same time:

  • UPSERT: Create or replace the whole Concept
  • UPDATE: Only updates the provided fields
  • DELETE: Delete the concept

You can refer to the Bulk Concept endpoint documentation for more details.

Note: This BULK process is synchronous. The result of the BULK is returned as a response.

Other Possible Operations