Device REST Endpoints

Sort by

Task Path Method

Description

Device

This topic describes information for the Device resource.

Overview

The Device resource Implementation is currently limited to devices such as pacemakers that are implanted in a patient as part of a charted procedure. As such, this resource currently exposes the known implant history for a patient occurring at this site.

Soarian Clinicals supports a read-only Application Programming Interface (API). This API accepts GET and POST based search and GET based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals at the time of the query.

Note:

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

Error: The common Client Errors (for more information, see unresolvable-reference.html) and OperationOutcomes may be returned.

The search results include the following fields if they contain values:

• Device ID
• Identifiers

• UDI carrier

  • Device identifier
  • CarrierHRF
• Status
• Distinct identifier
• Manufacturer
• Manufacture date
• Expiration date
• Lot number
• Serial number
• Type
• Patient

Terminology Bindings

• Device.type

  Description: The type of device.

  Details: FHIR Device Types

  System: http://snomed.info/sct

• Device.deviceName.type

  Description: The type of deviceName. Device Name Type can be either user-friendly-name or manufacturer-name.

  Details:

  System: http://hl7.org/fhir/device-nametype

Device

The operations from the Device category.

Get a device by its ID

Method: get

Path: /Device/{ID}

Get a list of devices

Method: get

Path: /Device