These instructions will give an overview of using the Better Archetype Designer, archetype/template tool, adapted from the generic Template Building guidance .

Archetype Designer is an online web-browser based product that will work on most browsers. Google Chrome or Mozilla Firefox are recommended and some versions of Internet Explorer may not work correctly.

Locate the online ADL Designer at https://tools.openehr.org/designer

Create an account using one of the social media accounts e.g Google, Microsoft or or GitHub

Open

then login

To create a new repository, click on the ‘New Repository’ button.

Open

Choose Local Folder for 'Repository type', name your repository and click on the ‘Create’ button.

Open

You will need to add archetypes and templates to the repository.

Although you can start to create your own archetypes and templates from scratch, it is much more common to import a set of existing archetypes and templates to re-use or adapt.

We suggest that you Import a pre-built set that has been developed for this course.

These are held on the Apperta Clinical Knowledge Manager (CKM) tool. This is a tool used to discuss, curate and publish archetypes and templates pertinent to the UK. It makes use of a number of models drawn from the openEHR International CKM, a number of which are used in the pre-built set which you are about to import

Click here and you will be taken to

Open

Press the ‘Export Resources (Zip)’ button and download the zip file onto a folder on your machine.

Choose the ‘Import’ option at the top of the Archetype Designer screen and you will get this dialog which allows you to select the zip file that you downloaded from CKM , or drag and drop onto the grey dropspace.

Open

Ensure that ‘Import concepts with warning’ is unticked and ‘Overwrite existing’ is ticked.

Now press ‘Upload’ or ‘Upload all’. The zip file will now be uploaded and imported.

Make sure you wait until the Status Icon appears - it should be a Green tick.

Open

One the Status icon has appeared you can press ‘Close’.

You should now see the repository populated with a number of archetypes and templates.

Open

At a later stage you may create more than one repository if you wish e.g. one for experimentation, one for F2F training, one for coursework.

Click on the ‘Repositories’ option at the top of the screen. This will list all of the repositories within your account. Unless you have done further work, you should only see the repository you have just created.

Now click on on your new repository name to open it.

Open

The ADL Designer will open to display a list of the archetypes and templates contained in the selected repository.

Open

Click on the 'New' button and select the 'Template' option.

Open

In this manual we will start the template using the default COMPOSITION archetype as the basis for this template, however a template can be created using any type of archetype.

Open

Select the Encounter COMPOSITION as the container archetype for the template.

Open

Type the name of the template in the ‘Template Id field'. In this example, we intend to represent the clinical content in a hypothetical Admission note.

Open

Click on the Create button to create the template, displayed below.

Open

1. Template name

   1. The name of the active template is always displayed in the top blue tab.

   2. In addition, the name of the template is also displayed at the top of the tree form – in this case 'Admission note' with the italicised annotation of NAME (from 'Encounter'), indicating that the Encounter archetype has been renamed for the purpose of creating a new Admission note template.
      Note: A star next to the template name indicates that the template has changes that need to be saved. When you save a template, it will ask you to provide versioning information - you can just accept whatever suggestion is given.
      
      

2. The 'Definition' tab is the default view for every new template.

3. At this point the template comprises only the Encounter archetype as the container for future clinical content.

Click on the 'Description' tab to be able to add optional details about the template.

There are two subtabs - Header and Attribution.

Open

• Template Id – this can be edited

• Lifecycle – select from a dropdown list. This is usually managed automatically within a CKM environment, but may be useful if using within a local governance environment.

• Keywords – these can assist in searching for a specific template within a CKM environment

• Purpose – the reason for creation of data set

• Use – information about how the data set is intended to be use

• Misuse – information about circumstances in which the data set should not be used, potentially including information about alternative templates that might be used as a valid alternative

• Copyright – this will usually be managed automatically within a CKM environment

• Other details – which are usually set within a CKM environment

  • License

  • Custodian organisation

  • Original namespace

  • Original publisher

  • Custodian namespace