Resources

Models

This page provides a comprehensive overview of all the models utilized within our APIs, accompanied by example JSON bodies for each. Here, you’ll find detailed descriptions and structures to help you understand how to effectively interact with our APIs, ensuring smooth integration and effective communication between your systems and ours.

Address

Represents a physical address, including information such as street lines, city, state, zip code, country, and an optional note for additional details.

Properties

NameTypeRequiredDescription
lineOnestringfalseAddress line one.
lineTwostringfalseAddress line two.
lineThreestringfalseAddress line three.
citystringfalseAddress city.
statestringfalseAddress state.
zipCodestringfalseAddress zip code.
countrystringfalseAddress country.
notestringfalseAddress note.
Address Model Sample
1{
2 "lineOne": "string",
3 "lineTwo": "string",
4 "lineThree": "string",
5 "city": "string",
6 "state": "string",
7 "zipCode": "string",
8 "country": "string",
9 "note": "string"
10}

AssociateDeviceRequest

Properties

NameTypeRequiredDescription
deviceIdinteger(int64)falseThe ID of the device. Either this value or a Device Identifier are required to identify the Device.
deviceIdentifierstringfalseThe Identifier, such as a Serial Number, of the device. Either this value or a Device Id are required to identify the Device.
patientIdinteger(int64)falseThe ID of the patient to have the Device associated to. Either this value or a Patient External Identifier are required to identify who should be (dis)associated with the device.
patientExternalIdentifierstringfalseThe External Identifier of the patient to have the Device (dis)associated to. Either this value or a Patient Id are required to identify who should be (dis)associated with the device.
AssociateDeviceRequest Model Sample
1{
2 "deviceId": 1,
3 "deviceIdentifier": "ABC123",
4 "patientId": 0,
5 "patientExternalIdentifier": "string"
6}

BloodGlucoseReading

This page describes Impilo’s blood glucose reading model.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the reading.
patientPatientfalseThe patient who took the reading.
itemItemfalseThe item used to take the reading.
deviceDevicefalseThe device used to take the reading.
readingTimestampstringfalseThe timestamp at which the reading was taken.
glucoseinteger(int32)falseThe blood glucose measurement value.
manualbooleanfalseTrue if the reading value was entered manually, false otherwise.
beforeMealbooleanfalseTrue if the reading was taken before a meal, false otherwise.
afterMealbooleanfalseTrue if the reading was taken after a meal, false otherwise.
BloodGlucoseReading Model Sample
1{
2 "id": 0,
3 "patient": {
4 "id": 1,
5 "externalIdentifier": "1234abcd",
6 "firstName": "John",
7 "lastName": "Doe",
8 "dateOfBirth": "1980-01-01",
9 "email": "john.doe@example.com",
10 "phoneNumber": "+1234567890",
11 "archived": true,
12 "address": {
13 "lineOne": "string",
14 "lineTwo": "string",
15 "lineThree": "string",
16 "city": "string",
17 "state": "string",
18 "zipCode": "string",
19 "country": "string",
20 "note": "string"
21 },
22 "site": {
23 "id": 1,
24 "name": "string",
25 "active": true,
26 "address": {
27 "lineOne": "string",
28 "lineTwo": "string",
29 "lineThree": "string",
30 "city": "string",
31 "state": "string",
32 "zipCode": "string",
33 "country": "string",
34 "note": "string"
35 }
36 },
37 "enrolled": true,
38 "sex": "female"
39 },
40 "item": {
41 "id": 1,
42 "manufacturer": {
43 "id": 1,
44 "name": "string"
45 },
46 "name": "string",
47 "model": "string",
48 "sku": "string"
49 },
50 "device": {
51 "id": 1,
52 "item": {
53 "id": 1,
54 "manufacturer": {
55 "id": 1,
56 "name": "string"
57 },
58 "name": "string",
59 "model": "string",
60 "sku": "string"
61 },
62 "currentStatus": "string",
63 "used": true,
64 "currentPatient": {
65 "id": 1,
66 "externalIdentifier": "1234abcd",
67 "firstName": "John",
68 "lastName": "Doe",
69 "dateOfBirth": "1980-01-01",
70 "email": "john.doe@example.com",
71 "phoneNumber": "+1234567890",
72 "archived": true,
73 "address": {
74 "lineOne": "string",
75 "lineTwo": "string",
76 "lineThree": "string",
77 "city": "string",
78 "state": "string",
79 "zipCode": "string",
80 "country": "string",
81 "note": "string"
82 },
83 "site": {
84 "id": 1,
85 "name": "string",
86 "active": true,
87 "address": {
88 "lineOne": "string",
89 "lineTwo": "string",
90 "lineThree": "string",
91 "city": "string",
92 "state": "string",
93 "zipCode": "string",
94 "country": "string",
95 "note": "string"
96 }
97 },
98 "enrolled": true,
99 "sex": "female"
100 },
101 "site": {
102 "id": 1,
103 "name": "string",
104 "active": true,
105 "address": {
106 "lineOne": "string",
107 "lineTwo": "string",
108 "lineThree": "string",
109 "city": "string",
110 "state": "string",
111 "zipCode": "string",
112 "country": "string",
113 "note": "string"
114 }
115 },
116 "lastHealthCheck": "string",
117 "deviceIdentifiers": [
118 {
119 "type": "string",
120 "value": "string"
121 }
122 ],
123 "deviceEvents": [
124 {
125 "type": "string",
126 "eventTimestamp": "string"
127 }
128 ],
129 "externalIdentifier": "string",
130 "disabledReadings": true
131 },
132 "readingTimestamp": "string",
133 "glucose": 0,
134 "manual": true,
135 "beforeMeal": true,
136 "afterMeal": true
137}

BloodGlucoseReadingRequest

This page describes Impilo’s blood glucose reading model.

Properties

NameTypeRequiredDescription
deviceIdinteger(int64)falseThe id of the device that took the reading.
deviceIdentifierstringfalseThe device identifier of the device that took the reading.
patientIdinteger(int64)falseThe id of the patient that took the reading.
readingTimestampstring(date-time)trueThe timestamp at which the reading was taken.
glucoseinteger(int32)trueThe blood glucose measurement value.
manualbooleanfalseTrue if the reading value was entered manually, false or null otherwise.
beforeMealbooleanfalseTrue if the reading was taken before a meal, false otherwise.
afterMealbooleanfalseTrue if the reading was taken after a meal, false otherwise.
BloodGlucoseReadingRequest Model Sample
1{
2 "deviceId": 0,
3 "deviceIdentifier": "string",
4 "patientId": 0,
5 "readingTimestamp": "2022-03-10T16:15:50Z",
6 "glucose": 0,
7 "manual": true,
8 "beforeMeal": true,
9 "afterMeal": true
10}

BloodOxygenReading

This page describes Impilo’s blood oxygen reading model.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the reading.
patientPatientfalseThe patient who took the reading.
itemItemfalseThe item used to take the reading.
deviceDevicefalseThe device used to take the reading.
readingTimestampstringfalseThe timestamp at which the reading was taken.
bloodOxygeninteger(int32)falseThe blood oxygen (spo2) measurement value.
heartRateinteger(int32)falseThe heart rate measurement value.
manualbooleanfalseTrue if the reading value was entered manually, false otherwise.
BloodOxygenReading Model Sample
1{
2 "id": 0,
3 "patient": {
4 "id": 1,
5 "externalIdentifier": "1234abcd",
6 "firstName": "John",
7 "lastName": "Doe",
8 "dateOfBirth": "1980-01-01",
9 "email": "john.doe@example.com",
10 "phoneNumber": "+1234567890",
11 "archived": true,
12 "address": {
13 "lineOne": "string",
14 "lineTwo": "string",
15 "lineThree": "string",
16 "city": "string",
17 "state": "string",
18 "zipCode": "string",
19 "country": "string",
20 "note": "string"
21 },
22 "site": {
23 "id": 1,
24 "name": "string",
25 "active": true,
26 "address": {
27 "lineOne": "string",
28 "lineTwo": "string",
29 "lineThree": "string",
30 "city": "string",
31 "state": "string",
32 "zipCode": "string",
33 "country": "string",
34 "note": "string"
35 }
36 },
37 "enrolled": true,
38 "sex": "female"
39 },
40 "item": {
41 "id": 1,
42 "manufacturer": {
43 "id": 1,
44 "name": "string"
45 },
46 "name": "string",
47 "model": "string",
48 "sku": "string"
49 },
50 "device": {
51 "id": 1,
52 "item": {
53 "id": 1,
54 "manufacturer": {
55 "id": 1,
56 "name": "string"
57 },
58 "name": "string",
59 "model": "string",
60 "sku": "string"
61 },
62 "currentStatus": "string",
63 "used": true,
64 "currentPatient": {
65 "id": 1,
66 "externalIdentifier": "1234abcd",
67 "firstName": "John",
68 "lastName": "Doe",
69 "dateOfBirth": "1980-01-01",
70 "email": "john.doe@example.com",
71 "phoneNumber": "+1234567890",
72 "archived": true,
73 "address": {
74 "lineOne": "string",
75 "lineTwo": "string",
76 "lineThree": "string",
77 "city": "string",
78 "state": "string",
79 "zipCode": "string",
80 "country": "string",
81 "note": "string"
82 },
83 "site": {
84 "id": 1,
85 "name": "string",
86 "active": true,
87 "address": {
88 "lineOne": "string",
89 "lineTwo": "string",
90 "lineThree": "string",
91 "city": "string",
92 "state": "string",
93 "zipCode": "string",
94 "country": "string",
95 "note": "string"
96 }
97 },
98 "enrolled": true,
99 "sex": "female"
100 },
101 "site": {
102 "id": 1,
103 "name": "string",
104 "active": true,
105 "address": {
106 "lineOne": "string",
107 "lineTwo": "string",
108 "lineThree": "string",
109 "city": "string",
110 "state": "string",
111 "zipCode": "string",
112 "country": "string",
113 "note": "string"
114 }
115 },
116 "lastHealthCheck": "string",
117 "deviceIdentifiers": [
118 {
119 "type": "string",
120 "value": "string"
121 }
122 ],
123 "deviceEvents": [
124 {
125 "type": "string",
126 "eventTimestamp": "string"
127 }
128 ],
129 "externalIdentifier": "string",
130 "disabledReadings": true
131 },
132 "readingTimestamp": "string",
133 "bloodOxygen": 0,
134 "heartRate": 0,
135 "manual": true
136}

