RDC Interoperability Guide
1.4.0

Fetch DeviceDefinition by ID

The client can fetch a specific DeviceDefinition resource by its FHIR ID. A DeviceDefinition describes the model of a device (manufacturer, model name, model number) and is not associated with any individual patient. As a result, no data-sharing consent is required to retrieve it.

Example

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

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

Response

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

The response resource contains:

Field Presence Description
id Always The FHIR ID of the device definition
meta.profile Always Identifies the Roche DeviceDefinition profile
modelNumber Always The model number (firmware/software version) of the device
manufacturer.display When available The name of the device manufacturer
deviceName When available The registered model name of the device

Example response:

{
  "resourceType": "DeviceDefinition",
  "id": "ed434a7c-8fd6-4382-ba7b-eccff3e6e07b",
  "meta": {
    "profile": [
      "https://roche.com/fhir/iop/StructureDefinition/rdc-DeviceDefinition"
    ]
  },
  "manufacturer": {
    "display": "Roche Diagnostics"
  },
  "deviceName": [
    {
      "name": "Accu-Chek Guide",
      "type": "registered-name"
    }
  ],
  "modelNumber": "2.0.0"
}

Error responses

Status Code Cause
400 Bad Request The provided ${device_definition_fhir_id} does not match the FHIR ID format [A-Za-z0-9\-.]{1,64}
404 Not Found No device definition 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.