Device REST Endpoints

Sort by

Task Path Method

Description

Device

This topic describes information for the Device resource.

Overview

Note:

The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

The Device resource implementation is currently limited to devices implanted in a patient such as a pacemaker or insulin pump. As such, this resource currently exposes the known implant history for a patient at this site.

Profile Support

This resource supports the US Core Implantable Device Profile from the HL7 FHIR US Core Implementation Guide STU 6.1.0.

Note:

The examples provided here are nonnormative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.

Returned Fields

Element	Type
Device	DomainResource
Device.id	id
Device.udiCarrier	BackboneElement
Device.deviceIdentifier	string
Device.carrierHRF	string
Device.status	code
Device.distinctIdentifier	string
Device.manufacturer	string
Device.manufactureDate	dateTime
Device.expirationDate	dateTime
Device.lotNumber	string
Device.serialNumber	string
Device.deviceName	BackboneElement
Device.deviceName.name	string
Device.type	CodeableConcept
Device.modelNumber	string
Device.patient	Reference (Patient)
Device.owner	Reference (Organization)

Terminology Bindings

Element	Description	Details
Device.type	The type of device.	SNOMED CT

Device

The operations from the Device category.

Get a device by ID

Method: get

Path: /Device/{id}

Get a list of devices

Method: get

Path: /Device