Record Blood Oxygen Reading

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

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

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

Request

This endpoint expects an object.

bloodOxygenintegerRequired

The blood oxygen (spo2) measurement value.

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.

bloodOxygenintegerOptional

The blood oxygen (spo2) measurement value.

bloodOxygenUnitenumOptional

Allowed values:

deviceobjectOptional

The device used to take the reading.

deviceTimeZoneOffsetintegerOptional

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

heartRateintegerOptional

The heart rate measurement value.

heartRateUnitenumOptional

Allowed values:

idlongOptional

Unique identifier for the reading.

itemobjectOptional

The item used to take the reading.

manualbooleanOptional

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

patientobjectOptional

The patient who took the reading.

patientTimeZoneOffsetintegerOptional

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

Headers

Request

Response