POST api/PrescriptionOrder

Returns all available forms, routes, strengths and other key information about a drug including the ePrescribing name that can be used to prescribe the drug electronically. Provides all valid combinations of forms, routes, and strengths associated with the drug, any related Brand or Generic names for the drug, and each combination’s E-Prescribing name. Additionally returns Tallman and Synonym names, if available and where applicable. Includes a ‘Maximum Results Returned’ option that allows you to limit the number of results returned.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

PrescriptionOrderRequest

Name	Description	Type	Additional information
OrderableName	Enter either the drug name or the orderable name.	string	Required
Strength	The Gold Standard unit of measurement for the Strength parameter value. The UnitCode must match the units used in the commercially supplied product. If the UnitCode does not correctly match the Strength or is not the correct UnitCode for a particular ingredient, then data is not returned. The system validates the input and determines which product(s) to use based on the requested strength. If the requested strength does not match one of the available strengths, then GSDD: Determines whether an existing strength can be multiplied to achieve the requested strength, or checks the scoring rules for the product to see if the strength can be split.	decimal number	None.
Unit	The unit of measure for Strength. This field is required if a value is entered in the Strength element. Enter a valid value to narrow search results. (NOTE: Values are case-sensitive.)	string	None.
FDAFormId	The Gold Standard FDA Form Id (not the FDA’s Id for the form).	integer	None.
RouteId	The numeric identifier associated with a route of administration and used to filter the results.	integer	None.
BrandGenericStatus	Value entered determines whether to return Generic Name, Brand Name, or Both.	BrandGenericEnum	None.
ProductNameType	Indicates which product name types you want listed in the response.	ProductNameEnum	None.
ReturnRxNormSynonyms	If this is set to 'true' the RxNorm PSN, TMSY, and SY synonmyn names will be returned if they exist.	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:

{
  "OrderableName": "Sample OrderableName text.",
  "Strength": 1.234,
  "Unit": "mg",
  "FDAFormId": 1,
  "RouteId": 2,
  "BrandGenericStatus": "Brand",
  "ProductNameType": "GenericName",
  "ReturnRxNormSynonyms": true,
  "MaxResults": 20,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

PrescriptionOrderResponse

Name	Description	Type	Additional information
Drugs	A collection of orderable drug output parameters, based on supplied input filters.	Collection of PrescriptionOrder	None.

Response Formats

application/json, text/json

Sample:

{
  "Drugs": [
    {
      "MarketedProductId": 1,
      "PrescribingName": "Sample PrescribingName text.",
      "TrademarkName": "Sample TrademarkName text.",
      "GenericName": "Sample GenericName text.",
      "Synonym": "Sample Synonym text.",
      "Strength": "Sample Strength text.",
      "DoseNote": "Sample DoseNote text.",
      "NCPDPUnit": "Sample NCPDPUnit text.",
      "NCPDPScriptForm": {
        "Code": "Sample Code text.",
        "Description": "Sample Description text."
      },
      "Route": {
        "Id": 2,
        "Name": "Sample Name text."
      },
      "FDAForm": {
        "Id": 3,
        "Name": "Sample Name text."
      },
      "BrandGenericStatus": "Brand",
      "ProductNameType": "GenericName",
      "RxNormList": [
        {
          "RxCUI": 2,
          "Name": "Sample Name text.",
          "Type": "Sample Type text.",
          "PSN": [
            "Sample PSN text.",
            "Sample PSN text."
          ],
          "TMSY": [
            "Sample TMSY text.",
            "Sample TMSY text."
          ],
          "SY": [
            "Sample SY text.",
            "Sample SY text."
          ]
        },
        {
          "RxCUI": 2,
          "Name": "Sample Name text.",
          "Type": "Sample Type text.",
          "PSN": [
            "Sample PSN text.",
            "Sample PSN text."
          ],
          "TMSY": [
            "Sample TMSY text.",
            "Sample TMSY text."
          ],
          "SY": [
            "Sample SY text.",
            "Sample SY text."
          ]
        }
      ],
      "Ingredients": [
        {
          "IngredientId": 4,
          "IngredientName": "Sample IngredientName text.",
          "NameAbbreviated": "Sample NameAbbreviated text.",
          "TallmanName": "Sample TallmanName text.",
          "Strength": 1.234,
          "Unit": "mg"
        },
        {
          "IngredientId": 5,
          "IngredientName": "Sample IngredientName text.",
          "NameAbbreviated": "Sample NameAbbreviated text.",
          "TallmanName": "Sample TallmanName text.",
          "Strength": 1.234,
          "Unit": "mL"
        }
      ]
    },
    {
      "MarketedProductId": 6,
      "PrescribingName": "Sample PrescribingName text.",
      "TrademarkName": "Sample TrademarkName text.",
      "GenericName": "Sample GenericName text.",
      "Synonym": "Sample Synonym text.",
      "Strength": "Sample Strength text.",
      "DoseNote": "Sample DoseNote text.",
      "NCPDPUnit": "Sample NCPDPUnit text.",
      "NCPDPScriptForm": {
        "Code": "Sample Code text.",
        "Description": "Sample Description text."
      },
      "Route": {
        "Id": 7,
        "Name": "Sample Name text."
      },
      "FDAForm": {
        "Id": 8,
        "Name": "Sample Name text."
      },
      "BrandGenericStatus": "Brand",
      "ProductNameType": "GenericName",
      "RxNormList": [
        {
          "RxCUI": 1,
          "Name": "Sample Name text.",
          "Type": "Sample Type text.",
          "PSN": [
            "Sample PSN text.",
            "Sample PSN text."
          ],
          "TMSY": [
            "Sample TMSY text.",
            "Sample TMSY text."
          ],
          "SY": [
            "Sample SY text.",
            "Sample SY text."
          ]
        },
        {
          "RxCUI": 1,
          "Name": "Sample Name text.",
          "Type": "Sample Type text.",
          "PSN": [
            "Sample PSN text.",
            "Sample PSN text."
          ],
          "TMSY": [
            "Sample TMSY text.",
            "Sample TMSY text."
          ],
          "SY": [
            "Sample SY text.",
            "Sample SY text."
          ]
        }
      ],
      "Ingredients": [
        {
          "IngredientId": 9,
          "IngredientName": "Sample IngredientName text.",
          "NameAbbreviated": "Sample NameAbbreviated text.",
          "TallmanName": "Sample TallmanName text.",
          "Strength": 1.234,
          "Unit": "mL"
        },
        {
          "IngredientId": 10,
          "IngredientName": "Sample IngredientName text.",
          "NameAbbreviated": "Sample NameAbbreviated text.",
          "TallmanName": "Sample TallmanName text.",
          "Strength": 1.234,
          "Unit": "mg"
        }
      ]
    }
  ]
}