OntoDL Tutorial: Defining a Terminology - Versionsgeschichte

Caumanns am 12. September 2016 um 12:31 Uhr

2016-09-12T12:31:47Z

Caumanns: /* Defining a codesystem Object */

2016-09-11T07:50:31Z

‎Defining a codesystem Object

Caumanns: /* Adding concept Objects to the Terminology */

2016-09-11T07:49:30Z

‎Adding concept Objects to the Terminology

Caumanns: /* Adding concept Objects to the Terminology */

2016-09-08T16:07:35Z

‎Adding concept Objects to the Terminology

Caumanns: /* Adding concept Objects to the Terminology */

2016-08-30T13:36:03Z

‎Adding concept Objects to the Terminology

Caumanns: /* Adding concept Objects to the Terminology */

2016-08-30T13:23:24Z

‎Adding concept Objects to the Terminology

Caumanns: /* Defining a codesystem Object */

2016-08-30T13:13:12Z

‎Defining a codesystem Object

Caumanns am 30. August 2016 um 12:35 Uhr

2016-08-30T12:35:42Z

Caumanns: Die Seite wurde neu angelegt: „'''''Storyboard:''''' ''In order to foster semantic interoperability among its IT-systems a hospital wants to define unique terminologies for its clinics. Each…“

2016-08-29T22:33:10Z

Die Seite wurde neu angelegt: „'''''Storyboard:''''' ''In order to foster semantic interoperability among its IT-systems a hospital wants to define unique terminologies for its clinics. Each…“

Neue Seite

'''''Storyboard:''''' ''In order to foster semantic interoperability among its IT-systems a hospital wants to define unique terminologies for its clinics. Each clinic and each ward shall be assigned a unique code that shall be used throughout all IT-systems for referring to that clinic or ward. ''

In OntoDL each newly defined terminology must be given a name which is used for referencing that terminology within the OntoDL document. Terminology names must be unique within an OntoDL document. Additionally each terminology must be assigned an OID or/and a URN. This is a globally unique identifier that is used for identifying and referencing the terminology outside the closed scope of an OntoDL document.

For the example storyboard sketched above, we first create a terminology "Clinics and Wards" that will contain a hierarchical list of all clinics and wards within the hospital. For this the following steps must be taken:
* Open a new MS Word Document using the "OntoDL.dotm" Template. This template already contains a set of predefined style sheets with names all starting with "OntoDL".
* In a new paragraph – formatted using the style sheet “OnloDL” - write the OntoDL statement "define" followed by the type of object to be defined and the name of the object to be defined:
** In OntoDL terminologies and value sets have the type "codesystem"
** Object names may consist of multiple words. For the interpreter to recognize that these words together make up the object name, they have to be put in parentheses.
* All further information about the terminology is provided within a pair of curly brackets ("{" "}"). These brackets have to be formatted as "OntoDL", too.
* Part of this information is the definition of descriptive attributes about the terminology. While the provisioning of an OID or URN is mandatory, there are several other attributes that are optional and should only be given when needed. For the example we want to provide information about the version of the terminology.
** For defining the attribute values a two-column table is placed into the definition scope of the codesystem-object which is delimited by the curly braces. The first column of the table gives the name of the attribute while the second gives the attribute value. Both columns must be formatted using the “OntoDL” style sheet.

The code snippet below shows how the terminology definition for the sample storyboard looks like:

<font face="courier">
define codesystem (Clinics and Wards) {

{|border = "1"
|URN
| http://hospital.com/placeofstay
|-
|Version
| 0.1
|}

}
</font>

