Freeplane CTS2-LE Plugin: Editing Value Sets

Aus CTS2-LE
Zur Navigation springen Zur Suche springen

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 value set.

Creating a value set

To create a value set:

  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, click the dots-icon on the left-hand side of the label. The icon changes from dots to bars, representing a list of codes.
  4. In the root node, adapt label and attribute values. See section Constituting a value set.


Importing a value set for editing

The Freeplane CTS2-LE Add-On manages code systems and value sets 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 value set

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:

Root Node Attribute Effect on Metadata
Label Sets the name.
description Sets the description.
groupName Selects the group, which contains the value set or 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 value set

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:

  1. 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.
  2. Select the root node or any other node.
  3. 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:

  1. Select the new node.
  2. 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.
  3. 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:

  1. Click on the tickmark on the left hand side of the label of the suggested code.

Exporting as FHIR ValueSet file

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.

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

Value sets authored with the CTS2-LE-Addon are not connected to version published on CTS2-LE.

To publish a value set on CTS2-LE:

  1. Open the Freeplane working document that models the code system or value set.
  2. Use the menu item Tools -> FHIR ValueSet Tools -> CTS2-Upload. Or, use the keyboard shortcut F11.