POST api/DrugToLifestyle

Returns all documented drug-lifestyle interactions for each drug passed into the request. Requires no input of lifestyle factors to check for lifestyle interactions. Returns the Lifestyle concept involved in the interaction, as opposed to an interacting drug class. 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

DrugToLifestyleRequest

Name	Description	Type	Additional information
IncludeProfessionalNotes	If this is set to 'true' the Professional notes for each possible interaction will be returned in the response. This is 'false' by default.	boolean	None.
IncludeConsumerNotes	If this is set to 'true' the Consumer notes for each possible interaction will be returned in the response. This is 'false' by default.	boolean	None.
CheckUnderDevelopment	The CheckUnderDevelopment parameter is used to check the input drug identifiers for monographs with interaction content still under development. This parameter is optional. It accepts a Boolean value (true/false) to turn on or off (default value is “false”).	boolean	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:

{
  "IncludeProfessionalNotes": true,
  "IncludeConsumerNotes": true,
  "CheckUnderDevelopment": true,
  "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

DrugToLifestyleResponse

Name	Description	Type	Additional information
LifestyleInteractions	A collection of drug identifiers that where screened for possible Drug to Lifestyle interactions.	Collection of LifestyleInteractions	None.
UnderDevelopment	When the CheckUnderDevelopment input parameter is set to 'true' in the request, this element returns collection of drug identifiers passed into the request with monograph interaction content still under development.	Collection of InteractionsUnderDevelopment	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:

{
  "LifestyleInteractions": [
    {
      "Interactions": [
        {
          "LifestyleId": 1,
          "ConceptId": 2,
          "ConceptName": "Sample ConceptName text.",
          "InteractionClass": {
            "Id": 3,
            "Name": "Sample Name text.",
            "Ingredients": [
              {
                "Id": 4,
                "Name": "Sample Name text."
              },
              {
                "Id": 5,
                "Name": "Sample Name text."
              }
            ],
            "DSMRoute": {
              "Id": 6,
              "Name": "Sample Name text."
            }
          },
          "ClinicalManagementStatement": [
            "Sample ClinicalManagementStatement text.",
            "Sample ClinicalManagementStatement text."
          ],
          "ConsumerNotes": "Sample ConsumerNotes text.",
          "Documentation": {
            "Ranking": 1,
            "Text": "Sample Text text."
          },
          "ProfessionalNotes": "Sample ProfessionalNotes text.",
          "ProfessionalNotesAbbr": "Sample ProfessionalNotesAbbr text.",
          "Severity": {
            "Ranking": 1,
            "Text": "Sample Text text."
          }
        },
        {
          "LifestyleId": 7,
          "ConceptId": 8,
          "ConceptName": "Sample ConceptName text.",
          "InteractionClass": {
            "Id": 9,
            "Name": "Sample Name text.",
            "Ingredients": [
              {
                "Id": 10,
                "Name": "Sample Name text."
              },
              {
                "Id": 11,
                "Name": "Sample Name text."
              }
            ],
            "DSMRoute": {
              "Id": 12,
              "Name": "Sample Name text."
            }
          },
          "ClinicalManagementStatement": [
            "Sample ClinicalManagementStatement text.",
            "Sample ClinicalManagementStatement text."
          ],
          "ConsumerNotes": "Sample ConsumerNotes text.",
          "Documentation": {
            "Ranking": 1,
            "Text": "Sample Text text."
          },
          "ProfessionalNotes": "Sample ProfessionalNotes text.",
          "ProfessionalNotesAbbr": "Sample ProfessionalNotesAbbr text.",
          "Severity": {
            "Ranking": 1,
            "Text": "Sample Text text."
          }
        }
      ],
      "DrugId": {
        "IdType": "NDC11",
        "Id": "12345-6789-04"
      },
      "DrugName": "Sample DrugName text.",
      "RequestSource": "Prescribing"
    },
    {
      "Interactions": [
        {
          "LifestyleId": 14,
          "ConceptId": 15,
          "ConceptName": "Sample ConceptName text.",
          "InteractionClass": {
            "Id": 16,
            "Name": "Sample Name text.",
            "Ingredients": [
              {
                "Id": 17,
                "Name": "Sample Name text."
              },
              {
                "Id": 18,
                "Name": "Sample Name text."
              }
            ],
            "DSMRoute": {
              "Id": 19,
              "Name": "Sample Name text."
            }
          },
          "ClinicalManagementStatement": [
            "Sample ClinicalManagementStatement text.",
            "Sample ClinicalManagementStatement text."
          ],
          "ConsumerNotes": "Sample ConsumerNotes text.",
          "Documentation": {
            "Ranking": 2,
            "Text": "Sample Text text."
          },
          "ProfessionalNotes": "Sample ProfessionalNotes text.",
          "ProfessionalNotesAbbr": "Sample ProfessionalNotesAbbr text.",
          "Severity": {
            "Ranking": 2,
            "Text": "Sample Text text."
          }
        },
        {
          "LifestyleId": 20,
          "ConceptId": 21,
          "ConceptName": "Sample ConceptName text.",
          "InteractionClass": {
            "Id": 22,
            "Name": "Sample Name text.",
            "Ingredients": [
              {
                "Id": 23,
                "Name": "Sample Name text."
              },
              {
                "Id": 24,
                "Name": "Sample Name text."
              }
            ],
            "DSMRoute": {
              "Id": 25,
              "Name": "Sample Name text."
            }
          },
          "ClinicalManagementStatement": [
            "Sample ClinicalManagementStatement text.",
            "Sample ClinicalManagementStatement text."
          ],
          "ConsumerNotes": "Sample ConsumerNotes text.",
          "Documentation": {
            "Ranking": 2,
            "Text": "Sample Text text."
          },
          "ProfessionalNotes": "Sample ProfessionalNotes text.",
          "ProfessionalNotesAbbr": "Sample ProfessionalNotesAbbr text.",
          "Severity": {
            "Ranking": 2,
            "Text": "Sample Text text."
          }
        }
      ],
      "DrugId": {
        "IdType": "NDC11",
        "Id": "12345-6789-08"
      },
      "DrugName": "Sample DrugName text.",
      "RequestSource": "Prescribing"
    }
  ],
  "UnderDevelopment": [
    {
      "DrugId": {
        "IdType": "NDC11",
        "Id": "12345-6789-00"
      },
      "RequestSource": "Prescribing",
      "MonographId": 28,
      "Message": "Sample Message text."
    },
    {
      "DrugId": {
        "IdType": "NDC11",
        "Id": "12345-6789-02"
      },
      "RequestSource": "Prescribing",
      "MonographId": 30,
      "Message": "Sample Message text."
    }
  ],
  "DrugsNotChecked": [
    {
      "IdType": "NDC11",
      "Id": "12345-6789-04"
    },
    {
      "IdType": "NDC11",
      "Id": "12345-6789-05"
    }
  ]
}