BloodOxygenReadingRequest

This page describes Impilo’s blood oxygen reading model.

Properties

NameTypeRequiredDescription
deviceIdinteger(int64)falseThe id of the device that took the reading.
deviceIdentifierstringfalseThe device identifier of the device that took the reading.
patientIdinteger(int64)falseThe id of the patient that took the reading.
readingTimestampstring(date-time)trueThe timestamp at which the reading was taken.
bloodOxygeninteger(int32)trueThe blood oxygen (spo2) measurement value.
heartRateinteger(int32)trueThe heart rate measurement value.
manualbooleanfalseTrue if the reading value was entered manually, false or null otherwise.
BloodOxygenReadingRequest Model Sample
1{
2 "deviceId": 0,
3 "deviceIdentifier": "string",
4 "patientId": 0,
5 "readingTimestamp": "2022-03-10T16:15:50Z",
6 "bloodOxygen": 0,
7 "heartRate": 0,
8 "manual": true
9}

BloodPressureReading

This page describes Impilo’s blood pressure reading model.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the reading.
patientPatientfalseThe patient who took the reading.
itemItemfalseThe item used to take the reading.
deviceDevicefalseThe device used to take the reading.
readingTimestampstringfalseThe timestamp at which the reading was taken.
systolicinteger(int32)falseThe systolic measurement value.
diastolicinteger(int32)falseThe diastolic measurement value.
heartRateinteger(int32)falseThe heart rate measurement value.
manualbooleanfalseTrue if the reading value was entered manually, false otherwise.
BloodPressureReading Model Sample
1{
2 "id": 0,
3 "patient": {
4 "id": 1,
5 "externalIdentifier": "1234abcd",
6 "firstName": "John",
7 "lastName": "Doe",
8 "dateOfBirth": "1980-01-01",
9 "email": "john.doe@example.com",
10 "phoneNumber": "+1234567890",
11 "archived": true,
12 "address": {
13 "lineOne": "string",
14 "lineTwo": "string",
15 "lineThree": "string",
16 "city": "string",
17 "state": "string",
18 "zipCode": "string",
19 "country": "string",
20 "note": "string"
21 },
22 "site": {
23 "id": 1,
24 "name": "string",
25 "active": true,
26 "address": {
27 "lineOne": "string",
28 "lineTwo": "string",
29 "lineThree": "string",
30 "city": "string",
31 "state": "string",
32 "zipCode": "string",
33 "country": "string",
34 "note": "string"
35 }
36 },
37 "enrolled": true,
38 "sex": "female"
39 },
40 "item": {
41 "id": 1,
42 "manufacturer": {
43 "id": 1,
44 "name": "string"
45 },
46 "name": "string",
47 "model": "string",
48 "sku": "string"
49 },
50 "device": {
51 "id": 1,
52 "item": {
53 "id": 1,
54 "manufacturer": {
55 "id": 1,
56 "name": "string"
57 },
58 "name": "string",
59 "model": "string",
60 "sku": "string"
61 },
62 "currentStatus": "string",
63 "used": true,
64 "currentPatient": {
65 "id": 1,
66 "externalIdentifier": "1234abcd",
67 "firstName": "John",
68 "lastName": "Doe",
69 "dateOfBirth": "1980-01-01",
70 "email": "john.doe@example.com",
71 "phoneNumber": "+1234567890",
72 "archived": true,
73 "address": {
74 "lineOne": "string",
75 "lineTwo": "string",
76 "lineThree": "string",
77 "city": "string",
78 "state": "string",
79 "zipCode": "string",
80 "country": "string",
81 "note": "string"
82 },
83 "site": {
84 "id": 1,
85 "name": "string",
86 "active": true,
87 "address": {
88 "lineOne": "string",
89 "lineTwo": "string",
90 "lineThree": "string",
91 "city": "string",
92 "state": "string",
93 "zipCode": "string",
94 "country": "string",
95 "note": "string"
96 }
97 },
98 "enrolled": true,
99 "sex": "female"
100 },
101 "site": {
102 "id": 1,
103 "name": "string",
104 "active": true,
105 "address": {
106 "lineOne": "string",
107 "lineTwo": "string",
108 "lineThree": "string",
109 "city": "string",
110 "state": "string",
111 "zipCode": "string",
112 "country": "string",
113 "note": "string"
114 }
115 },
116 "lastHealthCheck": "string",
117 "deviceIdentifiers": [
118 {
119 "type": "string",
120 "value": "string"
121 }
122 ],
123 "deviceEvents": [
124 {
125 "type": "string",
126 "eventTimestamp": "string"
127 }
128 ],
129 "externalIdentifier": "string",
130 "disabledReadings": true
131 },
132 "readingTimestamp": "string",
133 "systolic": 0,
134 "diastolic": 0,
135 "heartRate": 0,
136 "manual": true
137}

BloodPressureReadingRequest

This page describes Impilo’s blood pressure reading model.

Properties

NameTypeRequiredDescription
deviceIdinteger(int64)falseThe id of the device that took the reading.
deviceIdentifierstringfalseThe device identifier of the device that took the reading.
patientIdinteger(int64)falseThe id of the patient that took the reading.
readingTimestampstring(date-time)trueThe timestamp at which the reading was taken.
systolicinteger(int32)trueThe systolic measurement value.
diastolicinteger(int32)trueThe diastolic measurement value.
heartRateinteger(int32)falseThe heart rate measurement value.
manualbooleanfalseTrue if the reading value was entered manually, false or null otherwise.
BloodPressureReadingRequest Model Sample
1{
2 "deviceId": 0,
3 "deviceIdentifier": "string",
4 "patientId": 0,
5 "readingTimestamp": "2022-03-10T16:15:50Z",
6 "systolic": 0,
7 "diastolic": 0,
8 "heartRate": 0,
9 "manual": true
10}

BloodPressureReadingWebhook

Represents a webhook for blood pressure reading notifications.

Properties

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

Device

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.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the device, managed by Impilo.
itemItemfalseThe manufacturer for this item.
currentStatusstringfalseThe current status of this device.
usedbooleanfalseTrue if this device is used, false otherwise.
currentPatientPatientfalseThe patient currently in possession of this device. Null if this device is not currently with a patient.
siteSitefalseThe site to which this device is assigned.
lastHealthCheckstringfalseTimestamp for the last time Impilo received a signal from this device.
deviceIdentifiers[DeviceIdentifier]falseAn array of the device identifiers for this device.
deviceEvents[DeviceEvent]falseAn array of the device events for this device.
externalIdentifierstringfalseThe external identifier for this device.
disabledReadingsbooleanfalseTrue if readings from this device are disabled, false otherwise. If true, Impilo will not save or process readings from this device. Webhooks and alerts will not be triggered for readings taken on this device.
Device Model Sample
1{
2 "id": 1,
3 "item": {
4 "id": 1,
5 "manufacturer": {
6 "id": 1,
7 "name": "string"
8 },
9 "name": "string",
10 "model": "string",
11 "sku": "string"
12 },
13 "currentStatus": "string",
14 "used": true,
15 "currentPatient": {
16 "id": 1,
17 "externalIdentifier": "1234abcd",
18 "firstName": "John",
19 "lastName": "Doe",
20 "dateOfBirth": "1980-01-01",
21 "email": "john.doe@example.com",
22 "phoneNumber": "+1234567890",
23 "archived": true,
24 "address": {
25 "lineOne": "string",
26 "lineTwo": "string",
27 "lineThree": "string",
28 "city": "string",
29 "state": "string",
30 "zipCode": "string",
31 "country": "string",
32 "note": "string"
33 },
34 "site": {
35 "id": 1,
36 "name": "string",
37 "active": true,
38 "address": {
39 "lineOne": "string",
40 "lineTwo": "string",
41 "lineThree": "string",
42 "city": "string",
43 "state": "string",
44 "zipCode": "string",
45 "country": "string",
46 "note": "string"
47 }
48 },
49 "enrolled": true,
50 "sex": "female"
51 },
52 "site": {
53 "id": 1,
54 "name": "string",
55 "active": true,
56 "address": {
57 "lineOne": "string",
58 "lineTwo": "string",
59 "lineThree": "string",
60 "city": "string",
61 "state": "string",
62 "zipCode": "string",
63 "country": "string",
64 "note": "string"
65 }
66 },
67 "lastHealthCheck": "string",
68 "deviceIdentifiers": [
69 {
70 "type": "string",
71 "value": "string"
72 }
73 ],
74 "deviceEvents": [
75 {
76 "type": "string",
77 "eventTimestamp": "string"
78 }
79 ],
80 "externalIdentifier": "string",
81 "disabledReadings": true
82}

DeviceAssociationWebhookPayload

The webhook payload sent when a Device is either Associated or Disassociated with a patient.

