DeviceDefinition - FHIR Resource (r4)
This DeviceDefinition Resource uses the FHIR API standard for access and structure.
Validate an DeviceDefinition FHIR Resource (r4)
DeviceDefinition 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": [
{
"value": "0"
}
]Learn more about the (DeviceDefinition) identifier 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:
"udiDeviceIdentifier": Learn more about the (DeviceDefinition) udiDeviceIdentifier FHIR attribute
Description:
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:
"manufacturer[x]": Learn more about the (DeviceDefinition) manufacturer[x] FHIR attribute
Description: A name given to the device to identify it
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 (DeviceDefinition) 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 (DeviceDefinition) modelNumber 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 (DeviceDefinition) 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 (DeviceDefinition) specialization FHIR attribute
Description: The version of the standard that is used to operate and communicate
FHIR Version: r4
Attribute Type : string
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (DeviceDefinition) version FHIR attribute
Description: Safety characteristics of the 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 (DeviceDefinition) safety FHIR attribute
Description: Shelf Life and storage information
FHIR Version: r4
Attribute Type : ProductShelfLife
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"shelfLifeStorage": Learn more about the (DeviceDefinition) shelfLifeStorage FHIR attribute
Description: Dimensions, color etc.
FHIR Version: r4
Attribute Type : ProdCharacteristic
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"physicalCharacteristics": Learn more about the (DeviceDefinition) physicalCharacteristics FHIR attribute
Description: Language code for the human-readable text strings produced by the device (all supported)
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:
"languageCode": Learn more about the (DeviceDefinition) languageCode FHIR attribute
Description: Device capabilities
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:
"capability": Learn more about the (DeviceDefinition) capability 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 (DeviceDefinition) property 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 (DeviceDefinition) 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 (DeviceDefinition) contact 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 (DeviceDefinition) url FHIR attribute
Description: Access to on-line information
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:
"onlineInformation": Learn more about the (DeviceDefinition) onlineInformation 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 (DeviceDefinition) note FHIR attribute
Description: 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)
FHIR Version: r4
Attribute Type : Quantity
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"quantity": Learn more about the (DeviceDefinition) quantity FHIR attribute
Description: The parent device it can be part of
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:
"parentDevice": Learn more about the (DeviceDefinition) parentDevice FHIR attribute
Description: A substance used to create the material(s) of which the device is made
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:
"material": Learn more about the (DeviceDefinition) material FHIR attribute
DeviceDefinition Example
{
"resourceType": "DeviceDefinition",
"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>: 0</p></div>"
},
"identifier": [
{
"value": "0"
}
]
}DeviceDefinition Structure
{
"resourceType" : "DeviceDefinition",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Instance identifier
"udiDeviceIdentifier" : [{ // Unique Device Identifier (UDI) Barcode string
"deviceIdentifier" : "<string>", // R! The identifier that is to be associated with every Device that references this DeviceDefintiion for the issuer and jurisdication porvided in the DeviceDefinition.udiDeviceIdentifier
"issuer" : "<uri>", // R! The organization that assigns the identifier algorithm
"jurisdiction" : "<uri>" // R! The jurisdiction to which the deviceIdentifier applies
}],
// manufacturer[x]: Name of device manufacturer. One of these 2:
"manufacturerString" : "<string>",
"manufacturerReference" : { Reference(Organization) },
"deviceName" : [{ // A name given to the device to identify it
"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
"type" : { CodeableConcept }, // What kind of device or device system this is
"specialization" : [{ // The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication
"systemType" : "<string>", // 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" : ["<string>"], // Available versions
"safety" : [{ CodeableConcept }], // Safety characteristics of the device
"shelfLifeStorage" : [{ ProductShelfLife }], // Shelf Life and storage information
"physicalCharacteristics" : { ProdCharacteristic }, // Dimensions, color etc.
"languageCode" : [{ CodeableConcept }], // Language code for the human-readable text strings produced by the device (all supported)
"capability" : [{ // Device capabilities
"type" : { CodeableConcept }, // R! Type of capability
"description" : [{ CodeableConcept }] // Description of capability
}],
"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)
}],
"owner" : { Reference(Organization) }, // Organization responsible for device
"contact" : [{ ContactPoint }], // Details for human/organization for support
"url" : "<uri>", // Network address to contact device
"onlineInformation" : "<uri>", // Access to on-line information
"note" : [{ Annotation }], // Device notes and comments
"quantity" : { 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" : { Reference(DeviceDefinition) }, // The parent device it can be part of
"material" : [{ // A substance used to create the material(s) of which the device is made
"substance" : { CodeableConcept }, // R! The substance
"alternate" : <boolean>, // Indicates an alternative material of the device
"allergenicIndicator" : <boolean> // Whether the substance is a known or suspected allergen
}]
}
DeviceDefinition Search Parameters
The following search parameters can be used to query DeviceDefinition resources. Just submit them like so:
https://api.1up.health/fhir/r4/DeviceDefinition?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
identifier | text | identifier |
parent | reference | parentDevice |
type | text | type |
