This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "VocApp-ValSetChanges/ValSetMenu"

From HL7Wiki
Jump to navigation Jump to search
Line 18: Line 18:
 
====Add Codes to Value Set====
 
====Add Codes to Value Set====
 
====Remove Codes from a Value Set====
 
====Remove Codes from a Value Set====
 +
{| align="center" style="text-align:left"
 +
|-
 +
| valign="top"|
 +
 +
|[[Image:VocAppVSRemoveCode-010.gif|thumb|center|512px|Remove codes from VS: Menu]]
 +
|-
 +
| valign="top"|
 +
 +
|[[Image:VocAppVSRemoveCode-020.gif|thumb|center|512px|Delete Value Set: Select code(s) to delete from list and verify deletion with "Finish"]]
 +
|}
 +
 
====Update Value Set Description====
 
====Update Value Set Description====
 
{| align="center" style="text-align:left"
 
{| align="center" style="text-align:left"

Revision as of 01:18, 9 October 2007

Changes from a Value Set Selection

The figure at right shows the various options that can be selected when a Value Set node is selected in the Value Set Navigator window, and the right mouse button is clicked. In each case, the menu selection starts a process to define changes to be applied to the selected value set. (NOTE: The first selection Create Value Set actually creates a value set as a child (sub-type) of the selected value set.)

These selections are intended to cover all possible operations on a value set node. In aggregate, the functions provided include:

  • Create or Delete a Value Set;
  • Add or Remove codes from a Value Set;
  • Bind, but not unbind the Value Set to a Concept Domain; and
  • Add or Remove references from the Value Set to child value sets

Further, in several cases, these operations are redundant or partially so. For example, both Create Value Set and Bind Concept Domain to Value Set allow a value set to be bound to a concept domain, but only in Create Value Set can one also define a new concept domain.

Menu selections from a value set node

Create Value Set

Delete Value Set

Add Codes to Value Set

Remove Codes from a Value Set

Remove codes from VS: Menu
Delete Value Set: Select code(s) to delete from list and verify deletion with "Finish"

Update Value Set Description

Update VS Description: Menu

NOTE: TITLE IS WRONG

Update VS Description: Enter revised description and confirm with "Finish"

Bind Concept Domain to Value Set

Bind Concept Domain to VS: menu
Bind Concept Domain to VS: Select domain from list of existing domains.

Add Value Set References

Although "reference" is a generic term, the only kind of value set reference included in the Vocabulary Maintenance Language, and in the underlying Access data base tables, is a parent-child relationship wherein the reference is from the parent to the child. This action will allow the user to select one or more value sets to be added as children to the parent Value Set selected in the Value Set Navigator.

  1. Within the Value Set Navigator select the Value Set node that is to be the parent of the Value Set references you wish to establish.
  2. Right click on the selected node
  3. Select Add Value Set References (see menu at right)
Add VS References: Menu
  1. The wizard will present a Search for Value Set page (as at right) which includes the propsective parent value set listed in the middle of the pane.
  2. A Search box is presented at the top. The search is made on the Value Set names for the current code system, and will search for all value sets whose names begin with the string in the 'Search Text'. (The search is not case sensitive.)
  3. Enter a Search Text and click the Search button to populate the Value Set list at the bottom of the page.
  4. Select the child node(s) whose reference(s) you wish to add. Multiple selections may be made by judicious use of Shift-click and Control-click in addition to just Click.
  5. When the selection list is complete for this search sttring, click Next (not Finish).

If you need the results of more than one search string, you can click Next to move the current selections to the prospective list, and then Back (see note below) to return here to find and select other value sets.
Add VS References: Search on start of VS name and select one or more from list
  1. The next pane presented is the Abstract or Specilizable page on which each of the selected child value sets is listed.
  2. If you need to make additions to this list, you can click Back and you will be returned to the selection page where you can use different search strings or add selections from the previous search.
  3. There is no way to remove a value set from this list. To do that, you should click Cancel and restart this step.
  4. To the left of each entry in the list is a check box. The boxes can be marked with a check by clicking the box. (A second click will undo the first.)
  5. Put a check mark next to all value sets that will be added to the parent as 'specializable -- where the head code of the value set is to be included in the parent value set.
  6. Leave unchecked all value sets that will be added to the parent as 'abstract -- where the head code of the value set will not be included in the parent value set.
  7. When the list is complete and correct, click Next, not Finish.
Add VS References: List of Value Sets to be added as children; for each select to add as Abstract or Specializable
  1. The wizard presents the Value Set List page as at right. This page lists all of the selections made in the steps above.
  2. Verify that this list is correct.
  3. If you need to make changes, you can click Back and return to the previous panes to change or add to your selections. You will not be able to remove items.
  4. The Cancel button will stop the change wizard, with no entries added to the proposal file.
  5. When the listed elements meet your expectations, conclude the removal steps by clicking Finish.
Add VS References: Review current list of references to add and confirm with "Finish"

Remove Value Set References

Although "reference" is a generic term, the only kind of value set reference included in the Vocabulary Maintenance Language, and in the underlying Access data base tables, is a parent-child relationship wherein the reference is from the parent to the child. This action will remove one or more parent-to-child references from the parent Value Set selected in the Value Set Navigator.

CAUTIONS:

Removing a value set reference leaves the value set and its code content in limbo. They remain part of the Code System and part of the Value Set definitions, but will not be exposed because there is no longer a parent under which they will appear.

In general, a code system reference should only be removed in one of two circumstances:

  1. Where the child value set is already listed under two or more parents and the objective is to remove and not replace one of the references; or
  2. Where the goal is to move the child value set to a different parent. In this case, you will need to prepare a two-step change proposal that:
    1. Removes the parent child reference here, and
    2. Adds a value set reference from a new parent to the same child.

For any other purpose, the Delete Value Set function is probably more appropriate.

Process sequence to Remove reference
  1. Within the Value Set Navigator select the Value Set node that is the parent of the Value Set reference you wish to remove.
  2. Right click on the selected node
  3. Select Remove Value Set References (see menu at right)
Remove VS References: Menu
  1. The wizard will present a Value Set References page (as at right) listing all of the child references held by the parent value set node you selected in the navigator.
  2. Select the child node(s) whose reference(s) you wish to remove. Multiple selections may be made by judicious use of Shift-click and Control-click in addition to just Click.
  3. When the selection list is complete, click Next (not Finish).
Remove VS References: Select child reference(s) to remove from list
  1. The wizard presents the Value Set References to Remove page as at right. This page lists all of the selections made in the step above.
  2. Verify that this list is correct.
  3. If you need to make changes, you can click Back and you will be returned to the selection page with the previous selection showing. You can then use Control-click to add to or remove from the previous selection(s).
  4. The Cancel button will stop the change wizard, with no entries added to the proposal file.
  5. When the listed elements meet your expectations, conclude the removal steps by clicking Finish.
Remove VS References: Review list to be removed, and verify with "Finish"