Device

Overview

The Device API provides healthcare developers with a standardized interface to seamlessly integrate and manage medical devices, streamlining device data capture, monitoring, and utilization within clinical workflows. By leveraging this API, developers can enhance interoperability, optimize device management, and ensure accurate and timely access to critical data for improved patient care and operational efficiency in healthcare settings.

Use Cases

Equipment Management - Register medical equipment details like type, serial numbers, attributes.
Implant Registries - Track implantable device details and associate them with patients.
Software Integrations - Share device data with software managing usage and settings.
Patient Monitoring - Record patient vital signs from connected monitoring devices.
Utilization Analysis - Analyze usage duration and frequency for improved allocation.
Maintenance & Safety - Manage device cleaning, calibration and replace based on usages logged.
Adverse Events - Correlate patient complaints and complications with registered devices.
Location Tracking - Associate location tags using RFID for asset management.
Standards Adherence - Ensure devices conform with required certifications and capabilities.
Supply Chain - Integrate with supply chain systems for inventory management.

EHR Data Model

EHR	Supported?	Mapped Source Object
Athena	✅
Elation	✅
Epic	✅

Object Definition

{
  "resourceType": "Device",
  "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>: 345675</p></div>"
  },
  "identifier": [
    {
      "system": "http://goodcare.org/devices/id",
      "value": "345675"
    }
  ],
  "meta": {
    "tag": [
      {
        "system": "http://terminology.hl7.org/CodeSystem/v3-ActReason",
        "code": "HTEST",
        "display": "test health data"
      }
    ]
  }
}

Data Fields

Data Field	Type	Description
resourceType	Device	This is a Device resource
id	id	The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.
meta	Meta	The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.
implicitRules	uri	A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.
language	code	The base language in which the resource is written.
text	Narrative	A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.
contained	BackboneElement	These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.
extension	Extension	May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
identifier	Identifier	Unique instance identifiers assigned to a device by manufacturers other organizations or owners.
definition	Reference	The reference to the definition for the device.
udiCarrier	BackboneElement	Unique device identifier (UDI) assigned to device label or package. Note that the Device may include multiple udiCarriers as it either may include just the udiCarrier for the jurisdiction it is sold, or for multiple jurisdictions it could have been sold.
udiCarrier.id	string	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
udiCarrier.extension	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
udiCarrier.modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
udiCarrier.deviceIdentifier	string	The device identifier (DI) is a mandatory, fixed portion of a UDI that identifies the labeler and the specific version or model of a device.
udiCarrier.issuer	uri	Organization that is charged with issuing UDIs for devices. For example, the US FDA issuers include : 1) GS1: http://hl7.org/fhir/NamingSystem/gs1-di, 2) HIBCC: http://hl7.org/fhir/NamingSystem/hibcc-dI, 3) ICCBBA for blood containers: http://hl7.org/fhir/NamingSystem/iccbba-blood-di, 4) ICCBA for other devices: http://hl7.org/fhir/NamingSystem/iccbba-other-di.
udiCarrier.jurisdiction	uri	The identity of the authoritative source for UDI generation within a jurisdiction. All UDIs are globally unique within a single namespace with the appropriate repository uri as the system. For example, UDIs of devices managed in the U.S. by the FDA, the value is http://hl7.org/fhir/NamingSystem/fda-udi.
udiCarrier.carrierAIDC	base64Binary	The full UDI carrier of the Automatic Identification and Data Capture (AIDC) technology representation of the barcode string as printed on the packaging of the device - e.g., a barcode or RFID. Because of limitations on character sets in XML and the need to round-trip JSON data through XML, AIDC Formats SHALL be base64 encoded.
udiCarrier.carrierHRF	string	The full UDI carrier as the human readable form (HRF) representation of the barcode string as printed on the packaging of the device.
udiCarrier.entryType	code	A coded entry to indicate how the data was entered.
status	code	Status of the Device availability.
statusReason	CodeableConcept	Reason for the dtatus of the Device availability.
distinctIdentifier	string	The distinct identification string as required by regulation for a human cell, tissue, or cellular and tissue-based product.
manufacturer	string	A name of the manufacturer.
manufactureDate	dateTime	The date and time when the device was manufactured.
expirationDate	dateTime	The date and time beyond which this device is no longer valid or should not be used (if applicable).
lotNumber	string	Lot number assigned by the manufacturer.
serialNumber	string	The serial number assigned by the organization when the device was manufactured.
deviceName	BackboneElement	This represents the manufacturer's name of the device as provided by the device, from a UDI label, or by a person describing the Device. This typically would be used when a person provides the name(s) or when the device represents one of the names available from DeviceDefinition.
deviceName.id	string	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
deviceName.extension	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
deviceName.modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
deviceName.name	string	The name of the device.
deviceName.type	code	The type of deviceName. UDILabelName \| UserFriendlyName \| PatientReportedName \| ManufactureDeviceName \| ModelName.
modelNumber	string	The model number for the device.
partNumber	string	The part number of the device.
type	CodeableConcept	The kind or type of device.
specialization	BackboneElement	The capabilities supported on a device, the standards to which the device conforms for a particular purpose, and used for the communication.
specialization.id	string	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
specialization.extension	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
specialization.modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
specialization.systemType	CodeableConcept	The standard that is used to operate and communicate.
specialization.version	string	The version of the standard that is used to operate and communicate.
version	BackboneElement	The actual design of the device or software version running on the device.
version.id	string	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
version.extension	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
version.modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
version.type	CodeableConcept	The type of the device version.
version.component	Identifier	A single component of the device version.
version.value	string	The version text.
property	BackboneElement	The actual configuration settings of a device as it actually operates, e.g., regulation status, time properties.
property.id	string	Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
property.extension	Extension	May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
property.modifierExtension	Extension	May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).
property.type	CodeableConcept	Code that specifies the property DeviceDefinitionPropetyCode (Extensible).
property.valueQuantity	Quantity	Property value as a quantity.
property.valueCode	CodeableConcept	Property value as a code, e.g., NTP4 (synced to NTP).
patient	Reference	Patient information, If the device is affixed to a person.
owner	Reference	An organization that is responsible for the provision and ongoing maintenance of the device.
contact	ContactPoint	Contact details for an organization or a particular human that is responsible for the device.
location	Reference	The place where the device can be found.
url	uri	A network address on which the device may be contacted directly.
note	Annotation	Descriptive information, usage information or implantation information that is not captured in an existing element.
safety	CodeableConcept	Provides additional safety characteristics about a medical device. For example devices containing latex.
parent	Reference	The parent device.

Extensions

Name	URL

Device

Overview

Use Cases

EHR Data Model

Object Definition

Data Fields

Extensions

Operations & APIs

Device-GET

Device-POST

Device ID-GET

Device ID-PUT

Device ID-DELETE