NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

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

...

ActivateScheme

Activates a coding scheme based on unique URN and version.
Options:

  • -u,-urn <urn> URN uniquely identifying the code system.
  • -v,-version <versionId> Version identifier.
  • -f,-force Force activation (no confirmation).

    Example:

     

    ActivateScheme -u "urn:oid:2.16.840.1.113883.3.26.1.1" -v "05.09e"
CleanUpMetadata

Clean up metadata entries that are orphaned.

Options:

   -h, --help, Prints usage information

   -f,--force, Force removal without prompting of metadata that doesn't have a corresponding coding scheme entry(orphaned).

Example:

 

CleanUpMetadata -f

DeactivateScheme

Deactivates a coding scheme based on unique URN and version.
Options:

  • -u,-urn <urn> URN uniquely identifying the code system.
  • -v,-version <versionId> Version identifier.
  • -d,-date <yyyy-MM-dd,HH:mm:ss> Date and time for deactivation to take effect; immediate if not specified.
  • -f,-force Force deactivation (no confirmation).

    Example:

     

    DeactivateScheme -u "urn:oid:2.16.840.1.113883.3.26.1.1" -v "05.09e" -d "01/31/2099,12:00:00

ListExtensions

List registered extensions to the LexEVS runtime environment.
Options:

  • -a,-all List all extensions (default, override by specifying other options).
  • -i,-index List index extensions.
  • -m,-match List match algorithm extensions.
  • -s,-sort List sort algorithm extensions.
  • -g,-generic List generic extensions.

    Example:

     

    ListExtensions -a

ListSchemes

List all currently registered vocabularies.
Options:

  • -b,-brief List only coding scheme name, version, urn, and tags (default).
  • -f,-full List full detail for each scheme.

    Example: ListSchemes
LoadManifest

Load manifest data onto the codingscheme based on unique URN and version.

Options:

   -u,--urn "urn"; URN uniquely identifying the code system.

   -v,--version "versionId"; Version identifier.

   -mf,--manifest "manifest"; location of manifest xml file.

 

Note: If either the URN or the version values are unspecified, a list of available coding schemes will be presented for user selection.

Example:

 

LoadManifest -u \"urn:oid:2.16.840.1.113883.3.26.1.1\" -v \"05.09e\" -mf \"file://path//to//manifest.xml\""
LoadManifest -mf \"file://path//to//manifest.xml\"
RemoveTagScheme

Removes a tag ID (e.g. 'PRODUCTION' or 'TEST') from a coding scheme URN and version.

Options:

   -u,--urn <urn> URN uniquely identifying the code system.

   -v,--version <id> Version identifier.

 

Note: If the URN and version values are unspecified, a list of available coding schemes will be presented for user selection.

Example:

 

RemoveTagScheme -u "urn:oid:2.16.840.1.113883.3.26.1.1" -v "05.09e"
RemoveVSResolvedFromCodingScheme

Removes a resolved ValueSet based on coding scheme and version that was used for its resolution.

 

Options:

   -l, List of coding scheme versions to match when removing the ResolvedValueSet.

   -f,--force Force de-activation and removal without confirmation.

Example:

 

RemoveVSResolvedFromCodingSchemes  -l -l \"source.coding.scheme.uri::version1, second.source.uri::version2\" -f
RemoveResolvedValueSet

Removes a resolved ValueSet

Options:

   -l, The list of resolved value sets to remove, separated by comma. format "resolvedValueSetUri1::version1, resolvedValueSetUri2::version2,...".

   -f,--force Force de-activation and removal without confirmation.

 

Load Example:

 

RemoveResolvedValueSet  -l \"resolvedValueSetUri1::version1, resolvedValueSetUri2::version2\" -f
RemoveValueSetDefinition

Removes a coding scheme based on unique URN and version.

Options:

   -u,--urn <urn> URN uniquely identifying the code system.

 

Note: If the URN and version values are unspecified, a list of available coding schemes will be presented for user selection.

Example:

 

RemoveValueSetDefinition

 

RemoveValueSetDefinition -u http://evs.nci.nih.gov/Valueset/C100110

TagScheme

Associates a tag ID (e.g. 'PRODUCTION' or 'TEST') with a coding scheme URN and version.
Options:

  • -u,-urn <urn> URN uniquely identifying the code system.
  • -v,-version <versionId> Version identifier.
  • -t,-tag The tag ID (e.g. 'PRODUCTION' or 'TEST') to assign.

    Example:

     

    TagScheme -u "urn:oid:2.16.840.1.113883.3.26.1.1" -v 05.09e" -t "TEST"
SupplementScheme

Utility to register, unregister, and list Coding Scheme Supplements.

