CKM Release 1.18.0
Release Date: August 2022
Deployments: August - October 2022
Summary of Changes
The Clinical Knowledge Manager (CKM) Release 1.18.0 incorporates the changes of a total of 91 Jira Cards: 34 cards with new or significantly enhanced functionality, 35 mostly minor bug fixes and 22 changes “under the hood” of CKM, giving a myriad of improvements and extensions for CKM Editors and Clinical Knowledge Administrators, including:
Reusable review invitation templates that enable editors to setup new review rounds faster and more consistently.
Editors can now add additional (e.g. motivating) text directly to the review invitation email sent to the potential reviewers to increase the likelihood of reviewers participating.
Editors collaborating as a team are now able to display the various revision changes for each review feedback element to better support editor collaboration during the review feedback process.
Editors also benefit from an improved user interface to update contributors of archetypes, and a variety of other smaller improvements like improved warnings displayed before committing or publishing a resource, about uploading a resource to an outdated branch BEFORE submitting.
Normal Users benefit from the new release in many ways. The Archetype Data Points report has been enhanced and its performance has been improved significantly, the internal terminology client has been upgraded to support LOINC 2.72, the Welcome Emails have been improved, the Template Resource Centre has been cleaned up and the Archetype and Template Resource Centres now support JSON as Sample Data.
While maybe less relevant in the international context, CKM administrators can now bulk create and update users via uploading a CSV File - which is useful for national or regional programs as well as hospital groups using CKM for review purposes.
Various parts of CKM have been finetuned visually, with an improved and harmonised visual distinction of secondary headers in various CKM tabs, finetuned various project and subdomain related displays, improved the layout of the sticky note style (as used on the Dashboard and for editor comments), folded the ADL and XML tabs into one and finetuned some icons and various texts. Also, a new CKM theme based on navy blue & teal blue colours has been developed that can be configured for each CKM instance.
The REST API of the Clinical Knowledge Manager has been extended, for example by adding the ability to update the template status and by adding the semantic version numbers of the latest and latest published version to the listing of archetypes.
Minor bugs have been fixed in this release, most notably perhaps a fix to the Drag and Drop functionality when uploading files and improved support for Code System implicit FHIR® Value Sets which were not always automatically updated if cached from an external Terminology Server (such as Ontoserver®) connected to CKM.
“Under the hood” changes of CKM such as improved resilience of asynchronous mail sending if the configured mail server is temporarily unavailable, reworked and enhanced CKM connection handling and pooling, internal streamlining of the complete review invitation process, and a reworked subdomain export service that streamlines and thus also significantly improves the speed of - the resource export for larger subdomains.
Detailed descriptions of all changes in the following sections.
New & Improved Functionality (34 issues)
Key | Summary | Description |
|---|---|---|
CKM-444 | Reusable Review Invitation Text Templates | When editors initiate a review round, they need to supply an invitation text that is displayed to all reviewers on starting their review. To better support editors in initiating review rounds, functionality is added to CKM to define and then use and reuse review invitation templates. For this, CKAs can define review invitation templates with the following characteristics:
This functionality is available from the Reviews/Manage Invitation Templates menu. When creating a new review round, editors can select any applicable preconfigured review invitation template. This is done via a Button to import the invitation template which opens a window to select the desired invitation template. The selected review invitation template is then displayed in the usual review invitation text RichTextArea in CKM and can be finetuned for use in this particular review round, using the existing editing functionality. Any Review Invitation Text Template can contain a selection of placeholders to better enable the reuse. The following placeholders can be used in the Review Invitation Template:
Placeholders need to be wrapped like this: %{ … }% - for example: %{resource-type}% All placeholders are wrapped in percentage signs and curly brackets. To avoid problems with these placeholders, the invitation template cannot be stored if it contains an unsupported placeholder. Neither can a review round be created nor can reviewers be invited if non supported placeholders are found in any invitation text. Note that there are two types of invitation templates. Inline invitations are displayed inline in CKM when a reviewer starts to conduct a review. Custom mail invitation texts are ADDED to the usual invitation email in order to customise these emails, see CKM-1421: Ability to add additional (e.g. motivating) text to the review invitation email itself for details. Example invitation:
|
CKM-1274 | Improve warnings displayed before committing or publishing a resource (or initiating a review round) to look more like a checklist | When a resource is being committed or published, any warnings to check the archetype before committing or publishing are currently displayed like this:  Likewise, these warnings are displayed when initiating a review round, however the layout is horizontal to save some space in the review round creation wizard. The display of these warnings has been improved to be be more like a checklist that shows what has been validated and where there are still warnings or errors. The number of errors/warnings has been added as a badge, and if there aren’t any errors/warning of a given type, then a green badge with a tick is used to clearly state that there no errors/warnings of the type, for example: |
CKM-1421 | Ability to add additional (e.g. motivating) text to the review invitation email itself | With this issue, we add the ability for editors to define an individual text that is included in the review invitation email. This email is sent out to the reviewers when an editor initiates a new review round. This text would usually be different to the complete review invitation text that is displayed to reviewers when starting their review in CKM. The latter is usually a fairly lengthy text with detailed instructions on how to review on what to take into account. The reason for adding the ability to specify an additional text for the email invitation (“mail-invitation-details”) is to increase the likelihood that a potential reviewer is interested in reviewing the resource under review in the first place and accepts the review invitation. This separate mail-invitation-details field that can be filled in during review round setup via a new step. This text then added to current invitation email sent out to the reviewers, just before the “Your Options:” paragraph. This functionality has been designed for editors to have maximum flexibility: Editors can provide completely different or also exactly the same content for both the invitation details displayed to reviewers in CKM and in the email. Of course, they can also completely omit the additional email invitation text, which simply preserves the status quo of the current review invitation emails. In case that the content of the two invitation details (email vs. in CKM) overlaps, the editors would need to enter (copy-paste) the relevant parts at both places when initiating the review round. To simply this, CKM-444: Reusable Review Invitation Text Templates also introduces reusable invitation text templates. |
CKM-1455 | Warn the user about uploading a resource to an outdated branch BEFORE submitting | When a user uploads an archetype to a branch and that branch is outdated, for instance, because another branch has been committed to the trunk in the meantime, this may cause problems or simply unnecessary editorial work down the line. While it is - and should be - possible to continue work on the branch and integrate the changes from the trunk accordingly, it may in some cases be preferable to start again with a new branch. Therefore, CKM will now present an warning when an archetype or template is uploaded BEFORE it is actually submitted to the outdated branch. The user can then consider to reject/resolve/delete the outdated branch first. This warning is in addition to the warning the user currently already gets after the submission to the branch has been completed. |
CKM-1475 | Editor functionality to show the revision changes for each review feedback element | When multiple editors work collaboratively on the feedback for a review round, it has so far not been possible to see which editor contributed to the Editor feedback in the reviews, i.e. added/changed and maybe even deleted the feedback for an element. This is of course desirable when displayed to the reviewers - the editors speaking with one voice. However, when there are multiple editors, it is useful as an editor to see the editor and timestamp for each feedback element. This is to be able to reconstruct and streamline editorial discussions (especially afterwards). As each item could be changed multiple times, the whole history of who changed what when is relevant for each element under review. For this purpose, a new button is added next to the button to “Add New Task” for each feedback element. This button (like the existing “Add new task” button) is only displayed when the feedback element is focussed and will display the complete Feedback History for the element. |