A compilation of Frequently Asked Questions (FAQ) related to the usage of the Clinical Knowledge Manager.
General Questions
Expand | ||
---|---|---|
| ||
For example, you can:
Find out more details about ways to get involved here. |
Expand | ||
---|---|---|
| ||
If you have any problems, suggestions, or comments regarding the CKM tool, you can:
Note: Please be as specific as possible and please do not use this for suggestions to improve an archetype or template. See Archetype FAQs below. |
Registration Process
Expand | ||
---|---|---|
| ||
If you are not yet a registered user of the international openEHR Clinical Knowledge Manager, you should consider to register: The impact of CKM and its ability to publish archetypes and EHR artefacts will only come from the willingness and activity of its registered community of users. As a registered user, you can become an active participant in the development and quality improvement of open and shared clinical content for eHealth projects via the collaborative CKM community:
You will be also able to configure CKM to notify you about new archetypes or modifications to the existing ones. Most importantly, by recording your domain expertise and a willingness to participate in archetype reviews, the Editors will be able to invite you to participate in projects and teams where your expert opinion will help to enhance the archetypes under review. This involves no commitment – participate as and when it is convenient for you. If you have developed your own archetypes you can submit them to the Editors as a candidate for shared use within CKM. Without registering, you can still view all of the CKM content, but not get access to all the good stuff 'under the hood'. All visitors to CKM are welcome to self-register on the home page - there are no restrictions, and this will enable users to participate and to gain access to richness of CKM functionality. Sign up as a registered user for the international CKM instance here. |
Expand | ||
---|---|---|
| ||
Just click on the 'Register' button in the top right hand corner of the CKM home screen and follow the instructions. For more details view the detailed steps: Self-Registration in CKM |
Expand | ||
---|---|---|
| ||
Yes. If you would like to be registered user of two different CKMs, you need to create an account for both. |
Expand | ||
---|---|---|
| ||
You can log in to CKM and open your profile. CKM will send you a confirmation email to activate your new email adress. Note that the old email address will remain the active primary email address until you have activated your new email address. |
Expand | ||
---|---|---|
| ||
You can delete your CKM account at any time: just log in to your CKM instance and select Tools/Delete my Account from the menu.
|
Expand | ||
---|---|---|
| ||
If CKM finds during the registration process that your username (usually consisting of firstname.lastname) is already taken, CKM will guide you through a process to determine if the account of that username may belong to you because you have previously registered. If so, you can start using that account again. |
Expand | ||
---|---|---|
| ||
If CKM finds during the registration process that your email address is already taken, this usually means that you have already registered. If you cannot remember your password, you can use CKM's "Forgot Your Password" functionality to retrieve your password. |
Archetypes
Expand | ||
---|---|---|
| ||
The first option is to submit a new change request for the archetype: Just find and open the archetype and click on the Change Request icon, and then on the "Add New Change Request" button. The second option to let the CKM editors in charge know about your suggestion is to start a new discussion topic for the archetype. Just find an open the archetype, and click on the Discussion icon. Then use the "Start New Topic" button. |
Expand | ||
---|---|---|
| ||
If you are missing a particular archetype, you can create a new archetype and submit your archetype as a 'Archetype Proposal' to the CKM repository. Before you start development on new archetypes, we encourage you to first search thoroughly in CKM, including its incubators, and contact an editor of a CKM project that may be related to your archetype or a Clinical Knowledge Administrator first. Here's a little introduction on how to Search for an archetype in CKM. To submit a proposal for a new archetype, select 'Archetype Proposals' from the main menu or find the 'Propose New Archetype' Quick Task on the new CKM Dashboard or choose Archetypes/Archetype Proposals from the main menu (when logged in). |
Expand | ||
---|---|---|
| ||
If the archetype has not been officially published after one or more review rounds, it may be best to wait, where possible. If the archetype is published already, you can translate the archetype directly in CKM and submit it to the editor of the archetype. You can also use any external Archetype Editor and submit your translation to CKM. For details, please simply follow our instructions to Translate Archetypes Using CKM. |
Expand | ||
---|---|---|
| ||
Here's a little introduction on how to Search for an archetype in CKM. |
Expand | ||
---|---|---|
| ||
Adopting an archetype in CKM serves a couple of different purposes.
See more details and instructions on how to adopt an archetype and manage your archetype adoptions. |
Expand | ||
---|---|---|
| ||
Not all archetypes in CKM are ready for prime time yet. To differentiate stable and unstable archetypes, various lifecycle states are used in CKM. See a full explanation of the Archetype Lifecycle States. |
Expand | ||
---|---|---|
| ||
Best have a look at our explanation of the Demonstration Observation Archetype. |
Expand | ||
---|---|---|
| ||
In CKM, the change history of an archetype can be viewed in its entirety - every change made to a model has been tracked, along with the modifier, time/date and a log message summarising the change. Just click open the archetype and click on the Revision History icon. Also view more details about the Archetype Change History. |
Expand | ||
---|---|---|
| ||
The most important types/classes of an archetype for clinical modellers are the Observation, Evaluation, Action & Instruction Archetype classes:
In addition, Cluster archetypes are often used to reuse certain data elements across archetypes. The Composition archetype class is used as a container class in the openEHR reference model and it is the unit of committal to the EHR. That is to say, all information stored within the EHR will be contained within a Composition. Section archetypes are used as an organizer, usually contained within a Composition archetype. Sections correspond to the headings that you might find on a blank piece of paper. There are also Admin entry archetypes for administrative information as well as a series of Demographic archetype classes. Please refer to our Introduction to Archetypes and Archetype classes for a more detailed explanation. |
Expand | ||
---|---|---|
| ||
The easiest way to share a direct link for an archetype or template with a colleague or for example use in a publication is to open the archetype or template and then select the "Share with Colleague" Email icon. Also view the detailed explanation on how to link to an archetype or template in CKM. |
Reviewing
Expand | ||
---|---|---|
| ||
Usually you will be invited via email and you can follow the instructions in the email to start your review directly from the email. To ensure you are invited, you should consider to 'adopt' the archetypes you want to review. The editors of the archetype will invite you via email when the next review round for each adopted archetype starts. Also ensure that you have opted to be a reviewer in your User Profile and that you have specified your Profession and the Health Domains you are knowledgable in, so that editors can invite you to relevant reviews. You can, of course, always decline an invitation to review. View more detail on how to review archetype content. Also view our Archetype Review Checklist for further details on what to consider when reviewing an archetype. View more details on how to adopt an archetype. |
Expand | ||
---|---|---|
| ||
Yes. Once you have submitted your review, others can see it, for example in the summary view of each review round. CKM used to have the possibility to review anonymously, however this was never used, and apart from considerable overhead left the question of how editors could efficiently deal with this feedback. |
Expand | ||
---|---|---|
| ||
There is no general answer to this, however if you really need a particular archetype reviewed and published sooner rather than later, you can take the following steps.
|
Subdomains, Projects & Incubators
Expand | ||
---|---|---|
| ||
A CKM domain is essentially one CKM instance, functioning independently and providing a repository of archetypes, as well as templates and termsets as applicable. In each CKM domain/instance, it is possible for several so-called subdomains to co-exist. Projects contain strictly governed resources, whereas incubators are used to store archetypes or other resources that are in their initial stages of development and a strong governance process is not yet needed. A remote subdomain is a special sub-domain that allows a 'read only' view of archetypes from another (remote) CKM instance. You can easily identify archetype from a remote CKM from the left hand archetype trees: Remote archetypes are displayed in italics. See a more detailed explanation on CKM domains, subdomains, remote domains, projects and incubators. |
Customisation, User Profile & Notifications
Expand | ||
---|---|---|
| ||
The 'Preferred View' is the default or initial view of resources in the left-hand concertina's Preferred View Tab when you log in to CKM. You can choose to customise your 'Preferred View' in the following way:
The Preferred View is then prefilled with your preferred resources automatically on the left hand when you log in. Note: You can also control which of the tabs of the left-hand concertina is being expanded for you when you sign in. Go to 'Tools/Options' and select the appropriate See the full explanation on how to Customise the CKM Preferred View. |
Expand | ||
---|---|---|
| ||
Yes, other users can see your user profile. |
Expand | ||
---|---|---|
| ||
You have several options of how you get updated with new and updated archetypes and templates:
See the full explanation on how to get notified of new or updated archetypes or templates. |