ADL Workbench Help - Viewing Archetypes

Basics

Finding an Archetype The explorer on the left hand side of the tool provides a view on an archetype repository, which is simply a directory in the file system. The Repository menu is used to select the location of the archetype repository. Clicking on any archetype in the tree automatically causes it to be parsed.	explorer
Description / Meta-data This tab shows the contents of the "description" section near the top of an archetype, as well as the languages, translation details and terminologies supported by the archetype. A drop-down menu provides access to the translation details in each language.	typical archetype	unicode example
Translations Archetypes can contain any number of translations of their linguistic content, i.e. the description and ontology sections. The language combo box on the top right of the tool enables the language to be chosen.	translated view

Semantics

All of the following views of archetype semantics are available on 2 tabs, showing 'differential' and 'flat' views. The differential view of an archetype shows only the nodes of the archetype defined in the source, i.e. nodes that are further constrained or added (in the case of container objects, additional nodes are a kind of refinement). For top-level archetypes, this is simply the archetype as defined; for specialised archetypes, the differences are with respect to the immediate parent archetype. The flat view shows the effective structure of the archetype taking into account the inherited structures from all parent archetypes; for top-level archetypes, the flat view is the same as the differential view, whereas for specialised archetypes, it includes nodes from parents.

Node Map When an archetype is parsed, its definition (cADL) section is displayed graphically in the Node Map tab of the Definition tab. This map is a direct representation of the tree structure of the archetype, and consists of alternating object and attribute constraints, culminating in leaf nodes representing constraints on primitive types such as integers, strings and date/times. When an archetype is first successfully parsed, the node tree is shown collapsed to its root; repeatedly using the "Expand One" button reveals the structure of the archetype one tree level at a time. Quantities, coded terms and ordinal values have special representations, as defined in the openEHR Archetype Profile (oAP).	initial view	after expanding (CBC)	after expanding (CBC)	unicode example
Technical/Domain View The Technical and Domain radio buttons on the right hand side toggle between a view consisting of purely semantic labels and a technical view in which the reference model class names and node term codes are shown. This view enables the connection of semantic markers (local "at" codes) and the reference model to be understood.	basic view	technical view
Specialised Archetype View Specialised archetypes redefine parent archetypes by narrowing existing constraints. In the differential and flat tabs, the effects of inheritance and redefinition are shown in the node map as follows: parts of the archetype inherited unchanged are shown with yellow/grey icons of the same visual form as the usual icons; these parts of the archetype are also initially shown "rolled up" (i.e. collapsed tree nodes) for convenience; parts of the archetype inherited but then redefined in the current archetype are shown using coloured icons with a thin yellow border; parts of the archetype defined new in the current archetype are shown using normal coloured icons. A top level archetype consists solely of these kinds of nodes.	node map differential view - c-reactive protein	node map flat view - c-reactive protein
Paths The Path Map tab shows the paths extracted from the definition section of the archetype in "physical" (coded) and "logical" (codes replaced by their descriptions) forms. These paths are crucial to manipulating archetypes at runtime, and also to building queries. The path syntax is a slightly reduced form of XPath syntax, and can be converted to standard XPath for XML-based processing. For specialised archetypes, the Path Map under the differential view shows only paths in structures introduced in the specialised archetype, while the path map in the flat view shows paths due to all inherited nodes as well. The columns of the display can be controlled using the check boxes on the right, and are as follows: physical paths: paths containing [atnnnn] codes, used by the software logical paths: paths with [atnnnn] codes replaced by the human-readable values from the ontology RM Type: the Reference Model type constrained by the node corresponding to the displayed path AOM Type: Archetype Object Model type - this is the type of the archetype node, usually only of interest to implementers Paths can be selected and saved to the clipboard for use in other tools, by selecting rows (including multiple rows, by using the Ctrl key) and then using Ctrl+C (copy) to copy to the clipboard. The clipboard contents can be viewed from the Edit menu.	path map	save path to clipboard	differential view of paths - check_list- condition-third_party (EVALUATION archetype)	flat view of paths - check_list- condition-third_party
Ontology The ontology view shows the contents of the ontology section of the archetype, with terms and constraints shown under separate tabs. Mappings to external terminologies are also shown.	ontology view	terminology mapping	unicode example
Archetype Source The Source tab shows the raw archetype source, with line numbers added, in order to facilitate interpretation of the status output.	raw source	unicode example	differential source view - check_list- condition-third_party (EVALUATION archetype)	flat source view - check_list- condition-third_party

ADL Workbench Help - Viewing Archetypes

Basics

Finding an Archetype

Description / Meta-data

Translations

Semantics

Node Map

Paths

Ontology

Archetype Source