DeviceDefinition

Trial Use 1 Specialized — Devices

This is a specialized resource that defines the characteristics and capabilities of a device.

Endpoints

devhttps://api.sandbox.ovok.com/fhir/R5/DeviceDefinition

Interaction	Method	Path
Read	GET	/fhir/R5/DeviceDefinition/[id]
Vread	GET	/fhir/R5/DeviceDefinition/[id]/_history/[vid]
Update	PUT	/fhir/R5/DeviceDefinition/[id]
Patch	PATCH	/fhir/R5/DeviceDefinition/[id]
Delete	DELETE	/fhir/R5/DeviceDefinition/[id]
Create	POST	/fhir/R5/DeviceDefinition
Search	GET	/fhir/R5/DeviceDefinition?...
History	GET	/fhir/R5/DeviceDefinition/[id]/_history
Type-history	GET	/fhir/R5/DeviceDefinition/_history

Top-level elements

Element	Type(s)	Cardinality	Description
description	markdown	0..1	Additional information to describe the device
identifier	Identifier	0..*	Instance identifier
udiDeviceIdentifier	BackboneElement	0..*	Unique Device Identifier (UDI) Barcode string
regulatoryIdentifier	BackboneElement	0..*	Regulatory identifier(s) associated with this device
partNumber	string	0..1	The part number or catalog number of the device
manufacturer	Reference	0..1	Name of device manufacturer
deviceName	BackboneElement	0..*	The name or names of the device as given by the manufacturer
modelNumber	string	0..1	The catalog or model number for the device for example as defined by the manufacturer
classification	BackboneElement	0..*	What kind of device or device system this is
conformsTo	BackboneElement	0..*	Identifies the standards, specifications, or formal guidances for the capabilities supported by the device
hasPart	BackboneElement	0..*	A device, part of the current one
packaging	BackboneElement	0..*	Information about the packaging of the device, i.e. how the device is packaged
version	BackboneElement	0..*	The version of the device or software
safety	CodeableConcept	0..*	Safety characteristics of the device
shelfLifeStorage	ProductShelfLife	0..*	Shelf Life and storage information
languageCode	CodeableConcept	0..*	Language code for the human-readable text strings produced by the device (all supported)
property	BackboneElement	0..*	Inherent, essentially fixed, characteristics of this kind of device, e.g., time properties, size, etc
owner	Reference	0..1	Organization responsible for device
contact	ContactPoint	0..*	Details for human/organization for support
link	BackboneElement	0..*	An associated device, attached to, used with, communicating with or linking a previous or new device model to the focal device
note	Annotation	0..*	Device notes and comments
material	BackboneElement	0..*	A substance used to create the material(s) of which the device is made
productionIdentifierInUDI	code	0..*	lot-number
guideline	BackboneElement	0..1	Information aimed at providing directions for the usage of this model of device
correctiveAction	BackboneElement	0..1	Tracking of latest field safety corrective action
chargeItem	BackboneElement	0..*	Billing code or reference associated with the device

Resource-specific search parameters

Parameter	Type	Description
device-name	string	A server defined search that may match any of the string fields in DeviceDefinition.name or DeviceDefinition.classification.type - the latter to search for 'generic' devices.
identifier	token	The identifier of the component
manufacturer	reference	The manufacturer of the device
organization	reference	The organization responsible for the device
specification	token	The specification that the device conforms to
specification-version	composite	A composite of both specification and version
type	token	The device type

Reference

• Official FHIR R5 spec: DeviceDefinition
• Maturity: Trial Use 1 (FMM 1).