POST api/DuplicateTherapy
Compares 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:
This method groups duplicate therapy alerts by drug.
- 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).
- Therapeutic Class.
This method groups duplicate therapy alerts by drug.
Request Information
URI Parameters
None.
Body Parameters
DuplicateTherapyRequestName | 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
DuplicateTherapyResponseName | Description | Type | Additional information |
---|---|---|---|
DuplicateTherapyInteractions | Collection of duplicate therapy interactions. | Collection of DuplicateTherapyInteractions |
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:
{ "DuplicateTherapyInteractions": [ { "ProductDuplication": { "DuplicatePrescribedCount": 1, "DuplicatePrescribingCount": 2 }, "ClinicalDuplication": [ { "IdType": "NDC11", "Id": "12345-6789-01" }, { "IdType": "NDC11", "Id": "12345-6789-02" } ], "IngredientDuplication": [ { "IngredientId": 3, "IngredientName": "Sample IngredientName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-04" }, { "IdType": "NDC11", "Id": "12345-6789-05" } ] }, { "IngredientId": 6, "IngredientName": "Sample IngredientName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-07" }, { "IdType": "NDC11", "Id": "12345-6789-08" } ] } ], "IngredientFamilyDuplication": [ { "IngredientFamilyId": 9, "IngredientFamilyName": "Sample IngredientFamilyName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-01" }, { "IdType": "NDC11", "Id": "12345-6789-02" } ] }, { "IngredientFamilyId": 12, "IngredientFamilyName": "Sample IngredientFamilyName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-04" }, { "IdType": "NDC11", "Id": "12345-6789-05" } ] } ], "TherapeuticClassDuplication": [ { "MaxOccurances": 10, "TherapeuticClassId": 15, "TherapeuticClassName": "Sample TherapeuticClassName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-07" }, { "IdType": "NDC11", "Id": "12345-6789-08" } ] }, { "MaxOccurances": 20, "TherapeuticClassId": 18, "TherapeuticClassName": "Sample TherapeuticClassName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-01" }, { "IdType": "NDC11", "Id": "12345-6789-02" } ] } ], "ControlledSubstanceDuplication": [ { "IdType": "NDC11", "Id": "12345-6789-03" }, { "IdType": "NDC11", "Id": "12345-6789-04" } ], "DrugId": { "IdType": "NDC11", "Id": "12345-6789-05" }, "DrugName": "Sample DrugName text.", "RequestSource": "Prescribing" }, { "ProductDuplication": { "DuplicatePrescribedCount": 2, "DuplicatePrescribingCount": 3 }, "ClinicalDuplication": [ { "IdType": "NDC11", "Id": "12345-6789-06" }, { "IdType": "NDC11", "Id": "12345-6789-07" } ], "IngredientDuplication": [ { "IngredientId": 26, "IngredientName": "Sample IngredientName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-00" }, { "IdType": "NDC11", "Id": "12345-6789-01" } ] }, { "IngredientId": 29, "IngredientName": "Sample IngredientName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-03" }, { "IdType": "NDC11", "Id": "12345-6789-04" } ] } ], "IngredientFamilyDuplication": [ { "IngredientFamilyId": 32, "IngredientFamilyName": "Sample IngredientFamilyName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-06" }, { "IdType": "NDC11", "Id": "12345-6789-07" } ] }, { "IngredientFamilyId": 35, "IngredientFamilyName": "Sample IngredientFamilyName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-00" }, { "IdType": "NDC11", "Id": "12345-6789-01" } ] } ], "TherapeuticClassDuplication": [ { "MaxOccurances": 20, "TherapeuticClassId": 38, "TherapeuticClassName": "Sample TherapeuticClassName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-03" }, { "IdType": "NDC11", "Id": "12345-6789-04" } ] }, { "MaxOccurances": 10, "TherapeuticClassId": 41, "TherapeuticClassName": "Sample TherapeuticClassName text.", "Drugs": [ { "IdType": "NDC11", "Id": "12345-6789-06" }, { "IdType": "NDC11", "Id": "12345-6789-07" } ] } ], "ControlledSubstanceDuplication": [ { "IdType": "NDC11", "Id": "12345-6789-08" }, { "IdType": "NDC11", "Id": "12345-6789-00" } ], "DrugId": { "IdType": "NDC11", "Id": "12345-6789-01" }, "DrugName": "Sample DrugName text.", "RequestSource": "Prescribing" } ], "DrugsNotChecked": [ { "IdType": "NDC11", "Id": "12345-6789-02" }, { "IdType": "NDC11", "Id": "12345-6789-03" } ] }