Changes between Version 32 and Version 33 of RxNormForVista


Ignore:
Timestamp:
Nov 21, 2013, 4:59:24 PM (10 years ago)
Author:
Sam Habiel
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • RxNormForVista

    v32 v33  
    11= !RxNorm Files for Vista/RPMS =
    22[[PageOutline(2-5)]]
    3 [[Image(RxNormForVista.png,align=right,600px)]]
     3
    44
    55Welcome to the homepage for the !RxNorm VISTA/RPMS Support. I am Sam Habiel, and I am the developer for these packages. I can be reached at sam dot habiel at gmail dot com.
     
    1212== Why do I want this? ==
    1313!RxNorm is necessary for interoperability with other systems. If you use VISTA alone without having to talk to any other system, then you don't need !RxNorm. However, if you perform external drug interactions, send CCDA documents, or archive patient records for CCR, you are going to need !RxNorm. For Meaningful Use, you are required to have !RxNorm for various purposes.
     14
     15
    1416
    1517== What does this release contain? ==
     
    3234
    3335TODO: GT.M Example
     36
     37[[Image(RxNormForVista.png,align=right,600px)]]
    3438
    3539=== Installation ===
     
    307311
    308312=== Programmer APIs ===
    309 This is a list of APIs available for programmers for converting one terminology to another. Some APIs get
    310 
    311 
    312 
    313 {{{
    314 $$EXIST^C0CRXNLK(RXN)                                        $$ Public - Does this RxNorm CUI exist?
    315 $$GCN2RXN^C0CRXNLK(GCN)                                      $$ Public - Get RxNorm CUI using GCN
    316 $$RXN2GCN^C0CRXNLK(RXNCUI)                                   $$ Public - Get GCN(s) given an RxNorm Number
    317 $$RXN2VUI^C0CRXNLK(RXNCUI)                                   $$ Public - Get VUID(s) for given RXNCUI for Clinical Drug
    318 $$VUI2VAP^C0CRXNLK(VUID)                                     $$ Public - Get VA Product IEN(s) from VUID
    319 $$VAP2MED^C0CRXNLK(VAPROD)                                   $$ Public - Get Drug(s) using VA Product IEN
    320 $$RXN2MEDS^C0CRXNLK(RXNCUI)                                  $$ Public - Convert RxNorm value to currently existing drugs in File 50.
    321 $$FDI2RXN^C0CRXNLK(BASE)                                     $$ Public - Get RxNorm CUI for FDB Ingredient/Base
    322 $$RXN2VIN^C0CRXNLK(RXNCUI)                                   $$ Public - Get VUID Ingredient for RxNorm CUI
    323 $$VIN2VAG^C0CRXNLK(VUID)                                     $$ Public - Get VA Generic for VUID Ingredient
    324 $$FDI2VAG^C0CRXNLK(BASE)                                     $$ Public - Get VA Generic for FDB Ingredient/Base
    325 $$VIN2DIN^C0CRXNLK(VUID)                                     $$ Public - Get Drug Ingredient for VUID Ingredient
    326 $$FDI2DIN^C0CRXNLK(BASE)                                     $$ Public - Get Drug Ingredient for FDB Ingredient/Base
    327 $$VUI2RXN^C0CRXNLK(VUID)                                     $$ Public - Get RXNCUI for VUID (any VUID type)
    328 $$VUI2GCN^C0CRXNLK(VUID)                                     $$ Public - Get GCNs for a given VUID (any VUID type)
    329 $$MED2RXN^C0CRXNLK(DA)                                       $$ Public - Get RxNorm CUI for Drug
    330 $$MED2SCDN^C0CRXNLK(DA)                                      $$ Public - Medication to Semantic Clinical Drug Name
    331 $$RXN2NDI^C0CRXNLK(RXNCUI)                                   $$ Public - Get NDDF Ingredient for RXNCUI
    332 $$VIN2NDI^C0CRXNLK(VUID)                                     $$ Public - Get NDDF Ingredient for VUID
    333 $$NDC2RXN^C0CRXNLK(NDC)                                      $$ Public - Get RxCUI given the NDC
    334 $$ISBRAND^C0CRXNLK(RXN)                                      $$ Public - Is this RxCUI for a brand drug?
    335 $$BR2GEN^C0CRXNLK(RXN)                                       $$ Public - Convert Brand RxCUI to Generic RxCUI (many to 1)
    336 $$GEN2BR^C0CRXNLK(RXN)                                       $$ Public - Convert Generic RxCUI to Brand RxCUIs (1 to many).
    337 $$RXN2BNS^C0CRXNLK(RXN)                                      $$ Public - Get all Brand Names associated with an RXN
    338 $$RXN2NDC^C0CRXNLK(RXN)                                      $$ Public - Get NDC codes for RxNorm code
    339 }}}
     313
     314==== Update API ====
     315To update RxNorm to a newer monthly version from the NLM, run the following:
     316{{{
     317D IMPORT^C0CRXNRD("/path/to/rrf/folder/",optional include restricted/copyrighted sources (1 -> yes). Default is no.)
     318}}}
     319
     320If you need FDB or SNOMED-CT codes, you need to pass in the second parameter.
     321
     322==== Look-up APIs ====
     323This is a list of APIs available for programmers for converting one terminology to another. Some APIs return multiple results. If so, they will be delimited by "^".
     324
     325{{{
     326$$EXIST^C0CRXNLK(RXN)               $$ Public - Does this RxNorm CUI exist?
     327$$GCN2RXN^C0CRXNLK(GCN)             $$ Public - Get RxNorm CUI using GCN
     328$$RXN2GCN^C0CRXNLK(RXNCUI)          $$ Public - Get GCN(s) given an RxNorm Number
     329$$RXN2VUI^C0CRXNLK(RXNCUI)          $$ Public - Get VUID(s) for given RXNCUI for Clinical Drug
     330$$VUI2VAP^C0CRXNLK(VUID)            $$ Public - Get VA Product IEN(s) from VUID
     331$$VAP2MED^C0CRXNLK(VAPROD)          $$ Public - Get Drug(s) using VA Product IEN
     332$$RXN2MEDS^C0CRXNLK(RXNCUI)         $$ Public - Convert RxNorm value to currently existing drugs in File 50.
     333$$FDI2RXN^C0CRXNLK(BASE)            $$ Public - Get RxNorm CUI for FDB Ingredient/Base
     334$$RXN2VIN^C0CRXNLK(RXNCUI)          $$ Public - Get VUID Ingredient for RxNorm CUI
     335$$VIN2VAG^C0CRXNLK(VUID)            $$ Public - Get VA Generic for VUID Ingredient
     336$$FDI2VAG^C0CRXNLK(BASE)            $$ Public - Get VA Generic for FDB Ingredient/Base
     337$$VIN2DIN^C0CRXNLK(VUID)            $$ Public - Get Drug Ingredient for VUID Ingredient
     338$$FDI2DIN^C0CRXNLK(BASE)            $$ Public - Get Drug Ingredient for FDB Ingredient/Base
     339$$VUI2RXN^C0CRXNLK(VUID)            $$ Public - Get RXNCUI for VUID (any VUID type)
     340$$VUI2GCN^C0CRXNLK(VUID)            $$ Public - Get GCNs for a given VUID (any VUID type)
     341$$MED2RXN^C0CRXNLK(DA)              $$ Public - Get RxNorm CUI for Drug
     342$$MED2SCDN^C0CRXNLK(DA)             $$ Public - Medication to Semantic Clinical Drug Name
     343$$RXN2NDI^C0CRXNLK(RXNCUI)          $$ Public - Get NDDF Ingredient for RXNCUI
     344$$VIN2NDI^C0CRXNLK(VUID)            $$ Public - Get NDDF Ingredient for VUID
     345$$NDC2RXN^C0CRXNLK(NDC)             $$ Public - Get RxCUI given the NDC
     346$$ISBRAND^C0CRXNLK(RXN)             $$ Public - Is this RxCUI for a brand drug?
     347$$BR2GEN^C0CRXNLK(RXN)              $$ Public - Convert Brand RxCUI to Generic RxCUI (many to 1)
     348$$GEN2BR^C0CRXNLK(RXN)              $$ Public - Convert Generic RxCUI to Brand RxCUIs (1 to many).
     349$$RXN2BNS^C0CRXNLK(RXN)             $$ Public - Get all Brand Names associated with an RXN
     350$$RXN2NDC^C0CRXNLK(RXN)             $$ Public - Get NDC codes for RxNorm code
     351}}}
     352
     353Here's an example call to return all active NDCs for brand name Prozac 20mg capsules:
     354{{{
     355GTM>W $$RXN2NDC^C0CRXNLK(104849)
     35600777310502^58864091730^58016082830^58016082820^66105056403^58016082810^58016082890^52959023320
     357^54868051105^00777310507^52959023310^00247037204^58864097130^55289021522^54868051101^52959023314
     358^58016082840^52959023340^52959023350^54868051102^00247037210^00777310530^52959023330^54868051100
     359^58016082860^16590084390^52959023300^58016082800
     360}}}
     361
     362C0CRXNLK comes with Unit Tests. To run them, make sure M-Unit is installed and run !^C0CRXNLK from the top.
     363
     364==== Automatic Drug Addition API using RxNorm ====
     365To add a drug to the drug file using the RxNorm CUI, call the following entry point:
     366
     367{{{
     368W $$ADDDRUG^C0CRXNLK(RXNCUI for Drug, optional NDC to file, optional barcode to put for BCMA)
     369}}}
     370
     371Please note that this routine does not check to see if the drug is already there; it will add it again.
     372
     373This routine can be enhanced to use the barcode to figure out which drug it is that is being added from RxNorm. As such, it will enable you to add drugs to the drug file by just bar-code scanning them.
    340374
    341375== Technical Details ==