Device
Overview
For the Device resource query, the API returns a list of charted procedures that include Unique Device Identifiers (UDIs) for the patient. The list represents the most current procedure with UDI list that has been charted in Soarian.
Note that traditional charting practices have procedures resolved and charted in coding/billing systems and not interfaced back to the EMR, therefore, the procedure record in Soarian may not be complete nor precise to a procedure list provided as part of a patient’s billing record. The list of procedures in completed or aborted state with UDIs will be as charted in Soarian but may not represent a comprehensive state of implanted devices for a variety of operational reasons. The charting process flow for UDIs, both their implantation and ongoing status, is not fully mature and the charting at the point of care, material management and interventional/surgical systems is evolving. Clients may continue to chart patient devices outside a UDI process flow and the UDI list will not represent a comprehensive view of patient’s devices. Therefore, the Soarian Clinicals UDI information may not be complete nor representative of the current state of a patient’s implanted devices.
Note that the data returned with the UDI may be incomplete or inconsistent because the FDA (Food and Drug Administration) requirement for UDI labelling, effective 2017, states that manufacturers are responsible for populating an FDA database (GUDID) with information related to their devices; this UDI labelling and GUDID population is a new process and inconsistencies and gaps may exist in the data available. Soarian Clinicals has an ability to enter / scan and parse a UDI, query the FDA database (GUDID), and store information returned from the query. If the GUDID database is not available, empty, or partially populated, Soarian will store the UDI itself and any available information from the GUDID. The storage format, and therefore API response format is standardized, but GUDID-available data translated and stored may be inconsistent. The Soarian documentation defines any translation that is performed.
The FHIR definition of device is broader than the ONC definition of implantable device. The API Device response is per the ONC definition of those devices that are implanted and have a UDI. They are charted per encounter, per procedure where a patient may have:
- 1 or more visits, where each visit may have:
- 0 or more procedures charted in completed or aborted state, where each procedure may have:
- 0 or more devices with UDIs charted.
Terminology Bindings
| Device.identifier.type |
|
| Device.type |
|
Extensions
The bundle extension can be returned, see possible codes in the errors section below.
Search
GET /Device?:parameters
Implementation Notes
- The API returns the most current device list.
- The Narrative includes additional information pertaining to the device, and should be shown to the user to ensure completeness of clinical content and context. The structured component of the FHIR Device resource response will primarily contain the UDI and issuing authority for any entries in the list returned in the Narrative. This portion of the response may not be relevant to the user and should not be displayed.
Parameters
| Name | Required? | Type | Description |
|---|---|---|---|
| patientId | Y | reference |
The patient identifier provided in a pre-requisite authorization step. |
Headers
Accept: application/json+fhir
Authorization: <OAuth2 Bearer Token>Example
Request
GET https://fhir-myrecord.sandboxcerner.com/dstu2/123abc/Device?patientId=7568F2F3-FC76-4185-A540-1DB56331A387
Response
Status: 200 OK{
"resourceType": "Bundle",
"id": "80e6f1f5-5c79-482f-ab46-f27d6031e1c6",
"meta": {
"lastUpdated": "2017-04-27T10:52:59.689-04:00"
},
"extension": [
{
"url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
"valueExtension": {
"url": "http://cerner.hs.fhir.com/StructureDefinition/bundle-result-messages",
"extension": [
{
"url": "Severity",
"valueString": "info"
},
{
"url": "Code",
"valueString": "papi013"
},
{
"url": "Message",
"valueString": "This represents data charted for a procedure(s) performed on implanted devices with unique device identifiers. It may not represent a comprehensive device list or current device status. It is the responsibility of the patient or patient representative to confirm all implanted devices to appropriate care providers. "
}
]
}
}
],
"type": "searchset",
"link": [
{
"relation": "self",
"url": "base-url/bf615549-44cc-4899-bfa9-2cfd86bf358c/Device?patientId=7568F2F3-FC76-4185-A540-1DB56331A387+++++&_format=json"
}
],
"entry": [
{
"resource": {
"resourceType": "Device",
"text": {
"status": "additional",
"div": "<div ccdRefId="3001"><b>Introduction of Cardiac Pacemaker System via Vein [ Procedure Date: 10/5/2011 12:00 AM ] </b><br/> Device Description: CRT-D DTBA1QQ VIVA QUAD XT US IS4/DF4<br/> Surgical type: IMPLANT<br/> Device ID: (01)00643169007222(17)160128(21)BLC200461H<br/> MRI Safe: Labeling does not contain MRI Safety Information<br/> Natural Rubber/Latex indicator: No<br/> Company Name: MEDTRONIC, INC.<br/> Brand Name: Viva? Quad XT CRT-D<br/> Model #: DTBA1QQ<br/> Serial #: BLC200461H<br/></div>"
},
"identifier": [
{
"type": {
"coding": [
{
"system": "http://hl7.org/fhir/identifier-type",
"code": "SNO",
"display": "Serial Number"
}
],
"text": "Serial Number"
},
"value": "BLC200461H"
}
],
"type": {
"coding": [
{
"system": "urn:oid:2.16.840.1.113883.6.303",
"code": "KRG",
"display": "Programmer, pacemaker"
}
],
"text": "Programmer, pacemaker"
}
}
}
]
}Errors and Informational messages
The common errors and informational messages can be returned.
These additional informational messages may be returned within the bundle extension:
| Code | Message |
|---|---|
| papi014 | No implantable medical devices are associated with this query. |