NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Prior to using this tool, LexEVS instance should be configured properly. File lbconfig.props located at <LexEVS install directory>/resources/config/ should be set up properly, specially the database URL, driver, username and password.

Load

...

Function

Using this tool, you can load Value Set Definition(s) or Pick List Definition(s) from an XML file. The contents should confirm to LexGrid valuesets.xsd schema.

...

You can find a test data in <LexEVS install directory>/test/resources/testData/valueDomain/vdTestData.xml, that can be used to load for testing purpose.

Step

Action

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version=" 1" ac:macro-id="f27b8a85-e26d-4251-b2a9-d22810ba55d8"><ac:plain-text-body><![CDATA[ 1. Make sure to check 'Enable Admin Options' in 'Commands' menu.

[[Image:EnableAdminOptions.jpg

frameless

center

900px

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="2903c65b-e17a-4816-acdc-2ba18a494304"><ac:plain-text-body><![CDATA[

2. Select 'Load Value Set Definition – LexGrid XML' from 'Load' menu.

[[Image:LoadValueSetDefinitionMenu.jpg

frameless

center

900px

]]></ac:plain-text-body></ac:structured-macro>

Image Added

2. Select 'Load Value Set Definition – LexGrid XML' from 'Load' menu.

Image Added

3.

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="9199718e-ca65-4a79-9a1a-de099a6982ec"><ac:plain-text-body><![CDATA[

3. A separate window will open to select a file to load. Select a file to load.

[[Image: SelectVSDFileToLoad.jpg

frameless

center

900px

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="03c9bad8-9ead-4c60-a010-757d1287530e"><ac:plain-text-body><![CDATA[alt=""!

4. Click 'Load' button. Status of load process will be displayed as the data is getting loaded. If everything goes well, you should see 'Errors Logged: false' and 'End State: completed' at the bottom of the status output.

[[Image: VSDLoadComplete.jpg

frameless

center

900px

]]></ac:plain-text-body></ac:structured-macro>

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="1752e435-5d4d-4dd3-b689-7185e141d615"><ac:plain-text-body><![CDATA[Image Added

5. Value Set Definitions loaded should be displayed on the main console under 'Available Value Set Definitions'.

[[Image: !VSDLoadedContents.jpg

frameless

center

900px

]]></ac:plain-text-body></ac:structured-macro>alt=""

Loading Pick List Definition

This function allows you to load Pick List Definition contents from XML file that is in LexGrid format (ie. The contents confirms to LexGrid valuesets.xsd schema).

...

Step

Action

1. Make sure to check 'Enable Admin Options' in 'Commands' menu.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EnableAdminOptions.jpg Image Added

2. Select 'Load Pick List Definition – LexGrid XML' from 'Load' menu. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:LoadPickListDefinitionMenu.jpg

3. A separate window will open to select a file to load. Select a file to load.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:SelectPLDFileToLoad.jpg Image Added

4. Click 'Load' button. Status of load process will be displayed as the data is getting loaded. If everything goes well, you should see 'Errors Logged: false' and 'End State: completed' at the bottom of the status output.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDLoadComplete.jpg Image Added

5. Pick List Definitions loaded should be displayed on the main console under 'Available Pick List Definitions'.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDLoadedContents.jpg Image Added

Display Definition

...

Details

Display Value Set Definition

...

Details

This function displays the details of selected Value Set Definition.

Step

Action

1. Select Value Set Definition under 'Available Value Set Definitions' and click on 'Display Details' button (or double click on Value Set Definition).

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDDisplayDetialsButton.jpg Image Added

2. Separate window will be displayed with meta data of selected Value Set Definition at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDDetails1.jpg Image Added

3. Click on 'Definition Entries' tab to view Definition Entries of this Value Set Definition. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDDetails2.jpg

4. Click on 'Properties' tab to view Properties of this Value Set Definition. And in this Properties view, you can select any particular property and click on 'Display Details' button to view more details like property qualifiers etc. of the selected property.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDDetails3.jpg Image Added

5. Click on 'Supported Attributes' tab to view list of Supported Attributes of this Value Set Definition.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDDetails4.jpg Image Added

Display Pick List Definition Details

...

Step

Action

1. Select the Pick List Definition under 'Available Pick List Definitions' and click on 'Display Definition Details' button (or double click on Pick List Definition). ).

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDDisplayDetialsButton.jpg

2. A Separate window with the details of Pick List Definition will be displayed.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDDetails1.jpg Image Added


Exporting

Exporting Value Set Definition

...

Step

Action

1. Make sure to check 'Enable Admin Options' in 'Commands' menu.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EnableAdminOptions.jpg Image Added

2. Select the Value Set Definition under 'Available Value Set Definitions' to be exported and click on 'Value Set Definition as LexGrid XML' under 'Export' menu. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDExport1.jpg

3. Enter the destination and the file name (should be .xml extension). Choose options appropriately and click on 'Export' button. 'Async Load' - Checking this will export the contents asynchronously'Fail on all errors' - Checking this will stop the export if any error occurs.'force' - Checking this will replace existing file. If there exists a file and this option was not checked, export will fail.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDExport2.jpg Image Added

4. Status of an export process will be displayed as the data is getting exported. If everything goes well, you should see 'Errors Logged: false' and 'End State: completed' at the bottom of the status output.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDExport3.jpg Image Added

5. Verify the exported file. 'valueSetDefinition' should be the top element and all its available contents (mappings, properties, definitionEntries etc) should be exported. exported.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDExport5.jpg


Exporting Expanded Value Set (Value Set Resolution)

...

Step

Action

1. Make sure to check 'Enable Admin Options' in 'Commands' menu.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EnableAdminOptions.jpg Image Added

2. Select the Value Set Definition under 'Available Value Set Definitions' to be exported and click on 'Value Set Resolution as LexGrid XML' under 'Export' menu.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSRExport1.jpg Image Added

3. Enter the destination for the export at folder level. Choose options appropriately and click on 'Export' button. 'Async Load' - Checking this will export the contents asynchronously'Fail on all errors' - Checking this will stop the export if any error occurs.'force' - Checking this will replace existing file. If there exists a file and this option was not checked, export will fail.Select Coding Scheme And Version: Select the coding scheme version(s) to be used for resolving the Value Set Definition. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSRExport2.jpg

4. Status of an export process will be displayed as the data is getting exported. If everything goes well, you should see 'Errors Logged: false' and 'End State: completed' at the bottom of the status output.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSRExport3.jpg Image Added

5. Verify the exported file. 'codingScheme' should be the top element and all the concepts of the Resolved Value Set should be exported in 'entities' bucket.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSRExport4.jpg Image Added


Exporting Pick List Definition

...

Step

Action

1. Make sure to check 'Enable Admin Options' in 'Commands' menu. menu.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EnableAdminOptions.jpg

2. Select the Pick List Definition under 'Available Pick List Definitions' to be exported and click on 'Pick List Definition as LexGrid XML' under 'Export' menu.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDExport1.jpg Image Added

3. Enter the destination and the file name (should be .xml extension). Choose options appropriately and click on 'Export' button. 'Async Load' - Checking this will export the contents asynchronously'Fail on all errors' - Checking this will stop the export if any error occurs.'force' - Checking this will replace existing file. If there exists a file and this option was not checked, export will fail.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDExport2.jpg Image Added

4. Status of an export process will be displayed as the data is getting exported. If everything goes well, you should see 'Errors Logged: false' and 'End State: completed' at the bottom of the status output. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDExport3.jpg

5. Verify the exported file. 'pickListDefinition' should be the top element and all its available contents (mappings, properties, pickListEntryNodes etc) should be exported.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDExport4.jpg Image Added


Resolution

Value Set Resolution

...

Step

Action

1. Select the Value Set Definition under 'Available Value Set Definitions' to be resolved and click 'Resolve' button on the right.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDResolve1.jpg Image Added

2. Select the Coding Scheme Version(s) to be used to resolve the Value Set against and click on 'Resolve' button. button.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDResolve2.jpg

3. Resolved list of Concepts will be displayed in a new window. You can click on any concept to get more details.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDResolve3.jpg Image Added

Note: This feature can also be used to compare the Value Set Resolution by resolving Value Set Definition against different versions of Coding Scheme.

...

Step

Action

1. Select the Pick List Definition under 'Available Pick List Definitions' to be resolved and click 'Resolve Pick List Definition' button on the right.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDResolve1.jpg Image Added

2. Select the Coding Scheme Version(s) to be used to resolve the Pick List against and click on 'Resolve' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDResolve2.jpg

3. Resolved list of Concept Terms/Designations will be displayed in a new window.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:PLDResolve3.jpg Image Added

Note: This feature can also be used to compare the Pick List Resolution by resolving Pick List Definition against different versions of Coding Scheme.

...

Step

Action

1. Click on 'Value Set Definition by Concept Domain' in 'Query' menu at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryCD1.jpg Image Added

2. Enter the Concept Domain value and click on 'Filter' button. button.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryCD2.jpg

3. List of Value Set Definition URIs that has the matching Concept Domain will be displayed in a separate window. You can click on any of the Value Set Definition URIs to get more details.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryCD3.jpg Image Added


Value Set Definition by Coding Scheme

...

Step

Action

1. Click on 'Value Set Definition by Coding Scheme' in 'Query' menu at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryCS1.jpg Image Added

2. Enter the Coding Scheme value and click on 'Filter' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryCS2.jpg

3. List of Value Set Definition URIs that references the entered Coding Scheme will be displayed in a separate window. You can click on any of the Value Set Definition URIs to get more details.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryCS3.jpg Image Added


Value Set Definition by Value Set Definition Name

...

Step

Action

1. Click on 'Value Set Definition by Value Set Definition Name' in 'Query' menu at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryVSD1.jpg Image Added

2. Enter the full name of the Value Set Definition and click on 'Filter' button. You can leave it blank to get all the Value Set Definitions with no name. name.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryVSD2.jpg

3. List of Value Set Definition URIs that matches the entered name will be displayed in a separate window. You can click on any of the Value Set Definition URIs to get more details.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryVSD3.jpg Image Added


Value Set Definition is Sub Set

...

Step

Action

1. Click on 'Value Set Definition is Sub Set' in 'Query' menu at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQuerySS1.jpg Image Added

2. Select the Child and Parent Value Set Definitions from the drop down list, select Coding Scheme Version(s) to use for resolving both Child and Parent Value Set Definitions and click on 'Check' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQuerySS2.jpg

3. A separate window telling if Child Value Set Definition selected is a Sub Set of selected Parent Value Set Definition will be displayed.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQuerySS3.jpg Image Added


Value Set Definition has Entity Code

...

Step

Action

1. Click on 'Value Set Definition has Entity Code' in 'Query' menu at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryEC1.jpg Image Added

2. Enter Entity Code to check as well as the Namespace of the Entity Code, Value Set Definition URI and Coding Scheme Version(s) from the drop down lists. And click on 'Check' button. This will check if the Entity Code entered is present in the expanded Value Set when resolved against selected Coding Scheme Version. Version.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryEC2.jpg

3. A separate window telling if entered Entity Code is part of expaned Value Set will be displayed.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryEC3.jpg Image Added


Value Set Definition for Entity Term

...

Step

Action

1. Click on 'Value Set Definition for Entity Term' in 'Query' menu at the top.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryET1.jpg Image Added

2. Enter Entity Term to match, the match algorithm to use, Value Set Definition URI and Coding Scheme Version(s) from the drop down lists. And click on 'Check' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryET2.jpg

3. A separate window will be displayed with the list of Concepts that satisfies the term and match algorithm entered.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:VSDQueryET3.jpg Image Added


Authoring

This tool provides the capabilities to Create/Edit/Delete Value Set Definition Meta-Data, Definition Entry, and Properties. Authored data can be persisted to the database. You can use this function to test the definition entry (rule set) without persisting the changes to the database.

...

Step

Action

1. Click on 'Create Value Set Definition' under 'Create' menu at the top of the tool.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD1.jpg Image Added

2. Enter Value Set Definition meta data details: Value Set Definition URI: Mandatory field. A unique identifier for the Value Set Definition.Value Set Name: Optional. Name of the Value Set Definition.Default Coding Scheme: Optional. Local name of the primary Coding Scheme from which the Value Set is drawn. You can either choose from the drop down list or enter a value if the Coding Scheme is not yet loaded in the system.Concept Domain: Optional. Local name of the concept domain. When present, the contents of the Value Set defined are considered to be binded to the specific concept domain.Is Active: Optional. Lets you specify if this Value Set is active or not.Status: Optional. Status of the Value Set Definition. Ex. Active, pending, retired, etc.Owner: Optional. Owner of this Value Set Definition.Effective Date: Optional. Format - MM/dd/YYYY. The date this Value Set Definition is considered to be active. To be considered Active, Is Active must be true.Expiration Date: Optional. Format - MM/dd/YYYY. The date this Value Set Definition is considered to be inactive. Source: Optional. List of local identifiers of a person, organization that played a role in the creation or maintenance of this Value Set Definition. To add multiple source, enter the value and click on 'Add' button.Real or Context: Optional. The local identifier of a realm, context or situation that pertains to a lexical or semantic assertion about this Value Set Definition. To add multiple realm or context, enter the value and click on 'Add' button.

 

3. Click 'Save' button. This will persist the Value Set Definition meta data into the database. A separate windows will be displayed confirming the persistence. persistence.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD2.jpg

4. Click on 'Definition Entries' tab to add definition entries for this Value Set Definition.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD3.jpg Image Added

5. For this example, lets add Value Set Definition Reference first, click on 'Add' button with in 'Value Set Definition References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD4.jpg Image Added

6. A separate window will open to enter Value Set Definition Reference data. Set the Rule Order to 0, Operator to OR and select 'SRITEST:AUTO:GM' Value Set Definition URI from the drop down list and click on 'ADD' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD5.jpg

7. The Value Set Definition Reference data entered in previous step should now be visible in 'Value Set Definition Reference' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD6.jpg Image Added

8. Next, lets create Entity Reference for this Value Set Definition. Click on 'Add' button in 'Entity References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD7.jpg Image Added

9. In a separate window that opens to enter Entity Reference data, set following values: Rule Order = 1Operator = OREntity Code = FordEntity Code Namespace = AutomobilesReference Association = hasSubtypeTransitive Closure = trueTarget To Source = falseLeaf Only = falseAnd click on 'Add' button. button.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD8.jpg

10. The Entity Reference data entered in the previous step should now be visible in 'Entity References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD9.jpg Image Added

11. You can resolve the definition now to check what concepts will be returned by the service for this definition. Note:the definition entries (rule set) added in previous steps are not yet saved in the database. Still, the tool lets you to resolve this unsaved Value Set Definition.Click on 'Resolve' button next to 'Value Set Definition meta data' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD10.jpg Image Added

12. Select Coding Scheme Version(s) to use against to resolve the Value Set Definition and click on 'Resolve' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD11.jpg

13. Resolved concepts of the Value Set Definition will be displayed in a separate window. Only concepts related to GM and Ford will be returned. You can click on the concept to get more details.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD12.jpg Image Added

14. Optionally, you can save the changed Value Set Definition to the database. TO do this, click on 'Save' button.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD13.jpg Image Added

15. The new Value Set Definition created will now be available at the main console. console.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:CreateVSD14.jpg


Editing Value Set Definition

...

Step

Action

1. Select the Value Set Definition to be edited and click on 'Display Details'

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD1.jpg Image Added

2. Click on 'Edit' button on the Value Set Definition Details Console window. This will enable the fields to be edited.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD2.jpg Image Added


Modifying Meta Data

...

Step

Action

1. Click on 'Add' button within 'Coding Scheme References' group. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD6.jpg

2. Enter the Coding Scheme Reference data in a separate window that opens. Make sure that you enter unique number for Rule Order. Rule Order: Mandatory field. The unique identifier of the definition entry within the definition as well as the relative order in which this entry should be applied.Operator: Mandatory field. How this entry is to be applied to the value set. Select appropriate value from the drop down list.Coding Scheme: Mandatory field. The local identifier of the coding scheme that the entity codes are drawn from. All available coding scheme local identifier will be available in the drop down list, you can choose from this list or enter different value if the coding scheme you want to reference is not yet loaded in the system.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD7.jpg Image Added

3. Click on 'ADD' button.

 

4. Coding Scheme Reference added in previous step should now be visible within 'Coding Scheme References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD8.jpg Image Added

5. Click 'Save' button to save the changes.

 

...

Step

Action

1. Click on 'Add' button within 'Value Set Definition References' group. group.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD9.jpg

2. Enter the Value Set Definition Reference data in a separate window that opens. Make sure that you enter unique number for Rule Order. Rule Order: Mandatory field. The unique identifier of the definition entry within the definition as well as the relative order in which this entry should be applied.Operator: Mandatory field. How this entry is to be applied to the value set. Select appropriate value from the drop down list.Value Set Definition URI: Mandatory field. The URI of the value set definition to apply the operator to. This value set definition may be contained within the local service or may need to be resolved externally. All available Value Set Definition URI will be available in the drop down list, you can choose from this list or enter different value if the Value Set Definition you want to reference is not yet loaded in the system.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD10.jpg Image Added

3. Click on 'ADD' button.

 

4. Value Set Definition Reference added in previous step should now be visible within 'Value Set Definition References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD11.jpg Image Added

5. Click 'Save' button to save the changes.

 

...

Step

Action

1. Click on 'Add' button within 'Entity References' group. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD3.jpg

2. Enter the Entity Reference data in a separate window that opens. Make sure that you enter unique number for Rule Order. Rule Order: Mandatory field. The unique identifier of the definition entry within the definition as well as the relative order in which this entry should be applied.Operator: Mandatory field. How this entry is to be applied to the value set. Select appropriate value from the drop down list.Entity Code: Mandatory field. The entity code being reference.Entity Code Namespace: Optional. Local identifier of the namespace of the entityCode. If omitted, the URI of the defaultCodingScheme will be used as the URI of the entity code.Reference Association: Optional. The local identifier of an association that appears in the native relations collection in the default coding scheme. This association is used to describe a set of entity codes. If absent, only the entityCode itself is included in this definition.Transitive Closure: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that belong to transitive closure of referenceAssociation as applied to entity code. If true and no referenceAssociation is provided, only the entityCode specified will be included in the definition. If false and referenceAssociation is defined, entityCode specified and immediate nodes associated to the entityCodes will be included in the definition. Default: falseTarget To Source: If true and referenceAssociation is supplied, navigate from entityCode as the association target to the corresponding sources. If transitiveClosure is true and the referenceAssociation is transitive, include all the ancestors in the list rather than just the direct "parents" (sources).Leaf Only: If true and referenceAssociation is supplied and referenceAssociation is defined as transitive, include all entity codes that are "leaves" in transitive closure of referenceAssociation as applied to entity code. Default: false

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD4.jpg Image Added

3. Click on 'ADD' button.

 

4. Entity Reference added in previous step should now be visible within 'Entity References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD5.jpg Image Added

5. Click 'Save' button to save the changes.

 

...

Step

Action

1. Click on 'Add' button within 'Property References' group. group.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD12.jpg

2. Enter the Property Reference data in a separate window that opens. Make sure that you enter unique number for Rule Order. Rule Order: Mandatory field. The unique identifier of the definition entry within the definition as well as the relative order in which this entry should be applied.Operator: Mandatory field. How this entry is to be applied to the value set. Select appropriate value from the drop down list.Coding Scheme: Mandatory field. The local identifier of the codingScheme that this propertyreference will be resolved against. All available coding scheme local identifier will be available in the drop down list, you can choose from this list or enter different value if the coding scheme you want to reference is not yet loaded in the system.Property Name: Optional. The local identifier to be used to restrict the entities to have property with this name.Property Match Value: Optional. Value to be used to restrict entity property. matchAlgorithm can be used in conjunction to get matching entity properties.Property Match Algorithm: Default- Lucene. Algorithm to be used in conjunction with propertyValue. Select from the drop down list.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD13.jpg Image Added

3. Click on 'ADD' button.

 

4. Property Reference added in previous step should now be visible within 'Property References' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD14.jpg Image Added

5. Click 'Save' button to save the changes.

 

...

Step

Action

1. With in 'Coding Scheme References' group, select the Coding Scheme Reference entry you want to remove and click on 'Remove' button. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD15.jpg

2. Click 'Yes' to confirm deletion.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD16.jpg Image Added


Adding Properties

...

Step

Action

1. Click on 'Add' button in 'Properties' tab.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD17.jpg Image Added

2. Enter property information in a separate window (Property Details) that opens. And click on 'ADD' button to add this property to the Value Set Definition. Definition.

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD18.jpg

1. Click 'OK' on the confirm window.

 

...

Step

Action

4. After the property has been added, now you can also add a qualifier for the property just created. Property Qualifier is additional information that you can tag to a property. To do this, click on 'Add' button within 'Available Property Qualifiers' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD19.jpg Image Added

5. In the Property Qualifier window, enter qualifier data and click on 'Add' button.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD20.jpg Image Added


Editing Property

...

Step

Action

1. Select a property that needs to be modified and click on 'Edit' button in 'Properties' tab. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD21.jpg

2. Click on 'Edit' button in a separate window (Property Details) that opens.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD22.jpg Image Added

3. Modify the data and click on 'Add' button to save the changes.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD23.jpg Image Added

4. Click 'OK' on the confirm window.

 

...

Step

Action

5. Once you are in 'Property Details' window, you can also edit Property Qualifier. To do this, select the property qualifier to edit and click on 'Edit' button within 'Available Property Qualifiers' group. .

Image Added https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD24.jpg

6. In the Property Qualifier window, modify the qualifier data and click on 'Add' button.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD25.jpg Image Added


Removing Property Qualifier

Step

Action

5. Once you are in 'Property Details' window, you can also remove Property Qualifier. To do this, select the property qualifier to remove and click on 'Remove' button within 'Available Property Qualifiers' group.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD26.jpg Image Added

6. Click 'Yes' to confirm deletion.

 

...

Step

Action

1. Select a property that needs to be removed and click on 'Remove' button in 'Properties' tab.

https://cabig-kc.nci.nih.gov/Vocab/KC/index.php/Image:EditVSD27.jpg Image Added

6. Click 'Yes' to confirm deletion.

...