Jump to

• Request
• Response

Get a list of devices

get

/Device

Note: The FHIR API endpoints described below are currently pending production deployment for electronic health record (EHR) environments. Developers are welcome and encouraged to develop against the specifications in anticipation of production availability, which will be announced at a later date.

Retrieves a list of devices that meet the supplied query parameters.

Request

Query Parameters

• _id: string
  The logical resource ID.
• _revinclude: string
  The related Provenance resources to include in the search bundle.

  Allowed Values: [ "Provenance:target" ]
• patient: string
  The patient to whom the device is affixed.

Header Parameters

• accept(required): string

  The media type to be requested.

  Example: application/fhir+json

• authorization(required): string
  The credentials to authenticate a consumer to the service. This should be the OAuth2 Bearer Token.

There's no request body for this operation.

Back to Top

Response

200 Response

Successful search response.

Body ()

Root Schema : schema

Type: object

Show Source

• entry: array entry
• id(required): string
• link: array link
• resourceType(required): string
  Allowed Values: [ "Bundle" ]
• type(required): string

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Bundle"
            ]
        },
        "id":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "link":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/BundleLink"
            }
        },
        "entry":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "fullUrl":{
                        "type":"string",
                        "format":"uri"
                    },
                    "resource":{
                        "$ref":"#/components/schemas/Device"
                    },
                    "search":{
                        "$ref":"#/components/schemas/Search"
                    }
                }
            }
        }
    }
}

Nested Schema : entry

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "fullUrl":{
                "type":"string",
                "format":"uri"
            },
            "resource":{
                "$ref":"#/components/schemas/Device"
            },
            "search":{
                "$ref":"#/components/schemas/Search"
            }
        }
    }
}

Nested Schema : link

Type: array

Show Source

• Array of: object BundleLink

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/BundleLink"
    }
}

Nested Schema : items

Type: object

Show Source

• fullUrl: string (uri)
• resource: object Device
• search: object Search

{
    "type":"object",
    "properties":{
        "fullUrl":{
            "type":"string",
            "format":"uri"
        },
        "resource":{
            "$ref":"#/components/schemas/Device"
        },
        "search":{
            "$ref":"#/components/schemas/Search"
        }
    }
}

Nested Schema : Device

Type: object

Show Source

• distinctIdentifier: string
  (USCDI) The distinct identification string.
• expirationDate: string (date-time)
  (USCDI) The date and time of expiry of this device (if applicable).
• id(required): string
• lotNumber: string
  (USCDI) The manufacture lot number.
• manufactureDate: string (date-time)
  (USCDI) The date when the device was made.
• patient(required): patient
  (USCDI) The patient to whom the device is affixed.
• resourceType(required): string
  Allowed Values: [ "Device" ]
• serialNumber: string
  (USCDI) The serial number assigned by the manufacturer.
• type(required): type
  (USCDI) The kind or type of device.
• udiCarrier: array udiCarrier
  (USCDI) The unique device identifier (UDI) barcode string.

{
    "type":"object",
    "required":[
        "resourceType",
        "id",
        "type",
        "patient"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "Device"
            ]
        },
        "id":{
            "type":"string"
        },
        "udiCarrier":{
            "type":"array",
            "description":"(USCDI) The unique device identifier (UDI) barcode string.",
            "items":{
                "$ref":"#/components/schemas/DeviceUdiCarrier"
            }
        },
        "distinctIdentifier":{
            "type":"string",
            "description":"(USCDI) The distinct identification string."
        },
        "manufactureDate":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The date when the device was made."
        },
        "expirationDate":{
            "type":"string",
            "format":"date-time",
            "description":"(USCDI) The date and time of expiry of this device (if applicable)."
        },
        "lotNumber":{
            "type":"string",
            "description":"(USCDI) The manufacture lot number."
        },
        "serialNumber":{
            "type":"string",
            "description":"(USCDI) The serial number assigned by the manufacturer."
        },
        "type":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/CodeableConcept"
                }
            ],
            "description":"(USCDI) The kind or type of device."
        },
        "patient":{
            "allOf":[
                {
                    "$ref":"#/components/schemas/Reference"
                }
            ],
            "description":"(USCDI) The patient to whom the device is affixed."
        }
    }
}

