Device

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

Response Description

Sample Response

{

  "resourceType": "Device",

  "id": "DEV-DEV-11913-347",

  "meta": {

     "lastUpdated": "2022-11-14T12:00:00-05:00",

     "profile": [

        "http://hl7.org/fhir/us/core/StructureDefinition/us-core-implantable-device"

     ]

  },

  "text": {

     "status": "generated",

     "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><table><tbody><tr><td>Patient:</td><td>Cole Andersonian (DEV-DEV-11913)</td></tr><tr><td>Device:</td><td>ACME Knee Replacement Device</td></tr><tr><td>Status:</td><td>active</td></tr><tr><td>Unique Device ID:</td><td>(01)99863313444316(17)220101(10)M320(21)AC221</td></tr><tr><td>Serial Number:</td><td>Ser83469421</td></tr><tr><td>Expiration:</td><td>12/12/48</td></tr></tbody></table></div>"

  },

  "udiCarrier": [

     {

        "deviceIdentifier": "99863313444316",

        "carrierHRF": "(01)99863313444316(17)220101(10)M320(21)AC221"

     }

  ],

  "status": "active",

  "manufacturer": "ACME",

  "manufactureDate": "2022-01-12",

  "expirationDate": "2048-12-12",

  "lotNumber": "3463463463",

  "serialNumber": "Ser83469421",

  "distinctIdentifier": "UNK",

  "deviceName": [

     {

        "name": "ACME Knee Replacement Device",

        "type": "other"

     }

  ],

  "modelNumber": "89530589",

  "type": {

     "coding": [

        {

           "system": "http://snomed.info/sct",

           "code": "109228008",

           "display": "Knee joint prosthesis"

        }

     ],

     "text": "ACME Knee Replacement Device"

  },

  "patient": {

     "reference": "Patient/DEV-DEV-11913",

     "display": "Cole Andersonian (DEV-DEV-11913)"

  }

}

Device.id

The logical ID of the resource, as used in the URL for the resource. Once assigned, this value never changes.

Device.meta

Metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

Device.text

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative.

Device.udiCarrier

Unique Device Identifier (UDI) Barcode string.

Device.udiCarrier.deviceIdentifier

The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.

Device.udiCarrier.carrierHRF

The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.

Device.status

Status of the Device availability.

Device.manufacturer

Name of device manufacturer.

Device.manufactureDate

The date when the device was manufactured.

Device.expirationDate

The date beyond which this device is no longer valid or should not be used (if applicable).

Device.lotNumber

Lot number assigned by the manufacturer.

Device.serialNumber

The serial number assigned by the organization when the device was manufactured.

Device.distinctIdentifier

The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.

Device.deviceName

This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.

Device.modelNumber

The manufacturer's model number for the device.

Device.type

The kind or type of device.

Device.patient

Patient to whom Device is affixed.

Search

URL Syntax

Two HTTP methods are supported for searching: GET and POST. It is recommended to use HTTP POST.

Visit the FHIR Sandbox to try requests.

HTTP GET - searching

https://sandbox.pai.healthcare/preview/fhir/Device?{query string}

HTTP GET - return single record

https://sandbox.pai.healthcare/preview/fhir/Device/{resource id}

HTTP POST - searching

https://sandbox.pai.healthcare/preview/fhir/Device/_search

•Set the Content-Type header to application/x-www-urlencoded

•The body of the request is a similar query string used in the GET type of request detailed above.

Error Handling

If no records are returned or invalid search parameters are provided, then an HTTP 400 Bad Request is returned.

The body of the response will be an OperationOutcome.

Supported Search Parameters

_id

patient + type

patient + _revInclude:Provenance:target

patient