Device - FHIR Resource (stu3)
This Device Resource uses the FHIR API standard for access and structure.
Validate an Device FHIR Resource (stu3)
Device Attributes
AttributeField is listTypeDescription
Description: active | inactive | entered-in-error | unknown
FHIR Version: stu3
Attribute Type : code
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"status": "active"Learn more about the (Device) status FHIR attribute
Description: Date when the device was made
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufactureDate": Learn more about the (Device) manufactureDate FHIR attribute
Description: Unique Device Identifier (UDI) Barcode string
FHIR Version: stu3
Attribute Type : Data Type
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"udi": Learn more about the (Device) udi FHIR attribute
Description: Patient to whom Device is affixed
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"patient": Learn more about the (Device) patient FHIR attribute
Description: Network address to contact device
FHIR Version: stu3
Attribute Type : uri
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"url": Learn more about the (Device) url FHIR attribute
Description: Lot number of manufacture
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"lotNumber": "43453424"Learn more about the (Device) lotNumber FHIR attribute
Description: Details for human/organization for support
FHIR Version: stu3
Attribute Type : ContactPoint
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"contact": [
{
"system": "phone",
"value": "ext 4352"
}
]Learn more about the (Device) contact FHIR attribute
Description: Device notes and comments
FHIR Version: stu3
Attribute Type : Annotation
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"note": [
{
"text": "QA Checked",
"time": "2015-06-28T14:03:32+10:00",
"authorReference": {
"reference": "Practitioner/xcda-author"
}
}
]Learn more about the (Device) note FHIR attribute
Description: Version number (i.e. software)
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"version": Learn more about the (Device) version FHIR attribute
Description: Safety Characteristics of Device
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"safety": Learn more about the (Device) safety FHIR attribute
Description: Where the resource is found
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"location": Learn more about the (Device) location FHIR attribute
Description: Organization responsible for device
FHIR Version: stu3
Attribute Type : Reference
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"owner": Learn more about the (Device) owner FHIR attribute
Description: Model id assigned by the manufacturer
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"model": "AB 45-J"Learn more about the (Device) model FHIR attribute
Description: Instance identifier
FHIR Version: stu3
Attribute Type : Identifier
Required: N/A
Countability: Array
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"identifier": [
{
"system": "http://goodcare.org/devices/id",
"value": "345675"
},
{
"type": {
"text": "Serial Number",
"coding": [
{
"code": "SNO",
"system": "http://hl7.org/fhir/identifier-type"
}
]
},
"value": "AMID-342135-8464"
}
]Learn more about the (Device) identifier FHIR attribute
Description: What kind of device this is
FHIR Version: stu3
Attribute Type : CodeableConcept
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"type": {
"text": "ECG",
"coding": [
{
"code": "86184003",
"system": "http://snomed.info/sct",
"display": "Electrocardiographic monitor and recorder"
}
]
}Learn more about the (Device) type FHIR attribute
Description: Name of device manufacturer
FHIR Version: stu3
Attribute Type : string
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"manufacturer": "Acme Devices, Inc"Learn more about the (Device) manufacturer FHIR attribute
Description: Date and time of expiry of this device (if applicable)
FHIR Version: stu3
Attribute Type : dateTime
Required: N/A
Countability: Singleton
Flags: N/A
Terminology bindings: N/A
Requirements: N/A
Comments: N/A
Example:
"expirationDate": Learn more about the (Device) expirationDate FHIR attribute
Device Example
{
"status": "active",
"resourceType": "Device",
"text": {
"status": "generated",
"div": "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p><b>Generated Narrative with Details</b></p><p><b>id</b>: example</p><p><b>identifier</b>: 345675, Serial Number = AMID-342135-8464</p><p><b>status</b>: active</p><p><b>type</b>: ECG <span>(Details : {SNOMED CT code '86184003' = 'Electrocardiographic monitor and recorder', given as 'Electrocardiographic monitor and recorder'})</span></p><p><b>lotNumber</b>: 43453424</p><p><b>manufacturer</b>: Acme Devices, Inc</p><p><b>model</b>: AB 45-J</p><p><b>contact</b>: ph: ext 4352</p><p><b>note</b>: QA Checked</p></div>"
},
"contact": [
{
"system": "phone",
"value": "ext 4352"
}
],
"note": [
{
"text": "QA Checked",
"time": "2015-06-28T14:03:32+10:00",
"authorReference": {
"reference": "Practitioner/xcda-author"
}
}
],
"lotNumber": "43453424",
"model": "AB 45-J",
"identifier": [
{
"system": "http://goodcare.org/devices/id",
"value": "345675"
},
{
"type": {
"text": "Serial Number",
"coding": [
{
"code": "SNO",
"system": "http://hl7.org/fhir/identifier-type"
}
]
},
"value": "AMID-342135-8464"
}
],
"type": {
"text": "ECG",
"coding": [
{
"code": "86184003",
"system": "http://snomed.info/sct",
"display": "Electrocardiographic monitor and recorder"
}
]
},
"id": "example",
"manufacturer": "Acme Devices, Inc"
}Device Structure
{
"resourceType" : "Device",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"identifier" : [{ Identifier }], // Instance identifier
"udi" : { // Unique Device Identifier (UDI) Barcode string
"deviceIdentifier" : "<string>", // Mandatory fixed portion of UDI
"name" : "<string>", // Device Name as appears on UDI label
"jurisdiction" : "<uri>", // Regional UDI authority
"carrierHRF" : "<string>", // UDI Human Readable Barcode String
"carrierAIDC" : "<base64Binary>", // UDI Machine Readable Barcode String
"issuer" : "<uri>", // UDI Issuing Organization
"entryType" : "<code>" // barcode | rfid | manual +
},
"status" : "<code>", // active | inactive | entered-in-error | unknown
"type" : { CodeableConcept }, // What kind of device this is
"lotNumber" : "<string>", // Lot number of manufacture
"manufacturer" : "<string>", // Name of device manufacturer
"manufactureDate" : "<dateTime>", // Date when the device was made
"expirationDate" : "<dateTime>", // Date and time of expiry of this device (if applicable)
"model" : "<string>", // Model id assigned by the manufacturer
"version" : "<string>", // Version number (i.e. software)
"patient" : { Reference(Patient) }, // Patient to whom Device is affixed
"owner" : { Reference(Organization) }, // Organization responsible for device
"contact" : [{ ContactPoint }], // Details for human/organization for support
"location" : { Reference(Location) }, // Where the resource is found
"url" : "<uri>", // Network address to contact device
"note" : [{ Annotation }], // Device notes and comments
"safety" : [{ CodeableConcept }] // Safety Characteristics of Device
}
Device Search Parameters
The following search parameters can be used to query Device resources. Just submit them like so:
https://api.1up.health/fhir/stu3/Device?query-param=queryvalue| Search Parameter | Field Type | Resource Fields Searched |
|---|---|---|
device-name | text | udi.name | Device.type.text | Device.type.coding.display.fined search that may match any of the string fields in the Device.udi.name or Device.type.coding.display or Device.type.text |
identifier | text | identifier |
location | reference | location |
manufacturer | text | manufacturer |
model | text | model |
organization | reference | owner |
patient | reference | patient |
status | text | status |
type | text | type |
udi-carrier | text | udi.carrierHRF, udi.carrierAIDC |
udi-di | text | udi.deviceIdentifier |
url | uri | url |