Properties

NameTypeRequiredDescription
patientPatientfalseThe Patient that the device was either associated with or disassociated from.
deviceDevicefalseThe Device that was associated to or disassociated from the provided Patient.
actionstringfalseThe type of association that was performed — either ‘associate’ or ‘disassociate’.
eventTimestampstringfalseThe timestamp of the association event.
DeviceAssociationWebhookPayload Model Sample
1{
2 "patient": {
3 "id": 1,
4 "externalIdentifier": "1234abcd",
5 "firstName": "John",
6 "lastName": "Doe",
7 "dateOfBirth": "1980-01-01",
8 "email": "john.doe@example.com",
9 "phoneNumber": "+1234567890",
10 "archived": true,
11 "address": {
12 "lineOne": "string",
13 "lineTwo": "string",
14 "lineThree": "string",
15 "city": "string",
16 "state": "string",
17 "zipCode": "string",
18 "country": "string",
19 "note": "string"
20 },
21 "site": {
22 "id": 1,
23 "name": "string",
24 "active": true,
25 "address": {
26 "lineOne": "string",
27 "lineTwo": "string",
28 "lineThree": "string",
29 "city": "string",
30 "state": "string",
31 "zipCode": "string",
32 "country": "string",
33 "note": "string"
34 }
35 },
36 "enrolled": true,
37 "sex": "female"
38 },
39 "device": {
40 "id": 1,
41 "item": {
42 "id": 1,
43 "manufacturer": {
44 "id": 1,
45 "name": "string"
46 },
47 "name": "string",
48 "model": "string",
49 "sku": "string"
50 },
51 "currentStatus": "string",
52 "used": true,
53 "currentPatient": {
54 "id": 1,
55 "externalIdentifier": "1234abcd",
56 "firstName": "John",
57 "lastName": "Doe",
58 "dateOfBirth": "1980-01-01",
59 "email": "john.doe@example.com",
60 "phoneNumber": "+1234567890",
61 "archived": true,
62 "address": {
63 "lineOne": "string",
64 "lineTwo": "string",
65 "lineThree": "string",
66 "city": "string",
67 "state": "string",
68 "zipCode": "string",
69 "country": "string",
70 "note": "string"
71 },
72 "site": {
73 "id": 1,
74 "name": "string",
75 "active": true,
76 "address": {
77 "lineOne": "string",
78 "lineTwo": "string",
79 "lineThree": "string",
80 "city": "string",
81 "state": "string",
82 "zipCode": "string",
83 "country": "string",
84 "note": "string"
85 }
86 },
87 "enrolled": true,
88 "sex": "female"
89 },
90 "site": {
91 "id": 1,
92 "name": "string",
93 "active": true,
94 "address": {
95 "lineOne": "string",
96 "lineTwo": "string",
97 "lineThree": "string",
98 "city": "string",
99 "state": "string",
100 "zipCode": "string",
101 "country": "string",
102 "note": "string"
103 }
104 },
105 "lastHealthCheck": "string",
106 "deviceIdentifiers": [
107 {
108 "type": "string",
109 "value": "string"
110 }
111 ],
112 "deviceEvents": [
113 {
114 "type": "string",
115 "eventTimestamp": "string"
116 }
117 ],
118 "externalIdentifier": "string",
119 "disabledReadings": true
120 },
121 "action": "string",
122 "eventTimestamp": "string"
123}

DeviceEvent

A device event represents a significant activity or occurrence detected by the device. Impilo tracks these events to provide insights into device usage and operational status.

Properties

NameTypeRequiredDescription
typestringfalseThe event type for the Device Event.
eventTimestampstringfalseThe timestamp when the Device Event was created.
DeviceEvent Model Sample
1{
2 "type": "string",
3 "eventTimestamp": "string"
4}

DeviceIdentifier

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.

Properties

NameTypeRequiredDescription
typestringfalseThe type of the Device Identifier.
valuestringfalseThe value of the Device Identifier, based on it’s type.
DeviceIdentifier Model Sample
1{
2 "type": "string",
3 "value": "string"
4}

DeviceReferenceRequest

A request to reference a device by either its ID or Identifier.

Properties

NameTypeRequiredDescription
deviceIdinteger(int64)falseThe ID of the device. Either this value or a Device Identifier are required to identify the Device.
deviceIdentifierstringfalseThe Identifier, such as a Serial Number, of the device. Either this value or a Device Id are required to identify the Device.
DeviceReferenceRequest Model Sample
1{
2 "deviceId": 1,
3 "deviceIdentifier": "ABC123"
4}

Instant

Instant Model Sample
1"2022-03-10T16:15:50Z"

Item

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.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the item, managed by Impilo.
manufacturerManufacturerfalseThe manufacturer for this item.
namestringfalseThe name for this item.
modelstringfalseThe manufacturer-assigned model for this item.
skustringfalseThe Impilo-assigned SKU for this item.
Item Model Sample
1{
2 "id": 1,
3 "manufacturer": {
4 "id": 1,
5 "name": "string"
6 },
7 "name": "string",
8 "model": "string",
9 "sku": "string"
10}

Kit

A kit is a named collection of items that can be ordered as one unit.

Properties

NameTypeRequiredDescription
idinteger(int64)falsenone
namestringfalseThe name of the kit.
archivedbooleanfalseTrue if the kit is archived, false otherwise.
kitItems[KitItem]falseAn array of kit items.
Kit Model Sample
1{
2 "id": 0,
3 "name": "string",
4 "archived": true,
5 "kitItems": [
6 {
7 "item": {
8 "id": 1,
9 "manufacturer": {
10 "id": 1,
11 "name": "string"
12 },
13 "name": "string",
14 "model": "string",
15 "sku": "string"
16 },
17 "count": 0
18 }
19 ]
20}

KitItem

Properties

NameTypeRequiredDescription
itemItemfalseAn 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.
countinteger(int32)falsenone
KitItem Model Sample
1{
2 "item": {
3 "id": 1,
4 "manufacturer": {
5 "id": 1,
6 "name": "string"
7 },
8 "name": "string",
9 "model": "string",
10 "sku": "string"
11 },
12 "count": 0
13}

Manufacturer

A manufacturer is a supplier of an item. Every item has exactly one manufacturer.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the manufacturer, managed by Impilo.
namestringfalseThe name of the manufacturer.
Manufacturer Model Sample
1{
2 "id": 1,
3 "name": "string"
4}

Order

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the order
externalOrderIds[string]falseAn array of order ids specified by the client
patientPatientfalseThe patient receiving the order. Exactly one of patient or site must be not null.
siteSitefalseThe site receiving the order. Exactly one of patient or site must be not null.
currentStatusstringfalseThe current status of the order
orderItems[OrderItem]falseArray of items on the order. At least one of orderItems or orderKits must be not null.
orderKits[OrderKit]falseArray of order kits on the order. At least one of orderItems or orderKits must be not null.
orderEvents[OrderEvent]falseArray of order events. These are the status updates for the order.
trackingNumbers[TrackingNumber]falseArray of tracking numbers for the order.
devices[Device]falseThe order item devices
packedKits[PackedKit]falseThe kits packed in the order

currentStatus Enumerated Values

The current status of the order

