OntoDL Statement: define - Versionsgeschichte

Caumanns: /* Syntax */

2016-09-20T06:17:35Z

‎Syntax

Caumanns: /* Examples */

2016-09-17T08:48:47Z

‎Examples

Caumanns: /* Nesting of definition Statements */

2016-09-17T08:12:55Z

‎Nesting of definition Statements

Caumanns: /* Qualified Concepts */

2016-09-17T08:10:36Z

‎Qualified Concepts

Caumanns: /* Qualified Concepts */

2016-09-17T08:09:57Z

‎Qualified Concepts

Caumanns: /* Defining Objects from Internal References */

2016-09-17T08:03:44Z

‎Defining Objects from Internal References

Caumanns: /* Defining Objects from Internal References */

2016-09-16T16:55:49Z

‎Defining Objects from Internal References

Caumanns: /* Defining Objects from Internal References */

2016-09-16T16:53:51Z

‎Defining Objects from Internal References

Caumanns: /* Description */

2016-09-16T16:53:26Z

‎Description

Caumanns: /* Full Definition */

2016-09-16T16:13:24Z

‎Full Definition

@@ Zeile 5: / Zeile 5: @@
 | style="width:10em" | ''DefinitionStatement''
 | style="width:3em"  | :=
-| style="width:25em" | '''define''' [[OntoDL Statement: Base Types|''TypeName'']] ''ObjectName'' ''DefinitionBody''
+| style="width:30em" | '''define''' [[OntoDL Statement: Base Types|''TypeName'']] ''ObjectName'' ''DefinitionBody''
 | style="width:10em" | &nbsp;
 |                      <font face="arial" size="2"> </font>
 |- style="vertical-align:top"
 | ''ObjectName''
@@ Zeile 14: / Zeile 20: @@
+|
 | <font face="arial" size="2"> </font>
 |-
 | ''DefinitionBody''

