Scenarios Discussion

From BiomedGT

This page provides scenarios/use cases that describe the use of this wiki for terminology authoring and updating. If you have use cases not shown here, please contribute new ones.

Refer to the User Roles page for definitions of the various actors described below.

Contents 1 Entry Points for Finding a Concept 2 Content Review by Collaborators 3 Terminology Update 4 Update Review 5 Subset Creation 6 New Terminology Entry 7 Creating a new Hierarchy or Subtree (not implemented) 8 Reporting

Entry Points for Finding a Concept

SME locates a concept using any of the following methods:

• From any BiomedGT content page:
  1. Clicks one of the terminologies links on the left navigation bar.
  2. Navigates the hierarchy.
• From any BiomedGT content page, follows these steps to locate a known category page:
  1. Enters exact page name in the search box.
  2. Clicks the Go button.
• From any BiomedGT content page, follows these steps to run a query:
  1. Enters a code, preferred name, or other query mechanism in the search box.
  2. Clicks the Search button.
  3. Selects a result.
• Links to concepts of interest using a URL in the wiki itself.

Content Review by Collaborators

1. SME uses a navigation hierarchy to traverse a subset of existing content applicable to the domain of expertise.
   • The subset appears to the SME as—and may, in fact, be—a separate ontology.
   • Links to the integrating terminology can be exposed or hidden as required. These are not fully implemented for the first alpha release.
   • Tags might be used in the short term.
2. SME makes recommendations about enhancements to the terminology by submitting proposals to
   • change existing content, or
   • recommend addition of new content.
3. Proposals are added to a list of pending changes that can be reviewed, extended, or checked by other SMEs and the Alpha SME.
   • We anticipate that dialogs may occur between several SMEs on particularly thorny topics. These discussions will be recorded on an appropriate discussion page.
   • At some point, SMEs will decide that one or more of the recommendations are ready for implementation (that is, ready to be integrated into the BiomedGT or other curated terminology).
     • In some cases, this decision will occur at point of edit. Typo corrections, simple enhancements, and addition of obvious synonyms, fit this category.
     • In other cases, the decision will follow a long dialog, and groups of recommendations will be submitted en-masse. Submissions of this case would be performed by the Alpha SME, who would have the final say in what and when things are ready.
4. Recommendations are marked as ready for implementation, either as batches or singly.
   • The general notion is that recommendations need to follow an analog of the ACID principle and take the terminology database from one valid state to a second. For example: Delete concept A, create concept B and C, and link both concepts to the parent of concept A. This has to occur in one transaction. Similarly, the addition of 100 children to a particular branch may need to occur as one edit.
   • A recommendation package may be given additional metadata such as change description, urgency, or contacts.
   • Recommendations that are ready for implementation may not be changed without coordination with a representative of the Curation community.

Terminology Update

1. Alpha Curator
   • receives notification that a recommendation batch is ready for incorporation.
   • delegates the task to the appropriate curator.
2. Curator retrieves the recommendation batch.
   Each recommendation may include one or more of the following sub-components, as appropriate:
   • A structured image of the changes to be incorporated. This will be drawn from the forms/template/RDF mechanisms.
     
   • A freetext description of the requested changes. This may be drawn from a separate form, another edit tab or some combination of the above. Details need to be determined.
     
   • A discussion history. Curators will have access to the discussion threads that led to recommendation, if any.
3. If necessary, Curator continues an existing discussion on the wiki side, adds a new discussion, or edits a portion of a recommendation. SMEs must sign off on the edited recommendations before the process proceeds.
4. Curators incorporate the requested changes, creating additional notes about the process (such as why they didn't do things or things that they did differently). Notes are made available to the SME community (as they are created?) (when the change is committed?)

Update Review

1. Content Curator notifies SMEs, SME Curator, and other interested parties that the recommendation package has been incorporated.
2. The implementation becomes available in a conditional form on the wiki. (What and how still needs to be determined.)
3. If SMEs agree,
   • Alpha SME (or submitter in the case of simple changes) verifies that changes were implemented as requested and signs off.
   •  ??? notifies all interested parties that the change can be incorporated into the next release.
4. If SMEs disagree, (need alternate steps).

Subset Creation

• SME adds terms to multiple subsets by adding the appropriate entry to the Coding Scheme box in the structured change box.

or

• SME adds an existing concept from BiomedGT to a specific subset through the Coding Scheme box in the structured change box, as above. If the concept already exists, this is preferable to requesting a new term (see New Terminology Entry).

New Terminology Entry

1. SME
   • Locates concept to add a new child.
   • Selects the Add a Child function.
   • Fills out the structured form.
2. Content Curator
   • Retrieves proposal package using Protégé.
   • Reviews proposal.
   • Adds new term.
3. System assigns a new concept code.

Creating a new Hierarchy or Subtree (not implemented)

• SME wants to create a whole subtree at once, rather than one concept at a time.

Current wiki model can't accommodate this. WORK-AROUND -

1. SME
   • Locate the parent concept,
   • Go to the discussion page,
   • Sketch the hierarchy, with Preferred Name and Semantic Type,
   • Add signature to page
   • Incorporate this unstructured change proposal into a work package to send to Content Curator.
2. Content Curator
   • Reviews Proposal
   • Adds hierarchy concepts (may converse via wiki discussion or phone)
   • Marks complete and publishes concepts back to wiki
3. SME
   • Add change proposals for new concepts to include definitions, synonyms, etc.

Reporting

• SME wants to create concept reports or tree reports in excel or text documents (not implemented).