POST api/ListProductsByTherapeuticConceptTree

Accepts the TherapeuticConceptTreeId integer value of a location in the Therapeutic Concept Tree, and returns all products located in that classification. Includes a ‘MaxResults’ option that allows you to limit the number of results returned. Provides ‘Alert Optimizer’ filtering options to reduce alert fatigue by suppressing alerts and/or excluding drug results based on individual clinician's preferences or by customizing results specific to a patient.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

ListProductsByTherapeuticConceptTreeRequest

Name	Description	Type	Additional information
TherapeuticConceptTreeTreeId	(Required element) The Therapeutic Concept Tree location for which you want to return all products.	integer	Required
ReturnIngredientStrengthRouteForm	Used to indicate whether to return ingredient strength, route, and form information.	boolean	None.
LimitedDistributionId	A Limited Distribution ID to filter by.	integer	None.
ReturnLimitedDistribution	Used to indicate whether to return Limited Distribution information.	boolean	None.
FilterPreferences	Input filter parameters used to optionally exclude specific results by patient and/or physician preferences. Allows additional parameters to exclude ingredients, products, indications, and/or market classes from the output results. All warnings, drugs, indications, classifications, etc., for each supplied identifier are filtered out of the response. Provides one input node for physician (clinician) preferences and one for the patient preferences.	FilterPreferences	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:

{
  "TherapeuticConceptTreeTreeId": 1,
  "ReturnIngredientStrengthRouteForm": true,
  "LimitedDistributionId": 2,
  "ReturnLimitedDistribution": true,
  "FilterPreferences": {
    "Patient": [
      {
        "IdType": "IngredientId",
        "Id": "3"
      },
      {
        "IdType": "IngredientId",
        "Id": "4"
      }
    ],
    "Physician": [
      {
        "IdType": "IngredientId",
        "Id": "5"
      },
      {
        "IdType": "IngredientId",
        "Id": "6"
      }
    ]
  },
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListProductsByTherapeuticConceptTreeResponse

Name	Description	Type	Additional information
Products	Returns all the product detail output parameters, based on supplied input filters.	Collection of ProductDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "Products": [
    {
      "ProductId": 1,
      "LimitedDistribution": {
        "Id": 2,
        "Name": "Sample Name text."
      },
      "NDC9": "Sample NDC9 text.",
      "ProductNameLong": "Sample ProductNameLong text.",
      "ProductNameType": "Sample ProductNameType text.",
      "ProductNameShort": "Sample ProductNameShort text.",
      "Marketer": "Sample Marketer text.",
      "LegendStatus": "Sample LegendStatus text.",
      "BrandGenericStatus": "Sample BrandGenericStatus text.",
      "FederalDEAClass": "Sample FederalDEAClass text.",
      "ReplacedByProductId": 3,
      "LicenseType": "Sample LicenseType text.",
      "MarketStatus": "OffMarket",
      "IngredientStrengthRouteFormInfo": [
        {
          "Ingredient": {
            "Id": 4,
            "Name": "Sample Name text."
          },
          "Strength": 1.234,
          "StrengthUnitCode": "Sample StrengthUnitCode text.",
          "PerVolume": 1.234,
          "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.",
          "Route": {
            "Id": 5,
            "Name": "Sample Name text."
          },
          "FDAForm": {
            "Id": 6,
            "Name": "Sample Name text."
          },
          "GSForm": {
            "Id": 7,
            "Name": "Sample Name text."
          }
        },
        {
          "Ingredient": {
            "Id": 8,
            "Name": "Sample Name text."
          },
          "Strength": 1.234,
          "StrengthUnitCode": "Sample StrengthUnitCode text.",
          "PerVolume": 1.234,
          "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.",
          "Route": {
            "Id": 9,
            "Name": "Sample Name text."
          },
          "FDAForm": {
            "Id": 10,
            "Name": "Sample Name text."
          },
          "GSForm": {
            "Id": 11,
            "Name": "Sample Name text."
          }
        }
      ]
    },
    {
      "ProductId": 12,
      "LimitedDistribution": {
        "Id": 13,
        "Name": "Sample Name text."
      },
      "NDC9": "Sample NDC9 text.",
      "ProductNameLong": "Sample ProductNameLong text.",
      "ProductNameType": "Sample ProductNameType text.",
      "ProductNameShort": "Sample ProductNameShort text.",
      "Marketer": "Sample Marketer text.",
      "LegendStatus": "Sample LegendStatus text.",
      "BrandGenericStatus": "Sample BrandGenericStatus text.",
      "FederalDEAClass": "Sample FederalDEAClass text.",
      "ReplacedByProductId": 14,
      "LicenseType": "Sample LicenseType text.",
      "MarketStatus": "OffMarket",
      "IngredientStrengthRouteFormInfo": [
        {
          "Ingredient": {
            "Id": 15,
            "Name": "Sample Name text."
          },
          "Strength": 1.234,
          "StrengthUnitCode": "Sample StrengthUnitCode text.",
          "PerVolume": 1.234,
          "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.",
          "Route": {
            "Id": 16,
            "Name": "Sample Name text."
          },
          "FDAForm": {
            "Id": 17,
            "Name": "Sample Name text."
          },
          "GSForm": {
            "Id": 18,
            "Name": "Sample Name text."
          }
        },
        {
          "Ingredient": {
            "Id": 19,
            "Name": "Sample Name text."
          },
          "Strength": 1.234,
          "StrengthUnitCode": "Sample StrengthUnitCode text.",
          "PerVolume": 1.234,
          "PerVolumeUnitCode": "Sample PerVolumeUnitCode text.",
          "Route": {
            "Id": 20,
            "Name": "Sample Name text."
          },
          "FDAForm": {
            "Id": 21,
            "Name": "Sample Name text."
          },
          "GSForm": {
            "Id": 22,
            "Name": "Sample Name text."
          }
        }
      ]
    }
  ]
}