In a next step concepts can be added to the terminology. Each concept is an OntoDL object definition and follows the same principles and syntax as the definition of the terminology. Again curly brackets are used to delimiter the scope of a concept definition. Concept hierarchies can be set up by placing a concept within the definition scope of another concept.
The code below shows how a hierarchy of clinics and wards can be defined. In the example there are no further attributes defined for the concepts, because the only mandatory attribute – the code of the concept – defaults to the concept name which is stated in the object definition.
define codesystem (Clinics and Wards) {
URN http://hospital.com/placeofstay

Version 0.1
Description This terminology lists all clinics and wards of the ABC-hospital. All internal IT-Systems shall dynamically load information about clinics and wards from this terminology.

define concept (cardiologic clinic) {
define concept (ward 51.1)
define concept (ward 51.2)
}
define concept (orthopedic clinic) {
define concept (ward 52.1)
}
}

@@ Zeile 1: / Zeile 1: @@
-'''''Storyboard:''''' ''In order to foster semantic interoperability among its IT-systems a hospital wants to define unique terminologies for its clinics. Each clinic and each ward shall be assigned a unique code that shall be used throughout all IT-systems for referring to that clinic or ward. ''
+== Motivation ==
+;Rationale
-In OntoDL terminologies are defined as objects of type ''codesystem''. The semantics of a terminology is defined through the ''codesystem'' object's properties. Concepts within the terminology are defined as ''concept''-objects which are linked as children to the ''codesystem''-object that represents the terminology.
+:In OntoDL terminologies are defined as objects of type ''codesystem''. The semantics of a terminology is defined through the ''codesystem'' object's properties. Concepts within the terminology are defined as objects of type ''concept''. ''concept'' objects which are linked as children to the ''codesystem''-object that represents the terminology. ''concept'' objects can be nested for setting up hierarchical code systems.
 == Defining a ''codesystem'' Object ==
@@ Zeile 91: / Zeile 97: @@
 |}
 <hr>