NameDesciption
reconfirmAddressCustomer needs to reconfirm their address.
unableToFulfillOrder cannot be fulfilled due to current limitations or issues.
orderPlacedOrder has been successfully placed and is in the system.
shippedOrder has been shipped to the recipient.
onHoldOrder is on hold, possibly due to inventory or internal reviews.
unsuccessfulDeliveryDelivery of the order was attempted but unsuccessful.
awaitingShipmentOrder is ready to be shipped but is waiting for the next shipment cycle.
returnIssuedA return process has been initiated for the order.
pendingInventoryOrder is waiting for inventory to become available before it can be fulfilled.
voidedOrder has been canceled and is no longer valid.
deliveredOrder has been successfully delivered to the recipient.
pendingAdditionalInformationOrder is pending as additional information is required from the recipient.
Order Model Sample
1{
2 "id": 0,
3 "externalOrderIds": [
4 "string"
5 ],
6 "patient": {
7 "id": 1,
8 "externalIdentifier": "1234abcd",
9 "firstName": "John",
10 "lastName": "Doe",
11 "dateOfBirth": "1980-01-01",
12 "email": "john.doe@example.com",
13 "phoneNumber": "+1234567890",
14 "archived": true,
15 "address": {
16 "lineOne": "string",
17 "lineTwo": "string",
18 "lineThree": "string",
19 "city": "string",
20 "state": "string",
21 "zipCode": "string",
22 "country": "string",
23 "note": "string"
24 },
25 "site": {
26 "id": 1,
27 "name": "string",
28 "active": true,
29 "address": {
30 "lineOne": "string",
31 "lineTwo": "string",
32 "lineThree": "string",
33 "city": "string",
34 "state": "string",
35 "zipCode": "string",
36 "country": "string",
37 "note": "string"
38 }
39 },
40 "enrolled": true,
41 "sex": "female"
42 },
43 "site": {
44 "id": 1,
45 "name": "string",
46 "active": true,
47 "address": {
48 "lineOne": "string",
49 "lineTwo": "string",
50 "lineThree": "string",
51 "city": "string",
52 "state": "string",
53 "zipCode": "string",
54 "country": "string",
55 "note": "string"
56 }
57 },
58 "currentStatus": "reconfirmAddress",
59 "orderItems": [
60 {
61 "item": {
62 "id": 1,
63 "manufacturer": {
64 "id": 1,
65 "name": "string"
66 },
67 "name": "string",
68 "model": "string",
69 "sku": "string"
70 },
71 "count": 0
72 }
73 ],
74 "orderKits": [
75 {
76 "kit": {
77 "id": 0,
78 "name": "string",
79 "archived": true,
80 "kitItems": [
81 {
82 "item": {
83 "id": 1,
84 "manufacturer": {
85 "id": 1,
86 "name": "string"
87 },
88 "name": "string",
89 "model": "string",
90 "sku": "string"
91 },
92 "count": 0
93 }
94 ]
95 },
96 "count": 0
97 }
98 ],
99 "orderEvents": [
100 {
101 "name": "string",
102 "eventTimestamp": "string"
103 }
104 ],
105 "trackingNumbers": [
106 {
107 "carrier": "string",
108 "value": "string"
109 }
110 ],
111 "devices": [
112 {
113 "id": 1,
114 "item": {
115 "id": 1,
116 "manufacturer": {
117 "id": 1,
118 "name": "string"
119 },
120 "name": "string",
121 "model": "string",
122 "sku": "string"
123 },
124 "currentStatus": "string",
125 "used": true,
126 "currentPatient": {
127 "id": 1,
128 "externalIdentifier": "1234abcd",
129 "firstName": "John",
130 "lastName": "Doe",
131 "dateOfBirth": "1980-01-01",
132 "email": "john.doe@example.com",
133 "phoneNumber": "+1234567890",
134 "archived": true,
135 "address": {
136 "lineOne": "string",
137 "lineTwo": "string",
138 "lineThree": "string",
139 "city": "string",
140 "state": "string",
141 "zipCode": "string",
142 "country": "string",
143 "note": "string"
144 },
145 "site": {
146 "id": 1,
147 "name": "string",
148 "active": true,
149 "address": {
150 "lineOne": "string",
151 "lineTwo": "string",
152 "lineThree": "string",
153 "city": "string",
154 "state": "string",
155 "zipCode": "string",
156 "country": "string",
157 "note": "string"
158 }
159 },
160 "enrolled": true,
161 "sex": "female"
162 },
163 "site": {
164 "id": 1,
165 "name": "string",
166 "active": true,
167 "address": {
168 "lineOne": "string",
169 "lineTwo": "string",
170 "lineThree": "string",
171 "city": "string",
172 "state": "string",
173 "zipCode": "string",
174 "country": "string",
175 "note": "string"
176 }
177 },
178 "lastHealthCheck": "string",
179 "deviceIdentifiers": [
180 {
181 "type": "string",
182 "value": "string"
183 }
184 ],
185 "deviceEvents": [
186 {
187 "type": "string",
188 "eventTimestamp": "string"
189 }
190 ],
191 "externalIdentifier": "string",
192 "disabledReadings": true
193 }
194 ],
195 "packedKits": [
196 {
197 "kit": {
198 "id": 0,
199 "name": "string",
200 "archived": true,
201 "kitItems": [
202 {
203 "item": {
204 "id": 1,
205 "manufacturer": {
206 "id": 1,
207 "name": "string"
208 },
209 "name": "string",
210 "model": "string",
211 "sku": "string"
212 },
213 "count": 0
214 }
215 ]
216 },
217 "devices": [
218 {
219 "id": 1,
220 "item": {
221 "id": 1,
222 "manufacturer": {
223 "id": 1,
224 "name": "string"
225 },
226 "name": "string",
227 "model": "string",
228 "sku": "string"
229 },
230 "currentStatus": "string",
231 "used": true,
232 "currentPatient": {
233 "id": 1,
234 "externalIdentifier": "1234abcd",
235 "firstName": "John",
236 "lastName": "Doe",
237 "dateOfBirth": "1980-01-01",
238 "email": "john.doe@example.com",
239 "phoneNumber": "+1234567890",
240 "archived": true,
241 "address": {
242 "lineOne": "string",
243 "lineTwo": "string",
244 "lineThree": "string",
245 "city": "string",
246 "state": "string",
247 "zipCode": "string",
248 "country": "string",
249 "note": "string"
250 },
251 "site": {
252 "id": 1,
253 "name": "string",
254 "active": true,
255 "address": {
256 "lineOne": "string",
257 "lineTwo": "string",
258 "lineThree": "string",
259 "city": "string",
260 "state": "string",
261 "zipCode": "string",
262 "country": "string",
263 "note": "string"
264 }
265 },
266 "enrolled": true,
267 "sex": "female"
268 },
269 "site": {
270 "id": 1,
271 "name": "string",
272 "active": true,
273 "address": {
274 "lineOne": "string",
275 "lineTwo": "string",
276 "lineThree": "string",
277 "city": "string",
278 "state": "string",
279 "zipCode": "string",
280 "country": "string",
281 "note": "string"
282 }
283 },
284 "lastHealthCheck": "string",
285 "deviceIdentifiers": [
286 {
287 "type": "string",
288 "value": "string"
289 }
290 ],
291 "deviceEvents": [
292 {
293 "type": "string",
294 "eventTimestamp": "string"
295 }
296 ],
297 "externalIdentifier": "string",
298 "disabledReadings": true
299 }
300 ]
301 }
302 ]
303}

OrderEvent

Properties

NameTypeRequiredDescription
namestringfalsenone
eventTimestampstringfalsenone
OrderEvent Model Sample
1{
2 "name": "string",
3 "eventTimestamp": "string"
4}

OrderItem

Properties

NameTypeRequiredDescription
itemItemfalseAn 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.
countinteger(int32)falsenone
OrderItem Model Sample
1{
2 "item": {
3 "id": 1,
4 "manufacturer": {
5 "id": 1,
6 "name": "string"
7 },
8 "name": "string",
9 "model": "string",
10 "sku": "string"
11 },
12 "count": 0
13}

OrderKit

Properties

NameTypeRequiredDescription
kitKitfalseA kit is a named collection of items that can be ordered as one unit.
countinteger(int32)falsenone
OrderKit Model Sample
1{
2 "kit": {
3 "id": 0,
4 "name": "string",
5 "archived": true,
6 "kitItems": [
7 {
8 "item": {
9 "id": 1,
10 "manufacturer": {
11 "id": 1,
12 "name": "string"
13 },
14 "name": "string",
15 "model": "string",
16 "sku": "string"
17 },
18 "count": 0
19 }
20 ]
21 },
22 "count": 0
23}

PackedKit

Properties

NameTypeRequiredDescription
kitKitfalseA kit is a named collection of items that can be ordered as one unit.
devices[Device]false[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.]
PackedKit Model Sample
1{
2 "kit": {
3 "id": 0,
4 "name": "string",
5 "archived": true,
6 "kitItems": [
7 {
8 "item": {
9 "id": 1,
10 "manufacturer": {
11 "id": 1,
12 "name": "string"
13 },
14 "name": "string",
15 "model": "string",
16 "sku": "string"
17 },
18 "count": 0
19 }
20 ]
21 },
22 "devices": [
23 {
24 "id": 1,
25 "item": {
26 "id": 1,
27 "manufacturer": {
28 "id": 1,
29 "name": "string"
30 },
31 "name": "string",
32 "model": "string",
33 "sku": "string"
34 },
35 "currentStatus": "string",
36 "used": true,
37 "currentPatient": {
38 "id": 1,
39 "externalIdentifier": "1234abcd",
40 "firstName": "John",
41 "lastName": "Doe",
42 "dateOfBirth": "1980-01-01",
43 "email": "john.doe@example.com",
44 "phoneNumber": "+1234567890",
45 "archived": true,
46 "address": {
47 "lineOne": "string",
48 "lineTwo": "string",
49 "lineThree": "string",
50 "city": "string",
51 "state": "string",
52 "zipCode": "string",
53 "country": "string",
54 "note": "string"
55 },
56 "site": {
57 "id": 1,
58 "name": "string",
59 "active": true,
60 "address": {
61 "lineOne": "string",
62 "lineTwo": "string",
63 "lineThree": "string",
64 "city": "string",
65 "state": "string",
66 "zipCode": "string",
67 "country": "string",
68 "note": "string"
69 }
70 },
71 "enrolled": true,
72 "sex": "female"
73 },
74 "site": {
75 "id": 1,
76 "name": "string",
77 "active": true,
78 "address": {
79 "lineOne": "string",
80 "lineTwo": "string",
81 "lineThree": "string",
82 "city": "string",
83 "state": "string",
84 "zipCode": "string",
85 "country": "string",
86 "note": "string"
87 }
88 },
89 "lastHealthCheck": "string",
90 "deviceIdentifiers": [
91 {
92 "type": "string",
93 "value": "string"
94 }
95 ],
96 "deviceEvents": [
97 {
98 "type": "string",
99 "eventTimestamp": "string"
100 }
101 ],
102 "externalIdentifier": "string",
103 "disabledReadings": true
104 }
105 ]
106}

Page

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[any]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
Page Model Sample
1{
2 "content": [
3 null
4 ],
5 "page": 0,
6 "size": 0,
7 "total": 0,
8 "first": true,
9 "last": true
10}

