Skip to main content

Device

Overview​

The Device resource represents manufactured items used in healthcare provision, including medical devices, implants, and equipment. This resource tracks device information for clinical documentation and safety monitoring.

Important: Always validate Device resource support and available operations by retrieving the current CapabilityStatement from /metadata before implementing integrations.

Resource Schema​

The Device resource follows the HL7 FHIR R4 Device specification.

Key elements include:

  • identifier - Unique device identifiers (UDI, serial numbers)
  • definition - Device definition or model
  • udiCarrier - Unique Device Identifier (UDI) information
  • status - Active, inactive, entered-in-error, unknown
  • statusReason - Reason for current status
  • distinctIdentifier - Distinct identification string
  • manufacturer - Name of device manufacturer
  • manufactureDate - Date when device was made
  • expirationDate - Date beyond which device should not be used
  • lotNumber - Lot number assigned by manufacturer
  • serialNumber - Serial number assigned by manufacturer
  • deviceName - Device names (user-friendly, patient-reported, etc.)
  • modelNumber - Model or part number
  • type - Device type classification
  • patient - Patient to whom device is affixed

Example Device Resource​

{
  "resourceType": "Device",
  "id": "12345",
  "identifier": [{
    "type": {
      "coding": [{
        "system": "http://hl7.org/fhir/NamingSystem/hibcc-dI",
        "code": "SNO"
      }]
    },
    "value": "ABC123456789"
  }],
  "status": "active",
  "manufacturer": "Acme Medical Devices",
  "deviceName": [{
    "name": "Cardiac Pacemaker Model X",
    "type": "manufacturer-name"
  }],
  "modelNumber": "PM-X-2024",
  "serialNumber": "SN123456789",
  "type": {
    "coding": [{
      "system": "http://snomed.info/sct",
      "code": "14106009",
      "display": "Cardiac pacemaker"
    }]
  },
  "patient": {
    "reference": "Patient/12345"
  },
  "manufactureDate": "2024-01-15",
  "expirationDate": "2034-01-15"
}

Supported Profiles​

The API supports the following FHIR profiles:

Operations​

The General Purpose API Device resource supports the following standard operations. However, support varies by the targeted CareRecord or solution.

CareRecord / SolutionCreateReadUpdateSearch
GEHRIMED-Yes-Yes
myAvatarYesYesYesYes
myEvolv-Yes-Yes
myUnity-Yes-Yes
info

Not all Netsmart solutions support Device search. See supported operations table above and consult your target solution's documentation for more information.

This resource supports standard search parameters in addition to the common parameters.

Standard Parameters​

NameTypeDescription
patientreferencePatient information, if the resource is affixed to a person

Search Examples​

Via POST​

The POST method is recommended as it keeps health information out of the URL.

Search Medical Device by Patient
curl -X POST https://fhir.netsmartcloud.com/v4/Device/_search \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json" \
    -H "Content-Type: application/x-form-urlencoded" \
    -d "patient=Patient/2345"
Via GET​

The POST method is recommended as it keeps health information out of the URL.

Search by Patient
curl -X POST https://fhir.netsmartcloud.com/v4/Device?patient=Patient/2345 \
    -H "Authorization: {Bearer Token}" \
    -H "Accept: application/fhir+json"

Error Handling​

For information about error responses when working with Device resources, see Common Errors.

Common Device-related errors include:

  • Invalid device identifiers or UDI format
  • Missing required patient reference
  • Invalid device status codes
  • Malformed manufacture or expiration dates

Integration Patterns​

Device Safety Monitoring​

Track implanted devices for safety recalls:

# Get all active devices for patient
curl -X GET "https://fhir.netsmartcloud.com/v4/Device?patient=12345&status=active" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Clinical Documentation​

Document devices used in procedures:

# Get device details for clinical records
curl -X GET "https://fhir.netsmartcloud.com/v4/Device/12345" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Inventory Management​

Track device usage and expiration:

# Find devices by manufacturer
curl -X GET "https://fhir.netsmartcloud.com/v4/Device?manufacturer=Acme Medical" \
    -H "Authorization: Bearer {token}" \
    -H "Accept: application/fhir+json"

Relationships to Other Resources​

The Device resource connects to several clinical and administrative resources:

  • Patient - Individuals with implanted or assigned devices
  • Procedure - Procedures involving device implantation or use
  • Observation - Device-generated measurements and readings
  • Organization - Device manufacturers and suppliers
  • Practitioner - Healthcare providers managing devices

Support​

For questions about Device resource implementation or medical device tracking, contact Netsmart support through your designated support channels.