Business Requirements

The Concept Set module stores the search terms and the current Vocabulary version when Concepts are added to a Concept Set. For example, "aspirin 300" is a keyword used to search Concepts for the Concept Set named "Aspirin Case Study" using the "vocabulary_20220111" Vocabulary. These metadata will be stored within for tracking and documentation. [Primarily for regulatory and publication work]

Functional Requirements

When a Concept is added to a Concept Set as a Concept Set Item there should be an annotation automatically added which encompasses any contextual parameters being used to display a Concept

There are multiple screens from which it is possible to add a Concept into a Concept Set, the metadata might be the following:

• Search listing (the search term itself, advanced options (Domains, Vocabularies), filters)
• Concept Details (previous page context)
• Related Concepts (previous page context, filters)
• Concept Hierarchy (previous page context, filters)
• Concept Set - Included Concepts (previous page context, filters)
• Concept Set - Included Source Codes (previous page context, filters)
• Concept Set - Recommend (previous page context, filters)
• Concept Set - Import - Concept Identifiers (previous page context, filters)
• Concept Set - Import - Source Codes (previous page context, filters)
• Concept Set - Import - Concept Set (previous page context)
• Concept Set - Import - Repository (previous page context)
• any other places?!

The previous page context to be assessed if possible to add as metadata to a Concept Set Item annotation

It is essential to add the Vocabulary Version to the annotation so that a Concept origin is known (to be checked if anything extra to this badge "v5.0 19-MAY-20" is required)

A new tab "Metadata" (naming to be defined) should be added after the "Compare" tab to display annotations for each Concept Set Item, by default an annotation after being added will contain a templated text which can be edited after

The annotations listing should contain information when an annotation was added, who added it, the annotation text itself (editable) and when it was updated and by whom

The feature should be optional, effective by an explicit application property switch

Opened Questions

• there should be no intention to extend Circe with the Concept Set Item annotations so that this information is transferred between WebAPI / ATLAS installations