Implant List API

GET /devices/implantable/list

Returns a paginated list of devices that are implantable or accessories to an implant system along with some metadata about the device. If provided a UMLS single-use ticket, it also returns the SNOMED data.

Resource Information

format URL
JSON https://accessgudid.awsprod.nlm.nih.gov/api/v2/devices/implantable/list.json
XML https://accessgudid.awsprod.nlm.nih.gov/api/v2/devices/implantable/list.xml

Parameters

parameter type default description
ticket String null The single-use ticket used to access UMLS. A valid ticket will allow the SNOMED data to be returned in addition to all the other information normally returned without a ticket.
Example Value: ST-210847-HwTfbMTY100CWNe2owFF-cas

For information on how to generate a single-use ticket, please see the page on Generating UMLS Tickets.
page Integer 1 The page of paginated results to be returned
The response from the API will include X-Next-Page, X-Prev-Page, X-Total-Pages variables in the HTTP headers to allow paging back and forth.
per_page Integer[1,100] 100 The number of results per page of paginated results
from_date Date[(YY)YYMMDD or (YY)YY-MM-DD] null Results will only include those with a version date after from_date (inclusive)
to_date Date[(YY)YYMMDD or (YY)YY-MM-DD] null Results will only include those with a version date before to_date (inclusive)

Response Headers

header type description
X-Authenticated-Ticket Boolean The status of the single-use ticket
X-Next-Page Integer The next page number
X-Page Integer The current page of results
X-Per-Page Integer How many devices are returned per page
X-Prev-Page Integer The previous page number
X-Total Integer The total number of devices
X-Total-Pages Integer The total number of pages

Examples


Without Ticket

JSON: GEThttps://accessgudid.awsprod.nlm.nih.gov/api/v2/devices/implantable/list.json?page=30&per_page=2

{
  metadata: {
    page: 30,
    totalPages: 329678,
    totalResults: 659356
  },
  devices: [
    {
      deviceId: "10885862001856",
      deviceIdIssuingAgency: "GS1",
      publicDeviceRecordKey: "103606eb-6715-4378-aef9-97d21394478a",
      publicVersionNumber: 2,
      publicVersionDate: "2018-02-10T00:00:00.000Z",
      brandName: "Optetrak Logic",
      companyName: "Exactech, Inc.",
      versionModelNumber: "02-012-35-3511",
      dunsNumber: "157565946",
      MRISafetyStatus: "Labeling does not contain MRI Safety Information",
      labeledContainsNRL: false,
      gmdnPTName: [
        "Tibial insert"
      ],
      deviceRecordStatus: "Published",
      creationDate: "2018-03-15T22:57:33.925Z"
    },
    {
      deviceId: "10885862001863",
      deviceIdIssuingAgency: "GS1",
      publicDeviceRecordKey: "a9b06909-7100-4602-a9e8-618b1a96e470",
      publicVersionNumber: 2,
      publicVersionDate: "2018-02-10T00:00:00.000Z",
      brandName: "Optetrak Logic",
      companyName: "Exactech, Inc.",
      versionModelNumber: "02-012-35-3513",
      dunsNumber: "157565946",
      MRISafetyStatus: "Labeling does not contain MRI Safety Information",
      labeledContainsNRL: false,
      gmdnPTName: [
        "Tibial insert"
      ],
      deviceRecordStatus: "Published",
      creationDate: "2018-03-15T22:57:33.890Z"
    }
  ]
}

XML: GEThttps://accessgudid.awsprod.nlm.nih.gov/api/v2/devices/implantable/list.xml?page=30&per_page=2

<result>
  <metadata>
    <page type="integer">30</page>
    <totalPages type="integer">329678</totalPages>
    <totalResults type="integer">659356</totalResults>
  </metadata>
  <devices type="array">
    <device>
      <deviceId>10885862001856</deviceId>
      <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
      <publicDeviceRecordKey>103606eb-6715-4378-aef9-97d21394478a</publicDeviceRecordKey>
      <publicVersionNumber type="integer">2</publicVersionNumber>
      <publicVersionDate type="dateTime">2018-02-10T00:00:00Z</publicVersionDate>
      <brandName>Optetrak Logic</brandName>
      <companyName>Exactech, Inc.</companyName>
      <versionModelNumber>02-012-35-3511</versionModelNumber>
      <dunsNumber>157565946</dunsNumber>
      <MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus>
      <labeledContainsNRL type="boolean">false</labeledContainsNRL>
      <gmdnPTName type="array">
        <gmdnPTName>Tibial insert</gmdnPTName>
      </gmdnPTName>
      <deviceRecordStatus>Published</deviceRecordStatus>
      <creationDate type="dateTime">2018-03-15T22:57:33Z</creationDate>
    </device>
    <device>
      <deviceId>10885862001863</deviceId>
      <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
      <publicDeviceRecordKey>a9b06909-7100-4602-a9e8-618b1a96e470</publicDeviceRecordKey>
      <publicVersionNumber type="integer">2</publicVersionNumber>
      <publicVersionDate type="dateTime">2018-02-10T00:00:00Z</publicVersionDate>
      <brandName>Optetrak Logic</brandName>
      <companyName>Exactech, Inc.</companyName>
      <versionModelNumber>02-012-35-3513</versionModelNumber>
      <dunsNumber>157565946</dunsNumber>
      <MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus>
      <labeledContainsNRL type="boolean">false</labeledContainsNRL>
      <gmdnPTName type="array">
        <gmdnPTName>Tibial insert</gmdnPTName>
      </gmdnPTName>
      <deviceRecordStatus>Published</deviceRecordStatus>
      <creationDate type="dateTime">2018-03-15T22:57:33Z</creationDate>
    </device>
  </devices>
