Difference between revisions of "VocApp-ValSetChanges/ValSetMenu"
(11 intermediate revisions by the same user not shown) | |||
Line 91: | Line 91: | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | + | #The option to bind to a domain is presented in the '''Bind Value Set to Concept Domain''' page (as at right) | |
+ | #The options are circled at top | ||
+ | #This figure demonstrates the '''Search Existing Domains''' (top) options and the following two figures demonstrate the other options. | ||
+ | #The middle pane shows an alphabetic list of all domains defined by HL7. The list is extensive. It can be made to hop to a particular entry by quickly typing the initial characters of the name. (See [[Harmonization Editor Manual (Browsing)#Alphabetic Skipping in a Tree View|Alphabetic skipping in a list]].) | ||
+ | #Find (hop and/or scroll to) the domain to which the binding is to be made, and select that entry. | ||
+ | #When the selection is correct, click '''Next''' | ||
|[[Image:VocAppVSCreate-090.gif|thumb|center|512px|Create New VS: Choose whether to bind VS to a concept domain, and if so whether to select an existing domain, or define a new one. If existing, pick from the list provided.]] | |[[Image:VocAppVSCreate-090.gif|thumb|center|512px|Create New VS: Choose whether to bind VS to a concept domain, and if so whether to select an existing domain, or define a new one. If existing, pick from the list provided.]] | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | + | #The option to bind to a domain is presented in the '''Bind Value Set to Concept Domain''' page (as at right) | |
− | |[[Image:VocAppVSCreate-100.gif|thumb|center|512px|Create New VS: Choose whether to bind VS to a concept domain, and if so whether to select an existing domain, or define a new one. If new, enter Unique name (with no spaces or punctuation), description, and, if desired select an existing domain]] | + | #The options are circled at top |
+ | #This figure demonstrates the '''Create New Domain''' (middle) option and the preceding and following figures demonstrate the other options. | ||
+ | #The lower pane is used to define a new concept domain. It has three fields. | ||
+ | #The upper-lower field is for the new Concept Domain name. This name: | ||
+ | #*'''must have no spaces or punctuation'''; | ||
+ | #*'''must be unique across all HL7 Concept Domains'''; and | ||
+ | #*'''should''' be patterned after other HL7 concept domain names. | ||
+ | #The middle-lower field is a drop down list of all HL7 defined domains -- a long list. To speed finding an entry , the text box acts as a non-case-sensitive jump entry. Enter the opening character string of the domain being sought, and then click the "down-arrow" on the drop down list. The list will be positioned at the first domain name whose opening characters match the string entered. | ||
+ | #*This entry is '''optional''' leaving it blank will place the '''new domain''' at a level equivalent to domains like '''ActCode''' and '''RoleClass''' | ||
+ | #*Selecting a domain in this field will place the '''new domain''' as a child (restriction) on the selected domain. | ||
+ | #The lower-lower field is for the description of the value set. | ||
+ | #When the entries in the lower pane are as desired, click '''Next'''.<br/><br/> | ||
+ | | valign="top"| | ||
+ | [[Image:VocAppVSCreate-100.gif|thumb|center|512px|Create New VS: Choose whether to bind VS to a concept domain, and if so whether to select an existing domain, or define a new one. If new, enter Unique name (with no spaces or punctuation), description, and, if desired select an existing domain]] | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | + | #The option to bind to a domain is presented in the '''Bind Value Set to Concept Domain''' page (as at right) | |
+ | #The options are circled at top | ||
+ | #This figure demonstrates the '''Do Not Bind to Domain''' (bottom) option and the two preceding figures demonstrate the other options. | ||
+ | #Since this is the "do-nothing" option, click '''Next'''. | ||
|[[Image:VocAppVSCreate-110.gif|thumb|center|512px|Create New VS: Choose whether to bind VS to a concept domain, and if so whether to select an existing domain, or define a new one. If no binding, there is nothing else to specify on this form.]] | |[[Image:VocAppVSCreate-110.gif|thumb|center|512px|Create New VS: Choose whether to bind VS to a concept domain, and if so whether to select an existing domain, or define a new one. If no binding, there is nothing else to specify on this form.]] | ||
|- | |- | ||
Line 107: | Line 128: | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | + | #The wizard next presents the '''Add Concepts to the New Value Set''' page (as at right) | |
− | |[[Image:VocAppVSCreate-120.gif|thumb|center|512px|Create New VS: Select whether to add additional codes to value set, and if so whether to select existing codes or create new ones.]] | + | #In the upper pane, the page identifies the new value set being created. |
+ | #Below that are three options for adding Coded Concepts to the new value set: | ||
+ | #*to create '''new Coded Concepts''' to add; | ||
+ | #*to add '''existing Coded Concepts'''; or | ||
+ | #*to add '''no additional Coded Concepts'''. | ||
+ | #As noted on the figure, the wizard pages for the first options are identical to those seen when the '''Add Codes to Value Set''' option is taken for an existing value set, with one exception. | ||
+ | #The exception is that the final page of the selection sequence returns to the page shown at right, rather than to the equivalent option selections in the other wizard. | ||
+ | #'''Option: <u>Create a new Coded Concept</u>...''' After you click '''Next''', see [[#Subprocess to Create new codes|'''instructions in Create Codes wizard''']]. When you encounter hyper link to '''Return to New Value Set Wizard''', select that to return here. | ||
+ | #'''Option: <u>Add an existing Coded Concept</u>...''' After you click '''Next''', see [[#Subprocess to Add Existing codes|'''instructions in Create Codes wizard''']]. When you encounter hyper link to '''Return to New Value Set Wizard''', select that to return here. | ||
+ | #'''Option: <u>No additional Coded Concept</u>...''' After you click '''Next''', proce4ed to the following figure<br/><br/> | ||
+ | | valign="top"| | ||
+ | [[Image:VocAppVSCreate-120.gif|thumb|center|512px|Create New VS: Select whether to add additional codes to value set, and if so whether to select existing codes or create new ones.]] | ||
|- | |- | ||
| | | | ||
Line 115: | Line 147: | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | + | #The wizard next presents the '''Add Existing Value Set References''' page (as at right) | |
+ | #In the upper pane, the page identifies the new value set being created. | ||
+ | #Below that is an option to add parent-child references that will link existing value sets as children of the new value set, or not. | ||
+ | #As noted on the figure, the wizard pages for this option are identical to those seen when the '''Add Value Set References''' option is taken for an existing value set, with one exception. | ||
+ | #The exception is that the initial page showing the of the '''Add Value Set References''' menu selection is not part of this sequence. | ||
+ | #'''Option: <u>Add references</u>...''' After you click '''Next''', see [[#Add Value Set References|'''instructions in add references wizard''']]. When you encounter hyper link to '''Return to New Value Set Wizard''', select that to return here. | ||
+ | #'''Option: <u>No additional Coded Concept</u>...''' After you click '''Next''', proceed to the following figure | ||
|[[Image:VocAppVSCreate-130.gif|thumb|center|512px|Create New VS: Select whether or not to add references to existing value sets (make existing VS children of the new VS)]] | |[[Image:VocAppVSCreate-130.gif|thumb|center|512px|Create New VS: Select whether or not to add references to existing value sets (make existing VS children of the new VS)]] | ||
|- | |- | ||
Line 123: | Line 161: | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | + | #The final page is the '''New Value Set''' page that summarizes on a single page the definition of the value set as well as the codes and value set references (children) that are included in it. | |
+ | #Although '''Back''' will allow you to back up and add elements, it is not recommended, as there is a real chance that you could create duplicate entries that will invalidate the whole definition. | ||
+ | #If the page meets your expectations, click '''Finish''' to complete the process. | ||
|[[Image:VocAppVSCreate-140.gif|thumb|center|512px|Create New VS: Verify the final package with "Finish"]] | |[[Image:VocAppVSCreate-140.gif|thumb|center|512px|Create New VS: Verify the final package with "Finish"]] | ||
|} | |} | ||
Line 134: | Line 174: | ||
Since Value Sets may contain one or more leaf terms (coded concepts) and may reference one or more child value sets, this process leaves contained coded concepts and value sets in limbo. They remain as part of the Code System and Value Set tables, but will not be exposed because there is no longer a '''''parent''''' under which they will appear. | Since Value Sets may contain one or more leaf terms (coded concepts) and may reference one or more child value sets, this process leaves contained coded concepts and value sets in limbo. They remain as part of the Code System and Value Set tables, but will not be exposed because there is no longer a '''''parent''''' under which they will appear. | ||
− | '''In general''', if you wish to remove a value set, you should also plan the disposition of its children by, for example assigning them to one or more remaining value sets. To do this, you will need to prepare a [[ | + | '''In general''', if you wish to remove a value set, you should also plan the disposition of its children by, for example assigning them to one or more remaining value sets. To do this, you will need to prepare a [[Harmonization Editor Manual (Proposal)#Creating Multi-step Change Proposals|'''multi-step change proposal''']] that: |
#Deletes the Value Set here; | #Deletes the Value Set here; | ||
#Adds the child coded concept(s) to a different value set; and/or | #Adds the child coded concept(s) to a different value set; and/or | ||
Line 165: | Line 205: | ||
|- | |- | ||
|'''CAUTION:''' | |'''CAUTION:''' | ||
− | A coded term cannot be added to a value set if it is already in that value set or '''if it is in one of the descendant value sets''' of that value set. If you desire to move a coded concept from a descendant value set to its parent or an ancestor, you will need to prepare a [[ | + | A coded term cannot be added to a value set if it is already in that value set or '''if it is in one of the descendant value sets''' of that value set. If you desire to move a coded concept from a descendant value set to its parent or an ancestor, you will need to prepare a [[Harmonization Editor Manual (Proposal)#Creating Multi-step Change Proposals|'''two-step change proposal''']] that: |
#Removes the coded concept from the child or descendant, and | #Removes the coded concept from the child or descendant, and | ||
#Adds a the coded concept to the parent or ancestor value set using this function. | #Adds a the coded concept to the parent or ancestor value set using this function. | ||
Line 215: | Line 255: | ||
##Click '''Next''' to add further terms, either new or existing | ##Click '''Next''' to add further terms, either new or existing | ||
##Click '''Finish''' if the list is complete and correct | ##Click '''Finish''' if the list is complete and correct | ||
+ | #Click '''Next''' and [[#Subprocess to Add codes|Return to '''New Value Set Wizard''']] if you started there. | ||
|[[Image:VocAppVSAddCode-050.gif|thumb|center|512px|Add Code to VS: Note current list of additions]] | |[[Image:VocAppVSAddCode-050.gif|thumb|center|512px|Add Code to VS: Note current list of additions]] | ||
|- | |- | ||
Line 256: | Line 297: | ||
##Click '''Next''' to add further terms, either new or existing | ##Click '''Next''' to add further terms, either new or existing | ||
##Click '''Finish''' if the list is complete and correct | ##Click '''Finish''' if the list is complete and correct | ||
+ | #Click '''Next''' and [[#Subprocess to Add codes|Return to '''New Value Set Wizard''']] if you started there. | ||
|[[Image:VocAppVSAddCode-100.gif|thumb|center|512px|Add Code to VS: Review and accept list of new and existing codes to be added]] | |[[Image:VocAppVSAddCode-100.gif|thumb|center|512px|Add Code to VS: Review and accept list of new and existing codes to be added]] | ||
|} | |} | ||
Line 268: | Line 310: | ||
'''In general''', a code should only be removed from a value set in one of two circumstances: | '''In general''', a code should only be removed from a value set in one of two circumstances: | ||
#Where the coded concept is already listed under '''two or more value sets''' and the objective is to remove it from one of these; or | #Where the coded concept is already listed under '''two or more value sets''' and the objective is to remove it from one of these; or | ||
− | #Where the goal is to '''move the coded term to a different value set'''. In this case, you will need to prepare a [[ | + | #Where the goal is to '''move the coded term to a different value set'''. In this case, you will need to prepare a [[Harmonization Editor Manual (Proposal)#Creating Multi-step Change Proposals|'''two-step change proposal''']] that: |
##Removes the coded concept here, and | ##Removes the coded concept here, and | ||
##Adds a the coded concept to a different value set. | ##Adds a the coded concept to a different value set. | ||
Line 304: | Line 346: | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | #The wizard opens with the '''WRONG TITLE''' of '''Codes within the Selected Value Set''' (as at right) | + | #<s>The wizard opens with the '''WRONG TITLE''' of '''Codes within the Selected Value Set''' (as at right) </s> |
− | #Fortunately the wizard functions correctly. The upper portion shows the selected Value Set and its current description. | + | #<s>Fortunately the wizard functions correctly. The upper portion shows the selected Value Set and its current description. </s> |
+ | #<s>The lower pane provides three text boxes in which to create the '''''definition, discussion''''' and '''''examples''''' for the new description. </s> | ||
+ | #<s>When the lower panes are correctly updated, click '''Finish''' </s> | ||
+ | |[[Image:VocAppVSUpdate-020.gif|thumb|center|512px|<s>Update VS Description: Enter revised description and confirm with "Finish" </s>]] | ||
+ | |- | ||
+ | | valign="top"| | ||
+ | #The upper portion of the wizard shows the selected Value Set and its current description. | ||
#The lower pane provides three text boxes in which to create the '''''definition, discussion''''' and '''''examples''''' for the new description. | #The lower pane provides three text boxes in which to create the '''''definition, discussion''''' and '''''examples''''' for the new description. | ||
#When the lower panes are correctly updated, click '''Finish''' | #When the lower panes are correctly updated, click '''Finish''' | ||
− | |[[Image:VocAppVSUpdate- | + | |[[Image:VocAppVSUpdate-021.gif|thumb|center|512px|Update VS Description: Enter revised description and confirm with "Finish"]] |
|} | |} | ||
Line 331: | Line 379: | ||
|- | |- | ||
| valign="top"| | | valign="top"| | ||
− | #The | + | #The wizard presents the '''Bind Value Set to Concept Domain''' pane as at right |
#The bottom portion of the screen is an alphabetic list of all concept domains defined in HL7. The list is extensive. It can be made to hop to a particular entry by quickly typing the initial characters of the name. (See [[Harmonization Editor Manual (Browsing)#Alphabetic Skipping in a Tree View|Alphabetic skipping in a list]].) | #The bottom portion of the screen is an alphabetic list of all concept domains defined in HL7. The list is extensive. It can be made to hop to a particular entry by quickly typing the initial characters of the name. (See [[Harmonization Editor Manual (Browsing)#Alphabetic Skipping in a Tree View|Alphabetic skipping in a list]].) | ||
#Find (hop and/or scroll to) the domain to which the binding is to be made, and select that entry. | #Find (hop and/or scroll to) the domain to which the binding is to be made, and select that entry. | ||
Line 373: | Line 421: | ||
#The '''Cancel''' button will stop the change wizard, with no entries added to the proposal file. | #The '''Cancel''' button will stop the change wizard, with no entries added to the proposal file. | ||
#When the listed elements meet your expectations, conclude the removal steps by clicking '''Finish'''. | #When the listed elements meet your expectations, conclude the removal steps by clicking '''Finish'''. | ||
+ | #Click '''Next''' and [[#Subprocess to Add child sets|Return to '''New Value Set Wizard''']] if you started there. | ||
|[[Image:VocAppVSAddRef-040.gif|thumb|center|512px|Add VS References: Review current list of references to add and confirm with "Finish"]] | |[[Image:VocAppVSAddRef-040.gif|thumb|center|512px|Add VS References: Review current list of references to add and confirm with "Finish"]] | ||
|} | |} | ||
Line 385: | Line 434: | ||
'''In general''', a code system reference should only be removed in one of two circumstances: | '''In general''', a code system reference should only be removed in one of two circumstances: | ||
#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 | #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 | ||
− | #Where the goal is to '''move the child value set to a different parent'''. In this case, you will need to prepare a [[ | + | #Where the goal is to '''move the child value set to a different parent'''. In this case, you will need to prepare a [[Harmonization Editor Manual (Proposal)#Creating Multi-step Change Proposals|'''two-step change proposal''']] that: |
##Removes the parent child reference here, and | ##Removes the parent child reference here, and | ||
##Adds a value set reference from a new parent to the same child. | ##Adds a value set reference from a new parent to the same child. |
Latest revision as of 18:48, 21 October 2007
Contents
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:
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. |
Create Value Set
This action creates a new Value Set as a child of the Value set that was selected when the menu item was chosen. This is a multi-part operation that includes:
- Complete specification of the value set including:
- Name, description and whether "abstract or "specializable";
- Parent-child reference from the selected value set to the new one; and
- Assignment of a head code (if specializable), including the option of defining a new concept to be the head code.
- Option of binding the new value set to a concept domain, which may be created if the target does not already exist.
- Option to add existing or new coded concepts to the value set
- Option to add parent-child value set references from the new value set to existing value sets
Operations 3 and 4, above, are identical to stand-alone operations described in other sections below. They will be discussed in general terms in this section and a hyper link to the detailed discussion will be provided.
Process sequence to Create Value Set
|
|
Subprocess to specify Value Set |
|
|
|
|
|
|
|
|
|
|
|
|
|
Subprocess to Bind to domain |
|
|
|
|
|
|
|
Subprocess to Add codes |
|
|
|
Subprocess to Add child sets |
|
|
|
Subprocess to finish creation |
|
|
Delete Value Set
This selection is used to delete a Value Set from the data base.
CAUTION:
Since Value Sets may contain one or more leaf terms (coded concepts) and may reference one or more child value sets, this process leaves contained coded concepts and value sets in limbo. They remain as part of the Code System and Value Set tables, but will not be exposed because there is no longer a parent under which they will appear. In general, if you wish to remove a value set, you should also plan the disposition of its children by, for example assigning them to one or more remaining value sets. To do this, you will need to prepare a multi-step change proposal that:
|
Process sequence to Remove reference
|
|
|
Add Codes to Value Set
Value Sets may contain one or more leaf terms (coded concepts) and one or more child value sets. This process allows one to add leaf terms that are directly within the value set.
This process has multiple layers, as it also implements the function to create coded concepts in the relevant Code System, which (currently) cannot be done as a direct operation on the Code System.
CAUTION:
A coded term cannot be added to a value set if it is already in that value set or if it is in one of the descendant value sets of that value set. If you desire to move a coded concept from a descendant value set to its parent or an ancestor, you will need to prepare a two-step change proposal that:
|
Process sequence to Add codes
|
|
|
|
Subprocess to Add Existing codes |
|
|
|
|
|
|
|
|
|
Subprocess to Create new codes |
|
|
|
|
|
|
|
Subprocess to Complete addition |
|
|
Remove Codes from a Value Set
Value Sets may contain one or more leaf terms (coded concepts) and one or more child value sets. This process allows one to remove leaf terms that are directly within the value set. It will not allow removal of the "head codes" of child value sets, nor the leaf terms that are members of the child value sets.
CAUTION:
Removing a coded term from a value set leaves the coded concept in limbo. It remains part of the Code System, but will not be exposed because there is no longer a parent under which it will appear. In general, a code should only be removed from a value set in one of two circumstances:
For other purposes, the Retire Code function is probably more appropriate. |
Process sequence to Remove codes
|
|
|
Update Value Set Description
Each Value Set has a description that defines what the value set represents and/or contains. These definitions may include sections for the definition, discussion of the rationale underlying the value set. and examples of coded terms it may contain.
Process sequence to Update description
|
|
|
|
|
Bind Concept Domain to Value Set
Each Concept Domain in the terminology may be bound to one or more value sets. Where there are multiple bindings, each binding is in a particular context or binding realm. This function allows a predefined value set (the one selected to start the process) to be bound to a predefined concept domain. It uses the "default" context (no value) meaning that it will be bound in the universal (UV) realm.
Data definition for Binding Concept Domain to Value Set
CAUTIONS:
|
Process sequence to Bind Concept Domain
|
|
|
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.
|
|
|
|
|
|
|
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:
For any other purpose, the Delete Value Set function is probably more appropriate. |
Process sequence to Remove reference
|
|
|
|
|