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 ==== |
| 315 | To update RxNorm to a newer monthly version from the NLM, run the following: |
| 316 | {{{ |
| 317 | D IMPORT^C0CRXNRD("/path/to/rrf/folder/",optional include restricted/copyrighted sources (1 -> yes). Default is no.) |
| 318 | }}} |
| 319 | |
| 320 | If you need FDB or SNOMED-CT codes, you need to pass in the second parameter. |
| 321 | |
| 322 | ==== Look-up APIs ==== |
| 323 | This 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 | |
| 353 | Here's an example call to return all active NDCs for brand name Prozac 20mg capsules: |
| 354 | {{{ |
| 355 | GTM>W $$RXN2NDC^C0CRXNLK(104849) |
| 356 | 00777310502^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 | |
| 362 | C0CRXNLK 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 ==== |
| 365 | To add a drug to the drug file using the RxNorm CUI, call the following entry point: |
| 366 | |
| 367 | {{{ |
| 368 | W $$ADDDRUG^C0CRXNLK(RXNCUI for Drug, optional NDC to file, optional barcode to put for BCMA) |
| 369 | }}} |
| 370 | |
| 371 | Please note that this routine does not check to see if the drug is already there; it will add it again. |
| 372 | |
| 373 | This 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. |