The Device resource implements the FHIR R4 Device specification and US Core v3.1.1 Implantable Device profile

Fields

Name Type Cardinality Required Description
identifier Identifier 0..*   Instance identifier
definition Reference 0..1   The reference to the definition for the device
udiCarrier BackboneElement 0..1   Unique Device Identifier (UDI) Barcode string
udiCarrier.deviceIdentifier string 1..1 * Mandatory fixed portion of UDI
udiCarrier.carrierAIDC base64Binary 0..1   UDI Machine Readable Barcode String
udiCarrier.carrierHRF string 0..1   UDI Human Readable Barcode String
status code 0..1   active | inactive | entered-in-error | unknown
statusReason CodeableConcept 0..*   online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
distinctIdentifier string 0..1   The distinct identification string
manufacturer string 0..1   Name of device manufacturer
manufactureDate dateTime 0..1   Date when the device was made
expirationDate dateTime 0..1   Date and time of expiry of this device (if applicable)
lotNumber string 0..1   Lot number of manufacture
serialNumber string 0..1   Serial number assigned by the manufacturer
deviceName BackboneElement 0..*   The name of the device as given by the manufacturer
modelNumber string 0..1   The model number for the device
partNumber string 0..1   The part number of the device
type CodeableConcept 1..1 * The kind or type of device - Binding
specialization BackboneElement 0..*   The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
version BackboneElement 0..*   The actual design of the device or software version running on the device
property BackboneElement 0..*   The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
patient Reference(US Core Patient Profile) 1..1 * Patient to whom Device is affixed
owner Reference 0..1   Organization responsible for device
contact ContactPoint 0..*   Details for human/organization for support
location Reference 0..1   Where the resource is found
url uri 0..1   Network address to contact device
note Annotation 0..*   Device notes and comments
safety CodeableConcept 0..*   Safety Characteristics of Device
parent Reference 0..1   The reference to the definition for the device

Interactions

Read

Get an Device entry by id

GET /Device/:id

Example

Request

https://r4cert.medicasoft.us/api/fhir/Device/68740f5e-7338-6ceb-22ab-68f0ffa1c1b0

Response

{
  "resourceType": "Device",
  "udiCarrier": [
    {
      "deviceIdentifier": "70608470043845",
      "carrierHRF": "(01)70608470043845(11)890823(17)140907(10)91868675434900(21)556517"
    }
  ],
  "status": "active",
  "distinctIdentifier": "70608470043845",
  "manufactureDate": "1989-08-23",
  "expirationDate": "2014-09-07T00:56:44-04:00",
  "lotNumber": "91868675434900",
  "serialNumber": "556517",
  "type": {
    "coding": [
      {
        "code": "72506001",
        "system": "http://snomed.info/sct",
        "display": "Implantable defibrillator, device (physical object)"
      }
    ],
    "text": "Implantable defibrillator, device (physical object)"
  },
  "patient": {
    "reference": "Patient/bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2"
  },
  "id": "68740f5e-7338-6ceb-22ab-68f0ffa1c1b0"
}

Query Device resources

GET /Device?:query_parameters

Example

Request

https://r4cert.medicasoft.us/api/fhir/Device?patient=bcfa83df-ee8c-9721-cc07-bdcfc2b1e3f2

Parameters

Name Type Description
udi-di string The udi Device Identifier (DI)
identifier token Instance id from manufacturer, owner, and others
device-name string A server defined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text
patient reference Patient information, if the resource is affixed to a person
organization reference The organization responsible for the device
model string The model of the device
location reference A location, where the resource is found
type token The type of the device
url uri Network address to contact device
manufacturer string The manufacturer of the device
status token active | inactive | entered-in-error | unknown
_revinclude   Provenance:target

Errors

Code Description
400 Invalid parameters
404 Resource not found