Latest ADL (archetype definition language)
|
Dear all, an update of the ADL language for writing archetypes has been posted. News: This language is being proposed to CEN for the archetypes facility in its revised ENV13606, and will be discussed at the CEN TC/251 Aarhus meeting (29/30 September). It is also being considered for use in the HL7v3 templates work, and was discussed at the HL7 Memphis WGM (7-12 September). A clinician's editor is under construction. Links: Language specification: http://www.oceaninformatics.biz/adl/adl_0_9_5.pdf Toolkit: http://www.oceaninformatics.biz/adl/ADL_0_9_5.zip (this contains everything) ADL page with examples: http://www.oceaninformatics.biz/adl.html README file: see end of this mail The toolkit contains the following things: - GUI validator executable for Windows - example archetypes in ADL and HTML format - a copy of the PDF manual - thomas beale ...... Here is a copy of the README file: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ADL - Archetype Description Language Toolkit Version Last Change: 20 September 2003 ADL language 0.9 ADL language manual 0.9.5 Authors: Thomas Beale, Sam Heard Ocean Informatics <www.OceanInformatics.biz> Description: This toolkit contains a set of ADL archetype files, a simple GUI validating parser, and a PDF file describing the ADL language. The parser provides a reasonable amount of syntax error reporting on ADL files. It also does a certain amount of semantic checking. It is capable of serialising into ADL and HTML. The parser tool is *not* designed as a clinical or other domain specialist's tool - other GUI tools are being developed for this purpose. Accordingly, the user interface is designed for technical users. What you can use it for: At the moment, you can hand-write new ADL files, or experiment with the example files. In the future, this validator will mainly be used to do standalone checks on ADL files. Directories: ADL: root directory, containing the application and other directories. repository: a tree of example ADL files gvim: (for vi fans only...) files for adding ADL to the vim/gvim editor. - The adl.vim file goes in the $VIM/syntax directory; - the file synload.vim.example should be used to add an entry into your existing $VIM/syntax/synload.vim directory (don't replace it!); - the file filetype.vim.example should be used to update (not replace) the file $VIM/filetype.vim. parse_specification: yacc and lex production rule files describing the ADL syntax. Running the validator Double-click the adl_validator.exe file. The GUI ADL workbench tool should appear. Follow these general steps: * open a file - use the "Open" button to choose an archetype * parse the archetype - use the "Parse" button * for files that parse successfully, you can now use the other controls to explore the archetype, including the node map and the ontology display in the lower half of the tool. You can change the language and terminology for archetypes that have bindings and translations; this will cause all controls to be updated visually. * edit the archetype - use the "Edit" button to bring up a text editor. Saving from the text editor will cause the archetype to be reloaded. * Serialise (save) the archetype - choose a format, using the "Format" drop-down, then use the "Save" button. This will cause the parse tree to be written out to the selected format, currently HTML or ADL. Reading the ADL files The ADL files are plain text files, rather like programming language source files. You can edit them in any editor you like. Try making some errors and seeing if the validator catches them. It helps A LOT if you have a syntax-senstive editor! There is a mode supplied for the gvim editor. Modes needed for emacs etc. See the ADL PDF manual for a full description of the syntax. COPYRIGHT This work, including all files in this directory and subdirectories is copyrighted to Ocean Informatics Pty Ltd, Australia, 2003. USE The archetype files, GUI validator, and PDF manual can all be freely distributed provided they are kept intact, and are accompanied by this readme file. FEEDBACK Software support: mail <support@OceanInformatics.biz> Discussion about ADL, archetypes: join the openEHR-technical mailing list <www.openEHR.org> FUTURE A model-based checker will be added in the future. This will perform validation of the archetype against a particular information model, such as the openEHR EHR information model, a CEN model and HL7 model, such as the RIM, or any other model. Numerous small GUI improvements are in the pipeline. The specification and tools for ADL will be given to the openEHR Foundation after a period of review and feedback. |