POST api/DoseCheckByIngredient

WARNING: This method is now deprecated and will be removed from the next major GSDD release. Use DoseCheckInfo or DoseCheckScreening instead.

Informs or alerts the user (based on a flag) whether dosing information entered for an active ingredient is within a normal range. Returns minimum, maximum, and usual dosing amounts to be administered for an active ingredient. Returns the numeric identifier for the associated Gold Standard Professional Drug Monograph’s ‘Max Dosage Limits Section’ for the drug, if licensed.


Request Information

URI Parameters

None.

Body Parameters

DoseCheckByIngredientRequest
NameDescriptionTypeAdditional information
DrugId The drug identifier. PedcDrugIdentifier

Required
Dosing Dosing input information. DoseCheckIngredientDose

Required
DateOfBirth Information-only request = OPTIONAL. Screening request = REQUIRED. Used to filter the response based on a calculated age. API converts Date of Birth (DOB) into age and then matches to an age group. date

None.
InformationOnly Identifies whether the request is an Information Only or a Screening call. boolean

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: 
{
  "DrugId": {
    "IdType": "SpecificProductId",
    "Id": "1"
  },
  "Dosing": {
    "Strength": 1.234,
    "UnitCode": "mL",
    "Frequency": 1.234,
    "Interval": 1.234,
    "Weight": 1.234,
    "WeightUnit": "kg",
    "BodySurfaceArea": 1.234,
    "PatientExperience": "Experienced",
    "GestationalAge": 7
  },
  "DateOfBirth": "2024-05-18",
  "InformationOnly": false,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

DoseCheckByIngredientResponse
NameDescriptionTypeAdditional information
AgeGroups A collection of Dose Check age group information; including ingredient dosing information by age band, if available and based on supplied input filters. Collection of DoseCheckAgeGroupIngredient

None.
Messages If applicable, a collection of the Dose Check or No Data Reason messages Collection of DoseCheckMessage

None.
LifeTimeMaxIngredients A collection of Dose Check lifetime max dosing information; provided only if a Lifetime Max is applicable. The lifetime maximum ingredient/strength dosing information is for the ingredient or specific product. Lifetime Max refers to maximum total dose of the product that can be given over the course of a patient’s lifetime. Lifetime maximum dosing is only provided for the adult/geriatric population (ages 18+). Collection of DoseCheckLifetimeMaxIngredient

None.
HepaticImpairmentMayRequireDoseAdjustment Informational alert that, if ‘true’, indicates that the dose needs to be adjusted. boolean

None.
RenalImpairmentMayRequireDoseAdjustment Informational alert that, if ‘true’, indicates that the dose needs to be adjusted. boolean

None.
MonographSectionId Numeric section identifier for the “Max Dosage Limits” section from the Professional Monograph, if applicable. integer

None.

Response Formats

application/json, text/json

Sample: 
{
  "AgeGroups": [
    {
      "IngredientDosing": [
        {
          "IngredientId": 1,
          "IngredientName": "Sample IngredientName text.",
          "DosingType": "Weight",
          "PatientExperience": "Experienced",
          "Message": {
            "Id": 2,
            "Message": "Sample Message text.",
            "NoDataReason": {
              "Id": 3,
              "NoDataReason": "Sample NoDataReason text."
            }
          },
          "CalculatedDose": {
            "LowCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "HighCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "UsualCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "Unit": "mL",
            "Frequency": 2,
            "Interval": 3
          },
          "DosingValues": {
            "Low": 1.234,
            "High": 1.234,
            "Usual": 1.234,
            "Unit": "mL",
            "Frequency": 5,
            "Interval": 6
          }
        },
        {
          "IngredientId": 4,
          "IngredientName": "Sample IngredientName text.",
          "DosingType": "Weight",
          "PatientExperience": "Experienced",
          "Message": {
            "Id": 5,
            "Message": "Sample Message text.",
            "NoDataReason": {
              "Id": 6,
              "NoDataReason": "Sample NoDataReason text."
            }
          },
          "CalculatedDose": {
            "LowCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "HighCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "UsualCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "Unit": "mg",
            "Frequency": 1,
            "Interval": 2
          },
          "DosingValues": {
            "Low": 1.234,
            "High": 1.234,
            "Usual": 1.234,
            "Unit": "mg",
            "Frequency": 4,
            "Interval": 5
          }
        }
      ],
      "Id": 7,
      "Demographic": {
        "Name": "Sample Name text.",
        "MinAge": {
          "AgeUnit": "Week",
          "Value": 2
        },
        "MaxAge": {
          "AgeUnit": "Week",
          "Value": 2
        },
        "MinGestationalAge": {
          "AgeUnit": "Week",
          "Value": 2
        },
        "MaxGestationalAge": {
          "AgeUnit": "Week",
          "Value": 2
        }
      },
      "Message": {
        "Id": 8,
        "Message": "Sample Message text.",
        "NoDataReason": {
          "Id": 9,
          "NoDataReason": "Sample NoDataReason text."
        }
      },
      "NoDataReason": {
        "Id": 10,
        "NoDataReason": "Sample NoDataReason text."
      }
    },
    {
      "IngredientDosing": [
        {
          "IngredientId": 11,
          "IngredientName": "Sample IngredientName text.",
          "DosingType": "Weight",
          "PatientExperience": "Experienced",
          "Message": {
            "Id": 12,
            "Message": "Sample Message text.",
            "NoDataReason": {
              "Id": 13,
              "NoDataReason": "Sample NoDataReason text."
            }
          },
          "CalculatedDose": {
            "LowCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "HighCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "UsualCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "Unit": "mL",
            "Frequency": 2,
            "Interval": 3
          },
          "DosingValues": {
            "Low": 1.234,
            "High": 1.234,
            "Usual": 1.234,
            "Unit": "mL",
            "Frequency": 5,
            "Interval": 6
          }
        },
        {
          "IngredientId": 14,
          "IngredientName": "Sample IngredientName text.",
          "DosingType": "Weight",
          "PatientExperience": "Experienced",
          "Message": {
            "Id": 15,
            "Message": "Sample Message text.",
            "NoDataReason": {
              "Id": 16,
              "NoDataReason": "Sample NoDataReason text."
            }
          },
          "CalculatedDose": {
            "LowCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "HighCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "UsualCalculated": {
              "Formula": "Sample Formula text.",
              "CalculatedValue": 1.234
            },
            "Unit": "mg",
            "Frequency": 1,
            "Interval": 2
          },
          "DosingValues": {
            "Low": 1.234,
            "High": 1.234,
            "Usual": 1.234,
            "Unit": "mg",
            "Frequency": 4,
            "Interval": 5
          }
        }
      ],
      "Id": 17,
      "Demographic": {
        "Name": "Sample Name text.",
        "MinAge": {
          "AgeUnit": "Week",
          "Value": 2
        },
        "MaxAge": {
          "AgeUnit": "Week",
          "Value": 2
        },
        "MinGestationalAge": {
          "AgeUnit": "Week",
          "Value": 2
        },
        "MaxGestationalAge": {
          "AgeUnit": "Week",
          "Value": 2
        }
      },
      "Message": {
        "Id": 18,
        "Message": "Sample Message text.",
        "NoDataReason": {
          "Id": 19,
          "NoDataReason": "Sample NoDataReason text."
        }
      },
      "NoDataReason": {
        "Id": 20,
        "NoDataReason": "Sample NoDataReason text."
      }
    }
  ],
  "Messages": [
    {
      "Id": 21,
      "Message": "Sample Message text.",
      "NoDataReason": {
        "Id": 22,
        "NoDataReason": "Sample NoDataReason text."
      }
    },
    {
      "Id": 23,
      "Message": "Sample Message text.",
      "NoDataReason": {
        "Id": 24,
        "NoDataReason": "Sample NoDataReason text."
      }
    }
  ],
  "LifeTimeMaxIngredients": [
    {
      "IngredientId": 25,
      "IngredientName": "Sample IngredientName text.",
      "Message": {
        "Id": 26,
        "Message": "Sample Message text.",
        "NoDataReason": {
          "Id": 27,
          "NoDataReason": "Sample NoDataReason text."
        }
      },
      "Value": 1.234,
      "Unit": "mL"
    },
    {
      "IngredientId": 28,
      "IngredientName": "Sample IngredientName text.",
      "Message": {
        "Id": 29,
        "Message": "Sample Message text.",
        "NoDataReason": {
          "Id": 30,
          "NoDataReason": "Sample NoDataReason text."
        }
      },
      "Value": 1.234,
      "Unit": "mg"
    }
  ],
  "HepaticImpairmentMayRequireDoseAdjustment": true,
  "RenalImpairmentMayRequireDoseAdjustment": true,
  "MonographSectionId": 31
}