@@ Zeile 20: / Zeile 20: @@
 <hr>
 {|border="0" cellspacing="0" cellpadding="5"
-|-
+|- style="vertical-align:top"
 !! style="text-align:left" | Style&nbsp;Sheet !! &nbsp;&nbsp;&nbsp;&nbsp; !! style="text-align:left" style="width:25%" | Text !! &nbsp;&nbsp;&nbsp;&nbsp; !! style="text-align:left" | ''Comment''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || || style="background:#fff588"|
 <font face="courier">define codesystem (Clinics and Wards) {</font>
 || || ''Create a new codesystem object named "Clinics and Wards". The curly bracket opens the object's definiton scope. Everything defined in this scope is linked with the object.''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || || style="background:#fff588"|<font face="courier">
   {|border = "1" cellspacing="0" cellpadding="4"
@@ Zeile 37: / Zeile 37: @@
 </font>
 || || ''Set the values of the object's properties "URN" and "Version".''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || ||style="background:#fff588"|
 <font face="courier">}</font>

@@ Zeile 51: / Zeile 51: @@
 <hr>
 {|border="0" cellspacing="0" cellpadding="5"
-|-
+|- style="vertical-align:top"
 !! style="text-align:left" | Style&nbsp;Sheet !! &nbsp;&nbsp;&nbsp;&nbsp; !! style="text-align:left" style="width:25%" | Text !! &nbsp;&nbsp;&nbsp;&nbsp; !! style="text-align:left" | ''Comment''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || || style="background:#fff588"|
 <font face="courier">define codesystem (Clinics and Wards) {</font>
 || || ''Create a new codesystem object named "Clinics and Wards". The curly bracket opens the object's definiton scope. Everything defined in this scope is linked with the object.''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || || style="background:#fff588"|<font face="courier">
   {|border = "1" cellspacing="0" cellpadding="4"
@@ Zeile 68: / Zeile 68: @@
 </font>
 || || ''Set the values of the object's properties "URN" and "Version".''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || || style="background:#fff588"|
 <font face="courier">
@@ Zeile 77: / Zeile 77: @@
 </font>
 || || ''Create a new concept object named "cardiologic clinic". Because the object is defined inside the definition scope of the codesystem object "Clinics and Wards" it is assigned as a child to the respective code system. Within the definition scope of "cardiologic clinic" two concept objects "ward 51.1" and "ward 51.2" are defined. These are assigned as children (sub-concepts) to "cardiologic clinic".''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || || style="background:#fff588"|
 <font face="courier">
@@ Zeile 85: / Zeile 85: @@
 </font>
 || || ''Create a new concept object named "orthopedic clinic" as a child of the codesystem object "Clinics and Wards". Within the definition scope of "orthopedic clinic" a concept object "ward 52.1" is defined. This concept is assigned as a child (sub-concept) to "orthopedic clinic".''
-|-
+|- style="vertical-align:top"
 || OntoDL                      || ||style="background:#fff588"|
 <font face="courier">}</font>

@@ Zeile 72: / Zeile 72: @@
 <font face="courier">
 &nbsp;&nbsp;&nbsp;&nbsp;define concept (cardiologic clinic) {<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;define concept (ward 51.1)<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;define concept (ward 51.1) { }<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;define concept (ward 51.2)<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;define concept (ward 51.2) { }<br>
 &nbsp;&nbsp;&nbsp;&nbsp;}
 </font>
@@ Zeile 81: / Zeile 81: @@
 <font face="courier">
 &nbsp;&nbsp;&nbsp;&nbsp;define concept (orthopedic clinic) {<br>
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;define concept (ward 52.1)<br>
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;define concept (ward 52.1) { }<br>
 &nbsp;&nbsp;&nbsp;&nbsp;}<br>
 </font>

@@ Zeile 84: / Zeile 84: @@
 &nbsp;&nbsp;&nbsp;&nbsp;}<br>
 </font>
-|| || ''Create a new codesystem object named "Clinics and Wards". The curly bracket opens the object's definiton scope. Everything defined in this scope is linked with the object.''
+|| || ''Create a new concept object named "orthopedic clinic" as a child of the codesystem object "Clinics and Wards". Within the definition scope of "orthopedic clinic" a concept object "ward 52.1" is defined. This concept is assigned as a child (sub-concept) to "orthopedic clinic".''
 |-
 || OntoDL                      || ||style="background:#fff588"|
@@ Zeile 91: / Zeile 91: @@
 |}
 <hr>

@@ Zeile 48: / Zeile 48: @@
 The code below shows how a hierarchy of clinics and wards can be defined. In the example there are no further attributes defined for the concepts, because the only mandatory attribute – the code of the concept – defaults to the concept name which is stated in the object definition.
 define codesystem (Clinics and Wards) {
 URN	http://hospital.com/placeofstay

@@ Zeile 1: / Zeile 1: @@
 '''''Storyboard:''''' ''In order to foster semantic interoperability among its IT-systems a hospital wants to define unique terminologies for its clinics. Each clinic and each ward shall be assigned a unique code that shall be used throughout all IT-systems for referring to that clinic or ward. ''
-In OntoDL each newly defined terminology must be given a name which is used for referencing that terminology within the OntoDL document. Terminology names must be unique within an OntoDL document. Additionally each terminology must be assigned an OID or/and a URN. This is a globally unique identifier that is used for identifying and referencing the terminology outside the closed scope of an OntoDL document.
 For the example storyboard sketched above, we first create a terminology "Clinics and Wards" that will contain a hierarchical list of all clinics and wards within the hospital. For this the following steps must be taken:
@@ Zeile 28: / Zeile 32: @@
 </font>
-In a next step concepts can be added to the terminology. Each concept is an OntoDL object definition and follows the same principles and syntax as the definition of the terminology. Again curly brackets are used to delimiter the scope of a concept definition. Concept hierarchies can be set up by placing a concept within the definition scope of another concept.
+== Adding ''concept'' Objects to the Terminology ==
 The code below shows how a hierarchy of clinics and wards can be defined. In the example there are no further attributes defined for the concepts, because the only mandatory attribute – the code of the concept – defaults to the concept name which is stated in the object definition.
 define codesystem (Clinics and Wards) {