Add support for synonyms, active flag and @HideChoice

This release adds support for synonyms, an active flag and the @HideChoice action tag.

Synonyms

Synonyms allows the definition of alternative text which will be search for the same term.
These can be defined in both json and bar value formats
e.g.

[
{"code": "fan", "display": "Robert Fanning", "synonyms": ["Bob Fanning", "fan"]},
{"code": "che", "display": "Justine Brown", "synonyms": ["Justine Chen", "Jai Li Chen", "che"]},
{"code": "coo", "display": "Cooper Derricks", "synonyms": ["coo"]},
{"code": "col", "display": "Morty Cole", "synonyms": ["col"]}
]

Active Flag

Codes can be marked as being inactive. Inactive terms will not be returned as options when a search takes place, but will still be present for if the code needs to be looked up. This can be defined in json by adding an extra "active": false or by using a ! at the beginning of the line for list and bar formats.
e.g.

fan|Robert Fanning|Bob Fanning|fan
che|Justine Brown|Justine Chen|Jai Li Chen|che
coo|Cooper Derricks|coo
!col|Morty Cole|col
\!escape|Code with an leading !

Morty Cole is considered not active and will not show as a choice when selecting from the ontology. The !escape code needs to be escaped with a leading \ as its code starts with the ! character.

@HideChoice
The module will look for the action tag @HideChoice which is normally available for choice variables. It is used to specify codes in the ontology which should not be returned for this field.

Add search type configuration option

In version 0.3 a word based search mechanism was implemented, this release adds a new option to the ontology configuration to chose between the word based search or a simple full text match.

Add Spanish Translation

Dr Daniel Hinostroza from Hospital de Especialidades Carlos Andrade Marín very kindly wrote a Spanish translation for this module Github Documentación en español. This release includes the translation and moving to the internationisation support for external modules. If you have an older version of redcap the module will use the english default, a newer (9.5+) version will allow the language to be selected.

Minor Bug Fix

Fix a bug where the plugin would cause errors if there was no current project.

Simple Ontology Provider v0.3

Change search from simple string compare to splitting the search string into words and searching for each word in turn. The results are sorted by number of words found followed by position of first found character.

For Example

Search: tuberculosis bacterial

10044772: Tuberculosis of adrenal glands, confirmed by bacterial culture
10044780: Tuberculosis of bladder, confirmed by bacterial culture
10044799: Tuberculosis of ear, confirmed by bacterial culture

One problem with this new method is that it doesn't match the REDCap front end. When results are returned they are marked up to bold the section of text that matches the search string. This bolding will only match the whole search string, so for multi-word matches no bold will be displayed showing the matching text.

Simple Ontology Provider v0.2

• Added a mechanism to allow a custom value to be returned if no search results were found.
  This is to allow for branching logic to use this value. The option is on an ontology specific basis, so it does not need to be enabled for all simple ontologies.

• Adjusted search routine to allow letters to match their accented version to better support non-english users.

Initial Release

Initial Release of the Simple Ontology Provider external module for REDCap.