GET /devices/snomed
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.
Resource Information
format | URL |
---|---|
JSON |
https://accessgudid.nlm.nih.gov/api/v2/devices/snomed.json |
XML |
https://accessgudid.nlm.nih.gov/api/v2/devices/snomed.xml |
Parameters
di
, udi
, or a record_key
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. The UDI parameter should be percent-encoded. |
record_key |
String |
The unique Public Device Record Key string for a device |
Examples
JSON: GET with DI
https://accessgudid.nlm.nih.gov/api/v2/devices/snomed?ticket=ST-163397-AmYzAyfCfhWjqbod4nHc-cas&di=08717648200274
{
concepts: [
{
snomedCTName: "Drug-eluting coronary artery stent, non-bioabsorbable-polymer-coated (physical object)",
snomedIdentifier: 700516001
}
]
}
XML: GET with UDI
https://accessgudid.nlm.nih.gov/api/v2/devices/snomed.xml?ticket=ST-163439-GTEVSfgIPLe1dBkrM51X-cas&udi=%3D%2F08717648200274%3D%2C000025%3DA99971312345600%3D>014032%3D%7D013032%26%2C1000000000000XYZ123
<result>
<concepts type="array">
<concept>
<snomedCTName>
Drug-eluting coronary artery stent, non-bioabsorbable-polymer-coated (physical object)
</snomedCTName>
<snomedIdentifier type="integer">700516001</snomedIdentifier>
</concept>
</concepts>
<udi>
<udi>
=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123
</udi>
<issuingAgency>ICCBBA</issuingAgency>
<di>08717648200274</di>
<serialNumber>000025</serialNumber>
<donationId>A99971312345600</donationId>
<expirationDateOriginalFormat>YYYJJJ</expirationDateOriginalFormat>
<expirationDateOriginal>014032</expirationDateOriginal>
<expirationDate type="date">2014-02-01</expirationDate>
<manufacturingDateOriginalFormat>YYYJJJ</manufacturingDateOriginalFormat>
<manufacturingDateOriginal>013032</manufacturingDateOriginal>
<manufacturingDate type="date">2013-02-01</manufacturingDate>
<lotNumber>000000000000XYZ123</lotNumber>
</udi>
</result>