POST api/PregnancyAndLactationScreeningAlert

Provides the clinician with alerts on medication that represents a patient’s prescribed and/or prescribing therapy for those females of childbearing age who may be pregnant and/or lactating, based on supplied drug identifiers and optional filters. (NOTE: In GSDD, childbearing age (CBA) is defined as female gender with an age range of 13-50 years.)

Returns drug compatibility information based on the following pregnancy and lactation category conditions:

Pregnancy (data includes FDA trimester ratings)
Lactation (data identifies drugs to avoid or use with caution
Labor and Delivery
Childbearing Age

Returns the associated Gold Standard Professional Drug Monograph “Pregnancy/Breast-feeding” section identifier for the drug, if applicable.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

PregnancyAndLactationScreeningAlertRequest

Name	Description	Type	Additional information
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 ADRDrugIdentifier	Required
PrescribedDrugs	Use the PrescribedDrugs collection to pass in the identifiers of drugs that are considered active on the patient's medical history.	Collection of ADRDrugIdentifier	None.
DateOfBirth	The GSDD API converts the DateOfBirth value into an age and then matches to an age group. In GSDD, childbearing age (CBA) is defined as female gender with an age range of 13-50 years. If the DateOfBirth value indicates that the age is not within the childbearing age range, then the method returns the following message: “Input age is not a Child Bearing Age.” If no value is entered, the method returns all possible results for all pregnancy and lactation categories.	date	None.
FilterBy	Provides option to filter search results by pregnancy and lactation categories. If no value is included in the request, then the method returns information for all pregnancy and lactation categories.	PregnancyAndLactationEnum	None.
Trimester	The numeric pregnancy trimester number. If no value is included in the request, then the method returns information for all pregnancy trimesters.	TrimesterEnum	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:

{
  "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"
    }
  ],
  "DateOfBirth": "2024-05-18",
  "FilterBy": "ChildBearingAge",
  "Trimester": "First",
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

PregnancyAndLactationScreeningAlertResponse

Name	Description	Type	Additional information
Drugs	A collection of pregnancy and lactation information based on the supplied drug identifiers.	Collection of PregnancyAndLactationScreenedDrugRatings	Required

Response Formats

application/json, text/json

Sample:

{
  "Drugs": [
    {
      "Drug": {
        "RequestSource": "Prescribing",
        "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": {
        "RequestSource": "Prescribing",
        "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."
    }
  ]
}