Data Dictionaries
- clientDeviceId: a unique identifier for this device. Equivalent to the hwi-device-id for HWI clients.
- deviceName: the name of the device.
- gatewayId: the Gateway ID (or other unique hardware ID) associated with this device, if applicable.
- patientId: the “external_id” provided for the Patient associated with this device, if applicable. Note, this field is typically used to link devices/patients to unique user objects in an external system (e.g., a Patient’s EMR ID).
- patientName: the name of the Patient associated with this device, if applicable.
- patientPhysician: the Physician name provided for the Patient associated with this device, if applicable.
- patientClinicName: the Clinic name provided for the Patient associated with this device, if applicable. Note, for RPM software clients, this is NOT the Patient’s RPM facility.
- patientCareManager: the Care Manager name provided for the Patient associated with this device, if applicable.
- rpmFacility: the name of the RPM Facility the Patient associated with this devices is assigned to (applies to RPM clients only).
- shippingAddress: The shipping address provided for this device, if applicable.
- requestedDate: The date this device was requested (for dropshipped orders) or originally activated (if a Gateway ID was provided at creation).
- shippedDate: the date and time this device was shipped, if applicable.
- deliveredDate: the date and time this device was delivered, if applicable.
- connectedDate: the date and time the first measurement was uploaded to our data server for this device, if applicable.
- unlinkedDate: the date and time the Gateway ID was removed from this device.
- lastMeasurementDate: the timestamp of the latest measurement received for this device. Note, this could be earlier than the connectedDate if a user takes a timestamped reading from a device but does not upload it with their Gateway until later. In this case, the connectedDate will be the date and time the measurement was uploaded, and the lastMeasurementDate will be the original timestamp recorded when the measurement was taken.
- lastModifiedDate: the date and time the status was last updated for this device. For example, if the status is “Unlinked”, this field will show the date and time the Gateway ID was removed from this device.
- status: the current status of this device. Valid options are: Pending Shipment, Dropship Requested, Shipped, Dropshipped, Delivered, Returned, Connected, Replaced, and Unlinked.