Freeplane CTS2-LE Plugin: Editing Terminologies: Unterschied zwischen den Versionen

Aus CTS2-LE
Zur Navigation springen Zur Suche springen
(Die Seite wurde neu angelegt: „The CTS2-LE-Addon for Freeplane applies the concept of mind mapping to the authoring of value sets and code systems. ==== Creating a value set ==== To create…“)
 
Zeile 1: Zeile 1:
−
The CTS2-LE-Addon for Freeplane applies the concept of mind mapping to the authoring of value sets and code systems.
+
The CTS2-LE-Addon for Freeplane applies the concept of mind mapping to the authoring of value sets and code systems. This section explains how to create and/or edit a new code system.
  
−
==== Creating a value set ====
+
== Create a new code system ==
  
−
To create a value set:  
+
To create a new code system:  
  
 
# Use the menu item ''File'' -> ''New map from template…''  
 
# Use the menu item ''File'' -> ''New map from template…''  
 
# In the ''Open'' dialog, choose the file ''Neues-FHIR-ValueSet.mm''. A mindmap containing a single root node is created.  
 
# In the ''Open'' dialog, choose the file ''Neues-FHIR-ValueSet.mm''. A mindmap containing a single root node is created.  
−
# In the root node, click the dots-icon on the left-hand side of the label. The icon changes from dots to bars, representing a list of codes.
 
 
# In the root node, adapt label and attribute values. See section ''Describing a value set or a code system''.
 
# In the root node, adapt label and attribute values. See section ''Describing a value set or a code system''.
  
−
==== Creating a code system ====
+
== Open an exiating code system for editing ==
  
−
To create a code system:
+
The Freeplane CTS2-LE Add-On manages code systems as FHIR Value Set resources. By this you can use the tool for editing any existing FHIR Value Set resource file.  
−
 
 
−
# Use the menu item ''File'' -> ''New map from template…''
 
−
# In the ''Open'' dialog, choose the file ''Neues-FHIR-ValueSet.mm''. A mindmap containing a single root node is created.  
 
−
# In the root node, adapt label and attribute values. See section ''Describing a value set or a code system''.
 
−
 
 
−
==== Importing a FHIR ValueSet file ====
 
−
 
 
−
A FHIR ValueSet may define a code system or a value set.
 
  
 
To import a FHIR ValueSet:  
 
To import a FHIR ValueSet:  
Zeile 29: Zeile 20:
 
Note: The imported FHIR ValueSet is not the working file. To update the imported FHIR ValueSet file with changes you made in Freeplane, use the feature ''Exporting as FHIR ValueSet file''.
 
Note: The imported FHIR ValueSet is not the working file. To update the imported FHIR ValueSet file with changes you made in Freeplane, use the feature ''Exporting as FHIR ValueSet file''.
  
−
==== Constituting a value set or a code system ====
+
== Constituting a code system ==
  
−
The root node comprises a label and a set of attributes (name-value pairs). Modify the label and attribute values to set the metadata of the value set or code system:
+
The root node comprises a label and a set of attributes (name-value pairs). Modify the label and attribute values to set the metadata of the code system:
  
 
{| class="wikitable"
 
{| class="wikitable"
Zeile 44: Zeile 35:
 
|-
 
|-
 
|groupName
 
|groupName
−
|Selects the group, which contains the value set or code system when published on CTS2-LE.
+
|Selects the group, which contains the code system when published on CTS2-LE.
 
|-
 
|-
 
|status
 
|status
Zeile 56: Zeile 47:
 
|}
 
|}
  
−
==== Adding a code to a value set ====
+
== Adding a code to a code system ==
−
 
 
−
A code in a value set is a node in the mindmap. To add a code, you add a node to the mindmap. The attributes of the node reference a code of a code system.
 
−
 
 
−
To add a code to a value set:
 
−
 
 
−
# Open a value set by - creating a value set, or by - importing a FHIR ValueSet file, that defines a value set, or by - opening a Freeplane file, that models a value set.
 
−
# Select the root node or any other node.
 
−
# Use the menu item ''Edit'' -> ''New node'' -> ''New child node''. Or, use the keyboard shortcut ''INSERT''.
 
−
 
 
−
The new node does not reference a code of a code system so far. The CTS2-LE-Addon allows you to look up codes in CTS2-LE and to include them as in your value set without typewriting code and code system namespace URI.
 
−
 
 
−
To look up a code in CTS2-LE:
 
−
 
 
−
# Select the new node.
 
−
# Type in keyword, that is label the node. The keyword may be part of the code’s display name or it may be a part of the code value.
 
−
# Use the menu entry ''Tools'' -> ''FHIR ValueSet Tools'' -> ''Suggest Codes…'' Or, use the keyboard shortcut ''CTRL''+''ALT''+''L''. A list of suggested codes appears.
 
−
 
 
−
Each suggested code has a link to the code’s description page on CTS2-LE. Click a link to navigate to the description page.
 
−
 
 
−
To include a suggested code:
 
−
 
 
−
# Click on the tickmark on the left hand side of the label of the suggested code.
 
−
 
 
−
==== Adding a code to a code system ====
 
  
 
A code in a code system is a node in the mindmap. To add a code, you add a node to the mindmap and set its attributes.
 
