Device - FHIR Resource (stu3)


Resource Attributes

AttributeField is listTypeDescription
contacttrueContactPoint Details for human/organization for support
expirationDatefalsedateTime Date and time of expiry of this device (if applicable)
identifiertrueIdentifier Instance identifier
locationfalseReference Where the resource is found
lotNumberfalsestring Lot number of manufacture
manufactureDatefalsedateTime Date when the device was made
manufacturerfalsestring Name of device manufacturer
modelfalsestring Model id assigned by the manufacturer
notetrueAnnotation Device notes and comments
ownerfalseReference Organization responsible for device
patientfalseReference Patient to whom Device is affixed
safetytrueCodeableConcept Safety Characteristics of Device
statusfalsecode active | inactive | entered-in-error | unknown
typefalseCodeableConcept What kind of device this is
udifalseData Type Unique Device Identifier (UDI) Barcode string
urlfalseuri Network address to contact device
versionfalsestring Version number (i.e. software)

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 the like so:

https://api.1up.health/fhir/stu3/Device?query-param=queryvalue
Search ParameterField TypeResource Fields Searched
device-nametextudi.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
identifiertextidentifier
locationreferencelocation
manufacturertextmanufacturer
modeltextmodel
organizationreferenceowner
patientreferencepatient
statustextstatus
typetexttype
udi-carriertextudi.carrierHRF, udi.carrierAIDC
udi-ditextudi.deviceIdentifier
urluriurl