PageBloodGlucoseReading

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[BloodGlucoseReading]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageBloodGlucoseReading Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "patient": {
6 "id": 1,
7 "externalIdentifier": "1234abcd",
8 "firstName": "John",
9 "lastName": "Doe",
10 "dateOfBirth": "1980-01-01",
11 "email": "john.doe@example.com",
12 "phoneNumber": "+1234567890",
13 "archived": true,
14 "address": {
15 "lineOne": "string",
16 "lineTwo": "string",
17 "lineThree": "string",
18 "city": "string",
19 "state": "string",
20 "zipCode": "string",
21 "country": "string",
22 "note": "string"
23 },
24 "site": {
25 "id": 1,
26 "name": "string",
27 "active": true,
28 "address": {
29 "lineOne": "string",
30 "lineTwo": "string",
31 "lineThree": "string",
32 "city": "string",
33 "state": "string",
34 "zipCode": "string",
35 "country": "string",
36 "note": "string"
37 }
38 },
39 "enrolled": true,
40 "sex": "female"
41 },
42 "item": {
43 "id": 1,
44 "manufacturer": {
45 "id": 1,
46 "name": "string"
47 },
48 "name": "string",
49 "model": "string",
50 "sku": "string"
51 },
52 "device": {
53 "id": 1,
54 "item": {
55 "id": 1,
56 "manufacturer": {
57 "id": 1,
58 "name": "string"
59 },
60 "name": "string",
61 "model": "string",
62 "sku": "string"
63 },
64 "currentStatus": "string",
65 "used": true,
66 "currentPatient": {
67 "id": 1,
68 "externalIdentifier": "1234abcd",
69 "firstName": "John",
70 "lastName": "Doe",
71 "dateOfBirth": "1980-01-01",
72 "email": "john.doe@example.com",
73 "phoneNumber": "+1234567890",
74 "archived": true,
75 "address": {
76 "lineOne": "string",
77 "lineTwo": "string",
78 "lineThree": "string",
79 "city": "string",
80 "state": "string",
81 "zipCode": "string",
82 "country": "string",
83 "note": "string"
84 },
85 "site": {
86 "id": 1,
87 "name": "string",
88 "active": true,
89 "address": {
90 "lineOne": "string",
91 "lineTwo": "string",
92 "lineThree": "string",
93 "city": "string",
94 "state": "string",
95 "zipCode": "string",
96 "country": "string",
97 "note": "string"
98 }
99 },
100 "enrolled": true,
101 "sex": "female"
102 },
103 "site": {
104 "id": 1,
105 "name": "string",
106 "active": true,
107 "address": {
108 "lineOne": "string",
109 "lineTwo": "string",
110 "lineThree": "string",
111 "city": "string",
112 "state": "string",
113 "zipCode": "string",
114 "country": "string",
115 "note": "string"
116 }
117 },
118 "lastHealthCheck": "string",
119 "deviceIdentifiers": [
120 {
121 "type": "string",
122 "value": "string"
123 }
124 ],
125 "deviceEvents": [
126 {
127 "type": "string",
128 "eventTimestamp": "string"
129 }
130 ],
131 "externalIdentifier": "string",
132 "disabledReadings": true
133 },
134 "readingTimestamp": "string",
135 "glucose": 0,
136 "manual": true,
137 "beforeMeal": true,
138 "afterMeal": true
139 }
140 ],
141 "page": 0,
142 "size": 0,
143 "total": 0,
144 "first": true,
145 "last": true
146}

PageBloodOxygenReading

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[BloodOxygenReading]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageBloodOxygenReading Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "patient": {
6 "id": 1,
7 "externalIdentifier": "1234abcd",
8 "firstName": "John",
9 "lastName": "Doe",
10 "dateOfBirth": "1980-01-01",
11 "email": "john.doe@example.com",
12 "phoneNumber": "+1234567890",
13 "archived": true,
14 "address": {
15 "lineOne": "string",
16 "lineTwo": "string",
17 "lineThree": "string",
18 "city": "string",
19 "state": "string",
20 "zipCode": "string",
21 "country": "string",
22 "note": "string"
23 },
24 "site": {
25 "id": 1,
26 "name": "string",
27 "active": true,
28 "address": {
29 "lineOne": "string",
30 "lineTwo": "string",
31 "lineThree": "string",
32 "city": "string",
33 "state": "string",
34 "zipCode": "string",
35 "country": "string",
36 "note": "string"
37 }
38 },
39 "enrolled": true,
40 "sex": "female"
41 },
42 "item": {
43 "id": 1,
44 "manufacturer": {
45 "id": 1,
46 "name": "string"
47 },
48 "name": "string",
49 "model": "string",
50 "sku": "string"
51 },
52 "device": {
53 "id": 1,
54 "item": {
55 "id": 1,
56 "manufacturer": {
57 "id": 1,
58 "name": "string"
59 },
60 "name": "string",
61 "model": "string",
62 "sku": "string"
63 },
64 "currentStatus": "string",
65 "used": true,
66 "currentPatient": {
67 "id": 1,
68 "externalIdentifier": "1234abcd",
69 "firstName": "John",
70 "lastName": "Doe",
71 "dateOfBirth": "1980-01-01",
72 "email": "john.doe@example.com",
73 "phoneNumber": "+1234567890",
74 "archived": true,
75 "address": {
76 "lineOne": "string",
77 "lineTwo": "string",
78 "lineThree": "string",
79 "city": "string",
80 "state": "string",
81 "zipCode": "string",
82 "country": "string",
83 "note": "string"
84 },
85 "site": {
86 "id": 1,
87 "name": "string",
88 "active": true,
89 "address": {
90 "lineOne": "string",
91 "lineTwo": "string",
92 "lineThree": "string",
93 "city": "string",
94 "state": "string",
95 "zipCode": "string",
96 "country": "string",
97 "note": "string"
98 }
99 },
100 "enrolled": true,
101 "sex": "female"
102 },
103 "site": {
104 "id": 1,
105 "name": "string",
106 "active": true,
107 "address": {
108 "lineOne": "string",
109 "lineTwo": "string",
110 "lineThree": "string",
111 "city": "string",
112 "state": "string",
113 "zipCode": "string",
114 "country": "string",
115 "note": "string"
116 }
117 },
118 "lastHealthCheck": "string",
119 "deviceIdentifiers": [
120 {
121 "type": "string",
122 "value": "string"
123 }
124 ],
125 "deviceEvents": [
126 {
127 "type": "string",
128 "eventTimestamp": "string"
129 }
130 ],
131 "externalIdentifier": "string",
132 "disabledReadings": true
133 },
134 "readingTimestamp": "string",
135 "bloodOxygen": 0,
136 "heartRate": 0,
137 "manual": true
138 }
139 ],
140 "page": 0,
141 "size": 0,
142 "total": 0,
143 "first": true,
144 "last": true
145}

PageBloodPressureReading

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[BloodPressureReading]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageBloodPressureReading Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "patient": {
6 "id": 1,
7 "externalIdentifier": "1234abcd",
8 "firstName": "John",
9 "lastName": "Doe",
10 "dateOfBirth": "1980-01-01",
11 "email": "john.doe@example.com",
12 "phoneNumber": "+1234567890",
13 "archived": true,
14 "address": {
15 "lineOne": "string",
16 "lineTwo": "string",
17 "lineThree": "string",
18 "city": "string",
19 "state": "string",
20 "zipCode": "string",
21 "country": "string",
22 "note": "string"
23 },
24 "site": {
25 "id": 1,
26 "name": "string",
27 "active": true,
28 "address": {
29 "lineOne": "string",
30 "lineTwo": "string",
31 "lineThree": "string",
32 "city": "string",
33 "state": "string",
34 "zipCode": "string",
35 "country": "string",
36 "note": "string"
37 }
38 },
39 "enrolled": true,
40 "sex": "female"
41 },
42 "item": {
43 "id": 1,
44 "manufacturer": {
45 "id": 1,
46 "name": "string"
47 },
48 "name": "string",
49 "model": "string",
50 "sku": "string"
51 },
52 "device": {
53 "id": 1,
54 "item": {
55 "id": 1,
56 "manufacturer": {
57 "id": 1,
58 "name": "string"
59 },
60 "name": "string",
61 "model": "string",
62 "sku": "string"
63 },
64 "currentStatus": "string",
65 "used": true,
66 "currentPatient": {
67 "id": 1,
68 "externalIdentifier": "1234abcd",
69 "firstName": "John",
70 "lastName": "Doe",
71 "dateOfBirth": "1980-01-01",
72 "email": "john.doe@example.com",
73 "phoneNumber": "+1234567890",
74 "archived": true,
75 "address": {
76 "lineOne": "string",
77 "lineTwo": "string",
78 "lineThree": "string",
79 "city": "string",
80 "state": "string",
81 "zipCode": "string",
82 "country": "string",
83 "note": "string"
84 },
85 "site": {
86 "id": 1,
87 "name": "string",
88 "active": true,
89 "address": {
90 "lineOne": "string",
91 "lineTwo": "string",
92 "lineThree": "string",
93 "city": "string",
94 "state": "string",
95 "zipCode": "string",
96 "country": "string",
97 "note": "string"
98 }
99 },
100 "enrolled": true,
101 "sex": "female"
102 },
103 "site": {
104 "id": 1,
105 "name": "string",
106 "active": true,
107 "address": {
108 "lineOne": "string",
109 "lineTwo": "string",
110 "lineThree": "string",
111 "city": "string",
112 "state": "string",
113 "zipCode": "string",
114 "country": "string",
115 "note": "string"
116 }
117 },
118 "lastHealthCheck": "string",
119 "deviceIdentifiers": [
120 {
121 "type": "string",
122 "value": "string"
123 }
124 ],
125 "deviceEvents": [
126 {
127 "type": "string",
128 "eventTimestamp": "string"
129 }
130 ],
131 "externalIdentifier": "string",
132 "disabledReadings": true
133 },
134 "readingTimestamp": "string",
135 "systolic": 0,
136 "diastolic": 0,
137 "heartRate": 0,
138 "manual": true
139 }
140 ],
141 "page": 0,
142 "size": 0,
143 "total": 0,
144 "first": true,
145 "last": true
146}

