DeviceDefinition

ResourceSpecialized · Definitional ArtifactsTrial useMaturity 0

The characteristics, operational status and capabilities of a medical-related component of a medical device.

StructureSearch parametersHL7 specificationStructureDefinition JSON

Tested supportFull test results →

Backends

PostgreSQLElasticsearch

Interactions

CreateReadUpdatePatchDelete

Search

3 of 3 parameters tested

Structure

Show inherited elements (26)

Element	Card.	Type	Description
identifier	0..*	Identifier	Instance identifier
udiDeviceIdentifier	0..*	BackboneElement	Unique Device Identifier (UDI) Barcode string
deviceIdentifierRequired	1..1	string	The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
issuerRequired	1..1	uri	The organization that assigns the identifier algorithm
jurisdictionRequired	1..1	uri	The jurisdiction to which the deviceIdentifier applies
manufacturer[x]	0..1	string | Reference(Organization)	Name of device manufacturer
deviceName	0..*	BackboneElement	A name given to the device to identify it
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
type	0..1	CodeableConcept	What kind of device or device system this isBinding (example): device-kind
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	string	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..*	string	Available versions
safetyΣ	0..*	CodeableConcept	Safety characteristics of the deviceBinding (example): device-safety
shelfLifeStorage	0..*	ProductShelfLife	Shelf Life and storage information
physicalCharacteristics	0..1	ProdCharacteristic	Dimensions, color etc.
languageCode	0..*	CodeableConcept	Language code for the human-readable text strings produced by the device (all supported)
capability	0..*	BackboneElement	Device capabilities
typeRequired	1..1	CodeableConcept	Type of capability
description	0..*	CodeableConcept	Description of capability
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)
owner	0..1	Reference(Organization)	Organization responsible for device
contact	0..*	ContactPoint	Details for human/organization for support
url	0..1	uri	Network address to contact device
onlineInformation	0..1	uri	Access to on-line information
note	0..*	Annotation	Device notes and comments
quantity	0..1	Quantity	The quantity of the device present in the packaging (e.g. the number of devices present in a pack, or the number of devices in the same package of the medicinal product)
parentDeviceΣ	0..1	Reference(DeviceDefinition)	The parent device it can be part of
material	0..*	BackboneElement	A substance used to create the material(s) of which the device is made
substanceRequired	1..1	CodeableConcept	The substance
alternate	0..1	boolean	Indicates an alternative material of the device
allergenicIndicator	0..1	boolean	Whether the substance is a known or suspected allergen

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

Search parameters

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

Parameter	Type	Description	PG	ES
identifier	token	The identifier of the component DeviceDefinition.identifier
parent	reference	The parent DeviceDefinition resource DeviceDefinition.parentDevice
type	token	The device component type DeviceDefinition.type

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