com.apothesource.pillfill.rxnorm.service

Interface RxNormService

All Known Implementing Classes:

NihRxNormServiceProxy

public interface RxNormService

The RxNorm API is a web service for accessing the current RxNorm data set. NIH Documentation. Note: Some of the parameters & ordering in this interface are intentionally inconsistent to match the NIH documentation. Created by Michael Ramirez (michael@pillfill.com) on 7/21/15.

Method Summary

Modifier and Type	Method and Description
IdGroupResponse	findRxcuiById(IdTypeNames type, java.lang.String id, int allSrc) Search for an identifier from another vocabulary and return the RxCUIs of any concepts which have an RxNorm term as a synonym or have that identifier as an attribute.
IdGroupResponse	findRxcuiByName(java.lang.String name, int search) Search for a name in the RxNorm data set and return the RxCUIs of any concepts which have that name as an RxNorm term or as a synonym of an RxNorm term.
PropertiesGroupResponse	getAllProperties(java.lang.String id, PropCategoryNames propName) Return the properties for a specified concept.
AllRelatedGroupResponse	getAllRelatedInfo(java.lang.String id) Get all the related RxNorm concepts for a given RxNorm identifier.
ApproximateGroupResponse	getApproximateMatch(java.lang.String id, int maxEntries) Do an approximate match search to determine the strings in the data set that most closely match the search string.
BrandGroupResponse	getMultiIngredBrand(java.util.List<java.lang.String> ingredientIds) Get the brands that contain all the specified ingredients.
NdcsGroupResponse	getNdcs(java.lang.String id) Get the National Drug Codes (NDCs) for the RxNorm concept.
RelatedGroupResponse	getRelatedByRelationship(java.lang.String id, java.util.List<RelationshipNames> rela) Get the related RxNorm identifiers of an RxNorm concept specified by a relational attribute.
RelatedGroupResponse	getRelatedByType(java.lang.String id, java.util.List<TTYNames> tty) Get the related RxNorm identifiers of an RxNorm concept specified by one or more term types.

Method Detail

findRxcuiById

IdGroupResponse findRxcuiById(IdTypeNames type,
                              java.lang.String id,
                              int allSrc)
                       throws java.io.IOException

Search for an identifier from another vocabulary and return the RxCUIs of any concepts which have an RxNorm term as a synonym or have that identifier as an attribute. See the /idtypes example for the valid types.

Parameters:

type - the identifier type. Valid types are listed in the table below:

id - the identifier

allSrc - an optional field indicating whether all RxCUIs are to be returned. If set to 1, all non-suppressed RxCUIs will be returned, including those which contain no terms from the RxNorm vocabulary. If set to 0 (the default), only RxCUIs which contain a non-suppressed RxNorm vocabulary term will be returned.

Returns:

A set of IdGroups associated with the provided identifier

Throws:

java.io.IOException

findRxcuiByName

IdGroupResponse findRxcuiByName(java.lang.String name,
                                int search)
                         throws java.io.IOException

Search for a name in the RxNorm data set and return the RxCUIs of any concepts which have that name as an RxNorm term or as a synonym of an RxNorm term.

Parameters:

name - - the search string. This must be specified.

search - - a number indicating the type of search to be performed. If set to 0 (the default), exact match search will be performed. If set to 1, a normalized string search will be done. When search = 2, then an exact match search will be done, and if no results are found, a normalized search will be done. For more information on the normalized string search, click here.

Returns:

A set of IdGroups associated with the provided name

Throws:

java.io.IOException

getAllProperties

PropertiesGroupResponse getAllProperties(java.lang.String id,
                                         PropCategoryNames propName)
                                  throws java.io.IOException

Return the properties for a specified concept.

Parameters:

id - The RxCUI ID of the concept

propName - the property categories for the properties to be returned. This field is required.

Returns:

A set of properties associated with this concept ID of the provided type

Throws:

java.io.IOException

getAllRelatedInfo

AllRelatedGroupResponse getAllRelatedInfo(java.lang.String id)
                                   throws java.io.IOException

Get all the related RxNorm concepts for a given RxNorm identifier. This includes concepts of term types "IN", "MIN", "PIN", "BN", "SBD", "SBDC", "SBDF", "SBDG", "SCD", "SCDC", "SCDF", "SCDG", "DF", "DFG", "BPCK" and "GPCK". See default paths for the paths traveled to get concepts for each term type.

Parameters:

id - The RxCUI for term

Returns:

related concepts for the provided terms

Throws:

java.io.IOException

getApproximateMatch

ApproximateGroupResponse getApproximateMatch(java.lang.String id,
                                             int maxEntries)
                                      throws java.io.IOException

Do an approximate match search to determine the strings in the data set that most closely match the search string.

Parameters:

id - The term to search for

maxEntries - The max number of entries to return (default 10)

Returns:

Result containing a list of Candidate concepts that may match the term provided

Throws:

java.io.IOException

getRelatedByRelationship

RelatedGroupResponse getRelatedByRelationship(java.lang.String id,
                                              java.util.List<RelationshipNames> rela)
                                       throws java.io.IOException

Get the related RxNorm identifiers of an RxNorm concept specified by a relational attribute.

Parameters:

id - The Rxcui for the term

rela - a list of the relationship attribute names such as "tradename_of", "has_form", "isa", etc. This field is required. See the /relatypes example for the valid relationship attributes.

Returns:

A response containing ConceptProperty items related to the identified concept

Throws:

java.io.IOException

getRelatedByType

RelatedGroupResponse getRelatedByType(java.lang.String id,
                                      java.util.List<TTYNames> tty)
                               throws java.io.IOException

Get the related RxNorm identifiers of an RxNorm concept specified by one or more term types. See default paths for the paths traveled to get concepts for each term type.

Parameters:

id - The Rxcui for the term

tty - a list of one or more RxNorm term types. This field is required. See the /termtypes example for the valid term types.

Returns:

A response containing ConceptProperty items related to the identified concept

Throws:

java.io.IOException

getNdcs

NdcsGroupResponse getNdcs(java.lang.String id)
                   throws java.io.IOException

Get the National Drug Codes (NDCs) for the RxNorm concept. The NDCs are returned in the CMS 11-digit NDC derivative form.

Parameters:

id - The Rxcui for the term

Returns:

A list of NDCs associated with this RxNorm CUI

Throws:

java.io.IOException

getMultiIngredBrand

BrandGroupResponse getMultiIngredBrand(java.util.List<java.lang.String> ingredientIds)
                                throws java.io.IOException

Get the brands that contain all the specified ingredients. Note that the brands returned may contain other ingredients in addition to those specified.

Parameters:

ingredientIds - list of ingredient RxCUIs that the returned brands must contain.

Returns:

A list of brand concepts that include the specified ingredients

Throws:

java.io.IOException