POST api/LactationAlternateDrugs
Accepts one or more drug identifiers from a selection of identifier types as inputs.
Returns pregnancy and lactation alternate drug therapy information based on the supplied drug identifier(s).
- Lactation Ratings: returns drugs to either avoid or use with caution for those patients who may be pregnant and/or lactating, based on the supplied identifier(s). (Gold Standard bases lactation ratings on the childbearing age range of 13-50 and female gender.)
- Pregnancy and Lactation Categories: returns drug information for the supplied identifier by pregnancy and lactation categories (if available).
- Alternate Drugs: returns a list of alternate drugs (and their Marketed Product identifiers) for those drugs with lactation ratings of Avoid or Caution, (if available).
Request Information
URI Parameters
None.
Body Parameters
LactationAlternateDrugsRequestName | Description | Type | Additional information |
---|---|---|---|
DrugIds | A collection of drug identifiers to retrieve the lactation information for. | Collection of ADRDrugIdentifier |
Required |
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:
{ "DrugIds": [ { "IdType": "NDC11", "Id": "12345-6789-01" }, { "IdType": "NDC11", "Id": "12345-6789-02" } ], "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
LactationAlternateDrugsResponseName | Description | Type | Additional information |
---|---|---|---|
Drugs | A collection of pregnancy and lactation information based on the supplied drug identifiers. | Collection of PregnancyAndLactationDrugRatings |
Required |
Response Formats
application/json, text/json
Sample:
{ "Drugs": [ { "Drug": { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-01" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." }, "Ratings": [ { "PregnancyAndLactationCategory": "ChildBearingAge", "Code": "Sample Code text.", "AlternateDrugs": [ { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-02" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." }, { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-03" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." } ], "Description": "Sample Description text.", "Trimester": "First", "MonographSectionId": 4, "InfoMessage": "Sample InfoMessage text." }, { "PregnancyAndLactationCategory": "ChildBearingAge", "Code": "Sample Code text.", "AlternateDrugs": [ { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-05" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." }, { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-06" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." } ], "Description": "Sample Description text.", "Trimester": "First", "MonographSectionId": 7, "InfoMessage": "Sample InfoMessage text." } ], "InfoMessage": "Sample InfoMessage text." }, { "Drug": { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-08" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." }, "Ratings": [ { "PregnancyAndLactationCategory": "ChildBearingAge", "Code": "Sample Code text.", "AlternateDrugs": [ { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-00" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." }, { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-01" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." } ], "Description": "Sample Description text.", "Trimester": "First", "MonographSectionId": 11, "InfoMessage": "Sample InfoMessage text." }, { "PregnancyAndLactationCategory": "ChildBearingAge", "Code": "Sample Code text.", "AlternateDrugs": [ { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-03" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." }, { "DrugId": { "IdType": "NDC11", "Id": "12345-6789-04" }, "Name": "Sample Name text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ], "Message": "Sample Message text." } ], "Description": "Sample Description text.", "Trimester": "First", "MonographSectionId": 14, "InfoMessage": "Sample InfoMessage text." } ], "InfoMessage": "Sample InfoMessage text." } ] }