POST api/ListProductsByRxNorm
Accepts an RxNorm CUI Identifier or Name Filetr as input.
Returns all products (GSDD ProductId and Name) matching to the RxNorm CUI identier or Name Filter.
Includes a ‘MaxResults’ option that allows you to limit the number of results returned
Request Information
URI Parameters
None.
Body Parameters
ListProductsByRxNormRequestName | Description | Type | Additional information |
---|---|---|---|
RxNormId | Return all products mapped to this numeric RxNorm Concept Unique Identifier (RxCUI) as defined by the National Library of Medicine (NLM). | integer |
None. |
NameFilter | Return all products with RxNorm names or synonyms matching this input filter. Accepts full or partial (with a wildcard (‘%’) filter) values. | string |
None. |
MaxResults | Limits the number of results returned. A null value means no limit, and everthing will be returned. | integer |
None. |
AccessToken |
Temporary access token from the GSDD Auth API.
Used to validate your license.
Note: Access tokens are temporary and may be invalidated early for various reasons, including—but not limited to—site maintenance and security updates. If a token is invalidated prematurely, simply request new tokens via the AccessToken method in the GSDD Auth API. This is a rather rare occurrence, but should be planned for and handled by the consuming application. |
string |
Required |
Request Formats
application/json, text/json
Sample:
{ "RxNormId": 1, "NameFilter": "%filter%", "MaxResults": 10, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ListProductsByRxNormResponseName | Description | Type | Additional information |
---|---|---|---|
Products | Returns the Identifier Type, Identifier, and Name for the drug product. | Collection of ProductIdentifierName |
None. |
Response Formats
application/json, text/json
Sample:
{ "Products": [ { "Name": "Sample Name text.", "IdType": "NDC9", "Id": "1" }, { "Name": "Sample Name text.", "IdType": "NDC9", "Id": "2" } ] }