POST api/ListHCPCSByPackage

Returns the Centers for Medicare and Medicade Services (CMS) Healthcare Common Procedure Coding System (HCPCS) information grouped by package for the input drug identifier.


Request Information

URI Parameters

None.

Body Parameters

ListHCPCSByPackageRequest
NameDescriptionTypeAdditional information
DrugId The drug identifier to retrieve the HCPCS information for. ADRDrugIdentifier

Required

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:
{
  "DrugId": {
    "IdType": "NDC11",
    "Id": "12345-6789-01"
  },
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListHCPCSByPackageResponse
NameDescriptionTypeAdditional information
HCPCSInfo A collection of Healthcare Common Procedure Coding System (HCPCS) information grouped by package. Collection of PackageHCPCSInfo

None.

Message Message text if applicable. string

None.

Response Formats

application/json, text/json

Sample:
{
  "HCPCSInfo": [
    {
      "PackageID": 1,
      "HCPCSCode": "Sample HCPCSCode text.",
      "ShortDescription": "Sample ShortDescription text.",
      "AdditionDate": "2024-05-18",
      "EffectiveDate": "2024-05-18",
      "EndDate": "2024-05-18"
    },
    {
      "PackageID": 2,
      "HCPCSCode": "Sample HCPCSCode text.",
      "ShortDescription": "Sample ShortDescription text.",
      "AdditionDate": "2024-05-18",
      "EffectiveDate": "2024-05-18",
      "EndDate": "2024-05-18"
    }
  ],
  "Message": "Sample Message text."
}