Device

A type of a manufactured item that is used in the provision of healthcare without being substantially changed through that activity. The device may be a medical or non-medical device.

http://hl7.org/fhir/us/core/STU3.1.1/StructureDefinition-us-core-implantable-device.html

For information about creating Device resources for a patient, see this Zendesk article. Devices are not currently used by the Canvas UI, but any devices that are created can be accessed with the Device read and search endpoints, In order to generate the type attribute, a device code must be created and linked to the device via the admin settings on Canvas.

Endpoints

get
/Device/{id}
 get
/Device
get
/Device/{id}

Device read

Path Parameters

id required
string
The unique identifier for the Device

Response Payload Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the Device

udiCarrier
array[json]

Unique Device Identifier (UDI) Barcode string.

Click to view child attributes
deviceIdentifier
string

Mandatory fixed portion of UDI.

carrierHRF
string

UDI Human Readable Barcode String.

status
enum [ active | inactive ]

Status of the Device availability.

distinctIdentifier
string

The distinct identification string. This will match the id attribute.

manufacturer
string

Name of device manufacturer.

manufactureDate
date

Date when the device was made.

expirationDate
date

Date of expiry of this device (if applicable).

lotNumber
string

Lot number of manufacture.

serialNumber
string

Serial number assigned by the manufacturer.

modelNumber
string

The model number for the device.

type
json

The kind or type of device.

Click to view child attributes
coding

A CodeableConcept combination of one or more coding elements.

Click to view child attributes
system
string

The system url of the coding.

code
string

The code of the category.

display
string

The display name of the coding.

patient
json

Patient to whom Device is affixed

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

Responses

200 OK
Request was successful.

Errors

401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
404 Not Found
The requested resource was not found.
get
/Device

Device search

Query Parameters

_id
string

The identifier of the Device.

patient
string

The patient reference associated to the Device in the format Patient/a39cafb9d1b445be95a2e2548e12a787.

Response Payload Attributes

resourceType
string

The FHIR Resource name.

type
string

This element and value designate that the bundle is a search response. Search result bundles will always have the Bundle.type of searchset .

total
integer

The number of resources that match the search parameter.

link
array[json]

Attributes relevant to pagination, see our Pagination page for more detail.

Click to view child attributes
relation
enum [self|first|next|last]

The relation of the page search

url

The search url for the specific relation

entry
array[json]

The results bundle that lists out each object returned in the search

Click to view child attributes
resource
json

The attributes specific to the resource type, see the Attributes section below

Attributes

resourceType
string

The FHIR Resource name.

id
string

The identifier of the Device

udiCarrier
array[json]

Unique Device Identifier (UDI) Barcode string.

Click to view child attributes
deviceIdentifier
string

Mandatory fixed portion of UDI.

carrierHRF
string

UDI Human Readable Barcode String.

status
enum [ active | inactive ]

Status of the Device availability.

distinctIdentifier
string

The distinct identification string. This will match the id attribute.

manufacturer
string

Name of device manufacturer.

manufactureDate
date

Date when the device was made.

expirationDate
date

Date of expiry of this device (if applicable).

lotNumber
string

Lot number of manufacture.

serialNumber
string

Serial number assigned by the manufacturer.

modelNumber
string

The model number for the device.

type
json

The kind or type of device.

Click to view child attributes
coding

A CodeableConcept combination of one or more coding elements.

Click to view child attributes
system
string

The system url of the coding.

code
string

The code of the category.

display
string

The display name of the coding.

patient
json

Patient to whom Device is affixed

Click to view child attributes
reference
string

The reference string of the subject in the format of "Patient/a39cafb9d1b445be95a2e2548e12a787".

type
string

Type the reference refers to (e.g. “Patient”).

Responses

200 OK
Request was successful.

Errors

400 Bad Request
The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401 Unauthorized
The request requires user authentication.
403 Forbidden
The request requires user authorization.
  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Device/<id>' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Device/<id>"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Device",
    "id": "c6bf6efc-1fe1-4221-9821-e60acb53becc",
    "udiCarrier":
    [
        {
            "deviceIdentifier": "08717648200274",
            "carrierHRF": "=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123"
        }
    ],
    "status": "active",
    "distinctIdentifier": "A99971312345600",
    "manufacturer": "ACME Biomedical",
    "manufactureDate": "2021-02-15",
    "expirationDate": "2021-09-15",
    "lotNumber": "234234",
    "serialNumber": "13213123123123",
    "modelNumber": "1.0",
    "type":
    {
        "coding":
        [
            {
                "system": "http://snomed.info/sct",
                "code": "2478003",
                "display": "Ocular prosthesis"
            }
        ]
    },
    "patient":
    {
        "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
        "type": "Patient"
    }
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "not-found",
      "details": {
        "text": "Unknown Device resource 'a47c7b0e-bbb4-42cd-bc4a-df259d148ea1'"
      }
    }
  ]
}

  • curl --request GET \
     --url 'https://fumage-example.canvasmedical.com/Device?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0' \
     --header 'Authorization: Bearer <token>' \
     --header 'accept: application/json'

  • import requests

url = "https://fumage-example.canvasmedical.com/Device?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0"

headers = {
    "accept": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

  • {
    "resourceType": "Bundle",
    "type": "searchset",
    "total": 1,
    "link": [
        {
            "relation": "self",
            "url": "/Device/?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
        },
        {
            "relation": "first",
            "url": "/Device/?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
        },
        {
            "relation": "last",
            "url": "/Device/?patient=Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0&_count=10&_offset=0"
        }
    ],
    "entry": [
        {
            "resource": {
                "resourceType": "Device",
                "id": "c6bf6efc-1fe1-4221-9821-e60acb53becc",
                "udiCarrier": [
                    {
                        "deviceIdentifier": "08717648200274",
                        "carrierHRF": "=/08717648200274=,000025=A99971312345600=>014032=}013032&,1000000000000XYZ123"
                    }
                ],
                "status": "active",
                "distinctIdentifier": "A99971312345600",
                "manufacturer": "ACME Biomedical",
                "manufactureDate": "2021-02-15",
                "expirationDate": "2021-09-15",
                "lotNumber": "234234",
                "serialNumber": "13213123123123",
                "modelNumber": "1.0",
                "type": {
                    "coding": [
                        {
                            "system": "http://snomed.info/sct",
                            "code": "2478003",
                            "display": "Ocular prosthesis"
                        }
                    ]
                },
                "patient": {
                    "reference": "Patient/b8dfa97bdcdf4754bcd8197ca78ef0f0",
                    "type": "Patient"
                }
            }
        }
    ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "invalid",
      "details": {
        "text": "Bad request"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "unknown",
      "details": {
        "text": "Authentication failed"
      }
    }
  ]
}

  • {
  "resourceType": "OperationOutcome",
  "issue": [
    {
      "severity": "error",
      "code": "forbidden",
      "details": {
        "text": "Authorization failed"
      }
    }
  ]
}