Wiki Spaces


Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack


Page tree
Skip to end of metadata
Go to start of metadata

User Testing Pointers

Please follow this link to test the application.
Key pointers:
- If you do not have credentials, use the old OCL to [sign up](, and then be sure to come back to the new OCL, again [here](
- If you are unable to login even after you had signed up, the database may have been reset and you would have to sign up again

All feedback can be shared at the user feedback discussion channel on talk(


To login, provide your registered username and password, then click the "Log in" button. 

Note: You can use your credentials from the Traditional OCL or click the "Sign up" link to register a new account, which will take the user to Traditional OCL.

User Home

After successful login, the application will redirect to the homepage. This page contains a list of the Dictionaries you created. Users can also navigate to the tabs side by to see

  • Your Organizations' Dictionaries: Dictionaries that are created and maintained under the Organizations they're member of 
  • Public Dictionaries: Dictionaries across OCL that are enabled with Public view access. This will also include the Dictionaries created by the user themselves if it has Public access enabled. 

You will have the option of creating a new Dictionary by clicking the "Create New Dictionary" button (circular plus icon).

Your Organizations' Dictionaries

Users who are part of an organization can create Dictionaries under that organization and also can contribute to the Dictionaries created by other members of the Organization. Below page allows the users to browse through such Dictionaries that are created and maintained under the Organizations they're member of. 

Public Dictionaries

Users can browse through all the public dictionaries, including those that belong to other people/organisations. Users can switch tab from their landing page to Public Dictionaries, which will take them to below page

New Dictionary

A real-life user may be creating dictionaries for different reasons, e.g. they may be creating an implementation dictionary for a specific hospital, or a starter set that will eventually be used by multiple hospitals. The UI for these is the same. Click "Create New Dictionary" to get started.

Field level details:

  • Dictionary name: Commonly used name for the dictionary
  • Shot code: Mnemonic used to identify the collection in the URL (usually an acronym e.g. Community-MCH)
  • Description: Details about the collection
  • Preferred Source: Source from which the concepts are going to be referred from.
  • Owner: Logged in user or the organizations that the user is member of
  • Visibility: Public access would enable people across OCL to view the Dictionary and subscribe. Private access would allow only the Owner to view and manage the dictionary. 
  • Preferred language: Language in which the concepts needs to have their names displayed on the UI.
  • Supported language: This helps while defining the translations for a concept where the locales will be based upon the languages selected here.

User will be taken to the same page when they want to edit a dictionary. Fields such as Short code, Owner cannot be changed from the value defined while creating the dictionary.

Dictionary Overview

Click on any of the available Dictionaries to access its overview page. This includes:

  • General details (Description, Owner, Access, ... )
  • Concept counts (From Preferred Source, Custom concepts from other Sources, ... )
  • Option to view the list of concepts in the HEAD version of the dictionary
  • A list of released versions with options to:
    • Create new version of the dictionary
    • Release/Unrelease a version of the Dictionary
    • Copy the Subscription URL, which can be used in OCL Subscription Module for importing the concepts from a OCL Dictionary into OpenMRS.
  • Option to edit the Dictionary

Releasing a Dictionary Version

You can release a dictionary version, essentially creating a frozen 'checkpoint' for the contents of your dictionary. Clicking the 'Create new version' button will give the following prompt;

Name your version and provide an optional description. Note that the version name must be one you have not used before, e.g you cannot release two 'Version 1's.

You can mark the Release status as Yes/No, indicating whether this version of the dictionary can be used for subscription or not. 

Providing these details and confirming the version creation will add that version to the list;

Users can see the list of concepts in each version by expanding the Actions button (3-dotted icon) and by clicking on the View concepts button. 

Users can then use the subscription URL to import a particular dictionary version.

For example, in the previous example, we have two release versions. The URL for version 2 is this;

and for version ID 1;

Dictionary Concepts

Click "View Concepts" to view the page similar to the one above. This shows a tabulated list of all Concepts in the HEAD version of the Dictionary with options for Search, Filter, Edit, Remove, and Retire

Note: Concepts that are imported from a source can only be Removed from a dictionary. Custom concepts created within the dictionary can be Edited and Retired but cannot be removed from the dictionary. 

Add Concepts To Your Collection (e.g. Add CIEL Concepts)

Users can add concepts to a dictionary by two ways:

  • Import concepts from a source (e.g. CIEL)
  • Create a custom concept within the dictionary

Add Concepts from a Source

Users can add concepts from a source, either by

  • Picking concepts from the source
  • Bulk import concepts with concept IDs

Pick concepts:

Use the search field and/or the filters to find your desired CIEL concept then click "Add to Dictionary" to add it to your Dictionary.

To see a preview of a Concept, click the Concept Name, which will take the user to a page similar to below

Bulk Add Concepts

To add existing concepts in bulk:

  1. Select the bulk import option to Add concepts
  2. You can switch between the preferred sources (top right corner) from where the concepts are to be imported into the dictionary.
  3. If you already have the Concept IDs, simply write/paste them into the Concept IDs field
  4. Click the "Add Concepts" button
  5. You can track the progress of the import in "Progress Notification" page (shown below)

Update A Concept's Version

Adding a CIEL concept adds the latest version of that concept to your collection. A later release of CIEL may update this concept with new information or mappings. If you would like to have these updates in your collection, simply remove the concept and then add it to the collection again. This will pull in the latest version of the concept once again.

Removing a concept from your collection

Clicking the remove button removes a concept from your collection.

Create a new concept

Click "Create new concept" then select the class of the Concept you wish to create. Fill in the form with appropriate values for Names, Descriptions, Mappings, e.t.c and click "Submit".

Create a concept example

Other OCL for OpenMRS Wiki Resources

Overview: Open Concept Lab (OCL) for OpenMRS

Road map: Open Concept Lab (OCL) for OpenMRS

MVP Testing Scenarios

  • No labels