User Tools

Site Tools


6. Reply Data

Reply data is returned to the user in either XML or JSON format, as selected in the HTTP request header.

Reply Data details

A JSON response may contain the following base objects:

  • "replyStatus" contains information about the status of the request. Always included in reply. See replyStatus below.
  • "nlmRxImages" is an array containing detailed metadata on the images returned.
  • "enum" contains an enumeration list containing details of requested parameter input values.

A XML response consists of a single <rxImageAccess> and the following top-level elements:

  • <replyStatus> contains information about the status of the request. See replyStatus below.
  • <nlmRxImages> contains a variable number of <image> elements each containing metadata on the images returned.
  • <enum> contains an enumeration list containing details of requested parameter input values.
GroupParameterDescription
replyStatus
successboolean (true / false)

true = request was completed without errors
false = request was not completed without errors, see errorMsg
errorCode integer, non-negative
Error code in case of error. See Error messages.
errorMsg string
Textual description of error. See Error messages.
imageCount integer, non-negative
Number of image elements returned in this reply
pageNumber integer, non-negative
Page number if paged results have been requested. Only included if paged results have been requested.
totalPageCount integer, non-negative
Total number of results pages generated by request. Only included if paged results have been requested.
totalImageCount integer, non-negative
Total number of images generated by request. Note this number may be higher than imageCount if request included results to be paged or limited.
date text string
Date that reply was generated.
matchedTermssee matchedTerms element definition below.
image array element, may occur 1 or more times
idUnique image ID
ndc11NDC 11 code with dash separated segments. The eleven digit NDC value is comprised of three fixed length segments, labeler (5 digits), product (4 digits), packaging (2 digits). Normally presented with dashes separating the segments e.g. 12345-1234-12. An NDC-11 can be successfully be separated into constituent components when segment dashes are absent e.g. “12345123412”
partPart number
nameProduct name and strength
labelerLabeler name
deaScheduleDEA Schedule
matchNdcType of NDC match returned when using ndc as search parameter, either “Exact” or “Other”. Also see parameter matchrelabeled
relabelersNdc9Comma separated list of all known NDC-9 values for relabeled products of stated source NDC-9, a 'sourceNdc9' attribute lists the source of these relabeled products. All relabled and source products listed are believed to be visually identical. The returned image, as identified by the ndc11 field may be listed as either as a relabled or source product. NDC-9 represents the first two segments of the NDC-11 format, labeler (5 digits), product (4 digits), and does not include the specific packaging code for that product. Normally presented with dashes separating the segments e.g. 12345-1234. Can be successfully broken into constituent components when segment dashes are absent e.g. “123451234”
acqDatePhysical sample acquisition date
imageUrlURL for image file
imageSizeSize of image file in bytes
statusDoes this image represent the latest physical form available for this SDP. [CURRENT / OLD / WITHDRAWN]
rxcuiRxNorm RxCUI
Note: a value of 0 is returned if no RxCUI is available for this product.
splSetIdSetID of SPL file related to this image
splRootIdRootID of SPL file related to this image
splVersionVersion of SPL file related to this image
attributionImage Attribution and Disclaimer Information
mpcsee mpc element definition below
ingredientsAvailableboolean (true / false)

true = ingredients are available for this image
false = no ingredients are available for this image
ingredientssee ingredients element definition below
SPL Fields|[optional] SPL data field
enum
colorenumeration list of possible input colors for the color parameter, see enum element definition below
shapeenumeration list of possible input shapes for the shape parameter, see enum element definition below
sizeenumeration list of possible input sizes for the size parameter, see enum element definition below
scoreenumeration list of possible input values for the score parameter, see enum element definition below
imprintTypeenumeration list of possible imprint types for the imprintType parameter, see enum element definition below
imprintColorenumeration list of possible input colors for the imprintColor parameter, see enum element definition below
collectionNameenumeration list of valid collection names for use in resource path definition, see enum element definition below
resolutionenumeration list of valid resolutions for the resolution parameter, see enum element definition below

matchedTerms Element Definition

ElementSub ElementDescription
matchedTerms Details of matched terms for results set
ndcNational Drug Code
idRxImage Identifier
setIdSPL SetId
rootIdSPL RootId
imprintImprint(s)
rxcuiRxNorm RxCUI
shapeShape(s)
colorColor(s)
symbolSymbol
sizeSize
scoreScore
imprintColorColor(s)
imprintTypeImprintType
nameBrand, Generic, or active ingredient name
inactiveInactive ingredient name

ingredients Element Definition

ElementSub ElementDescription
ingredients
activeactive ingredient
inactiveinactive ingredient

mpc Element Definition

ElementSub ElementDescription
mpc
shapeShape
sizeSize in mm
colorColors, comma separated
imprintImprint
imprintColorImprint color
imprintTypeImprint type
symbolSymbol
scoreScore

enum Element Definition

ElementSub ElementDescription
enum name enumeration list name e.g. “color”, “shape”, etc.
nameItem name
descriptionOptional item description

Page Tools