Device - FHIR Resource (r4)
This Device Resource uses the FHIR API standard for access and structure.
Validate an Device FHIR Resource (r4)
Device Attributes
AttributeField is listTypeDescription
Description: Instance identifier
FHIR Version: r4
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://goodcare.org/devices/id",
"value": "345675"
}
]Learn more about the (Device) identifier FHIR attribute
Description: The reference to the definition for the device
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"definition": Learn more about the (Device) definition FHIR attribute
Description: Unique Device Identifier (UDI) Barcode string
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"udiCarrier": Learn more about the (Device) udiCarrier FHIR attribute
Description: active | inactive | entered-in-error | unknown
FHIR Version: r4
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": Learn more about the (Device) status FHIR attribute
Description: online | paused | standby | offline | not-ready | transduc-discon | hw-discon | off
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"statusReason": Learn more about the (Device) statusReason FHIR attribute
Description: The distinct identification string
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"distinctIdentifier": Learn more about the (Device) distinctIdentifier FHIR attribute
Description: Name of device manufacturer
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufacturer": Learn more about the (Device) manufacturer FHIR attribute
Description: Date when the device was made
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufactureDate": Learn more about the (Device) manufactureDate FHIR attribute
Description: Date and time of expiry of this device (if applicable)
FHIR Version: r4
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expirationDate": Learn more about the (Device) expirationDate FHIR attribute
Description: Lot number of manufacture
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lotNumber": Learn more about the (Device) lotNumber FHIR attribute
Description: Serial number assigned by the manufacturer
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"serialNumber": Learn more about the (Device) serialNumber FHIR attribute
Description: The name of the device as given by the manufacturer
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"deviceName": Learn more about the (Device) deviceName FHIR attribute
Description: The model number for the device
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"modelNumber": Learn more about the (Device) modelNumber FHIR attribute
Description: The part number of the device
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"partNumber": Learn more about the (Device) partNumber FHIR attribute
Description: udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | other
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": Learn more about the (Device) type FHIR attribute
Description: The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"specialization": Learn more about the (Device) specialization FHIR attribute
Description: The version of the standard that is used to operate and communicate
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (Device) version FHIR attribute
Description: The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
FHIR Version: r4
Attribute Type : Data Type
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"property": Learn more about the (Device) property FHIR attribute
Description: Patient to whom Device is affixed
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": Learn more about the (Device) patient FHIR attribute
Description: Organization responsible for device
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"owner": Learn more about the (Device) owner FHIR attribute
Description: Details for human/organization for support
FHIR Version: r4
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": Learn more about the (Device) contact FHIR attribute
Description: Where the device is found
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (Device) location FHIR attribute
Description: Network address to contact device
FHIR Version: r4
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (Device) url FHIR attribute
Description: Device notes and comments
FHIR Version: r4
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": Learn more about the (Device) note FHIR attribute
Description: Safety Characteristics of Device
FHIR Version: r4
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"safety": Learn more about the (Device) safety FHIR attribute
Description: The parent device
FHIR Version: r4
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"parent": Learn more about the (Device) parent FHIR attribute
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 Parameter | Field Type | Resource Fields Searched |
|---|---|---|
device-name | text | deviceName.name |
identifier | text | identifier |
location | reference | location |
manufacturer | text | manufacturer |
model | text | modelNumber |
organization | reference | owner |
patient | reference | patient |
status | text | status |
type | text | type |
udi-carrier | text | udiCarrier.carrierHRF |
udi-di | text | udiCarrier.deviceIdentifier |
url | uri | url |
