Device - FHIR Resource (r4)


This Device Resource uses the FHIR API standard for access and structure.

Validate an Device FHIR Resource (r4)



Resource Attributes

AttributeField is listTypeDescription
contacttrueContactPoint# Details for human/organization for support
definitionfalseReference# The reference to the definition for the device
deviceNametrueData Type# The name of the device as given by the manufacturer
distinctIdentifierfalsestring# The distinct identification string
expirationDatefalsedateTime# Date and time of expiry of this device (if applicable)
identifiertrueIdentifier# Instance identifier
locationfalseReference# Where the device is found
lotNumberfalsestring# Lot number of manufacture
manufactureDatefalsedateTime# Date when the device was made
manufacturerfalsestring# Name of device manufacturer
modelNumberfalsestring# The model number for the device
notetrueAnnotation# Device notes and comments
ownerfalseReference# Organization responsible for device
parentfalseReference# The parent device
partNumberfalsestring# The part number of the device
patientfalseReference# Patient to whom Device is affixed
propertytrueData Type# The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
safetytrueCodeableConcept# Safety Characteristics of Device
serialNumberfalsestring# Serial number assigned by the manufacturer
specializationtrueData Type# The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
statusfalsecode# active | inactive | entered-in-error | unknown
statusReasontrueCodeableConcept# online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
typefalseCodeableConcept# udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
udiCarriertrueData Type# Unique Device Identifier (UDI) Barcode string
urlfalseuri# Network address to contact device
versiontrueData Type# The version of the standard that is used to operate and communicate

Device Example

{
  "resourceType": "Device",
  "id": "example",
  "text": {
    "status": "generated",
    "div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 345675</p></div>"
  },
  "identifier": [
    {
      "system": "http://goodcare.org/devices/id",
      "value": "345675"
    }
  ]
}

Device Structure

{
  "resourceType" : "Device",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // Instance identifier
  "definition" : { Reference(DeviceDefinition) }, // The reference to the definition for the device
  "udiCarrier" : [{ // Unique Device Identifier (UDI) Barcode string
    "deviceIdentifier" : "<string>", // Mandatory fixed portion of UDI
    "issuer" : "<uri>", // UDI Issuing Organization
    "jurisdiction" : "<uri>", // Regional UDI authority
    "carrierAIDC" : "<base64Binary>", // UDI Machine Readable Barcode String
    "carrierHRF" : "<string>", // UDI Human Readable Barcode String
    "entryType" : "<code>" // barcode | rfid | manual +
  }],
  "status" : "<code>", // active | inactive | entered-in-error | unknown
  "statusReason" : [{ CodeableConcept }], // online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
  "distinctIdentifier" : "<string>", // The distinct identification string
  "manufacturer" : "<string>", // Name of device manufacturer
  "manufactureDate" : "<dateTime>", // Date when the device was made
  "expirationDate" : "<dateTime>", // Date and time of expiry of this device (if applicable)
  "lotNumber" : "<string>", // Lot number of manufacture
  "serialNumber" : "<string>", // Serial number assigned by the manufacturer
  "deviceName" : [{ // The name of the device as given by the manufacturer
    "name" : "<string>", // R!  The name of the device
    "type" : "<code>" // R!  udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
  }],
  "modelNumber" : "<string>", // The model number for the device
  "partNumber" : "<string>", // The part number of the device
  "type" : { CodeableConcept }, // The kind or type of device
  "specialization" : [{ // The capabilities supported on a  device, the standards to which the device conforms for a particular purpose, and used for the communication
    "systemType" : { CodeableConcept }, // R!  The standard that is used to operate and communicate
    "version" : "<string>" // The version of the standard that is used to operate and communicate
  }],
  "version" : [{ // The actual design of the device or software version running on the device
    "type" : { CodeableConcept }, // The type of the device version
    "component" : { Identifier }, // A single component of the device version
    "value" : "<string>" // R!  The version text
  }],
  "property" : [{ // The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
    "type" : { CodeableConcept }, // R!  Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
    "valueQuantity" : [{ Quantity }], // Property value as a quantity
    "valueCode" : [{ CodeableConcept }] // Property value as a code, e.g., NTP4 (synced to NTP)
  }],
  "patient" : { Reference(Patient) }, // Patient to whom Device is affixed
  "owner" : { Reference(Organization) }, // Organization responsible for device
  "contact" : [{ ContactPoint }], // Details for human/organization for support
  "location" : { Reference(Location) }, // Where the device is found
  "url" : "<uri>", // Network address to contact device
  "note" : [{ Annotation }], // Device notes and comments
  "safety" : [{ CodeableConcept }], // Safety Characteristics of Device
  "parent" : { Reference(Device) } // The parent device
}

Device Search Parameters

The following search parameters can be used to query Device resources. Just submit them like so:

https://api.1up.health/fhir/r4/Device?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
device-nametextdeviceName.name
identifiertextidentifier
locationreferencelocation
manufacturertextmanufacturer
modeltextmodelNumber
organizationreferenceowner
patientreferencepatient
statustextstatus
typetexttype
udi-carriertextudiCarrier.carrierHRF
udi-ditextudiCarrier.deviceIdentifier
urluriurl