A code in a code system is a node in the mindmap. To add a code, you add a node to the mindmap and set its attributes.
Zeile 105: Zeile 72:
 
|}
 
|}
  
−
==== Exporting as FHIR ValueSet file ====
+
== Exporting a code system as a FHIR ValueSet file ==
  
−
Code systems and value sets authored with the CTS2-LE-Addon are not connected to any FHIR ValueSet Ressource in the first place. Instead, your working document is a Freeplane mindmap document.
+
Code systems authored with the CTS2-LE-Addon are not connected to any FHIR ValueSet Ressource in the first place. Instead, your working document is a Freeplane mindmap document.
  
 
To export the mindmap document as FHIR ValueSet file:  
 
To export the mindmap document as FHIR ValueSet file:  
Zeile 116: Zeile 83:
 
# In the file chooser dialog, select or name the target file. If the file exists already, it will be overwritten.
 
# In the file chooser dialog, select or name the target file. If the file exists already, it will be overwritten.
  
−
==== Publishing to CTS2-LE ====
+
== Publishing to CTS2-LE ==
  
−
Code systems and value sets authored with the CTS2-LE-Addon are not connected to version published on CTS2-LE.
+
Code systems authored with the CTS2-LE-Addon are not connected to versions published on CTS2-LE.
  
 
To publish a value set or code system on CTS2LE:  
 
To publish a value set or code system on CTS2LE:  
  
−
# Open the Freeplane working document that models the code system or value set.  
+
# Open the Freeplane working document that models the code system.  
 
# Use the menu item ''Tools'' -> ''FHIR ValueSet Tools'' -> ''CTS2-Upload''. Or, use the keyboard shortcut ''F11''.
 
# Use the menu item ''Tools'' -> ''FHIR ValueSet Tools'' -> ''CTS2-Upload''. Or, use the keyboard shortcut ''F11''.

Version vom 16. Juni 2015, 09:21 Uhr

The CTS2-LE-Addon for Freeplane applies the concept of mind mapping to the authoring of value sets and code systems. This section explains how to create and/or edit a new code system.

Create a new code system

To create a new code system:

  1. Use the menu item File -> New map from template…
  2. In the Open dialog, choose the file Neues-FHIR-ValueSet.mm. A mindmap containing a single root node is created.
  3. In the root node, adapt label and attribute values. See section Describing a value set or a code system.

Open an exiating code system for editing

The Freeplane CTS2-LE Add-On manages code systems as FHIR Value Set resources. By this you can use the tool for editing any existing FHIR Value Set resource file.

To import a FHIR ValueSet:

  1. Use the menu item File -> New map from template…
  2. Use the menu item Tools -> FHIR ValueSet Tools -> Import FHIR ValueSet. Or, use the keyboard shortcut F9.

Note: The imported FHIR ValueSet is not the working file. To update the imported FHIR ValueSet file with changes you made in Freeplane, use the feature Exporting as FHIR ValueSet file.

Constituting a code system

The root node comprises a label and a set of attributes (name-value pairs). Modify the label and attribute values to set the metadata of the code system:

Root Node Attribute Effect on Metadata
Label Sets the name.
description Sets the description.
groupName Selects the group, which contains the code system when published on CTS2-LE.
status Sets the status. The value shall be one of draft, active, and retired.
uri Sets the namespace URI.
language Sets the language code.

Adding a code to a code system

A code in a code system is a node in the mindmap. To add a code, you add a node to the mindmap and set its attributes.

To add a code to a code system:

  1. Open a code system by - creating a code system, or by - importing a FHIR ValueSet file, that defines a code system, or by - opening a Freeplane file, that models a code system.
  2. Select the node, that is parent to the new code. Code systems may be flat, in which case you would select the root node of the code system as a parent.
  3. Use the menu item Edit -> New node -> New child node. Or, use the keyboard shortcut INSERT.
  4. Set the label and attribute values of the new code-node.
Node Attribute Effect on Metadata
Label Sets the display name of the code.
code Sets the code value of the code. The code value is in the namespace URI of the code system as defined on the root node.
definition Sets the definition or description of the code.

Exporting a code system as a FHIR ValueSet file

Code systems authored with the CTS2-LE-Addon are not connected to any FHIR ValueSet Ressource in the first place. Instead, your working document is a Freeplane mindmap document.

To export the mindmap document as FHIR ValueSet file:

  1. Open the Freeplane working document that models the code system or value set.
  2. If working document has unsafed changes, save.
  3. Use the menu item Tools -> FHIR ValueSet Tools -> Export FHIR ValueSet. Or, use the keyboard shortcut F10.
  4. In the file chooser dialog, select or name the target file. If the file exists already, it will be overwritten.

Publishing to CTS2-LE

Code systems authored with the CTS2-LE-Addon are not connected to versions published on CTS2-LE.

To publish a value set or code system on CTS2LE:

  1. Open the Freeplane working document that models the code system.
  2. Use the menu item Tools -> FHIR ValueSet Tools -> CTS2-Upload. Or, use the keyboard shortcut F11.
Abgerufen von „https://websites.fraunhofer.de/CTS2-LE/index.php?title=Freeplane_CTS2-LE_Plugin:_Editing_Terminologies&oldid=186“