← Nächstältere Version		Version vom 17. September 2016, 08:48 Uhr
Zeile 274:		Zeile 274:

	== Examples ==		== Examples ==
		+
		+	=== Tutorial ===
		+	The folling lessons of the OntoDL tutorial provide examples on uning the ''define'' statement for defing objects of various types:
		+	* The lesson "[[OntoDL Tutorial: Defining a Terminology\|Defining a Terminology]]" shows how to define a simple terminology using the table notation
		+	* The lesson "[[OntoDL Tutorial: Mapping Concept Hierarchies onto Word Sections\|Mapping Concept Hierarchies onto Word Sections]]" shows how ''definition'' statements may be substituted by using the [[OntoDL Style Sheet Directive: heading\|''#heading'' directive]]
		+	* The lesson "[[OntoDL Tutorial: Defining Custom Properties\|Defining Custom Properties]]" shows how to use the ''define'' statement for intorducting custom objects of type ''property''
		+	* The lesson "[[OntoDL Tutorial: Using an External Code System\|Using an External Code System]]" shows how to introduce an external code system as newly defined object of type ''system''
		+	* The lesson "[[OntoDL Tutorial: OntoDL Global Objects\|OntoDL Global Objects]]" introduces the use of internal references for defining an object of type ''system''
		+	* The lesson "[[OntoDL Tutorial: Defining a Value Set\|Defining a Value Set]]" shows how to use qualified concepts to set up a value set
		+	* The lesson "[[OntoDL Tutorial: Linking Concepts\|Linking Concepts]]" introduces the definition and use of object of type ''predicate''
		+
		+	=== OntoDL Object Language ===
		+
		+	For examples see the section "[[#Description\|Description]]" above.
		+
		+	=== OntoDL Macro Language ===
		+
		+	==== Example 1: Terminology including References to an External Code System ====
		+
		+	In the example below an external code system "OPS" of type ''system'' is defined. For referencing to concepts within that system, a relationship "bei OPS" of type ''predicate'' is defined. The definiton of the custom terminology "Zusatzentgelte nach § 6 Abs. 1 KHEntgG" and its contained concepts is done using the [[OntoDL Style Sheet Directive: heading\|''#heading'' directive]] of the OntoDL Macro Language.
		+	{\|
		+	\|-
		+	! style="text-align:left; width:6em" \| Style Sheet !!   !! style="text-align:left; width:44em" \| Text !!   !! style="text-align:left" \| ''Comment''
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">define system OPS = CTS2LE.Systems[OID=(1.2.276.0.76.5.425)]</span>
		+	\|}
		+	\|\| \|\| Introducing the system OPS as an external code system using the ''internal reference'' notation
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">define predicate (bei OPS) { set me.URI = (http://dkg.de/301/predicate/OPS) set me.TargetSystem=OPS }</span>
		+	\|}
		+	\|\| \|\| Defining a custom predicate using the ''full definition'' notation
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">#heading 2 codesystem .Name</span>
		+	\|}
		+	\|\| \|\| advising the OntoDL Makro Language interpreter to map all level-2 headings onto code system definitions. Internally the interpreter will replace any heading 2 text by "define codesystem (''Text'') {" and insert a "}" character at the end of the level-2 section of the document.
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">#heading 5 concept .Name : .Definition</span>
		+	\|}
		+	\|\| \|\| advising the OntoDL Makro Language interpreter to map all level-5 headings onto concept definitions. Internally the interpreter will split any heading 5 text into a name part and an definition part and then replace the heading by the OntoDL commands "define concept (''name'') { set me.Definition=(definition)". Again the interpreter inserts a "}" character at the end of the level-5 section (e.g. when a new level-5 heading is discovered).
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">#pattern OPS => OPS %c => --(bei OPS)-->(%c)</span>
		+	\|}
		+	\|\| \|\| this pattern allows us to just write the OPS-code we want to refer to instead of writing the full OntoDL syntax for concept relationships.
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%"></span>
		+	\|}
		+	\|\| \|\|
		+	\|- style="vertical-align:top"
		+	\| Überschrift 2\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Arial;font-size:118%">'''Zusatzentgelte nach § 6 Abs. 1 KHEntgG'''</span>
		+	\|}
		+	\|\| \|\| Defining a code system named "Zusatzentgelte nach § 6 Abs. 1 KHEntgG"
		+	\|- style="vertical-align:top"
		+	\| OntoDL\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:0em"\|
		+	\|<span style="font-family:Courier;font-size:91%">set me.URI = (http://sample.de/6-1_KHEntgG)</span>
		+	\|}
		+	\|\| \|\| As explained above, the heading directive maps a heading onto a full definition. This opens up a definion scope and allows us to further refine the definition of the code system.
		+	\|- style="vertical-align:top"
		+	\| Überschrift 5\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:2em"\|
		+	\|<span style="font-family:Arial;font-size:109%">76097392: ZE2016-110 Gabe von Tocilizumab, subkutan, je Fertigspritze 162 mg</span>
		+	\|}
		+	\|\| \|\| a cocnept named "76097392" is defined.
		+	\|- style="vertical-align:top"
		+	\| OPS\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:2em"\|
		+	\|<span style="font-family:Arial;font-size:82%">OPS 6-005.n</span>
		+	\|}
		+	\|\| \|\| the concept refers to the OPS-code "6-005.n"
		+	\|- style="vertical-align:top"
		+	\| Überschrift 5\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:2em"\|
		+	\|<span style="font-family:Arial;font-size:109%">76097394: ZE2016-03 ECMO und PECLA, 576 bis unter 800 Stunden</span>
		+	\|}
		+	\|\| \|\|
		+	\|- style="vertical-align:top"
		+	\| OPS\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:2em"\|
		+	\|<span style="font-family:Arial;font-size:82%">OPS 8-852.0a</span>
		+	\|}
		+	\|\| \|\|
		+	\|- style="vertical-align:top"
		+	\| Überschrift 5\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:2em"\|
		+	\|<span style="font-family:Arial;font-size:109%">76097395: ZE2016-03 ECMO und PECLA, 800 bis unter 1000 Stunden</span>
		+	\|}
		+	\|\| \|\|
		+	\|- style="vertical-align:top"
		+	\| OPS\|\| \|\|style="background:#fff588"\|
		+	{\|
		+	\|style="text-align:left; width:2em"\|
		+	\|<span style="font-family:Arial;font-size:82%">OPS 8-852.0a</span>
		+	\|}
		+	\|\| \|\|
		+	\|}
		+	<hr>