Nested Schema : Search

Type: object

Show Source

• mode: string

{
    "type":"object",
    "properties":{
        "mode":{
            "type":"string"
        }
    }
}

Nested Schema : patient

(USCDI) The patient to whom the device is affixed.

Match All

(USCDI) The patient to whom the device is affixed.

Show Source

• object Reference

{
    "allOf":[
        {
            "$ref":"#/components/schemas/Reference"
        }
    ],
    "description":"(USCDI) The patient to whom the device is affixed."
}

Nested Schema : type

(USCDI) The kind or type of device.

Match All

(USCDI) The kind or type of device.

Show Source

• object CodeableConcept

{
    "allOf":[
        {
            "$ref":"#/components/schemas/CodeableConcept"
        }
    ],
    "description":"(USCDI) The kind or type of device."
}

Nested Schema : udiCarrier

Type: array

(USCDI) The unique device identifier (UDI) barcode string.

Show Source

• Array of: object DeviceUdiCarrier

{
    "type":"array",
    "description":"(USCDI) The unique device identifier (UDI) barcode string.",
    "items":{
        "$ref":"#/components/schemas/DeviceUdiCarrier"
    }
}

Nested Schema : Reference

Type: object

Show Source

• reference: string
• type: string

{
    "type":"object",
    "properties":{
        "reference":{
            "type":"string"
        },
        "type":{
            "type":"string"
        }
    }
}

Nested Schema : CodeableConcept

Type: object

Show Source

• coding: array coding
• text: string

{
    "type":"object",
    "properties":{
        "coding":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Coding"
            }
        },
        "text":{
            "type":"string"
        }
    }
}

Nested Schema : coding

Type: array

Show Source

• Array of: object Coding

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Coding"
    }
}

Nested Schema : Coding

Type: object

Show Source

• code: string
• display: string
• system: string (uri)

{
    "type":"object",
    "properties":{
        "system":{
            "type":"string",
            "format":"uri"
        },
        "code":{
            "type":"string"
        },
        "display":{
            "type":"string"
        }
    }
}

Nested Schema : DeviceUdiCarrier

Type: object

Show Source

• carrierHRF: string
  (USCDI) The UDI carrier's human-readable barcode string.
• deviceIdentifier(required): string
  (USCDI) The mandatory fixed portion of the UDI.

{
    "type":"object",
    "required":[
        "deviceIdentifier"
    ],
    "properties":{
        "deviceIdentifier":{
            "type":"string",
            "description":"(USCDI) The mandatory fixed portion of the UDI."
        },
        "carrierHRF":{
            "type":"string",
            "description":"(USCDI) The UDI carrier's human-readable barcode string."
        }
    }
}

Nested Schema : BundleLink

Type: object

Show Source

• relation: string
  Allowed Values: [ "self", "next", "previous" ]
• url: string (uri)

{
    "type":"object",
    "properties":{
        "relation":{
            "type":"string",
            "enum":[
                "self",
                "next",
                "previous"
            ]
        },
        "url":{
            "type":"string",
            "format":"uri"
        }
    }
}

Default Response

An OperationOutcome describing any error that occurred.

Body ()

Root Schema : OperationOutcome

Type: object

Show Source

• issue(required): array issue
• resourceType(required): string
  Allowed Values: [ "OperationOutcome" ]

{
    "type":"object",
    "required":[
        "resourceType",
        "issue"
    ],
    "properties":{
        "resourceType":{
            "type":"string",
            "enum":[
                "OperationOutcome"
            ]
        },
        "issue":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "severity",
                    "code"
                ],
                "properties":{
                    "severity":{
                        "type":"string"
                    },
                    "code":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : issue

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "severity",
            "code"
        ],
        "properties":{
            "severity":{
                "type":"string"
            },
            "code":{
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• code(required): string
• severity(required): string

{
    "type":"object",
    "required":[
        "severity",
        "code"
    ],
    "properties":{
        "severity":{
            "type":"string"
        },
        "code":{
            "type":"string"
        }
    }
}

Back to Top