PageDevice

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Device]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageDevice Model Sample
1{
2 "content": [
3 {
4 "id": 1,
5 "item": {
6 "id": 1,
7 "manufacturer": {
8 "id": 1,
9 "name": "string"
10 },
11 "name": "string",
12 "model": "string",
13 "sku": "string"
14 },
15 "currentStatus": "string",
16 "used": true,
17 "currentPatient": {
18 "id": 1,
19 "externalIdentifier": "1234abcd",
20 "firstName": "John",
21 "lastName": "Doe",
22 "dateOfBirth": "1980-01-01",
23 "email": "john.doe@example.com",
24 "phoneNumber": "+1234567890",
25 "archived": true,
26 "address": {
27 "lineOne": "string",
28 "lineTwo": "string",
29 "lineThree": "string",
30 "city": "string",
31 "state": "string",
32 "zipCode": "string",
33 "country": "string",
34 "note": "string"
35 },
36 "site": {
37 "id": 1,
38 "name": "string",
39 "active": true,
40 "address": {
41 "lineOne": "string",
42 "lineTwo": "string",
43 "lineThree": "string",
44 "city": "string",
45 "state": "string",
46 "zipCode": "string",
47 "country": "string",
48 "note": "string"
49 }
50 },
51 "enrolled": true,
52 "sex": "female"
53 },
54 "site": {
55 "id": 1,
56 "name": "string",
57 "active": true,
58 "address": {
59 "lineOne": "string",
60 "lineTwo": "string",
61 "lineThree": "string",
62 "city": "string",
63 "state": "string",
64 "zipCode": "string",
65 "country": "string",
66 "note": "string"
67 }
68 },
69 "lastHealthCheck": "string",
70 "deviceIdentifiers": [
71 {
72 "type": "string",
73 "value": "string"
74 }
75 ],
76 "deviceEvents": [
77 {
78 "type": "string",
79 "eventTimestamp": "string"
80 }
81 ],
82 "externalIdentifier": "string",
83 "disabledReadings": true
84 }
85 ],
86 "page": 0,
87 "size": 0,
88 "total": 0,
89 "first": true,
90 "last": true
91}

PageItem

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Item]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageItem Model Sample
1{
2 "content": [
3 {
4 "id": 1,
5 "manufacturer": {
6 "id": 1,
7 "name": "string"
8 },
9 "name": "string",
10 "model": "string",
11 "sku": "string"
12 }
13 ],
14 "page": 0,
15 "size": 0,
16 "total": 0,
17 "first": true,
18 "last": true
19}

PageKit

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Kit]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageKit Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "name": "string",
6 "archived": true,
7 "kitItems": [
8 {
9 "item": {
10 "id": 1,
11 "manufacturer": {
12 "id": 1,
13 "name": "string"
14 },
15 "name": "string",
16 "model": "string",
17 "sku": "string"
18 },
19 "count": 0
20 }
21 ]
22 }
23 ],
24 "page": 0,
25 "size": 0,
26 "total": 0,
27 "first": true,
28 "last": true
29}

PageManufacturer

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Manufacturer]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageManufacturer Model Sample
1{
2 "content": [
3 {
4 "id": 1,
5 "name": "string"
6 }
7 ],
8 "page": 0,
9 "size": 0,
10 "total": 0,
11 "first": true,
12 "last": true
13}

PageOrder

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Order]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageOrder Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "externalOrderIds": [
6 "string"
7 ],
8 "patient": {
9 "id": 1,
10 "externalIdentifier": "1234abcd",
11 "firstName": "John",
12 "lastName": "Doe",
13 "dateOfBirth": "1980-01-01",
14 "email": "john.doe@example.com",
15 "phoneNumber": "+1234567890",
16 "archived": true,
17 "address": {
18 "lineOne": "string",
19 "lineTwo": "string",
20 "lineThree": "string",
21 "city": "string",
22 "state": "string",
23 "zipCode": "string",
24 "country": "string",
25 "note": "string"
26 },
27 "site": {
28 "id": 1,
29 "name": "string",
30 "active": true,
31 "address": {
32 "lineOne": "string",
33 "lineTwo": "string",
34 "lineThree": "string",
35 "city": "string",
36 "state": "string",
37 "zipCode": "string",
38 "country": "string",
39 "note": "string"
40 }
41 },
42 "enrolled": true,
43 "sex": "female"
44 },
45 "site": {
46 "id": 1,
47 "name": "string",
48 "active": true,
49 "address": {
50 "lineOne": "string",
51 "lineTwo": "string",
52 "lineThree": "string",
53 "city": "string",
54 "state": "string",
55 "zipCode": "string",
56 "country": "string",
57 "note": "string"
58 }
59 },
60 "currentStatus": "reconfirmAddress",
61 "orderItems": [
62 {
63 "item": {
64 "id": 1,
65 "manufacturer": {
66 "id": 1,
67 "name": "string"
68 },
69 "name": "string",
70 "model": "string",
71 "sku": "string"
72 },
73 "count": 0
74 }
75 ],
76 "orderKits": [
77 {
78 "kit": {
79 "id": 0,
80 "name": "string",
81 "archived": true,
82 "kitItems": [
83 {
84 "item": {
85 "id": 1,
86 "manufacturer": {
87 "id": 1,
88 "name": "string"
89 },
90 "name": "string",
91 "model": "string",
92 "sku": "string"
93 },
94 "count": 0
95 }
96 ]
97 },
98 "count": 0
99 }
100 ],
101 "orderEvents": [
102 {
103 "name": "string",
104 "eventTimestamp": "string"
105 }
106 ],
107 "trackingNumbers": [
108 {
109 "carrier": "string",
110 "value": "string"
111 }
112 ],
113 "devices": [
114 {
115 "id": 1,
116 "item": {
117 "id": 1,
118 "manufacturer": {
119 "id": 1,
120 "name": "string"
121 },
122 "name": "string",
123 "model": "string",
124 "sku": "string"
125 },
126 "currentStatus": "string",
127 "used": true,
128 "currentPatient": {
129 "id": 1,
130 "externalIdentifier": "1234abcd",
131 "firstName": "John",
132 "lastName": "Doe",
133 "dateOfBirth": "1980-01-01",
134 "email": "john.doe@example.com",
135 "phoneNumber": "+1234567890",
136 "archived": true,
137 "address": {
138 "lineOne": "string",
139 "lineTwo": "string",
140 "lineThree": "string",
141 "city": "string",
142 "state": "string",
143 "zipCode": "string",
144 "country": "string",
145 "note": "string"
146 },
147 "site": {
148 "id": 1,
149 "name": "string",
150 "active": true,
151 "address": {
152 "lineOne": "string",
153 "lineTwo": "string",
154 "lineThree": "string",
155 "city": "string",
156 "state": "string",
157 "zipCode": "string",
158 "country": "string",
159 "note": "string"
160 }
161 },
162 "enrolled": true,
163 "sex": "female"
164 },
165 "site": {
166 "id": 1,
167 "name": "string",
168 "active": true,
169 "address": {
170 "lineOne": "string",
171 "lineTwo": "string",
172 "lineThree": "string",
173 "city": "string",
174 "state": "string",
175 "zipCode": "string",
176 "country": "string",
177 "note": "string"
178 }
179 },
180 "lastHealthCheck": "string",
181 "deviceIdentifiers": [
182 {
183 "type": "string",
184 "value": "string"
185 }
186 ],
187 "deviceEvents": [
188 {
189 "type": "string",
190 "eventTimestamp": "string"
191 }
192 ],
193 "externalIdentifier": "string",
194 "disabledReadings": true
195 }
196 ],
197 "packedKits": [
198 {
199 "kit": {
200 "id": 0,
201 "name": "string",
202 "archived": true,
203 "kitItems": [
204 {
205 "item": {
206 "id": 1,
207 "manufacturer": {
208 "id": 1,
209 "name": "string"
210 },
211 "name": "string",
212 "model": "string",
213 "sku": "string"
214 },
215 "count": 0
216 }
217 ]
218 },
219 "devices": [
220 {
221 "id": 1,
222 "item": {
223 "id": 1,
224 "manufacturer": {
225 "id": 1,
226 "name": "string"
227 },
228 "name": "string",
229 "model": "string",
230 "sku": "string"
231 },
232 "currentStatus": "string",
233 "used": true,
234 "currentPatient": {
235 "id": 1,
236 "externalIdentifier": "1234abcd",
237 "firstName": "John",
238 "lastName": "Doe",
239 "dateOfBirth": "1980-01-01",
240 "email": "john.doe@example.com",
241 "phoneNumber": "+1234567890",
242 "archived": true,
243 "address": {
244 "lineOne": "string",
245 "lineTwo": "string",
246 "lineThree": "string",
247 "city": "string",
248 "state": "string",
249 "zipCode": "string",
250 "country": "string",
251 "note": "string"
252 },
253 "site": {
254 "id": 1,
255 "name": "string",
256 "active": true,
257 "address": {
258 "lineOne": "string",
259 "lineTwo": "string",
260 "lineThree": "string",
261 "city": "string",
262 "state": "string",
263 "zipCode": "string",
264 "country": "string",
265 "note": "string"
266 }
267 },
268 "enrolled": true,
269 "sex": "female"
270 },
271 "site": {
272 "id": 1,
273 "name": "string",
274 "active": true,
275 "address": {
276 "lineOne": "string",
277 "lineTwo": "string",
278 "lineThree": "string",
279 "city": "string",
280 "state": "string",
281 "zipCode": "string",
282 "country": "string",
283 "note": "string"
284 }
285 },
286 "lastHealthCheck": "string",
287 "deviceIdentifiers": [
288 {
289 "type": "string",
290 "value": "string"
291 }
292 ],
293 "deviceEvents": [
294 {
295 "type": "string",
296 "eventTimestamp": "string"
297 }
298 ],
299 "externalIdentifier": "string",
300 "disabledReadings": true
301 }
302 ]
303 }
304 ]
305 }
306 ],
307 "page": 0,
308 "size": 0,
309 "total": 0,
310 "first": true,
311 "last": true
312}

