Record Heart Rate Reading

1 curl -X POST https://app.impiloplatform.com/api/v3/heart-rate-reading \ 2 -H "Impilo-API-Key: <Impilo-API-Key>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "readingTimestamp": "foo" 6 }'

1 { 2 "readingTimestamp": "foo", 3 "device": { 4 "currentPatient": { 5 "firstName": "John", 6 "lastName": "Doe", 7 "address": { 8 "city": "foo", 9 "country": "foo", 10 "lineOne": "foo", 11 "state": "foo", 12 "zipCode": "foo", 13 "lineThree": "foo", 14 "lineTwo": "foo", 15 "note": "foo" 16 }, 17 "archived": true, 18 "dateOfBirth": "1980-01-01", 19 "email": "john.doe@example.com", 20 "enrolled": true, 21 "externalIdentifier": "1234abcd", 22 "id": 1, 23 "phoneNumber": "+1234567890", 24 "sex": "unknown", 25 "site": { 26 "active": true, 27 "address": { 28 "city": "foo", 29 "country": "foo", 30 "lineOne": "foo", 31 "state": "foo", 32 "zipCode": "foo", 33 "lineThree": "foo", 34 "lineTwo": "foo", 35 "note": "foo" 36 }, 37 "id": 1, 38 "name": "foo", 39 "phoneNumber": "foo" 40 } 41 }, 42 "currentStatus": "foo", 43 "deviceEvents": [ 44 { 45 "eventTimestamp": "foo", 46 "type": "foo" 47 } 48 ], 49 "deviceIdentifiers": [ 50 { 51 "type": "foo", 52 "value": "foo" 53 } 54 ], 55 "disabledReadings": false, 56 "externalIdentifier": "1d23-4567-89ab-cdef", 57 "id": 1, 58 "item": { 59 "id": 1, 60 "manufacturer": { 61 "id": 1, 62 "name": "foo" 63 }, 64 "model": "foo", 65 "name": "foo", 66 "orderable": true, 67 "sku": "foo" 68 }, 69 "lastHealthCheck": "2023-10-01T12:00:00Z", 70 "site": { 71 "active": true, 72 "address": { 73 "city": "foo", 74 "country": "foo", 75 "lineOne": "foo", 76 "state": "foo", 77 "zipCode": "foo", 78 "lineThree": "foo", 79 "lineTwo": "foo", 80 "note": "foo" 81 }, 82 "id": 1, 83 "name": "foo", 84 "phoneNumber": "foo" 85 }, 86 "used": true 87 }, 88 "deviceTimeZoneOffset": -14400, 89 "heartRate": 42, 90 "id": 42, 91 "item": { 92 "id": 1, 93 "manufacturer": { 94 "id": 1, 95 "name": "foo" 96 }, 97 "model": "foo", 98 "name": "foo", 99 "orderable": true, 100 "sku": "foo" 101 }, 102 "manual": true, 103 "patient": { 104 "firstName": "John", 105 "lastName": "Doe", 106 "address": { 107 "city": "foo", 108 "country": "foo", 109 "lineOne": "foo", 110 "state": "foo", 111 "zipCode": "foo", 112 "lineThree": "foo", 113 "lineTwo": "foo", 114 "note": "foo" 115 }, 116 "archived": true, 117 "dateOfBirth": "1980-01-01", 118 "email": "john.doe@example.com", 119 "enrolled": true, 120 "externalIdentifier": "1234abcd", 121 "id": 1, 122 "phoneNumber": "+1234567890", 123 "sex": "unknown", 124 "site": { 125 "active": true, 126 "address": { 127 "city": "foo", 128 "country": "foo", 129 "lineOne": "foo", 130 "state": "foo", 131 "zipCode": "foo", 132 "lineThree": "foo", 133 "lineTwo": "foo", 134 "note": "foo" 135 }, 136 "id": 1, 137 "name": "foo", 138 "phoneNumber": "foo" 139 } 140 }, 141 "patientTimeZoneOffset": -14400 142 }

Records a heart rate reading based on the provided request. Either a device ID, device identifier, or patient ID is required.

Request

This endpoint expects an object.

readingTimestampstringRequiredformat: "date-time"

The UTC timestamp at which the reading was taken.

deviceIdlongOptional

The id of the device that took the reading.

deviceIdentifierstringOptional

The device identifier of the device that took the reading.

deviceTimeZoneOffsetintegerOptional

The offset of the device's timezone from UTC in seconds. Null if unavailable.

heartRateintegerOptional

The heart rate measurement value.

manualbooleanOptional

True if the reading value was entered manually, false or null otherwise.

patientIdlongOptional

The id of the patient that took the reading.

Response

readingTimestampstringformat: "date-time"

The UTC timestamp at which the reading was taken.

deviceobjectOptional

A device is an instance of an item. Impilo creates device records for items that are serialized, i.e., items where each individual unit is identified by a serial number, IMEI, or other identifier.

deviceTimeZoneOffsetintegerOptional

The offset of the device's timezone from UTC in seconds. Null if unavailable.

heartRateintegerOptional

The heart rate measurement value.

idlongOptional

Unique identifier for the reading.

itemobjectOptional

An item is any of the supplies handled by Impilo. Examples include medical devices like a blood pressure monitor or weight scale, but the term ‘item’ also refers to non-medical supplies like AAA batteries and package inserts. A customer catalog is a subset of all items supported by Impilo. This is set during onboarding and may be modified by your account manager at any time. A customer may view the items in their catalog.

manualbooleanOptional

True if the reading value was entered manually, false or null otherwise.

patientobjectOptional

The Patient resource represents a patient in the Impilo system. It includes personal information, contact details, and enrollment status.

patientTimeZoneOffsetintegerOptional

The offset of the patient's timezone from UTC in seconds. Null if unavailable.

Headers

Request

Response