GET /devices/history

Returns the history associated with a device. A device identifier or device record key is required to receive a response.

Resource Information

format	URL
`JSON`	`https://accessgudid-beta.nlm.nih.gov/api/v3/devices/history.json`
`XML`	`https://accessgudid-beta.nlm.nih.gov/api/v3/devices/history.xml`

Parameters

Either a di or a udi must be provided.

parameter	type	description
`record_key`	`String`	The Device Public Record Key unique to a specific device
`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.

Fields

name	type	description
`udi`	`String`	The full Unique Device Identifier string for a device
`issuingAgency`	`String`	The Issuing Agency of this specific `udi`
`di`	`String`	The Device Identifier string unique to a specific device
`manufacturingDate`	`Date (YYYY-MM-DD)`	The manufacturing/production date of the device in a normalized date format (if provided in the `udi`)
`expirationDate`	`Date (YYYY-MM-DD)`	The expiration date of the device in a normalized date format (if provided in the `udi`)
`lotNumber`	`String`	The batch/lot of the device (if provided in the `udi`)
`serialNumber`	`String`	The serial number of the device (if provided in the `udi`)
`mphoLotNumber`	`String`	The MPHO Lot Number of the device (if provided in the `udi` and the `issuing-agency` is ICCBBA)
`donationId`	`String`	The Donation Identification Number of the device (if provided in the `udi` and the `issuing-agency` is ICCBBA)
`manufacturingDateOriginal`	`Date (Misc. formats)`	The manufacturing/production date of the device as it was provided (if provided in the `udi`)
`manufacturingDateOriginalFormat`	`String`	The date format of the manufacturing/production date as it was provided (if provided in the `udi`). This is to assist users who choose to use the `manufacturing-date-original` date.
`expirationDateOriginal`	`Date (Misc. formats)`	The expiration date of the device as it was provided (if provided in the `udi`)
`expirationDateOriginalFormat`	`String`	The date format of the expiration date as it was provided (if provided in the `udi`). This is to assist users who choose to use the `expiration-date-original` date.

Examples

JSON: GET with DIhttps://accessgudid-beta.nlm.nih.gov/api/v3/devices/history.json?di=03596010535344

{
  history: {
    2: {
    primary_di: "03596010535344",
    publicDeviceRecordKey: "f18845df-38a8-4fc2-8d26-5cce28c8b868",
    publicVersionNumber: "2",
    publicVersionStatus: "Update",
    publicVersionDate: "2018-03-29T00:00:00.000Z",
    creationDate: "2018-04-02T18:42:24.902Z",
    xml: "<?xml version='1.0' encoding='UTF-8'?><device xmlns='http://www.fda.gov/cdrh/gudid' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'><publicDeviceRecordKey>f18845df-38a8-4fc2-8d26-5cce28c8b868</publicDeviceRecordKey><publicVersionStatus>Update</publicVersionStatus><deviceRecordStatus>Published</deviceRecordStatus><publicVersionNumber>2</publicVersionNumber><publicVersionDate>2018-03-29</publicVersionDate><devicePublishDate>2015-08-30</devicePublishDate><deviceCommDistributionEndDate>2018-03-30</deviceCommDistributionEndDate><deviceCommDistributionStatus>Not in Commercial Distribution</deviceCommDistributionStatus><identifiers><identifier><deviceId>03596010535344</deviceId><deviceIdType>Primary</deviceIdType><deviceIdIssuingAgency>GS1</deviceIdIssuingAgency><containsDINumber xsi:nil="true"/><pkgQuantity xsi:nil="true"/><pkgDiscontinueDate xsi:nil="true"/><pkgStatus xsi:nil="true"/><pkgType xsi:nil="true"/></identifier></identifiers><brandName>EMPERION</brandName><versionModelNumber>71360949</versionModelNumber><catalogNumber>71360949</catalogNumber><dunsNumber>109903521</dunsNumber><companyName>Smith &amp; Nephew, Inc.</companyName><deviceCount>1</deviceCount><deviceDescription>19MM MODULAR PILOT</deviceDescription><DMExempt>false</DMExempt><premarketExempt>false</premarketExempt><deviceHCTP>false</deviceHCTP><deviceKit>false</deviceKit><deviceCombinationProduct>false</deviceCombinationProduct><singleUse>false</singleUse><lotBatch>true</lotBatch><serialNumber>false</serialNumber><manufacturingDate>false</manufacturingDate><expirationDate>false</expirationDate><donationIdNumber>false</donationIdNumber><labeledContainsNRL>false</labeledContainsNRL><labeledNoNRL>false</labeledNoNRL><MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus><rx>true</rx><otc>false</otc><contacts><customerContact><phone>+1(800)238-7538</phone><phoneExtension xsi:nil="true"/><email>GUDID@SMITH-NEPHEW.COM</email></customerContact></contacts><gmdnTerms><gmdn><gmdnCode>58481</gmdnCode><gmdnPTName>Femoral stem trial prosthesis</gmdnPTName><gmdnPTDefinition>A copy of a final femoral stem prosthesis designed to be used for trial reductions during hip arthroplasty to judge the correct offset, leg-length, and range of motion of the final femoral prosthesis to be implanted. It is one of a set of trial hip prostheses that match the different anatomical structures of the hip joint, and is used in conjunction with femoral head trial prostheses. It is typically made of metal or polymer material and includes trial stems and trial necks. This is a reusable device intended to be sterilized prior to use.</gmdnPTDefinition><implantable>true</implantable><gmdnCodeStatus>Active</gmdnCodeStatus></gmdn></gmdnTerms><productCodes><fdaProductCode><productCode>JDG</productCode><productCodeName>Prosthesis, hip, femoral component, cemented, metal</productCodeName></fdaProductCode></productCodes><deviceSizes/><environmentalConditions/><sterilization><deviceSterile>false</deviceSterile><sterilizationPriorToUse>true</sterilizationPriorToUse><methodTypes><sterilizationMethod>Moist Heat or Steam Sterilization</sterilizationMethod></methodTypes></sterilization></device>"
    }
  }
}

XML: GET with UDIhttps://accessgudid-beta.nlm.nih.gov/api/v3/devices/history.xml?udi=%3D%2F03596010535344%3D%2C000025%3DA99971312345600%3D>014032%3D%7D013032%26%2C1000000000000XYZ123

<result>
  <history type="array">
    <version number="2">
      <primary-di>03596010535344</primary-di>
      <publicDeviceRecordKey>f18845df-38a8-4fc2-8d26-5cce28c8b868</publicDeviceRecordKey>
      <publicVersionNumber>2</publicVersionNumber>
      <publicVersionStatus>Update</publicVersionStatus>
      <publicVersionDate type="dateTime">2018-03-29T00:00:00Z</publicVersionDate>
      <creationDate type="dateTime">2018-04-02T18:42:24Z</creationDate>
      <xml>
        <?xml version='1.0' encoding='UTF-8'?><device xmlns='http://www.fda.gov/cdrh/gudid' xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'><publicDeviceRecordKey>f18845df-38a8-4fc2-8d26-5cce28c8b868</publicDeviceRecordKey><publicVersionStatus>Update</publicVersionStatus><deviceRecordStatus>Published</deviceRecordStatus><publicVersionNumber>2</publicVersionNumber><publicVersionDate>2018-03-29</publicVersionDate><devicePublishDate>2015-08-30</devicePublishDate><deviceCommDistributionEndDate>2018-03-30</deviceCommDistributionEndDate><deviceCommDistributionStatus>Not in Commercial Distribution</deviceCommDistributionStatus><identifiers><identifier><deviceId>03596010535344</deviceId><deviceIdType>Primary</deviceIdType><deviceIdIssuingAgency>GS1</deviceIdIssuingAgency><containsDINumber xsi:nil="true"/><pkgQuantity xsi:nil="true"/><pkgDiscontinueDate xsi:nil="true"/><pkgStatus xsi:nil="true"/><pkgType xsi:nil="true"/></identifier></identifiers><brandName>EMPERION</brandName><versionModelNumber>71360949</versionModelNumber><catalogNumber>71360949</catalogNumber><dunsNumber>109903521</dunsNumber><companyName>Smith &amp; Nephew, Inc.</companyName><deviceCount>1</deviceCount><deviceDescription>19MM MODULAR PILOT</deviceDescription><DMExempt>false</DMExempt><premarketExempt>false</premarketExempt><deviceHCTP>false</deviceHCTP><deviceKit>false</deviceKit><deviceCombinationProduct>false</deviceCombinationProduct><singleUse>false</singleUse><lotBatch>true</lotBatch><serialNumber>false</serialNumber><manufacturingDate>false</manufacturingDate><expirationDate>false</expirationDate><donationIdNumber>false</donationIdNumber><labeledContainsNRL>false</labeledContainsNRL><labeledNoNRL>false</labeledNoNRL><MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus><rx>true</rx><otc>false</otc><contacts><customerContact><phone>+1(800)238-7538</phone><phoneExtension xsi:nil="true"/><email>GUDID@SMITH-NEPHEW.COM</email></customerContact></contacts><gmdnTerms><gmdn><gmdnCode>58481</gmdnCode><gmdnPTName>Femoral stem trial prosthesis</gmdnPTName><gmdnPTDefinition>A copy of a final femoral stem prosthesis designed to be used for trial reductions during hip arthroplasty to judge the correct offset, leg-length, and range of motion of the final femoral prosthesis to be implanted. It is one of a set of trial hip prostheses that match the different anatomical structures of the hip joint, and is used in conjunction with femoral head trial prostheses. It is typically made of metal or polymer material and includes trial stems and trial necks. This is a reusable device intended to be sterilized prior to use.</gmdnPTDefinition><implantable>true</implantable><gmdnCodeStatus>Active</gmdnCodeStatus></gmdn></gmdnTerms><productCodes><fdaProductCode><productCode>JDG</productCode><productCodeName>Prosthesis, hip, femoral component, cemented, metal</productCodeName></fdaProductCode></productCodes><deviceSizes/><environmentalConditions/><sterilization><deviceSterile>false</deviceSterile><sterilizationPriorToUse>true</sterilizationPriorToUse><methodTypes><sterilizationMethod>Moist Heat or Steam Sterilization</sterilizationMethod></methodTypes></sterilization></device>
      </xml>
    </version>
  </history>
  <udi>
    <udi>
      =/03596010535344=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123
    </udi>
    <issuingAgency>ICCBBA</issuingAgency>
    <di>03596010535344</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>

Device History API

GET /devices/history