Skip to main content

DeviceDefinition

Draft Specialized — Devices

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

Endpoints​

alphahttps://api.dev.ovok.com/fhir/R4/DeviceDefinition
InteractionMethodPath
ReadGET/fhir/R4/DeviceDefinition/[id]
VreadGET/fhir/R4/DeviceDefinition/[id]/_history/[vid]
UpdatePUT/fhir/R4/DeviceDefinition/[id]
PatchPATCH/fhir/R4/DeviceDefinition/[id]
DeleteDELETE/fhir/R4/DeviceDefinition/[id]
CreatePOST/fhir/R4/DeviceDefinition
SearchGET/fhir/R4/DeviceDefinition
HistoryGET/fhir/R4/DeviceDefinition/[id]/_history

Top-level elements​

ElementType(s)CardinalityDescription
identifierIdentifier0..*Instance identifier
udiDeviceIdentifierBackboneElement0..*Unique Device Identifier (UDI) Barcode string
manufacturer[x]string / Reference0..1Name of device manufacturer
deviceNameBackboneElement0..*A name given to the device to identify it
modelNumberstring0..1The model number for the device
typeCodeableConcept0..1What kind of device or device system this is
specializationBackboneElement0..*The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
versionstring0..*Available versions
safetyCodeableConcept0..*Safety characteristics of the device
shelfLifeStorageProductShelfLife0..*Shelf Life and storage information
physicalCharacteristicsProdCharacteristic0..1Dimensions, color etc.
languageCodeCodeableConcept0..*Language code for the human-readable text strings produced by the device (all supported)
capabilityBackboneElement0..*Device capabilities
propertyBackboneElement0..*The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties
ownerReference0..1Organization responsible for device
contactContactPoint0..*Details for human/organization for support
urluri0..1Network address to contact device
onlineInformationuri0..1Access to on-line information
noteAnnotation0..*Device notes and comments
quantityQuantity0..1The 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)
parentDeviceReference0..1The parent device it can be part of
materialBackboneElement0..*A substance used to create the material(s) of which the device is made

Resource-specific search parameters​

ParameterTypeDescription
_compartmentstring
_countstringhttps://www.hl7.org/fhir/search.html#_count
_elementsstringhttps://www.hl7.org/fhir/search.html#_elements
_idstring
_lastUpdatedstring
_profilestring
_securitystring
_sortstringhttps://www.hl7.org/fhir/search.html#_sort
_sourcestring
_summarystringhttps://www.hl7.org/fhir/search.html#_summary
_tagstring
_totalstringhttps://www.hl7.org/fhir/search.html#_total
classificationstringhttp://hl7.org/fhir/SearchParameter/DeviceDefinition-classification
identifierstringhttp://hl7.org/fhir/SearchParameter/DeviceDefinition-identifier
parentstringhttp://hl7.org/fhir/SearchParameter/DeviceDefinition-parent
typestringhttp://hl7.org/fhir/SearchParameter/DeviceDefinition-type

Reference​