</result>

With Ticket

JSON: GEThttps://accessgudid.awsprod.nlm.nih.gov/api/v2/devices/implantable/list.json?ticket=ST-210847-HwTfbMTY100CWNe2owFF-cas&page=30&per_page=2

{
  metadata: {
    authenticatedTicket: true,
    page: 30,
    totalPages: 329678,
    totalResults: 659356
  },
  devices: [
    {
      deviceId: "10885862001856",
      deviceIdIssuingAgency: "GS1",
      publicDeviceRecordKey: "103606eb-6715-4378-aef9-97d21394478a",
      publicVersionNumber: 2,
      publicVersionDate: "2018-02-10T00:00:00.000Z",
      brandName: "Optetrak Logic",
      companyName: "Exactech, Inc.",
      versionModelNumber: "02-012-35-3511",
      dunsNumber: "157565946",
      MRISafetyStatus: "Labeling does not contain MRI Safety Information",
      labeledContainsNRL: false,
      gmdnPTName: [
        "Tibial insert"
      ],
      snomed: [
        {
          snomedIdentifier: "465042008",
          snomedCTName: "Tibial insert (physical object)"
        }
      ],
      deviceRecordStatus: "Published",
      creationDate: "2018-03-15T22:57:33.925Z"
    },
    {
      deviceId: "10885862001863",
      deviceIdIssuingAgency: "GS1",
      publicDeviceRecordKey: "a9b06909-7100-4602-a9e8-618b1a96e470",
      publicVersionNumber: 2,
      publicVersionDate: "2018-02-10T00:00:00.000Z",
      brandName: "Optetrak Logic",
      companyName: "Exactech, Inc.",
      versionModelNumber: "02-012-35-3513",
      dunsNumber: "157565946",
      MRISafetyStatus: "Labeling does not contain MRI Safety Information",
      labeledContainsNRL: false,
      gmdnPTName: [
        "Tibial insert"
      ],
      snomed: [
        {
          snomedIdentifier: "465042008",
          snomedCTName: "Tibial insert (physical object)"
        }
      ],
      deviceRecordStatus: "Published",
      creationDate: "2018-03-15T22:57:33.890Z"
    }
  ]
}

XML: GEThttps://accessgudid.awsprod.nlm.nih.gov/api/v2/devices/implantable/list.xml?ticket=ST-210847-HwTfbMTY100CWNe2owFF-cas&page=30&per_page=2

<result>
  <metadata>
    <page type="integer">30</page>
    <totalPages type="integer">329678</totalPages>
    <totalResults type="integer">659356</totalResults>
  </metadata>
  <devices type="array">
    <device>
      <deviceId>10885862001856</deviceId>
      <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
      <publicDeviceRecordKey>103606eb-6715-4378-aef9-97d21394478a</publicDeviceRecordKey>
      <publicVersionNumber type="integer">2</publicVersionNumber>
      <publicVersionDate type="dateTime">2018-02-10T00:00:00Z</publicVersionDate>
      <brandName>Optetrak Logic</brandName>
      <companyName>Exactech, Inc.</companyName>
      <versionModelNumber>02-012-35-3511</versionModelNumber>
      <dunsNumber>157565946</dunsNumber>
      <MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus>
      <labeledContainsNRL type="boolean">false</labeledContainsNRL>
      <gmdnPTName type="array">
        <gmdnPTName>Tibial insert</gmdnPTName>
      </gmdnPTName>
      <snomed type="array">
        <snomed>
          <snomedIdentifier>465042008</snomedIdentifier>
          <snomedCTName>Tibial insert (physical object)</snomedCTName>
        </snomed>
      </snomed>
      <deviceRecordStatus>Published</deviceRecordStatus>
      <creationDate type="dateTime">2018-03-15T22:57:33Z</creationDate>
    </device>
    <device>
      <deviceId>10885862001863</deviceId>
      <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
      <publicDeviceRecordKey>a9b06909-7100-4602-a9e8-618b1a96e470</publicDeviceRecordKey>
      <publicVersionNumber type="integer">2</publicVersionNumber>
      <publicVersionDate type="dateTime">2018-02-10T00:00:00Z</publicVersionDate>
      <brandName>Optetrak Logic</brandName>
      <companyName>Exactech, Inc.</companyName>
      <versionModelNumber>02-012-35-3513</versionModelNumber>
      <dunsNumber>157565946</dunsNumber>
      <MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus>
      <labeledContainsNRL type="boolean">false</labeledContainsNRL>
      <gmdnPTName type="array">
        <gmdnPTName>Tibial insert</gmdnPTName>
      </gmdnPTName>
      <snomed type="array">
        <snomed>
          <snomedIdentifier>465042008</snomedIdentifier>
          <snomedCTName>Tibial insert (physical object)</snomedCTName>
        </snomed>
      </snomed>
      <deviceRecordStatus>Published</deviceRecordStatus>
      <creationDate type="dateTime">2018-03-15T22:57:33Z</creationDate>
    </device>
  </devices>
</result>