Ruby implementation of openEHR

h1. YADL

h2. Background

ADL is one of the openEHR official formalism to express archetype, defined as "ADL 1.4"http://www.openehr.org/svn/specification/TRUNK/publishing/architecture/am/adl1.4.pdf

Many archetypes are registered on "Clinical Knowledge Manager":http://www.openehr.org/knowledge/ shown such as bellow:

<pre>

archetype (adl_version=1.4)

	openEHR-EHR-OBSERVATION.sample.v1

concept

	[at0000]	-- sample archetype

language

	original_language = <[ISO_639-1::ja]>

description

	original_author = <

		["name"] = <"">

	>

	details = <

		["ja"] = <

			language = <[ISO_639-1::ja]>

			purpose = <"">

			use = <"">

			misuse = <"">

		>

	>

	lifecycle_state = <"0">

	other_contributors = <>

	other_details = <

		["references"] = <"">

		["MD5-CAM-1.0.1"] = <"F5DEA5434726E79CFB3CEA0A7796E501">

	>

definition

	OBSERVATION[at0000] matches {	-- sample archetype

		data matches {

			HISTORY[at0001] matches {	-- Event Series

				events cardinality matches {1..*; unordered} matches {

					EVENT[at0002] occurrences matches {0..1} matches {	-- Any event

						data matches {

							ITEM_TREE[at0003] matches {	-- Tree

								items cardinality matches {0..*; unordered} matches {

									ELEMENT[at0004] occurrences matches {0..1} matches {	-- Description

										value matches {

											DV_TEXT matches {*}

										}

									}

								}

							}

						}

					}

				}

			}

		}

	}

ontology

	term_definitions = <

		["ja"] = <

			items = <

				["at0000"] = <

					text = <"sample archetype">

					description = <"sample archetype to discuss its  formalism.">

				>

				["at0001"] = <

					text = <"Event Series">

					description = <"@ internal @">

				>

				["at0002"] = <

					text = <"Any event">

					description = <"*">

				>

				["at0003"] = <

					text = <"Tree">

					description = <"@ internal @">

				>

				["at0004"] = <

					text = <"Description">

					description = <"*">

				>

			>

		>

	>

</pre>

Otherwise, ADL is not so common formalism such as XML or OWL.

XML serialisation is considered more popular alternative to express archetype.

XML form of archetype is shown bellow

<pre>

<?xml version="1.0"?>

<archetype xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://schemas.openehr.org/v1">

  <original_language>

    <terminology_id>

      <value>ISO_639-1</value>

    </terminology_id>

    <code_string>ja</code_string>

  </original_language>

  <description>

    <original_author id="name" />

    <lifecycle_state>0</lifecycle_state>

    <other_details id="MD5-CAM-1.0.1">F5DEA5434726E79CFB3CEA0A7796E501</other_details>

    <details>

      <language>

        <terminology_id>

          <value>ISO_639-1</value>

        </terminology_id>

        <code_string>ja</code_string>

      </language>

      <purpose />

      <use />

      <misuse />

    </details>

  </description>

  <archetype_id>

    <value>openEHR-EHR-OBSERVATION.sample.v1</value>

  </archetype_id>

  <adl_version>1.4</adl_version>

  <concept>at0000</concept>

  <definition>

    <rm_type_name>OBSERVATION</rm_type_name>

    <occurrences>

      <lower_included>true</lower_included>

      <upper_included>true</upper_included>

      <lower_unbounded>false</lower_unbounded>

      <upper_unbounded>false</upper_unbounded>

      <lower>1</lower>

      <upper>1</upper>

    </occurrences>

    <node_id>at0000</node_id>

    <attributes xsi:type="C_SINGLE_ATTRIBUTE">

      <rm_attribute_name>data</rm_attribute_name>

      <existence>

        <lower_included>true</lower_included>

        <upper_included>true</upper_included>

        <lower_unbounded>false</lower_unbounded>

        <upper_unbounded>false</upper_unbounded>

        <lower>1</lower>

        <upper>1</upper>

      </existence>

 ... snips ...

      <items code="at0004">

        <items id="text">Description</items>

        <items id="description">*</items>

      </items>

    </term_definitions>

  </ontology>

</pre>

XML form is exploding by tags and lacks simplicity of ADL formalism.

YAML form is remarked as easy and simple formalism, which is recognised te be an alternative for XML.

Sample YAML form is considered as bellow:

<pre>

arhetype:

  archetype_id: openEHR-EHR-OBSERVATION.sample.v1

  concept:

    at0000: sample archetype

  language:

    original_language: [ISO_639-1::ja]

  description:

..snips..

</pre>

YAML format is more similar to ADL than XML and seems very comprehensive form. So our project will challenge to implement YADL(Yet another ADL) as alternative formalism for archetype and our Ruby implementation.

h2. Methods

We should implement YAML scheme to express archetype as cADL and YAML instance to express dADL.

h2. Result

on going.