Usage: SupplementScheme  [-r] [-u] [-l]

   [-parentUri parentUri]

   [-parentVersion parentVersion]

   [-supplementUri supplementUri]

   [-supplementVersion supplementVersion]

 

   -r  Register Coding Scheme as a Supplement

   -u Unregister Coding Scheme as a Supplement

   -l,--list List Supplements

   -parentUri <parentUri> Parent URI.

   -parentVersion <parentVersion> Parent Version.

   -supplementUri <supplementUri> Supplement URI.

   -supplementVersion <supplementVersion>Supplement Version.


Example:

  • SupplementScheme -u -parentUri "urn:oid:2.16.840.1.113883.3.26.1.1" -parentVersion "05.09e" -supplementUri "http://supplement.ontology.org" -supplementVersion "1.0.1"

Lucene Index Administration

...

LoadPickListDefinition

Loads Pick List Definition content, provided in LexGrid canonical xml format.
Options:

  • -in,-input <uri> URI or path specifying location of the source file.
  • -v, -validate <int> Perform validation of the candidate resource without loading data.
    Supported levels of validation include:
    • 0 = Verify document is well-formed
    • 1 = Verify document is valid
      Example:

       

      LoadPickListDefinition -in "file:///path/to/file.xml"

LoadAllDefinitionsToResolvedValueSet

Loads All Value Set Definitions for a given uri as resolved coding scheme.
Options:

 

LoadAllDefinitionsToResolvedValueSet  -uri "http://ncicb.nci.nih.gov/xml/owl/EVS/Thesaurus.owl#"
LoadValueSetDefinition.sh

Loads Value Set Definition content, provided in LexGrid canonical xml format.

Options:

  • -in, Input <uri> URI or path specifying location of the source file.
  • -v, Validate <int> Perform validation of the candidate

    resource without loading data.  Supported levels of validation include:

       0 = Verify document is well-formed

       1 = Verify document is valid


    Load Example:

     

    LoadValueSetDefinition -in "file:///path/to/file.xml"
SourceAssertedResolvedValueSetLoad

Loads all source asserted Value Sets from a given source.

Options:

   -cs, --codingScheme, usage="Name of Coding Scheme that asserts values sets"

   -v, --version, usage="Version of the coding scheme."

   -a, --association, usage="Relationship name asserted by the codingScheme")

   -t", --target", usage="Target to Source resolution.")

   -uri", --uri", usage="Base uri to build the conding scheme uri upon")

   -o", --owner", usage="Owener of the value set assertioin")

   -s", --sourceName", usage="Gives the name of the property to resolve the source value against")

 Load Example:

 

SourceAssertedResolvedValueSetLoad.sh -v "17.04d"
SourceAssertedValueSetDefinitionLoad

Loads all source asserted Value Sets from a given source.

Options:

   -cs, --codingScheme, usage="Name of Coding Scheme that asserts values sets"

   -v, --version, usage="Version of the coding scheme."

   -a, --association, usage="Relationship name asserted by the codingScheme"

   -t", --target", usage="Target to Source resolution."

   -uri", --uri", usage="Base uri to build the conding scheme uri upon"

   -o", --owner", usage="Owener of the value set assertioin"

   -s", --sourceName", usage="Gives the name of the property to resolve the source value against"

   -cd, --conceptDomainName" usage= "Gives the name of the property to resolve the concept domain value against"

Load Example:

 

SourceAssertedValueSetDefinitionLoad -v "17.04d"
SourceAssertedValueSetUpdate

Loads all source asserted Value Sets from a given source.
 
Options:
  -cs  -codingScheme - Name of Coding Scheme that asserts values sets
   default "NCI_Thesaurus"


  -pv --pversion - Previous version of the coding scheme.
   Optional default none


  -cv --cversion - Version of the coding scheme. User must input a current version.
   default none;


  -a --association - Relationship name asserted by the codingScheme.
   default association = "Concept_In_Subset";


  -t --target - Target to Source resolution.
   default target = "true";


  -uri --uri - Base uri to build the value set coding scheme uri upon.  
   defaul uri = "http://evs.nci.nih.gov/valueset/";


  -o --owner - Owner of the value set assertion.
   default owner="NCI";


  -s --sourceName - Gives the name of the property to resolve the source value against.
   default source = "Contributing_Source";


  -cd --conceptDomainName - Gives the name of the property to resolve the concept domain value against.
   defaultconceptDomainIndicator = "Semantic_Type";


  -sUri --schemeUri - Scheme Uri for the coding scheme containing the value set updates.
   defaultschemeUri = NCItSourceAssertedValueSetUpdateService.NCIT_URI;

Load Example:

 

SourceAssertedValueSetUpdate.sh -cv "17.04d"

Expert Admin Scripts (Focused on Mass Loads of Value Sets)

...