Print Page as PDF
LEXICON CONCEPT DATA FOR TEXT ICR (4913)

LEXICON CONCEPT DATA FOR TEXT    ICR (4913)

Name Value
NUMBER 4913
IA # 4913
DATE CREATED 2006/10/05
CUSTODIAL PACKAGE LEXICON UTILITY
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE LEXTRAN
NAME LEXICON CONCEPT DATA FOR TEXT
GENERAL DESCRIPTION 
This API will return an array of data for a given text,
optional code source, optional date, optional subset, and optional return
array name.  The API will display a pick list based on the parameters passed
and allow a user to select an item from the list. The API will then return the
array for the item selected.  The data returned will include:
code
hierarchy or subset (if available)
version (if available)
legacy code (if available)
code status
fully specified name (if available)
preferred term
any applicable synonyms

If any of the data in the passed parameters data is incorrect or
unrecognizable, the API will return an error message indicating the nature of
the error. If no date is specified, then the date will default to the current
system date.  This API was developed specifically for the SNOMED CT code
system in support of the LDSI project, but is applicable to any code system.
STATUS Active
DURATION Till Otherwise Agreed
ID LEXTRAN
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT VARIABLES
$$TEXT(TEXT,DATE,SUBSET,SOURCE,ARRAY)
VARIABLES TYPE VARIABLES DESCRIPTION
TEXT Input 
This is the search text string (mandatory).
DATE Input 
This is the effective date (optional); the default,
if no date is specified, is the current system date.
SUBSET Input 
This is any code system subset mnemonic (optional).
The allowable subset mnemonics are those that exist in the "AA" index of the
subset definitions file (757.2).
SOURCE Input 
This is the mnemonic for a code system (mandatory).
The allowable code system mnemonics are those that exist in the "B" index of
the coding systems file (757. 03).
ARRAY Both 
This is the name of the output array. The default if
no array name is specified is 'LEX' (optional) The format of the output is as
follows:
Output

if call is finds an active code for the source
"1^LEXCODE"
LEX     -   an array containing information about the code
LEX(0)  -   a five piece string:
1. code
2. hierarchy
3. version
4. legacy code
5. code status
LEX("F")    fully specified name
LEX("P")    preferred term
LEX("S",n)  synonyms (n is the nth synonym)

if call cannot find specified code on file
"-2^"_LEXSCNM_" code "_LEXCODE_" not on file"
"-2^"_LEXSCNM_" code "_LEXCODE_" not on file"
where LEXSCNM is the source name
LEXCODE is the code

if call finds an inactive code for the source
"-4^"_LEXSCNM_" code "_LEXCODE_" not active for "_LEXVDT
LEX    - an array containing information about the code
LEX(0) -  a five piece string:
1. code
2. hierarchy
3. version
4. legacy code
5. code status

otherwise
"-1^error text"

example of LEX array:
LEX(0)="67922002^Substance^20050701^T-C2500^1"
LEX("F")="Serum (Substance)"
LEX("P")="Serum"