Implant List API

GET /v1/devices/implantable/list (v1)

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.

This API is going to be deprecated. Please move to the v2 Implant List API.

Resource Information

format URL
JSON https://accessgudid.nlm.nih.gov/api/v1/devices/implantable/list.json
XML https://accessgudid.nlm.nih.gov/api/v1/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 creation date after from_date (inclusive)
to_date Date[(YY)YYMMDD or (YY)YY-MM-DD] null Results will only include those with a creation 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.nlm.nih.gov/api/v1/devices/implantable/list.json?page=30&per_page=2

[{
    deviceId: "00885556274866",
    deviceIdIssuingAgency: "GS1",
    brandName: "R3 ACETABULAR",
    companyName: "Smith & Nephew, Inc.",
    versionModelNumber: "71334850",
    MRISafetyStatus: "Labeling does not contain MRI Safety Information",
    labeledContainsNRL: "false",
    gmdnPTName: [
        "Ceramic acetabular liner"
    ]
}, {
    deviceId: "00885556274910",
    deviceIdIssuingAgency: "GS1",
    brandName: "R3 ACETABULAR",
    companyName: "Smith & Nephew, Inc.",
    versionModelNumber: "71334852",
    MRISafetyStatus: "Labeling does not contain MRI Safety Information",
    labeledContainsNRL: "false",
    gmdnPTName: [
        "Ceramic acetabular liner"
    ]
}]

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

<result type="array">
    <result>
        <deviceId>00885556274866</deviceId>
        <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
        <brandName>R3 ACETABULAR</brandName>
        <companyName>Smith & Nephew, Inc.</companyName>
        <versionModelNumber>71334850</versionModelNumber>
        <MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus>
        <labeledContainsNRL>false</labeledContainsNRL>
        <gmdnPTName type="array">
            <gmdnPTName>Ceramic acetabular liner</gmdnPTName>
        </gmdnPTName>
    </result>
    <result>
        <deviceId>00885556274910</deviceId>
        <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
        <brandName>R3 ACETABULAR</brandName>
        <companyName>Smith & Nephew, Inc.</companyName>
        <versionModelNumber>71334852</versionModelNumber>
        <MRISafetyStatus>Labeling does not contain MRI Safety Information</MRISafetyStatus>
        <labeledContainsNRL>false</labeledContainsNRL>
        <gmdnPTName type="array">
            <gmdnPTName>Ceramic acetabular liner</gmdnPTName>
        </gmdnPTName>
    </result>
</result>

With Ticket

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

[{
    deviceId: "08022057012753",
    deviceIdIssuingAgency: "GS1",
    brandName: "CARBOMEDICS STANDARD",
    companyName: "SORIN GROUP ITALIA SRL",
    versionModelNumber: "M7",
    MRISafetyStatus: "MR Conditional",
    labeledContainsNRL: "false",
    gmdnPTName: [
        "Mitral bi-leaflet heart valve prosthesis"
    ],
    snomed: [{
        snomedIdentifier: "701898003",
        snomedCTName: "Mitral bi-leaflet heart valve prosthesis"
    }]
}, {
    deviceId: "08022057012760",
    deviceIdIssuingAgency: "GS1",
    brandName: "CARBOMEDICS REDUCED",
    companyName: "SORIN GROUP ITALIA SRL",
    versionModelNumber: "R5",
    MRISafetyStatus: "MR Conditional",
    labeledContainsNRL: "false",
    gmdnPTName: [
        "Aortic bi-leaflet heart valve prosthesis"
    ],
    snomed: [{
        snomedIdentifier: "701897008",
        snomedCTName: "Aortic bi-leaflet heart valve prosthesis"
    }]
}]

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

<result type="array">
    <result>
        <deviceId>08022057012753</deviceId>
        <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
        <brandName>CARBOMEDICS STANDARD</brandName>
        <companyName>SORIN GROUP ITALIA SRL</companyName>
        <versionModelNumber>M7</versionModelNumber>
        <MRISafetyStatus>MR Conditional</MRISafetyStatus>
        <labeledContainsNRL>false</labeledContainsNRL>
        <gmdnPTName type="array">
            <gmdnPTName>Mitral bi-leaflet heart valve prosthesis</gmdnPTName>
        </gmdnPTName>
        <snomed type="array">
            <snomed>
                <snomedIdentifier>701898003</snomedIdentifier>
                <snomedCTName>Mitral bi-leaflet heart valve prosthesis</snomedCTName>
            </snomed>
        </snomed>
    </result>
    <result>
        <deviceId>08022057012760</deviceId>
        <deviceIdIssuingAgency>GS1</deviceIdIssuingAgency>
        <brandName>CARBOMEDICS REDUCED</brandName>
        <companyName>SORIN GROUP ITALIA SRL</companyName>
        <versionModelNumber>R5</versionModelNumber>
        <MRISafetyStatus>MR Conditional</MRISafetyStatus>
        <labeledContainsNRL>false</labeledContainsNRL>
        <gmdnPTName type="array">
            <gmdnPTName>Aortic bi-leaflet heart valve prosthesis</gmdnPTName>
        </gmdnPTName>
        <snomed type="array">
            <snomed>
                <snomedIdentifier>701897008</snomedIdentifier>
                <snomedCTName>Aortic bi-leaflet heart valve prosthesis</snomedCTName>
            </snomed>
        </snomed>
    </result>
</result>