Device Lookup API

GET /v1/devices/snomed (v1)

Returns a single device's associated SNOMED information in XML or JSON. A device identifier and a UMLS single-use ticket are required to receive a response.

This API is going to be deprecated. Please move to the v2 Device SNOMED API.

Resource Information

format URL
JSON https://accessgudid-beta.nlm.nih.gov/api/v1/devices/snomed.json
XML https://accessgudid-beta.nlm.nih.gov/api/v1/devices/snomed.xml

Parameters

Either a di or a udi must be provided.
parameter type description
ticket String The single-use ticket used to access UMLS. A valid ticket is required.
Example Value: ST-210847-HwTfbMTY100CWNe2owFF-cas

For information on how to generate a single-use ticket, please see the page on Generating UMLS Tickets.
di String The Device Identifier string unique to a specific device
udi String The full Unique Device Identifier string for a device

This calls and uses the Parse UDI API and returns the parsed UDI information in the response headers.
The UDI parameter should be percent-encoded.

Examples

JSON: GET with DIhttps://accessgudid-beta.nlm.nih.gov/api/v1/devices/snomed?ticket=ST-163397-AmYzAyfCfhWjqbod4nHc-cas&di=08717648200274

[
  {
    snomedCTName: "EXAMPLE_SNOMED_CT_NAME",
    snomedIdentifier: 000000000
  }
]

XML: GET with UDIhttps://accessgudid-beta.nlm.nih.gov/api/v1/devices/snomed.xml?ticket=ST-163439-GTEVSfgIPLe1dBkrM51X-cas&udi=%3D%2F08717648200274%3D%2C000025%3DA99971312345600%3D>014032%3D%7D013032%26%2C1000000000000XYZ123

<snomed type="array">
  <snomed>
    <snomedCTName>
      EXAMPLE_SNOMED_CT_NAME
    </snomedCTName>
    <snomedIdentifier type="integer">000000000</snomedIdentifier>
  </snomed>
</snomed>