PagePatient

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Patient]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PagePatient Model Sample
1{
2 "content": [
3 {
4 "id": 1,
5 "externalIdentifier": "1234abcd",
6 "firstName": "John",
7 "lastName": "Doe",
8 "dateOfBirth": "1980-01-01",
9 "email": "john.doe@example.com",
10 "phoneNumber": "+1234567890",
11 "archived": true,
12 "address": {
13 "lineOne": "string",
14 "lineTwo": "string",
15 "lineThree": "string",
16 "city": "string",
17 "state": "string",
18 "zipCode": "string",
19 "country": "string",
20 "note": "string"
21 },
22 "site": {
23 "id": 1,
24 "name": "string",
25 "active": true,
26 "address": {
27 "lineOne": "string",
28 "lineTwo": "string",
29 "lineThree": "string",
30 "city": "string",
31 "state": "string",
32 "zipCode": "string",
33 "country": "string",
34 "note": "string"
35 }
36 },
37 "enrolled": true,
38 "sex": "female"
39 }
40 ],
41 "page": 0,
42 "size": 0,
43 "total": 0,
44 "first": true,
45 "last": true
46}

PageSite

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Site]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageSite Model Sample
1{
2 "content": [
3 {
4 "id": 1,
5 "name": "string",
6 "active": true,
7 "address": {
8 "lineOne": "string",
9 "lineTwo": "string",
10 "lineThree": "string",
11 "city": "string",
12 "state": "string",
13 "zipCode": "string",
14 "country": "string",
15 "note": "string"
16 }
17 }
18 ],
19 "page": 0,
20 "size": 0,
21 "total": 0,
22 "first": true,
23 "last": true
24}

PageTemperatureReading

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[TemperatureReading]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageTemperatureReading Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "patient": {
6 "id": 1,
7 "externalIdentifier": "1234abcd",
8 "firstName": "John",
9 "lastName": "Doe",
10 "dateOfBirth": "1980-01-01",
11 "email": "john.doe@example.com",
12 "phoneNumber": "+1234567890",
13 "archived": true,
14 "address": {
15 "lineOne": "string",
16 "lineTwo": "string",
17 "lineThree": "string",
18 "city": "string",
19 "state": "string",
20 "zipCode": "string",
21 "country": "string",
22 "note": "string"
23 },
24 "site": {
25 "id": 1,
26 "name": "string",
27 "active": true,
28 "address": {
29 "lineOne": "string",
30 "lineTwo": "string",
31 "lineThree": "string",
32 "city": "string",
33 "state": "string",
34 "zipCode": "string",
35 "country": "string",
36 "note": "string"
37 }
38 },
39 "enrolled": true,
40 "sex": "female"
41 },
42 "item": {
43 "id": 1,
44 "manufacturer": {
45 "id": 1,
46 "name": "string"
47 },
48 "name": "string",
49 "model": "string",
50 "sku": "string"
51 },
52 "device": {
53 "id": 1,
54 "item": {
55 "id": 1,
56 "manufacturer": {
57 "id": 1,
58 "name": "string"
59 },
60 "name": "string",
61 "model": "string",
62 "sku": "string"
63 },
64 "currentStatus": "string",
65 "used": true,
66 "currentPatient": {
67 "id": 1,
68 "externalIdentifier": "1234abcd",
69 "firstName": "John",
70 "lastName": "Doe",
71 "dateOfBirth": "1980-01-01",
72 "email": "john.doe@example.com",
73 "phoneNumber": "+1234567890",
74 "archived": true,
75 "address": {
76 "lineOne": "string",
77 "lineTwo": "string",
78 "lineThree": "string",
79 "city": "string",
80 "state": "string",
81 "zipCode": "string",
82 "country": "string",
83 "note": "string"
84 },
85 "site": {
86 "id": 1,
87 "name": "string",
88 "active": true,
89 "address": {
90 "lineOne": "string",
91 "lineTwo": "string",
92 "lineThree": "string",
93 "city": "string",
94 "state": "string",
95 "zipCode": "string",
96 "country": "string",
97 "note": "string"
98 }
99 },
100 "enrolled": true,
101 "sex": "female"
102 },
103 "site": {
104 "id": 1,
105 "name": "string",
106 "active": true,
107 "address": {
108 "lineOne": "string",
109 "lineTwo": "string",
110 "lineThree": "string",
111 "city": "string",
112 "state": "string",
113 "zipCode": "string",
114 "country": "string",
115 "note": "string"
116 }
117 },
118 "lastHealthCheck": "string",
119 "deviceIdentifiers": [
120 {
121 "type": "string",
122 "value": "string"
123 }
124 ],
125 "deviceEvents": [
126 {
127 "type": "string",
128 "eventTimestamp": "string"
129 }
130 ],
131 "externalIdentifier": "string",
132 "disabledReadings": true
133 },
134 "temperatureUnit": "string",
135 "temperature": 0.1,
136 "readingTimestamp": "string"
137 }
138 ],
139 "page": 0,
140 "size": 0,
141 "total": 0,
142 "first": true,
143 "last": true
144}

PageWebhook

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[Webhook]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageWebhook Model Sample
1{
2 "content": [
3 {
4 "id": 1,
5 "type": "eventType",
6 "url": "http://example.com"
7 }
8 ],
9 "page": 0,
10 "size": 0,
11 "total": 0,
12 "first": true,
13 "last": true
14}

PageWebhookLog

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[WebhookLog]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageWebhookLog Model Sample
1{
2 "content": [
3 {
4 "webhookId": 1,
5 "webhookType": "order.status",
6 "webhookUrl": "http://webhookserver.com",
7 "payload": "{'id':1234}",
8 "createTimestamp": "2023-08-22T14:15:30.345Z",
9 "lastResponseStatus": 200,
10 "retryAttempts": 3,
11 "lastRetryTimestamp": "2023-08-22T14:15:30.345Z"
12 }
13 ],
14 "page": 0,
15 "size": 0,
16 "total": 0,
17 "first": true,
18 "last": true
19}

PageWeightReading

Pagination is supported whenever an API response returns a list of objects. In paginated responses, objects are nested in a content attribute and have first and last attributes indicating whether you are on the first or last page, respectively. Additionally, the pagination response includes a page attribute indicating the current page number, a size attribute indicating the current page size, and a total attribute indicating the number of objects matching the request.

Properties

NameTypeRequiredDescription
content[WeightReading]falseThe content of the page, consisting of a list of objects.
pageinteger(int32)falseThe current page number. The first page has value 1.
sizeinteger(int32)falseThe current page size. Default 15, maximum 250.
totalinteger(int32)falseThe number of objects matching the request.
firstbooleanfalseTrue if this is the first page, false otherwise.
lastbooleanfalseTrue if this is the last page, false otherwise.
PageWeightReading Model Sample
1{
2 "content": [
3 {
4 "id": 0,
5 "patient": {
6 "id": 1,
7 "externalIdentifier": "1234abcd",
8 "firstName": "John",
9 "lastName": "Doe",
10 "dateOfBirth": "1980-01-01",
11 "email": "john.doe@example.com",
12 "phoneNumber": "+1234567890",
13 "archived": true,
14 "address": {
15 "lineOne": "string",
16 "lineTwo": "string",
17 "lineThree": "string",
18 "city": "string",
19 "state": "string",
20 "zipCode": "string",
21 "country": "string",
22 "note": "string"
23 },
24 "site": {
25 "id": 1,
26 "name": "string",
27 "active": true,
28 "address": {
29 "lineOne": "string",
30 "lineTwo": "string",
31 "lineThree": "string",
32 "city": "string",
33 "state": "string",
34 "zipCode": "string",
35 "country": "string",
36 "note": "string"
37 }
38 },
39 "enrolled": true,
40 "sex": "female"
41 },
42 "item": {
43 "id": 1,
44 "manufacturer": {
45 "id": 1,
46 "name": "string"
47 },
48 "name": "string",
49 "model": "string",
50 "sku": "string"
51 },
52 "device": {
53 "id": 1,
54 "item": {
55 "id": 1,
56 "manufacturer": {
57 "id": 1,
58 "name": "string"
59 },
60 "name": "string",
61 "model": "string",
62 "sku": "string"
63 },
64 "currentStatus": "string",
65 "used": true,
66 "currentPatient": {
67 "id": 1,
68 "externalIdentifier": "1234abcd",
69 "firstName": "John",
70 "lastName": "Doe",
71 "dateOfBirth": "1980-01-01",
72 "email": "john.doe@example.com",
73 "phoneNumber": "+1234567890",
74 "archived": true,
75 "address": {
76 "lineOne": "string",
77 "lineTwo": "string",
78 "lineThree": "string",
79 "city": "string",
80 "state": "string",
81 "zipCode": "string",
82 "country": "string",
83 "note": "string"
84 },
85 "site": {
86 "id": 1,
87 "name": "string",
88 "active": true,
89 "address": {
90 "lineOne": "string",
91 "lineTwo": "string",
92 "lineThree": "string",
93 "city": "string",
94 "state": "string",
95 "zipCode": "string",
96 "country": "string",
97 "note": "string"
98 }
99 },
100 "enrolled": true,
101 "sex": "female"
102 },
103 "site": {
104 "id": 1,
105 "name": "string",
106 "active": true,
107 "address": {
108 "lineOne": "string",
109 "lineTwo": "string",
110 "lineThree": "string",
111 "city": "string",
112 "state": "string",
113 "zipCode": "string",
114 "country": "string",
115 "note": "string"
116 }
117 },
118 "lastHealthCheck": "string",
119 "deviceIdentifiers": [
120 {
121 "type": "string",
122 "value": "string"
123 }
124 ],
125 "deviceEvents": [
126 {
127 "type": "string",
128 "eventTimestamp": "string"
129 }
130 ],
131 "externalIdentifier": "string",
132 "disabledReadings": true
133 },
134 "readingTimestamp": "string",
135 "weight": 0.1,
136 "manual": true
137 }
138 ],
139 "page": 0,
140 "size": 0,
141 "total": 0,
142 "first": true,
143 "last": true
144}

