Record Blood Oxygen Reading

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

For more information see the BloodOxygenReadingRequest Model.

Request

This endpoint expects an object.

readingTimestampdatetimeRequired

The UTC timestamp at which the reading was taken.

bloodOxygenintegerRequired

The blood oxygen (spo2) measurement value.

deviceIdlongOptional

The id of the device that took the reading.

deviceIdentifierstringOptional

The device identifier of the device that took the reading.

patientIdlongOptional

The id of the patient 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.

Response

This endpoint returns an object.

readingTimestampdatetime

The UTC timestamp at which the reading was taken.

idlongOptional

Unique identifier for the reading.

manualbooleanOptional

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

deviceTimeZoneOffsetintegerOptional

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

patientTimeZoneOffsetintegerOptional

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

patientobjectOptional

The patient who took the reading.

itemobjectOptional

The item used to take the reading.

deviceobjectOptional

The device used to take the reading.

bloodOxygenintegerOptional

The blood oxygen (spo2) measurement value.

bloodOxygenUnit"spo2"Optional

Allowed values: spo2

heartRateintegerOptional

The heart rate measurement value.

heartRateUnit"bpm"Optional

Allowed values: bpm

1 curl -X POST https://app.impiloplatform.com/api/v3/blood-oxygen-reading \ 2 -H "Impilo-API-Key: <apiKey>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "readingTimestamp": "2024-07-04T00:00:00Z", 6 "bloodOxygen": 88, 7 "deviceId": 599, 8 "deviceTimeZoneOffset": -14400, 9 "heartRate": 77, 10 "manual": false 11 }'

1 { 2 "readingTimestamp": "2024-07-04T00:00:00Z", 3 "id": 42, 4 "manual": false, 5 "deviceTimeZoneOffset": -14400, 6 "patientTimeZoneOffset": -14400, 7 "patient": { 8 "firstName": "John", 9 "lastName": "Doe", 10 "address": { 11 "lineOne": "1234 Market Street", 12 "city": "Philadelphia", 13 "state": "PA", 14 "zipCode": "19137", 15 "country": "USA", 16 "lineTwo": "Suite 110", 17 "lineThree": "lineThree", 18 "note": "note" 19 }, 20 "id": 456, 21 "externalIdentifier": "external-identifier-123", 22 "dateOfBirth": "1987-09-13", 23 "email": "email@example.com", 24 "phoneNumber": "111-222-3333", 25 "archived": true, 26 "site": { 27 "id": 1, 28 "name": "name", 29 "active": true, 30 "address": { 31 "lineOne": "lineOne", 32 "city": "city", 33 "state": "state", 34 "zipCode": "zipCode", 35 "country": "country" 36 } 37 }, 38 "enrolled": true, 39 "sex": "unknown" 40 }, 41 "item": { 42 "id": 791, 43 "manufacturer": { 44 "id": 2, 45 "name": "Custom Manufacturer" 46 }, 47 "name": "Blood Pressure Monitor", 48 "model": "iBloodPressureMonitor123", 49 "sku": "0000001", 50 "orderable": true 51 }, 52 "device": { 53 "id": 599, 54 "item": { 55 "id": 791, 56 "manufacturer": { 57 "id": 2, 58 "name": "Custom Manufacturer" 59 }, 60 "name": "Blood Pressure Monitor", 61 "model": "iBloodPressureMonitor123", 62 "sku": "0000001", 63 "orderable": true 64 }, 65 "currentStatus": "withPatient", 66 "used": true, 67 "currentPatient": { 68 "firstName": "John", 69 "lastName": "Doe", 70 "address": { 71 "lineOne": "1234 Market Street", 72 "city": "Philadelphia", 73 "state": "PA", 74 "zipCode": "19137", 75 "country": "USA", 76 "lineTwo": "Suite 110" 77 }, 78 "id": 456, 79 "externalIdentifier": "external-identifier-123", 80 "dateOfBirth": "1987-09-13", 81 "email": "email@example.com", 82 "phoneNumber": "111-222-3333", 83 "archived": true, 84 "site": { 85 "id": 1 86 }, 87 "enrolled": true, 88 "sex": "unknown" 89 }, 90 "site": { 91 "id": 1, 92 "name": "name", 93 "active": true, 94 "address": { 95 "lineOne": "lineOne", 96 "city": "city", 97 "state": "state", 98 "zipCode": "zipCode", 99 "country": "country" 100 } 101 }, 102 "lastHealthCheck": "lastHealthCheck", 103 "deviceIdentifiers": [ 104 { 105 "type": "imei", 106 "value": "354833969951611" 107 }, 108 { 109 "type": "serial", 110 "value": "A44-A0623930" 111 }, 112 { 113 "type": "macAddress", 114 "value": "f51da43314fc" 115 } 116 ], 117 "deviceEvents": [ 118 {} 119 ], 120 "externalIdentifier": "externalIdentifier", 121 "disabledReadings": false 122 }, 123 "bloodOxygen": 95, 124 "bloodOxygenUnit": "spo2", 125 "heartRate": 90, 126 "heartRateUnit": "bpm" 127 }

