RDC Interoperability Guide
1.4.0

Fetch Device by ID

The client can fetch a specific Device resource by its FHIR ID. This is useful when the client already knows the FHIR ID of the device and wants to retrieve its details.

The device must belong to a patient for whom the requesting organization has a valid data-sharing consent. Attempting to fetch a device without the required consent will result in a 403 Forbidden response.

Example

curl -sS "https://${server}/${basePath}/Device/${device_fhir_id}" \
  -H "client_id: ${client_id}" \
  -H "client_secret: ${client_secret}" \
  -H "org_id: ${org_id}" \
  -H "certificate: ${certificate}" | jq

Where ${device_fhir_id} is the FHIR ID of the device to be fetched.

Response

On success, the server responds with 200 OK and a FHIR R5 Device resource conforming to the Roche profile https://roche.com/fhir/iop/StructureDefinition/rdc-Device.

The response resource contains:

Field Description
id The FHIR ID of the device
meta.profile Identifies the Roche Device profile
definition A reference to the associated DeviceDefinition resource describing the device model. The referenced DeviceDefinition can be fetched using the Fetch DeviceDefinition by ID endpoint.
serialNumber The serial number of the device

Example response:

{
  "resourceType": "Device",
  "id": "37f8e876-d3ef-40ed-aaf4-795c3f88ce6c",
  "meta": {
    "profile": [
      "https://roche.com/fhir/iop/StructureDefinition/rdc-Device"
    ]
  },
  "definition": {
    "reference": {
      "reference": "DeviceDefinition/ed434a7c-8fd6-4382-ba7b-eccff3e6e07b"
    }
  },
  "serialNumber": "SN-1234"
}

Error responses

Status Code Cause
400 Bad Request The provided ${device_fhir_id} does not match the FHIR ID format [A-Za-z0-9\-.]{1,64}
403 Forbidden The requesting organization does not have a valid data-sharing consent for the patient who owns the device
404 Not Found No device with the given FHIR ID exists
500 Internal Server Error An unexpected server-side error occurred

All error responses follow the FHIR OperationOutcome format described in Error Responses.