Patient

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the patient, managed by Impilo.
externalIdentifierstringfalseUnique external identifier for the patient, managed by the customer.
firstNamestringfalseThe patient’s first name.
lastNamestringfalseThe patient’s last name.
dateOfBirthstring(date)falseThe patient’s date of birth in the format YYYY-MM-DD.
emailstring(email)falseThe patient’s email.
phoneNumberstringfalseThe patient’s phone number.
archivedbooleanfalseTrue if the patient is archived, false otherwise.
addressAddressfalseThe patient’s shipping address.
siteSitefalseThe site responsible for this patient.
enrolledbooleanfalseThe enrollment status. False if disenrolled.
sexSexfalseSex
Patient Model Sample
1{
2 "id": 1,
3 "externalIdentifier": "1234abcd",
4 "firstName": "John",
5 "lastName": "Doe",
6 "dateOfBirth": "1980-01-01",
7 "email": "john.doe@example.com",
8 "phoneNumber": "+1234567890",
9 "archived": true,
10 "address": {
11 "lineOne": "string",
12 "lineTwo": "string",
13 "lineThree": "string",
14 "city": "string",
15 "state": "string",
16 "zipCode": "string",
17 "country": "string",
18 "note": "string"
19 },
20 "site": {
21 "id": 1,
22 "name": "string",
23 "active": true,
24 "address": {
25 "lineOne": "string",
26 "lineTwo": "string",
27 "lineThree": "string",
28 "city": "string",
29 "state": "string",
30 "zipCode": "string",
31 "country": "string",
32 "note": "string"
33 }
34 },
35 "enrolled": true,
36 "sex": "female"
37}

Procurement

A procurement is a procurement of devices by a customer.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the site, managed by Impilo.
currentStatusstringfalseThe current status of the procurement
procurementItems[ProcurementItem]falseList of items on the procurement
Procurement Model Sample
1{
2 "id": 1,
3 "currentStatus": "string",
4 "procurementItems": [
5 {
6 "item": {
7 "id": 1,
8 "manufacturer": {
9 "id": 1,
10 "name": "string"
11 },
12 "name": "string",
13 "model": "string",
14 "sku": "string"
15 },
16 "quantityRequested": 0,
17 "quantityApproved": 0,
18 "costPerItem": 0.1,
19 "trackingNumbers": [
20 {
21 "carrier": "string",
22 "value": "string"
23 }
24 ]
25 }
26 ]
27}

ProcurementItem

Properties

NameTypeRequiredDescription
itemItemfalseAn 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.
quantityRequestedinteger(int32)falsenone
quantityApprovedinteger(int32)falsenone
costPerItemnumber(double)falsenone
trackingNumbers[TrackingNumber]false[The tracking number model includes details about the shipping carrier and the tracking number value.]
ProcurementItem Model Sample
1{
2 "item": {
3 "id": 1,
4 "manufacturer": {
5 "id": 1,
6 "name": "string"
7 },
8 "name": "string",
9 "model": "string",
10 "sku": "string"
11 },
12 "quantityRequested": 0,
13 "quantityApproved": 0,
14 "costPerItem": 0.1,
15 "trackingNumbers": [
16 {
17 "carrier": "string",
18 "value": "string"
19 }
20 ]
21}

Return

A return is an occurrence of a device(s) or non-tracked item(s) being returned by a Patient.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the return, managed by Impilo.
patientPatientfalseThe patient that is making the return.
currentStatusstringfalseThe current status of this return.
returnItems[ReturnItem]falseAn array of non-tracked items expected on this return.
returnEvents[ReturnEvent]falseAn array of the return events for this return.
trackingNumbers[TrackingNumber]falseAn array of tracking numbers associated with this return.
returnDevices[Device]falseAn array of devices expected on this return.
relatedOrderIdinteger(int64)falseThe identifier of a related order, if exists.
Return Model Sample
1{
2 "id": 1,
3 "patient": {
4 "id": 1,
5 "externalIdentifier": "1234abcd",
6 "firstName": "John",
7 "lastName": "Doe",
8 "dateOfBirth": "1980-01-01",
9 "email": "john.doe@example.com",
10 "phoneNumber": "+1234567890",
11 "archived": true,
12 "address": {
13 "lineOne": "string",
14 "lineTwo": "string",
15 "lineThree": "string",
16 "city": "string",
17 "state": "string",
18 "zipCode": "string",
19 "country": "string",
20 "note": "string"
21 },
22 "site": {
23 "id": 1,
24 "name": "string",
25 "active": true,
26 "address": {
27 "lineOne": "string",
28 "lineTwo": "string",
29 "lineThree": "string",
30 "city": "string",
31 "state": "string",
32 "zipCode": "string",
33 "country": "string",
34 "note": "string"
35 }
36 },
37 "enrolled": true,
38 "sex": "female"
39 },
40 "currentStatus": "string",
41 "returnItems": [
42 {
43 "item": {
44 "id": 1,
45 "manufacturer": {
46 "id": 1,
47 "name": "string"
48 },
49 "name": "string",
50 "model": "string",
51 "sku": "string"
52 },
53 "count": 0
54 }
55 ],
56 "returnEvents": [
57 {
58 "type": "string",
59 "eventTimestamp": "string"
60 }
61 ],
62 "trackingNumbers": [
63 {
64 "carrier": "string",
65 "value": "string"
66 }
67 ],
68 "returnDevices": [
69 {
70 "id": 1,
71 "item": {
72 "id": 1,
73 "manufacturer": {
74 "id": 1,
75 "name": "string"
76 },
77 "name": "string",
78 "model": "string",
79 "sku": "string"
80 },
81 "currentStatus": "string",
82 "used": true,
83 "currentPatient": {
84 "id": 1,
85 "externalIdentifier": "1234abcd",
86 "firstName": "John",
87 "lastName": "Doe",
88 "dateOfBirth": "1980-01-01",
89 "email": "john.doe@example.com",
90 "phoneNumber": "+1234567890",
91 "archived": true,
92 "address": {
93 "lineOne": "string",
94 "lineTwo": "string",
95 "lineThree": "string",
96 "city": "string",
97 "state": "string",
98 "zipCode": "string",
99 "country": "string",
100 "note": "string"
101 },
102 "site": {
103 "id": 1,
104 "name": "string",
105 "active": true,
106 "address": {
107 "lineOne": "string",
108 "lineTwo": "string",
109 "lineThree": "string",
110 "city": "string",
111 "state": "string",
112 "zipCode": "string",
113 "country": "string",
114 "note": "string"
115 }
116 },
117 "enrolled": true,
118 "sex": "female"
119 },
120 "site": {
121 "id": 1,
122 "name": "string",
123 "active": true,
124 "address": {
125 "lineOne": "string",
126 "lineTwo": "string",
127 "lineThree": "string",
128 "city": "string",
129 "state": "string",
130 "zipCode": "string",
131 "country": "string",
132 "note": "string"
133 }
134 },
135 "lastHealthCheck": "string",
136 "deviceIdentifiers": [
137 {
138 "type": "string",
139 "value": "string"
140 }
141 ],
142 "deviceEvents": [
143 {
144 "type": "string",
145 "eventTimestamp": "string"
146 }
147 ],
148 "externalIdentifier": "string",
149 "disabledReadings": true
150 }
151 ],
152 "relatedOrderId": 0
153}

ReturnEvent

Properties

NameTypeRequiredDescription
typestringfalseThe event type for the Return Event.
eventTimestampstringfalseThe timestamp when the Return Event was created.
ReturnEvent Model Sample
1{
2 "type": "string",
3 "eventTimestamp": "string"
4}

ReturnItem

Properties

NameTypeRequiredDescription
itemItemfalseThe item type extected on this return.
countinteger(int32)falseThe quantity of this item type expected on this return.
ReturnItem Model Sample
1{
2 "item": {
3 "id": 1,
4 "manufacturer": {
5 "id": 1,
6 "name": "string"
7 },
8 "name": "string",
9 "model": "string",
10 "sku": "string"
11 },
12 "count": 0
13}

Sex

Enumerated Values

NameDesciption
otherSex other than male or female.
femaleFemale sex.
maleMale sex.
unknownSex is unknown.
Sex Model Sample
1"other"

Site

A site is a customer-managed location that interacts with Impilo’s services. Patient may be associated with a site, and a customer may order items and hold inventory at a site.

Properties

NameTypeRequiredDescription
idinteger(int64)falseUnique identifier for the site, managed by Impilo.
namestringfalseThe name of the site.
activebooleanfalseTrue if the site is active, false otherwise.
addressAddressfalseThe shipping address for the site.
Site Model Sample