View on
MetaCPAN is shutting down
For details read Perl NOC. After June 25th this page will redirect to
Bridget McInnes > UMLS-Interface >


Annotate this POD


Open  0
View/Report Bugs

NAME ^ - This program returns the definition of a concept or a term.


This program takes in a CUI or a term and returns its definitions. If a term is specified, the associated CUI is obtained using the sources specified in the configuration file. The definitions come from the entire UMLS.




Required Arguments:


Concept Unique Identifier (CUI) or a term from the Unified Medical Language System (UMLS)

Optional Arguments:

--config FILE

This is the configuration file. The format of the configuration file is as follows:

SAB :: <include|exclude> <source1, source2, ... sourceN>

REL :: <include|exclude> <relation1, relation2, ... relationN>

RELA :: <include|exclude> <rela1, rela2, ... relaN> (optional)

For example, if we wanted to use the MSH vocabulary with only the RB/RN relations, the configuration file would be:

SAB :: include MSH REL :: include RB, RN RELA :: include inverse_isa, isa


SAB :: include MSH REL :: exclude PAR, CHD

If you go to the configuration file directory, there will be example configuration files for the different runs that you have performed.


Prints the source in which the definition comes from


Sets the debug flag for testing

--username STRING

Username is required to access the umls database on MySql unless it was specified in the my.cnf file at installation

--password STRING

Password is required to access the umls database on MySql unless it was specified in the my.cnf file at installation

--hostname STRING

Hostname where mysql is located. DEFAULT: localhost

--socket STRING

The socket your mysql is using. DEFAULT: /tmp/mysql.sock

--database STRING

Database contain UMLS DEFAULT: umls


Displays the quick summary of program options.


Displays the version information.


List of CUIs that are associated with the input term



 Bridget T. McInnes, University of Minnesota


Copyright (c) 2007-2009,

 Bridget T. McInnes, University of Minnesota
 bthomson at
 Ted Pedersen, University of Minnesota Duluth
 tpederse at

 Siddharth Patwardhan, University of Utah, Salt Lake City
 Serguei Pakhomov, University of Minnesota Twin Cities

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to:

 The Free Software Foundation, Inc.,
 59 Temple Place - Suite 330,
 Boston, MA  02111-1307, USA.
syntax highlighting: