Device

ResourceBase · EntitiesTrial useMaturity 2

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.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

12 of 12 parameters tested

Structure

Show inherited elements (23)

Element	Card.	Type	Description
identifier	0..*	Identifier	Instance identifier
definition	0..1	Reference(DeviceDefinition)	The reference to the definition for the device
udiCarrierΣ	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string
deviceIdentifierΣ	0..1	string	Mandatory fixed portion of UDI
issuer	0..1	uri	UDI Issuing Organization
jurisdiction	0..1	uri	Regional UDI authority
carrierAIDCΣ	0..1	base64Binary	UDI Machine Readable Barcode String
carrierHRFΣ	0..1	string	UDI Human Readable Barcode String
entryType	0..1	code	barcode | rfid | manual +Binding (required): udi-entry-type
status?!Σ	0..1	code	active | inactive | entered-in-error | unknownBinding (required): device-status
statusReason	0..*	CodeableConcept	online | paused | standby | offline | not-ready | transduc-discon | hw-discon | offBinding (extensible): device-status-reason
distinctIdentifier	0..1	string	The distinct identification string
manufacturer	0..1	string	Name of device manufacturer
manufactureDate	0..1	dateTime	Date when the device was made
expirationDate	0..1	dateTime	Date and time of expiry of this device (if applicable)
lotNumber	0..1	string	Lot number of manufacture
serialNumber	0..1	string	Serial number assigned by the manufacturer
deviceName	0..*	BackboneElement	The name of the device as given by the manufacturer
nameRequired	1..1	string	The name of the device
typeRequired	1..1	code	udi-label-name | user-friendly-name | patient-reported-name | manufacturer-name | model-name | otherBinding (required): device-nametype
modelNumber	0..1	string	The model number for the device
partNumber	0..1	string	The part number of the device
type	0..1	CodeableConcept	The kind or type of deviceBinding (example): device-type
specialization	0..*	BackboneElement	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
systemTypeRequired	1..1	CodeableConcept	The standard that is used to operate and communicate
version	0..1	string	The version of the standard that is used to operate and communicate
version	0..*	BackboneElement	The actual design of the device or software version running on the device
type	0..1	CodeableConcept	The type of the device version
component	0..1	Identifier	A single component of the device version
valueRequired	1..1	string	The version text
property	0..*	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
typeRequired	1..1	CodeableConcept	Code that specifies the property DeviceDefinitionPropetyCode (Extensible)
valueQuantity	0..*	Quantity	Property value as a quantity
valueCode	0..*	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP)
patient	0..1	Reference(Patient)	Patient to whom Device is affixed
owner	0..1	Reference(Organization)	Organization responsible for device
contact	0..*	ContactPoint	Details for human/organization for support
location	0..1	Reference(Location)	Where the device is found
url	0..1	uri	Network address to contact device
note	0..*	Annotation	Device notes and comments
safetyΣ	0..*	CodeableConcept	Safety Characteristics of Device
parent	0..1	Reference(Device)	The parent device

Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey

Search parameters

Query with GET [base]/Device?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.

Parameter	Type	Description	PG	ES
device-name	string	A server defined search that may match any of the string fields in Device.deviceName or Device.type. Device.deviceName.name | Device.type.coding.display | Device.type.text
identifier	token	Instance id from manufacturer, owner, and others Device.identifier
location	reference	A location, where the resource is found Device.location
manufacturer	string	The manufacturer of the device Device.manufacturer
model	string	The model of the device Device.modelNumber
organization	reference	The organization responsible for the device Device.owner
patient	reference	Patient information, if the resource is affixed to a person Device.patient
status	token	active | inactive | entered-in-error | unknown Device.status
type	token	The type of the device Device.type
udi-carrier	string	UDI Barcode (RFID or other technology) string in *HRF* format. Device.udiCarrier.carrierHRF
udi-di	string	The udi Device Identifier (DI) Device.udiCarrier.deviceIdentifier
url	uri	Network address to contact device Device.url

PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet.

Common parameters on every resource (8)

_haste-health-author	reference	The author of the resource
_id	token	Logical id of this artifact
_lastUpdated	date	When the resource version last changed
_profile	uri	Profiles this resource claims to conform to
_security	token	Security Labels applied to this resource
_source	uri	Identifies where the resource comes from
_tag	token	Tags applied to this resource
_type	token	Derived from the R4B Definition