GET /parse_udi
The Parse UDI API allows users to pass a complex GS1, HIBCC or ICCBBA UDI and it will return each part of the UDI in a structured format.
Resource URLs
format | URL |
---|---|
JSON |
https://accessgudid-us-east-1.awsprod.nlm.nih.gov/api/v3/parse_udi.json |
XML |
https://accessgudid-us-east-1.awsprod.nlm.nih.gov/api/v3/parse_udi.xml |
Parameters
udi
must be provided.
parameter | type | description |
---|---|---|
udi |
String |
The full Unique Device Identifier string for a device.
Example Value: (01)00208851107345(17)150331
The UDI parameter should be percent-encoded. |
Examples
JSON: GET
https://accessgudid-us-east-1.awsprod.nlm.nih.gov/api/v3/parse_udi.json?udi=%3D%2FA9999XYZ100T0944%3D%2C000025%3DA99971312345600%3D%3E014032%3D%7D013032%26%2C1000000000000XYZ123
{
udi: "=/A9999XYZ100T0944=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123",
issuingAgency: "ICCBBA",
di: "A9999XYZ100T0944",
serialNumber: "000025",
donationId: "A99971312345600",
expirationDateOriginalFormat: "YYYJJJ",
expirationDateOriginal: "014032",
expirationDate: "2014-02-01",
manufacturingDateOriginalFormat: "YYYJJJ",
manufacturingDateOriginal: "013032",
manufacturingDate: "2013-02-01",
lotNumber: "000000000000XYZ123"
}
XML: GET
https://accessgudid-us-east-1.awsprod.nlm.nih.gov/api/v3/parse_udi.xml?udi=%3D%2FA9999XYZ100T0944%3D%2C000025%3DA99971312345600%3D%3E014032%3D%7D013032%26%2C1000000000000XYZ123
<result>
<udi>
=/A9999XYZ100T0944=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123
</udi>
<issuingAgency>ICCBBA</issuingAgency>
<di>A9999XYZ100T0944</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>
</result>