Archetype Designer - template building manual
Getting Started
Locate the online Archetype Designer at https://tools.openehr.org/designer/
Sign up and log in using Google, Microsoft or GitHub accounts.
Choose a repository
Create a new repository
If you wish to create a new repository, click on the ‘New Repository’ button.
Name your repository and click on the ‘Create’ button.
You will need to add archetypes and templates to the repository.
Open an existing repository
Alternatively, click on the repository name of your choice to open it.
The ADL Designer will open to display a list of the archetypes and templates contained in the selected repository.
Create a new template
Click on the 'New' button and select the 'Template' option.
Select the Rm type (or class)
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.
Select the root archetype id
Select the Encounter COMPOSITION as the container archetype for the template.
Name the template
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.
Click on the Create button to create the template, displayed below.
Create the template
Template name
The name of the active template is always displayed in the top blue tab.
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.
The 'Definition' tab is the default view for every new template.
At this point the template comprises only the Encounter archetype as the container for future clinical content.
Add metadata descriptions
Select the Description tab
Click on the 'Description' tab to be able to add optional details about the template.
There are two subtabs - Header and Attribution.
Header subtab
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
Attribution subtab
Build Uid – usually automatically generated in a CKM environment
Author name
Organisation
Email
Date originally authored – default is today's date.
Contributors – names and details of all individuals who contributed to the development of the template.
Translators – may be available to add details of translators if the base archetype has translations available.
Adding clinical content
The clinical content is added to the 'Content' SLOT in the tree, one archetype at a time.
Archetypes that are allowed for that SLOT are displayed in the right hand column.
At this location within a COMPOSITION archetype, it is valid to add SECTION or ENTRY classes of archetypes.
Add an archetype
Search for, select and add content
To find a specific archetype type some text into the Search field – either the name of an archetype or the class. In this example, searching for 'adh' results in a single archetype being displayed – the SECTION archetype for 'Ad hoc heading'.
Clicking on any archetype in the right column will insert it into the content area of COMPOSITION container.