POST api/DrugLabParametersToMonitor
The DrugLabParametersToMonitor method accepts a drug identifier as input and returns suggested or recommended lab test codes for a drug.
For the supplied identifier, this method returns LOINC and/or SNOMED codes grouped by monitoring parameters (Parameters to Monitor).
If there is no data for the drug identifier, the method returns an appropriate message.
Parameters to Monitor are clinically relevant physical qualities (e.g., blood pressure, audiometry) or lab tests (e.g., blood count, liver functions) that are suggested and that need to be overseen while on therapy.
Request Information
URI Parameters
None.
Body Parameters
DrugLabParametersToMonitorRequestName | Description | Type | Additional information |
---|---|---|---|
Drug | The input parameters for the drug that you want to return recommended lab test codes for. | 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:
{ "Drug": { "IdType": "NDC11", "Id": "12345-6789-01" }, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
DrugLabParametersToMonitorResponseName | Description | Type | Additional information |
---|---|---|---|
ParametersToMonitor | Returns the parameters to monitor for the supplied drug. | Collection of DrugLabParameterToMonitor |
Required |
Response Formats
application/json, text/json
Sample:
{ "ParametersToMonitor": [ { "Name": "Sample Name text.", "Intervals": [ "Sample Intervals text.", "Sample Intervals text." ], "LoincCodes": [ "Sample LoincCodes text.", "Sample LoincCodes text." ], "SnomedCode": "Sample SnomedCode text." }, { "Name": "Sample Name text.", "Intervals": [ "Sample Intervals text.", "Sample Intervals text." ], "LoincCodes": [ "Sample LoincCodes text.", "Sample LoincCodes text." ], "SnomedCode": "Sample SnomedCode text." } ] }