← Nächstältere Version		Version vom 17. September 2016, 08:12 Uhr
Zeile 227:		Zeile 227:

	=== Nesting of ''definition'' Statements ===		=== Nesting of ''definition'' Statements ===
		+	''definition'' statements may be nested, e.g. a code system definition usualy contains further ''definition'' statements for the concepts within the code system. The table below lists which object definitions may be included within the definition scope of other objects.

	{\|class="wikitable"		{\|class="wikitable"

@@ Zeile 220: / Zeile 220: @@
 <pre>define codesystem documenttypes {
    define concept (hospital letter) = (68609-7)@LOINC
    define concept (referral note)   = (57133-1)@LOINC

← Nächstältere Version		Version vom 17. September 2016, 08:09 Uhr
Zeile 213:		Zeile 213:

	=== Qualified Concepts ===		=== Qualified Concepts ===
		+	Concepts from external code systems can be introduced by just providing their code together with a reference to the code system:

		+	<pre>define concept (hospital letter) = (68609-7)@LOINC</pre>
		+
		+	This compact notation is especially useful when defining a value set of codes from external code systems:
		+
		+	<pre>define codesystem documenttypes {
		+	define concept (hospital letter) = (68609-7)@LOINC
		+	define concept (referral note) = (57133-1)@LOINC
		+	define concept (hospital consult note) = (34104-0)@LOINC
		+	}</pre>

	=== Nesting of ''definition'' Statements ===		=== Nesting of ''definition'' Statements ===

@@ Zeile 205: / Zeile 205: @@
 It is important to notice that objects defined through internal references do not have a definiton scope. This is because they adopt all properties except the name from the assigned object. The assignment is "by reference" whoch means that the defined object is just a reference to the source object and therefore all changes applied to the source object will be visible to the newly defined object, too.
-In the example below, both concepts "demo" and "demo2" will have a display value of "demonstration" at the end of the definition scope of concept "demo" (''Note: This was just to demonstrate the principle. In fact this code would rise an error as there mast not be two concepts within the same code system that have the same code'').
+In the example below, both concepts "demo" and "demo2" will have a display value of "demonstration" at the end of the definition scope of concept "demo" (''Note: This was just to demonstrate the principle. In fact this code would rise an error because there must not be two concepts within the same code system that have the same code'').
 <pre>define concept demo {
    define concept demo2 = me

@@ Zeile 210: / Zeile 210: @@
    set me.Display = (demonstration)
+}
-<pre>
+</pre>
 === Qualified Concepts ===

@@ Zeile 195: / Zeile 195: @@
 |}
 <hr>
 === Qualified Concepts ===
 === Nesting of ''definition'' Statements ===

@@ Zeile 128: / Zeile 128: @@
 </pre>
-A special way for setting property values to an object is to place a MS Word table with two columns into the definition scope. This table holds the name of the property in the first column and the property value in the second column. You may advise the OntoDL interpreter to consider a property value as a string by prefixing it with "($". See the first two lessons of the tutorial for examples of this notation.
+A special way for setting property values to an object is to place a MS Word table with two columns into the definition scope. This table holds the name of the property in the first column and the property value in the second column. You may advise the OntoDL interpreter to consider a property value as a string by prefixing it with "($".
 === Qualified Concepts ===