Lexicon Obtain Synonyms for Code    ICR (5006)

Name Value
NUMBER 5006
IA # 5006
DATE CREATED 2007/06/28
CUSTODIAL PACKAGE LEXICON UTILITY
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE LEXTRAN1
NAME Lexicon Obtain Synonyms for Code
GENERAL DESCRIPTION
This API will return an array for a given code and
coding system. The array will contain all synonyms for the concept including
the preferred term and the fully specified name.  If any of the passed
parameters are incorrect or unrecognizable, the API will return an error
message indicating the nature of the error.
STATUS Active
KEYWORDS
  • SYNONYM
  • LEXICON
  • $$GETSYN
  • GETSYN
  • LEXTRAN1
ID LEXTRAN1
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT VARIABLES
$$GETSYN(SRC,CODE,VDT,ARRAY,IENS,ID,INC)
VARIABLES TYPE VARIABLES DESCRIPTION
SRC 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) This is code system source abbreviation
Lexicon.
CODE Input
This is a code of a classification system that is
stored in the Lexicon.  Classification systems include SNOMED CT, ICD, CPT,
HCPCS, etc.
VDT Input
This is the effective date; the default if no date is
specified is the current system date (optional).
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:
If valid code and source are passed
"1^no of synonyms"
LEX("P") = preferred term or major concept name^IEN
LEX("F") = fully specified name^IEN (if one exists)
LEX("S",n) = the nth synonym found^IEN (if they exist)
The presence of IEN in the return array is determined by the
LEXIENS parameter.  If the call does not find the code for the specified
source it will return
"-2^"_LEXSCNM_" code "_LEXCODE_" not on file"
where LEXCSNM is the source name
LEXCODE is the code If an invalid source is passed the call will
return
"-1^source not recognized"
IENS Input
If this parameter is set to 1 the expression IEN will
be included in the return array. Default is 0 - exclude IENS from return
array.
ID Input
Designation Identifiers (optional)
1 return Designation IDs (3rd piece)
0 do not return Designation IDs (default)

INC Input
Include Deactivated Terms (optional)
1 return Deactivated Terms
0 do not return Deactivated Terms (default)

CREATOR FRANKSON,FERDINAND
DBA Comments
09/02/14 DT: Added Kimball Rowe as editor: adding two new
input parameters to $$GETSYN^LEXTRAN1 (ID and INC).The new input parameters
default to 0 and causing the API to respond as if the parameter were not
passed and return data identical to the legacy API.

8/2/17-MM:  Found an old email and was not sure if this ICR had been
completed.  Current ICR in Forum matches the email from Kim after he updated
the ICR and status is active.  However the last action is Deactivated for
Edits not approved (re-activated).  Removed Kim as an editor and responded on
email.  LEX*2.0*86 was released on 2/25/15.
DATE ACTIVATED 2007/12/28
MAIL MESSAGE 47448054
DATE/TIME EDITED
DATE/TIME EDITED ACTION AT THE REQUEST OF WITH CONCURRENCE OF
2007/12/28 21:00 APPROVED FRANKSON,FERDINAND
2014/09/02 10:42 DEACTIVATED FOR EDITS ROWE,KIMBALL ROWE,KIMBALL
Generated from SEP 05, 2018@ IA Listing Descriptions