POST api/ListOrderableNames
Returns a list of drugs based on a drug name entered by the user to help narrow down the options for what should be prescribed.
Returns on-market drugs only (off-market products are excluded from the response), except in cases where a non-marketed brand or generic name appears in conjunction with a marketed name.
Returns Gold Standard Marketed Product identifiers associated with each orderable name concept.
Additionally returns Tallman and Synonym names, if available and where applicable.
Returns all precise forms, if the drug entered in the request is a Base Ingredient.
Includes a ‘MaxResults’ option that allows you to limit the number of results returned.
Request Information
URI Parameters
None.
Body Parameters
ListOrderableNamesRequestName | Description | Type | Additional information |
---|---|---|---|
SearchString | The drug name. Accepts full or partial (with a wildcard ‘%’) values as filters | string |
Required |
BrandOrGeneric | Value entered determines whether to return Generic Name, Brand Name, or Both. Enter one of the valid enumeration values to narrow search results. (NOTE: Values are case-sensitive.) If no value is entered, the method returns both Brand and Generic values. | BrandGenericEnum |
None. |
BaseIngredientsOnly | Value entered determines whether to return only drugs with base ingredients or all drugs. If no value is entered, the method returns all drugs. | boolean |
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:
{ "SearchString": "%name%", "BrandOrGeneric": "Brand", "BaseIngredientsOnly": false, "MaxResults": 10, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ListOrderableNamesResponseName | Description | Type | Additional information |
---|---|---|---|
OrderableNames | Returns orderable name details, based on supplied input filters. | Collection of OrderableName |
None. |
Response Formats
application/json, text/json
Sample:
{ "OrderableNames": [ { "Name": "Sample Name text.", "Type": "TrademarkName", "TallmanName": "Sample TallmanName text.", "MarketedProductIds": [ 1, 2 ] }, { "Name": "Sample Name text.", "Type": "TrademarkName", "TallmanName": "Sample TallmanName text.", "MarketedProductIds": [ 3, 4 ] } ] }