1	curl -X POST https://app.impiloplatform.com/api/v3/blood-oxygen-reading \
2	-H "Impilo-API-Key: <apiKey>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"readingTimestamp": "2024-07-04T00:00:00Z",
6	"bloodOxygen": 88,
7	"deviceId": 599,
8	"deviceTimeZoneOffset": -14400,
9	"heartRate": 77,
10	"manual": false
11	}'

1	{
2	"readingTimestamp": "2024-07-04T00:00:00Z",
3	"id": 42,
4	"manual": false,
5	"deviceTimeZoneOffset": -14400,
6	"patientTimeZoneOffset": -14400,
7	"patient": {
8	"firstName": "John",
9	"lastName": "Doe",
10	"address": {
11	"lineOne": "1234 Market Street",
12	"city": "Philadelphia",
13	"state": "PA",
14	"zipCode": "19137",
15	"country": "USA",
16	"lineTwo": "Suite 110",
17	"lineThree": "lineThree",
18	"note": "note"
19	},
20	"id": 456,
21	"externalIdentifier": "external-identifier-123",
22	"dateOfBirth": "1987-09-13",
23	"email": "email@example.com",
24	"phoneNumber": "111-222-3333",
25	"archived": true,
26	"site": {
27	"id": 1,
28	"name": "name",
29	"active": true,
30	"address": {
31	"lineOne": "lineOne",
32	"city": "city",
33	"state": "state",
34	"zipCode": "zipCode",
35	"country": "country"
36	}
37	},
38	"enrolled": true,
39	"sex": "unknown"
40	},
41	"item": {
42	"id": 791,
43	"manufacturer": {
44	"id": 2,
45	"name": "Custom Manufacturer"
46	},
47	"name": "Blood Pressure Monitor",
48	"model": "iBloodPressureMonitor123",
49	"sku": "0000001",
50	"orderable": true
51	},
52	"device": {
53	"id": 599,
54	"item": {
55	"id": 791,
56	"manufacturer": {
57	"id": 2,
58	"name": "Custom Manufacturer"
59	},
60	"name": "Blood Pressure Monitor",
61	"model": "iBloodPressureMonitor123",
62	"sku": "0000001",
63	"orderable": true
64	},
65	"currentStatus": "withPatient",
66	"used": true,
67	"currentPatient": {
68	"firstName": "John",
69	"lastName": "Doe",
70	"address": {
71	"lineOne": "1234 Market Street",
72	"city": "Philadelphia",
73	"state": "PA",
74	"zipCode": "19137",
75	"country": "USA",
76	"lineTwo": "Suite 110"
77	},
78	"id": 456,
79	"externalIdentifier": "external-identifier-123",
80	"dateOfBirth": "1987-09-13",
81	"email": "email@example.com",
82	"phoneNumber": "111-222-3333",
83	"archived": true,
84	"site": {
85	"id": 1
86	},
87	"enrolled": true,
88	"sex": "unknown"
89	},
90	"site": {
91	"id": 1,
92	"name": "name",
93	"active": true,
94	"address": {
95	"lineOne": "lineOne",
96	"city": "city",
97	"state": "state",
98	"zipCode": "zipCode",
99	"country": "country"
100	}
101	},
102	"lastHealthCheck": "lastHealthCheck",
103	"deviceIdentifiers": [
104	{
105	"type": "imei",
106	"value": "354833969951611"
107	},
108	{
109	"type": "serial",
110	"value": "A44-A0623930"
111	},
112	{
113	"type": "macAddress",
114	"value": "f51da43314fc"
115	}
116	],
117	"deviceEvents": [
118	{}
119	],
120	"externalIdentifier": "externalIdentifier",
121	"disabledReadings": false
122	},
123	"bloodOxygen": 95,
124	"bloodOxygenUnit": "spo2",
125	"heartRate": 90,
126	"heartRateUnit": "bpm"
127	}