POST api/DuplicateTherapyScreening

Screens all drugs passed into both the Prescribed and Prescribing collections between and among each other for potential duplication of therapy. Returns five different levels of potential duplication:

Same Product or Package.
Same Clinical Product (ingredients, strengths, dose forms).
Same Ingredient/Route.
Same Ingredient Family/Route combination (Ingredient families are collections of different salts of an identical base ingredient).
Same Therapeutic Classification.

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.

This method groups drugs by duplicate therapy alert.

API Method Test Client

Request Information

URI Parameters

None.

Body Parameters

DuplicateTherapyRequest

Name	Description	Type	Additional information
ControlledSubstanceMaxOccurrences	Numeric value indicating the maximum number of Federal DEA controlled substances allowed in a patient’s regimen before returning a duplicate controlled substances event. Although the API accepts Package, Product, Marketed Product, Specific Product, and Generic Product Clinical identifiers for Prescribed or Prescribing colections, only Packages and Products return duplicate controlled substance warnings, since Gold Standard hierarchy concepts do not contain Federal DEA classification values.	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, indications, classifications, etc., for each supplied identifier or combination pair of identifiers are filtered out of the response.	FilterPreferencesCombo	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:

{
  "ControlledSubstanceMaxOccurrences": 10,
  "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": {
    "PatientCombo": [
      {
        "Id1": {
          "IdType": "IngredientId",
          "Id": "5"
        },
        "Id2": {
          "IdType": "IngredientId",
          "Id": "6"
        }
      },
      {
        "Id1": {
          "IdType": "IngredientId",
          "Id": "7"
        },
        "Id2": {
          "IdType": "IngredientId",
          "Id": "8"
        }
      }
    ],
    "PhysicianCombo": [
      {
        "Id1": {
          "IdType": "IngredientId",
          "Id": "9"
        },
        "Id2": {
          "IdType": "IngredientId",
          "Id": "10"
        }
      },
      {
        "Id1": {
          "IdType": "IngredientId",
          "Id": "11"
        },
        "Id2": {
          "IdType": "IngredientId",
          "Id": "12"
        }
      }
    ],
    "Patient": [
      {
        "IdType": "IngredientId",
        "Id": "13"
      },
      {
        "IdType": "IngredientId",
        "Id": "14"
      }
    ],
    "Physician": [
      {
        "IdType": "IngredientId",
        "Id": "15"
      },
      {
        "IdType": "IngredientId",
        "Id": "16"
      }
    ]
  },
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

DuplicateTherapyScreeningResponse

Name	Description	Type	Additional information
ScreeningResult	Screening result.	DuplicateTherapyScreeningResultEnum	Required
IdentifierDuplication	Duplicate therapies of the exact same drug identifier.	Collection of DuplicationIdentifier	None.
ClinicalDuplication	Collection representing duplicate therapies of the same clinical product (ingredients, strengths, dose forms) that are not duplicated identifiers.	Collection of DuplicationClinical	None.
IngredientDuplication	Collection of drug therapies of the same ingredient route that are not clinical product duplicates.	Collection of DuplicationIngredient	None.
IngredientFamilyDuplication	A collection of drug therapies of the same ingredient family route combination that are not duplicate base ingredients. Ingredient families are collections of different salts of an identical base ingredient.	Collection of DuplicationIngredientFamily	None.
TherapeuticClassDuplication	Collection representing duplicate therapies of the same therapeutic class, that are not ingredient family duplicates.	Collection of DuplicationTherapeuticClass	None.
ControlledSubstances	Collection representing Federal DEA controlled substances in excess of the ControlledSubstanceMaxOccurrences value of the DuplicateTherapyRequest. The API sums the number of products and/or packages passed into the request that are listed as controlled substances with the Federal DEA. The API compares that sum to the ControlledSubstanceMaxOccurrences value of the DuplicateTherapyRequest. If the number of products and/or packages passed in exceeds this value, a Duplicate Controlled Substance alert is generated. Only Products and Packages are screened for duplicate controlled substances.	Collection of PackageProductIdentifierName	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:

{
  "ScreeningResult": "DuplicationAllFiltered",
  "IdentifierDuplication": [
    {
      "Drug": {
        "Name": "Sample Name text.",
        "IdType": "SpecificProductId",
        "Id": "1"
      },
      "PrescribingCount": 1,
      "PrescribedCount": 2
    },
    {
      "Drug": {
        "Name": "Sample Name text.",
        "IdType": "SpecificProductId",
        "Id": "2"
      },
      "PrescribingCount": 2,
      "PrescribedCount": 3
    }
  ],
  "ClinicalDuplication": [
    {
      "ClinicalId": 3,
      "ClinicalName": "Sample ClinicalName text.",
      "Drugs": [
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "4"
        },
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "5"
        }
      ]
    },
    {
      "ClinicalId": 6,
      "ClinicalName": "Sample ClinicalName text.",
      "Drugs": [
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "7"
        },
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "8"
        }
      ]
    }
  ],
  "IngredientDuplication": [
    {
      "IngredientId": 9,
      "IngredientName": "Sample IngredientName text.",
      "Drugs": [
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "10"
        },
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "11"
        }
      ]
    },
    {
      "IngredientId": 12,
      "IngredientName": "Sample IngredientName text.",
      "Drugs": [
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "13"
        },
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "14"
        }
      ]
    }
  ],
  "IngredientFamilyDuplication": [
    {
      "IngredientFamilyId": 15,
      "IngredientFamilyName": "Sample IngredientFamilyName text.",
      "Drugs": [
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "16"
        },
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "17"
        }
      ]
    },
    {
      "IngredientFamilyId": 18,
      "IngredientFamilyName": "Sample IngredientFamilyName text.",
      "Drugs": [
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "19"
        },
        {
          "Name": "Sample Name text.",
          "IdType": "SpecificProductId",
          "Id": "20"
        }
      ]
    }
  ],
  "TherapeuticClassDuplication": [
    {
      "TherapeuticClassId": 21,
      "TherapeuticClassName": "Sample TherapeuticClassName text.",
      "ParentTherapeuticClass": null,
      "MaxOccurrences": 0,
      "Drugs": null
    },
    {
      "TherapeuticClassId": 22,
      "TherapeuticClassName": "Sample TherapeuticClassName text.",
      "ParentTherapeuticClass": null,
      "MaxOccurrences": 0,
      "Drugs": null
    }
  ],
  "ControlledSubstances": [
    {
      "Name": "Sample Name text.",
      "IdType": "PackageId",
      "Id": "23"
    },
    {
      "Name": "Sample Name text.",
      "IdType": "PackageId",
      "Id": "24"
    }
  ],
  "DrugsNotChecked": [
    {
      "IdType": "NDC11",
      "Id": "12345-6789-07"
    },
    {
      "IdType": "NDC11",
      "Id": "12345-6789-08"
    }
  ]
}