com.apothesource.pillfill.rxnorm.service.ndfrt

Interface NdfrtService

All Known Implementing Classes:

NihNdfrtServiceProxy

public interface NdfrtService

Services to find and retrieve NDF-RT Concepts. NIH Documentation. Note: Some of the parameters & ordering in this interface are intentionally inconsistent to match the NIH documentation.

Method Summary

Modifier and Type	Method and Description
GroupConceptResponse	findConceptsByID(IdTypeNames idType, java.lang.String idString) Find the concepts from a given identifier.
GroupConceptResponse	findConceptsByName(java.lang.String conceptName, KindNames kindName) Get the concept identfier given a concept name and kind.
void	getAllConceptsByKind(java.util.List<KindNames> kindList, ConceptHandler handler) Get concept information for specified kinds.
FullConceptResponse	getAllInfo(java.lang.String nui) This resource returns concept information for a specified concept.
GroupConceptResponse	getChildConcepts(java.lang.String nui, java.lang.Boolean transitive) Get the child concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getChildConcepts
GroupPropertyResponse	getConceptProperties(java.lang.String nui, PropertyNames propertyName) Get the property values for a specified concept and property http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptProperties
GroupConceptResponse	getConceptsByProperty(PropertyNames propertyName, java.lang.String propertyValue) Get the concepts that contain the specified property name and value http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptsByProperty
GroupConceptResponse	getEPCClassOfConcept(java.lang.String nui) Get the FDA Established Pharmacologic classes (EPC) for a specified drug.
VersionResponse	getNdfrtVersion() Get the date for the last update of the underlying NDFRT data
GroupConceptResponse	getParentConcepts(java.lang.String nui, java.lang.Boolean transitive) Get the parent concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getParentConcepts
GroupAssociationResponse	getRelatedConceptsByAssociation(java.lang.String nui, AssociationNames assocName) Get the associations for a specified concept
GroupConceptResponse	getRelatedConceptsByReverseRole(java.lang.String nui, RoleNames roleName, java.lang.Boolean transitive) Get the concepts related to the specified object concept by role.
GroupConceptResponse	getRelatedConceptsByRole(java.lang.String nui, RoleNames roleName, java.lang.Boolean transitive) Get the concepts related to the specified concept by role.
GroupConceptResponse	getVAClassMembers(java.lang.String nui) Get the members of a VA class
ConceptListResponse	getVAClassOfConcept(java.lang.String nui) Get the VA class of a specified concept

Method Detail

getAllInfo

FullConceptResponse getAllInfo(java.lang.String nui)
                        throws java.io.IOException

This resource returns concept information for a specified concept. http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getAllInfo

Parameters:

nui - - the ndfrt identifier for the concept

Returns:

The concept associated with this NUI

Throws:

java.io.IOException

findConceptsByID

GroupConceptResponse findConceptsByID(IdTypeNames idType,
                                      java.lang.String idString)
                               throws java.io.IOException

Find the concepts from a given identifier. http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_findConceptsByID

Parameters:

idType - - the type of identifier. See /typeList for valid identifier types.

idString - - the value of the identifier

Throws:

java.io.IOException

findConceptsByName

GroupConceptResponse findConceptsByName(java.lang.String conceptName,
                                        KindNames kindName)
                                 throws java.io.IOException

Get the concept identfier given a concept name and kind. The name must match the NDF-RT name or one of its synonyms. http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_findConceptsByName

Parameters:

conceptName - - the name of the concept

kindName - - (optional) the kind value. If not specified, all kinds are returned. See getKindList for valid values.

Throws:

java.io.IOException

getChildConcepts

GroupConceptResponse getChildConcepts(java.lang.String nui,
                                      java.lang.Boolean transitive)
                               throws java.io.IOException

Get the child concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getChildConcepts

Parameters:

nui - the NDF-RT identifier

transitive - (optional, default: false) if false, then only direct child concepts are returned. If true, return all descendant concepts.

Returns:

The list of descendant concepts

Throws:

java.io.IOException - if errors occur communicating with the service

getParentConcepts

GroupConceptResponse getParentConcepts(java.lang.String nui,
                                       java.lang.Boolean transitive)
                                throws java.io.IOException

Get the parent concepts of a specified concept http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getParentConcepts

Parameters:

nui - the NDF-RT identifier

transitive - (optional, default: false) if false, then only direct child concepts are returned. If true, return all ancestor concepts.

Returns:

The list of descendant concepts

Throws:

java.io.IOException - if errors occur communicating with the service

getConceptProperties

GroupPropertyResponse getConceptProperties(java.lang.String nui,
                                           PropertyNames propertyName)
                                    throws java.io.IOException

Get the property values for a specified concept and property http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptProperties

Parameters:

nui - the NDF-RT identifier

propertyName - (optional) the property name. If not specified, all concept properties are returned. See /propertyList example for valid property names

Returns:

The named properties associated with this concept

Throws:

java.io.IOException - if errors occur communicating with the service

getConceptsByProperty

