Print Page as PDF
LEXICON CONCEPT DATA FOR CODE ICR (4912)

LEXICON CONCEPT DATA FOR CODE    ICR (4912)

Name Value
NUMBER 4912
IA # 4912
DATE CREATED 2006/10/05
CUSTODIAL PACKAGE LEXICON UTILITY
USAGE Supported
TYPE Routine
DBIC APPROVAL STATUS APPROVED
ROUTINE LEXTRAN
NAME LEXICON CONCEPT DATA FOR CODE
GENERAL DESCRIPTION 
This API will return an array of data for a given code,
code source, optional date, and optional return array name.  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
KEYWORDS
  • $$CODE
  • LEXTRAN
DURATION Till Otherwise Agreed
ID LEXTRAN
COMPONENT/ENTRY POINT
COMPONENT/ENTRY POINT VARIABLES
$$CODE(CODE,SRC,VDT,ARRAY,IENS,ID,INC)
VARIABLES TYPE VARIABLES DESCRIPTION
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.
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.
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:
Output

if call 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"
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"
IENS Input 
Include expression IENs in output array (optional)
1 return IENS (2nd piece)
0 do not return IENS (default)
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)