Archetype to HTML

HTML documentation of archetypes is required by:

  • Archetype Repository
  • openEHR's Knowledge Management environment
  • Archetype Editors to display individual archetypes

Standardising this process using XSL transformation of the XML expression of the archetype has advantages. It can be used anywhere and on any platform and should easily allow localisation. Many people know how to tweak and maintain XSL.

Requirements

The XSL Transformations will need to provide:

  • Access to terms in the requested language is required as headings or descriptions for this documentation from the openEHR terminology (words like archetype, element, section etc).
  • The language in which the archetype is to be expressed has to have an ontology section within the archetype - if not a secondary language (or order of languages) must be set (as in Firefox - language preferences)

Implementation

It is proposed that the XLS transform become the standard for documentation of archetypes. This will be utilised in:

  • The archetype editors to generate the HTML (-> XML + XSL Transform)
  • The Knowledge Management environment
  • Any repository wide documentation process
Known issues:
  • Access to the openEHR terminology is required for full language expression of some archetypes (any involving a DV_QUANTITY to provide the property). It seems sensible not to provide this in the documentation in the first instance (ie ignore openEHR terms)
  • A more efficient XML representation of the AOM has been proposed which utilises XML attributes which would require alteration of the XSLT but probably not substantially
  • More...?