GroupConceptResponse getConceptsByProperty(PropertyNames propertyName,
                                           java.lang.String propertyValue)
                                    throws java.io.IOException

Get the concepts that contain the specified property name and value http://rxnav.nlm.nih.gov/NdfrtAPIs.html#uLink=Ndfrt_REST_getConceptsByProperty

Parameters:

propertyName - name of the property. See /propertyList example for valid property names.

propertyValue - the property value

Returns:

The list of concepts matching the provided property

Throws:

java.io.IOException - if errors occur communicating with the service

getRelatedConceptsByReverseRole

GroupConceptResponse getRelatedConceptsByReverseRole(java.lang.String nui,
                                                     RoleNames roleName,
                                                     java.lang.Boolean transitive)
                                              throws java.io.IOException

Get the concepts related to the specified object concept by role. In NDF-RT, the relations between two concepts are defined by roles and are one directional. For example, "Fenofibrate" "may_treat" "Arteriosclerosis" is an example of a relationship in NDF-RT where the role "may_treat" is the relationship between the drug "Fenofibrate" (the subject) and the disease "Arteriosclerosis" (the object). To determine which diseases the drug "Fenofibrate" "may_treat", the resource here specifies the subject and the role. This resource allows the reverse direction, specifying the object and the role. In the example above, this means finding the drugs that "may_treat" "Arteriosclerosis".

Parameters:

nui - the NDF-RT identifier of the object of the role

roleName - the role. See /roleList example for valid role names.

transitive - (default:false) if false, then only the concepts directly associated with the role are returned. If true, the concepts directly associated with the role along with the descendants of these concepts are returned.

Returns:

The list of concepts

Throws:

java.io.IOException

getRelatedConceptsByRole

GroupConceptResponse getRelatedConceptsByRole(java.lang.String nui,
                                              RoleNames roleName,
                                              java.lang.Boolean transitive)
                                       throws java.io.IOException

Get the concepts related to the specified concept by role. In NDF-RT, the relations between two concepts are defined by roles and are one directional. For example, "Fenofibrate" "may_treat" "Arteriosclerosis" is an example of a relationship in NDF-RT where the role "may_treat" is the relationship between the drug "Fenofibrate" (the subject) and the disease "Arteriosclerosis" (the object). To determine which diseases the drug "Fenofibrate" "may_treat", this function specifies the subject and the role. getRelatedConceptsByReverseRole(java.lang.String, com.apothesource.pillfill.rxnorm.datamodel.ndf.RoleNames, java.lang.Boolean) allows the reverse direction, by specifying the object and the role. In the example above, this means finding the drugs that "may_treat" "Arteriosclerosis".

Parameters:

nui - the NDF-RT identifier of the object of the role

roleName - the role. See /roleList example for valid role names.

transitive - (default:false) if false, then only the concepts directly associated with the role are returned. If true, the concepts directly associated with the role and the descendants of these concepts are returned.

Returns:

The list of concepts

Throws:

java.io.IOException

getRelatedConceptsByAssociation

GroupAssociationResponse getRelatedConceptsByAssociation(java.lang.String nui,
                                                         AssociationNames assocName)
                                                  throws java.io.IOException

Get the associations for a specified concept

Parameters:

nui - the NDF-RT concept identifier

assocName - (optional) the association name. If not specified, then all associations are returned for the concept. See getAssociationList for valid values.

Returns:

An array of association structures. Each association structure contains: Association name, Concept identifier (NUI) of the object of the association

Throws:

java.io.IOException

getEPCClassOfConcept

GroupConceptResponse getEPCClassOfConcept(java.lang.String nui)
                                   throws java.io.IOException

Get the FDA Established Pharmacologic classes (EPC) for a specified drug. The specified drug must be an NDF-RT unique identifier (NUI) of a DRUG_KIND concept.

Parameters:

nui - the NDF-RT identifier

Returns:

a list of concepts in this class

Throws:

java.io.IOException

getVAClassMembers

GroupConceptResponse getVAClassMembers(java.lang.String nui)
                                throws java.io.IOException

Get the members of a VA class

Parameters:

nui - the NDF-RT identifier

Returns:

a list of concepts in this class

Throws:

java.io.IOException

getVAClassOfConcept

ConceptListResponse getVAClassOfConcept(java.lang.String nui)
                                 throws java.io.IOException

Get the VA class of a specified concept

Parameters:

nui - the NDF-RT identifier. The identifier must be for a concept that is a VA product (Level = "VA Product")

Returns:

a list of concepts in this class

Throws:

java.io.IOException

getNdfrtVersion

VersionResponse getNdfrtVersion()
                         throws java.io.IOException

Get the date for the last update of the underlying NDFRT data

Returns:

A date

Throws:

java.io.IOException

getAllConceptsByKind

void getAllConceptsByKind(java.util.List<KindNames> kindList,
                          ConceptHandler handler)

Get concept information for specified kinds.

Parameters:

kindList - one or more Kind identifiers. See /kindList example for valid values.

handler - A handler to receive concepts as they are retrieved (to minimize memory overhead vs. a single list object)