POST api/ListGSTermsByCategory
Returns grouped lists of Gold Standard (GS) indication, contraindication, and/or adverse drug reaction codes and corresponding text.
Also includes consumer and professional synonyms and abbreviations.
Includes a ‘MaxResults’ option that allows you to limit the number of results returned.
Note: Remember to set the 'UseCategorizedTerms' option to 'true' on the DrugDisease and ADR methods when using GSTermId results from this method as input.
Note: Remember to set the 'UseCategorizedTerms' option to 'true' on the DrugDisease and ADR methods when using GSTermId results from this method as input.
Request Information
URI Parameters
None.
Body Parameters
ListGSTermsByCategoryRequestName | Description | Type | Additional information |
---|---|---|---|
FilterType | The type of identifier or name to filter for. | GSTermFilterEnum |
None. |
Filter | The identifier or name to filter or search for. | string |
None. |
MaxResults | Limits the number of results returned. A null value means no limit, and everthing will be returned. | integer |
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:
{ "FilterType": "GSTermName", "Filter": "%name%", "MaxResults": 10, "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4=" }
Response Information
Resource Description
ListGSTermsByCategoryResponseName | Description | Type | Additional information |
---|---|---|---|
GSTermCategories | Returns the Gold Standard (GS) term output parameters grouped by category, based on the supplied identifiers. | Collection of GSTermCategory |
None. |
Response Formats
application/json, text/json
Sample:
{ "GSTermCategories": [ { "Category": "Contraindications", "GSTerms": [ { "GSTermId": 1, "GSTermName": "Sample GSTermName text.", "ConsumerDefinition": "Sample ConsumerDefinition text.", "ICD9s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC2" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC3" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "ICD10s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC4" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC5" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "SNOMEDCTs": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC6" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC7" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "Abbreviations": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ], "Synonyms": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ] }, { "GSTermId": 8, "GSTermName": "Sample GSTermName text.", "ConsumerDefinition": "Sample ConsumerDefinition text.", "ICD9s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC9" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC10" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "ICD10s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC11" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC12" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "SNOMEDCTs": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC13" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC14" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "Abbreviations": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ], "Synonyms": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ] } ] }, { "Category": "Contraindications", "GSTerms": [ { "GSTermId": 15, "GSTermName": "Sample GSTermName text.", "ConsumerDefinition": "Sample ConsumerDefinition text.", "ICD9s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC16" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC17" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "ICD10s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC18" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC19" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "SNOMEDCTs": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC20" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC21" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "Abbreviations": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ], "Synonyms": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ] }, { "GSTermId": 22, "GSTermName": "Sample GSTermName text.", "ConsumerDefinition": "Sample ConsumerDefinition text.", "ICD9s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC23" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC24" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "ICD10s": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC25" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC26" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "SNOMEDCTs": [ { "ConditionId": { "IdType": "ICD10", "Id": "123ABC27" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] }, { "ConditionId": { "IdType": "ICD10", "Id": "123ABC28" }, "Description": "Sample Description text.", "InfoMessage": "Sample InfoMessage text.", "LevelsOfEvidence": [ { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." }, { "Recommended": true, "StrengthOfRecommendation": "EquivocalWeakAgainst", "Rating": "VeryLow", "ErrorMessage": "Sample ErrorMessage text." } ] } ], "Abbreviations": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ], "Synonyms": [ { "Type": "Professional", "Name": "Sample Name text." }, { "Type": "Professional", "Name": "Sample Name text." } ] } ] } ] }