POST api/DrugToWarningLabel

Returns all warning label information for each drug passed into the request. Also 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

DrugToWarningLabelRequest

Name	Description	Type	Additional information
LanguageCode	The language code for the warning label.	string	Required
MaxLines	Specify the maximum number of lines a warning label can occupy. The API limits the warning label text to the maximum lines value. The default is: 5	integer	None.
CharsPerLine	Specify the the maximum character per line. The API auto-adjusts the warning label text to break before the maximum characters-per-line value. The default is: 24	integer	None.
PrescribingDrugs	Use the PrescribingDrugs collection to pass in the identifiers of drugs currently being dispensed. (i.e. Products being assigned to this patient during this dispensing/checking event.)	Collection of ClinicalDrugIdentifier	Required
PrescribedDrugs	Use the PrescribedDrugs collection to pass in the identifiers of drugs that are considered active on the patient's medical history. If the IgnorePrescribed flag is false, then the PrescribedDrugs collection is required.	Collection of ClinicalDrugIdentifier	None.
IgnorePrescribed	The IgnorePrescribed flag is used to disregard (or not to disregard) the PrescribedDrugs collection. If the Boolean value is set to ‘true’ the Clinical method only checks the PrescribingDrugs collection against the PrescribedDrugs collection, but does not check within the PrescribedDrugs collection itself. The IgnorePrescribed flag is optional. It accepts a Boolean value (true/false) to turn on or off (default is set to “false”).	boolean	None.
FilterPreferences	All warnings, drugs, etc., for each supplied identifier are filtered out of the response.	FilterPreferences	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:

{
  "LanguageCode": "en-US",
  "MaxLines": 10,
  "CharsPerLine": 20,
  "PrescribingDrugs": [
    {
      "IdType": "NDC11",
      "Id": "12345-6789-01"
    },
    {
      "IdType": "NDC11",
      "Id": "12345-6789-02"
    }
  ],
  "PrescribedDrugs": [
    {
      "IdType": "NDC11",
      "Id": "12345-6789-03"
    },
    {
      "IdType": "NDC11",
      "Id": "12345-6789-04"
    }
  ],
  "IgnorePrescribed": false,
  "FilterPreferences": {
    "Patient": [
      {
        "IdType": "IngredientId",
        "Id": "5"
      },
      {
        "IdType": "IngredientId",
        "Id": "6"
      }
    ],
    "Physician": [
      {
        "IdType": "IngredientId",
        "Id": "7"
      },
      {
        "IdType": "IngredientId",
        "Id": "8"
      }
    ]
  },
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

DrugToWarningLabelResponse

Name	Description	Type	Additional information
DrugWarningLabels	A collection of drug and warning label information.	Collection of WarningLabelDrugInfo	None.
DrugsNotChecked	Any drug identifier passed into the request that is not found in the Gold Standard Drug Database is shown in the DrugsNotChecked collection. This allows all other drugs to be checked normally, while still alerting the user that an identifier passed into the request was not found.	Collection of ClinicalDrugIdentifier	None.

Response Formats

application/json, text/json

Sample:

{
  "DrugWarningLabels": [
    {
      "WarningLabels": [
        {
          "WarningLabelId": 1,
          "WarningLabelText": [
            "Sample WarningLabelText text.",
            "Sample WarningLabelText text."
          ],
          "Position": 1
        },
        {
          "WarningLabelId": 2,
          "WarningLabelText": [
            "Sample WarningLabelText text.",
            "Sample WarningLabelText text."
          ],
          "Position": 2
        }
      ],
      "DrugId": {
        "IdType": "NDC11",
        "Id": "12345-6789-03"
      },
      "DrugName": "Sample DrugName text.",
      "RequestSource": "Prescribing"
    },
    {
      "WarningLabels": [
        {
          "WarningLabelId": 4,
          "WarningLabelText": [
            "Sample WarningLabelText text.",
            "Sample WarningLabelText text."
          ],
          "Position": 2
        },
        {
          "WarningLabelId": 5,
          "WarningLabelText": [
            "Sample WarningLabelText text.",
            "Sample WarningLabelText text."
          ],
          "Position": 1
        }
      ],
      "DrugId": {
        "IdType": "NDC11",
        "Id": "12345-6789-06"
      },
      "DrugName": "Sample DrugName text.",
      "RequestSource": "Prescribing"
    }
  ],
  "DrugsNotChecked": [
    {
      "IdType": "NDC11",
      "Id": "12345-6789-07"
    },
    {
      "IdType": "NDC11",
      "Id": "12345-6789-08"
    }
  ]
}