Device
Overview
The Device resource Implementation is currently limited to devices such as pacemakers that are implanted in a patient as part of a charted procedure. As such, this resource currently exposes the known implant history for a patient occurring at this site.
Soarian Clinicals® supports a read-only Application Programming Interface (API). This API accepts GET
and POST
based search and GET
based read interactions. The response represents the most current information about the patient that is charted in Soarian Clinicals® at the time of the query.
The search results include the following fields if they contain values:
- Device id
- Identifier
- UDI carrier
- Status
- Distinct identifier
- Manufacture date
- Expiration date
- Lot number
- Serial number
- Type
- Patient
Terminology Bindings
Device.type |
|
Search
Search for Device resources that meet the specified query parameters:
GET /Device?:parameters
Authorization Types
Parameters
Name | Required? | Type | Description |
---|---|---|---|
_id |
This, or patient
|
token |
The logical resource ID associated with the resource. Example: 9005 |
patient |
This, or _id
|
reference |
The patient for the device record. Example: A879904FD2FE4B2D90C89FDA84E1285F |
_revinclude |
No | _revinclude |
A request to include any Provenance resource in the bundle that refers to a Device resource in the search results. Only supported with Provenance. |
Notes:
- The
_revinclude
parameter may be provided once with the valueProvenance:target
. Example:_revinclude=Provenance:target
- When
_revinclude
is provided in a request, the OAuth2 token must include thepatient/Provenance.read system/Provenance.read
oruser/Provenance.read
scope as applicable.
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example Search by Patient
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device?patient=A879904FD2FE4B2D90C89FDA84E1285F
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "424b4c86-956d-437e-9558-fa12c9e8c04a",
"type": "searchset",
"timestamp": "2022-05-14T13:40:15-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device/A879904FD2FE4B2D90C89FDA84E1285F.13004",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Device",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.13004",
"meta": {
"lastUpdated": "2021-03-02T15:48:46-05:00"
},
"status": "active",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "714547008",
"display": "Bone matrix implant, human derived (physical object)"
}
],
"text": "DBM Putty, 0.5cc"
},
"patient": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"udiCarrier": [
{
"deviceIdentifier": "W4184030005T0473",
"carrierHRF": "=/W4184030005T0473=,987654=DN0000000001234=>020177=}014183&,1230000000012345678"
}
],
"serialNumber": "987654",
"distinctIdentifier": "DN0000000001234",
"manufactureDate": "2014-07-02T00:00:00-04:00",
"expirationDate": "2020-06-25T00:00:00-04:00",
"lotNumber": "230000000012345678",
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Device</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Device Type</b>:<br /><b>System</b>:http://snomed.info/sct <b>Code</b>:714547008 <b>Display</b>:Bone matrix implant, human derived (physical object) <b>Text</b>:DBM Putty, 0.5cc;<br /><b>Distinct Identifier</b>:DN0000000001234;<br /><b>Carrier HRF</b>:=/W4184030005T0473=,987654=DN0000000001234=>020177=}014183&,1230000000012345678;<br /><b>Manufacture Date</b>:2014-07-02T00:00:00-04:00;<br /><b>Expiration Date</b>:2020-06-25T00:00:00-04:00;<br /><b>Lot Number</b>:230000000012345678;<br /><b>Serial Number</b>:987654;<br /><b>Status</b>:active;<br /><b>Device Identifier</b>:W4184030005T0473;<br /></div>"
}
}
},
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device/A879904FD2FE4B2D90C89FDA84E1285F.9005",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Device",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.9005",
"meta": {
"lastUpdated": "2020-11-13T17:02:40-05:00"
},
"status": "active",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "700803007",
"display": "Orthopedic prosthesis implantation instrument, reusable (physical object)"
}
],
"text": "Signature Femoral Drill Guide\r\n"
},
"patient": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"udiCarrier": [
{
"deviceIdentifier": "00880304510135",
"carrierHRF": "(01)00880304510135(17)170301(10)08080707J"
}
],
"expirationDate": "2017-03-01T00:00:00-05:00",
"lotNumber": "08080707J",
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Device</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Device Type</b>:<br /><b>System</b>:http://snomed.info/sct <b>Code</b>:700803007 <b>Display</b>:Orthopedic prosthesis implantation instrument, reusable (physical object) <b>Text</b>:Signature Femoral Drill Guide\r\n;<br /><b>Carrier HRF</b>:(01)00880304510135(17)170301(10)08080707J;<br /><b>Expiration Date</b>:2017-03-01T00:00:00-05:00;<br /><b>Lot Number</b>:08080707J;<br /><b>Status</b>:active;<br /><b>Device Identifier</b>:00880304510135;<br /></div>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device?patient=A879904FD2FE4B2D90C89FDA84E1285F"
}
]
}
Example Search by ID
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device?_id=A879904FD2FE4B2D90C89FDA84E1285F.9005
Response
Status: 200 OK
{
"resourceType": "Bundle",
"id": "424b4c86-956d-437e-9558-fa12c9e8c04a",
"type": "searchset",
"timestamp": "2022-05-14T13:40:15-04:00",
"entry": [
{
"fullUrl": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device/A879904FD2FE4B2D90C89FDA84E1285F.9005",
"search": {
"mode": "match"
},
"resource": {
"resourceType": "Device",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.9005",
"meta": {
"lastUpdated": "2020-11-13T17:02:40-05:00"
},
"status": "active",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "700803007",
"display": "Orthopedic prosthesis implantation instrument, reusable (physical object)"
}
],
"text": "Signature Femoral Drill Guide\r\n"
},
"patient": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"udiCarrier": [
{
"deviceIdentifier": "00880304510135",
"carrierHRF": "(01)00880304510135(17)170301(10)08080707J"
}
],
"expirationDate": "2017-03-01T00:00:00-05:00",
"lotNumber": "08080707J",
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Device</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Device Type</b>:<br /><b>System</b>:http://snomed.info/sct <b>Code</b>:700803007 <b>Display</b>:Orthopedic prosthesis implantation instrument, reusable (physical object) <b>Text</b>:Signature Femoral Drill Guide\r\n;<br /><b>Carrier HRF</b>:(01)00880304510135(17)170301(10)08080707J;<br /><b>Expiration Date</b>:2017-03-01T00:00:00-05:00;<br /><b>Lot Number</b>:08080707J;<br /><b>Status</b>:active;<br /><b>Device Identifier</b>:00880304510135;<br /></div>"
}
}
}
],
"link": [
{
"relation": "self",
"url": "https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device?patient=A879904FD2FE4B2D90C89FDA84E1285F.9005"
}
]
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
- The common errors and OperationOutcomes may be returned.
Retrieve by ID
List an individual Device resource by its ID:
GET /Device/:id
Authorization Types
Headers
Accept: application/fhir+json
Authorization: <OAuth2 Bearer Token>
Example
Request
GET https://fhir-myrecord-sc.cerner.com/r4/2f8f5ec1-b7b8-4be5-ae27-e308284dd9c1/Device?patient=A879904FD2FE4B2D90C89FDA84E1285F.9005
Response
Status: 200 OK
{
"resourceType": "Device",
"id": "A879904FD2FE4B2D90C89FDA84E1285F.9005",
"meta": {
"lastUpdated": "2020-11-13T17:02:40-05:00"
},
"status": "active",
"type": {
"coding": [
{
"system": "http://snomed.info/sct",
"code": "700803007",
"display": "Orthopedic prosthesis implantation instrument, reusable (physical object)"
}
],
"text": "Signature Femoral Drill Guide\r\n"
},
"patient": {
"reference": "Patient/A879904FD2FE4B2D90C89FDA84E1285F",
"display": "Mcgovern,Astrid Santiago"
},
"udiCarrier": [
{
"deviceIdentifier": "00880304510135",
"carrierHRF": "(01)00880304510135(17)170301(10)08080707J"
}
],
"expirationDate": "2017-03-01T00:00:00-05:00",
"lotNumber": "08080707J",
"text": {
"status": "generated",
"div": "<div xmlns="http://www.w3.org/1999/xhtml"><br /><b>Device</b><br /><b>Patient</b>:Mcgovern,Astrid Santiago;<br /><b>Device Type</b>:<br /><b>System</b>:http://snomed.info/sct <b>Code</b>:700803007 <b>Display</b>:Orthopedic prosthesis implantation instrument, reusable (physical object) <b>Text</b>:Signature Femoral Drill Guide\r\n;<br /><b>Carrier HRF</b>:(01)00880304510135(17)170301(10)08080707J;<br /><b>Expiration Date</b>:2017-03-01T00:00:00-05:00;<br /><b>Lot Number</b>:08080707J;<br /><b>Status</b>:active;<br /><b>Device Identifier</b>:00880304510135;<br /></div>"
}
}
Note: The examples provided here are non-normative and replaying them in the public sandbox is not guaranteed to yield the results shown on the site.
Errors
- The common errors and OperationOutcomes may be returned.