POST api/ListRxNormByProduct

Returns a list of all RxNorm CUIs, names, and types associated to a given Gold Standard Product Identifier. Includes a ‘MaxResults’ option that allows you to limit the number of results returned


Request Information

URI Parameters

None.

Body Parameters

ListRxNormByProductRequest
NameDescriptionTypeAdditional information
ProductId Input parameters for any product identifiers passed into the request. ProductIdentifier

Required

ReturnRxNormSynonyms If this is set to 'true' the RxNorm PSN, TMSY, and SY synonmyn names will be returned if they exist. boolean

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:
{
  "ProductId": {
    "IdType": "NDC9",
    "Id": "12345-0001"
  },
  "ReturnRxNormSynonyms": true,
  "MaxResults": 10,
  "AccessToken": "T25lX0hhcHB5X0FuZF9TYXRpc2ZpZWRfR1NERF9DdXN0b21lcl9TYW1wbGVfQWNjZXNzVG9rZW4="
}

Response Information

Resource Description

ListRxNormByProductResponse
NameDescriptionTypeAdditional information
RxNorms Returns the RxNorm parameters for the supplied product. Collection of RxNormInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "RxNorms": [
    {
      "RxCUI": 1,
      "Name": "Sample Name text.",
      "Type": "Sample Type text.",
      "PSN": [
        "Sample PSN text.",
        "Sample PSN text."
      ],
      "TMSY": [
        "Sample TMSY text.",
        "Sample TMSY text."
      ],
      "SY": [
        "Sample SY text.",
        "Sample SY text."
      ]
    },
    {
      "RxCUI": 1,
      "Name": "Sample Name text.",
      "Type": "Sample Type text.",
      "PSN": [
        "Sample PSN text.",
        "Sample PSN text."
      ],
      "TMSY": [
        "Sample TMSY text.",
        "Sample TMSY text."
      ],
      "SY": [
        "Sample SY text.",
        "Sample SY text."
      ]
    }
  ]
}