Lexicon Utility Technical Manual and Developer’S Guide
Total Page:16
File Type:pdf, Size:1020Kb
Lexicon Utility Technical Manual and Developer’s Guide Version 2.0 September 1996 Revised May 23, 2017 Department of Veterans Affairs (VA) Office of Information and Technology (OI&T) Office of Enterprise Development (OED) Revision History Date Description of Change Author 09/24/2003 LEX*2.0*25 N/A CSV changes: pp. 7, 15-16, 22, 24-25, 28-33, 35, 38, 46, 52, 64-69 06/12/2008 LEX*2.0*41 REDACTED Changes related to the implementation of SNOMED CT codes in the Lexicon for the Lab Data Sharing Interoperability (LDSI) project. 05/06/2009 LEX*2.0*62 REDACTED Changes designed to implement advanced date testing. 09/22/2010 Existing Tech Manual into new template, edit, format. REDACTED Added changes for LEX*2.0*73. 11/05/2012 LEX*2.0*58 REDACTED Added new protocol and routine 04/02/2014 Tech Writer Review-edited for grammar, TOC, etc. REDACTED 04/21/2014 Added changes for LEX*2.0*80 (ICD-10) REDACTED 04/24/2014 Tech Writer Review REDACTED 12/19/2014 Added changes for $$CODE^LEXTRAN and REDACTED $$GETSYN^LEXTRAN1 for LEX*2.0*86 02/22/2016 LEX*2.0*102 HCUM Files, APIs and ICRs REDACTED 05/23/2017 LEX*2.0*103 changes for Index Repair, Special REDACTED Lookup, added APIs, Keyword Utility, Case Utility (Tokens) and update pointer relationship graphic ii Lexicon Utility Technical Manual & Developer’s Guide Table of Contents 1. Preface ............................................................................................. 7 1.1 Scope of Manual ...................................................................................... 7 1.2 Audience .................................................................................................. 7 2. Introduction ...................................................................................... 8 3. Clinical Lexicon Version 1.0 (GMPT) .............................................. 8 3.1 Problem List Expert Panel ..................................................................... 8 3.2 End User Requirements ....................................................................... 10 3.3 Application Requirements .................................................................... 10 4. Lexicon Version 2.0 (LEX) ............................................................. 10 5. Lexicon Example Entry – Migraine Headache ............................. 12 6. Package Components ................................................................... 13 6.1 Manager Options ................................................................................... 13 6.2 Code Set Versioning Options .............................................................. 16 6.3 Protocols ................................................................................................ 17 6.3.1 Lexicon Update ........................................................................................ 17 6.3.2 Lexicon Update Notification (example) .................................................. 17 6.3.3 Mapping/Subset Update .......................................................................... 17 6.4 Files, Pointers and Relationships........................................................ 18 6.5 Lexicon Files, Fields, and Indexes ...................................................... 19 6.6 Routines Supporting the Lexicon ........................................................ 21 6.6.1 Special Lookup ........................................................................................ 21 6.6.2 Silent Lookup ........................................................................................... 21 6.6.3 Setting/Displaying User Defaults ........................................................... 22 6.6.4 Edit ............................................................................................................ 24 6.6.5 ICD-10 Support ........................................................................................ 24 6.6.6 Indexing and Input Transformations ...................................................... 25 6.6.7 Code Set Versioning Queries ................................................................. 26 6.6.8 Supplemental Keyword Utility ................................................................ 27 6.6.9 Miscellaneous .......................................................................................... 27 1 Lexicon Utility Technical Manual & Developer’s Guide 7. Package Characteristics and Usage ............................................. 28 7.1 Supported Callable Routines ............................................................... 28 7.1.1 LEXSET ..................................................................................................... 29 CONFIG^LEXSET(App,Subset,Date) ICR 1609 ........................................................................ 29 7.1.2 LEXU ......................................................................................................... 33 $$ICDONE^LEXU(IEN,Date) ICR 1573 ...................................................................................... 33 $$CPTONE^LEXU(IEN,Date) ICR 1573 .................................................................................... 33 $$DSMONE^LEXU(IEN,Date) ICR 1573 .................................................................................... 33 $$D10ONE^LEXU(IEN,Date) ICR 5679 ..................................................................................... 33 $$P10ONE^LEXU(IEN,Date) ICR 5679...................................................................................... 33 $$DX^LEXU(IEN,Date) ICR 5679 ............................................................................................... 34 $$ONE^LEXU(IEN,Date,SAB) ICR 5679 .................................................................................... 35 $$ALL^LEXU(IEN,Date,SAB) ICR 5679 .................................................................................... 35 $$ICD^LEXU(IEN,Date) ICR 1573 .............................................................................................. 36 $$D10^LEXU(IEN,Date) ICR 5679 ............................................................................................. 36 $$IMPDATE^LEXU(SAB) ICR 5679 ........................................................................................... 36 $$CSYS^LEXU(Sys,Date) ICR 5679 .......................................................................................... 36 $$HIST^LEXU(Code,Sys,.ARY) ICR 5679 ................................................................................. 37 $$PERIOD^LEXU(Code,Sys,.ARY) ICR 5679 ........................................................................... 38 $$NXSAB^LEXU(SAB,Rev) ICR 5679 ........................................................................................ 39 $$CSDATA^LEXU(Code,Sys,Date,.ARY) ICR 5679 ................................................................. 39 $$MAX^LEXU(Sys) ICR 5679 ..................................................................................................... 42 $$FREQ^LEXU(Text) ICR 5679 ................................................................................................ 42 $$PAR^LEXU(Text,.ARY) ICR 5679 .......................................................................................... 43 $$CAT^LEXU(Code) ICR 5679 ................................................................................................... 44 $$RECENT^LEXU(SAB) ICR 5679 ........................................................................................... 44 $$RUPD^LEXU(SAB) ICR 5679 ................................................................................................ 44 $$LUPD^LEXU(SAB,DATE) ICR 5679 ...................................................................................... 45 $$EXP^LEXU(IEN) ICR 6265 ..................................................................................................... 45 EXPS^LEXU(IEN,CDT,.ARY) ICR 6265 ..................................................................................... 45 CODE^LEXU(CODE,SRC,CDT,.ARY,OUT) ICR 6265 .............................................................. 46 TERM^LEXU(IEN,CDT,.ARY,OUT) ICR 6265 ........................................................................... 49 $$PREF^LEXU(COD,SAB,CDT) ICR 6265 ................................................................................ 53 $$IENS^LEXU(CODE,.ARY,CDT) ICR 6265 .............................................................................. 53 $$SOS^LEXU(IEN,.ARY,SYN) ICR 6265 ................................................................................... 56 $$EXM^LEXU(TEXT,.ARY,DF,MC) ICR 6265 ........................................................................... 57 $$SUBSETS^LEXU(CODE,SRC,.ARY) ICR 6265 ..................................................................... 58 7.1.3 LEXCODE ................................................................................................. 59 EN^LEXCODE(Code,Date) ICR 1614 ....................................................................................... 59 EXP^LEXCODE(Code,Source,Date) ICR 5680 .......................................................................... 60 7.1.4 LEX10CS (ICD-10 Specific) ................................................................... 61 $$ICDSRCH^LEX10CS(Text,.ARY,Date,Len,Fil) ICR 5681 ....................................................... 61 $$DIAGSRCH^LEX10CS(Text,.ARY,Date,Len,Fil) ICR 5681 ..................................................... 62 $$PCSDIG^LEX10CS(Frag,Date) ICR 5681 ............................................................................