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

Name	Type	Required	Description
lineOne	string	true	Address line one.
lineTwo	string	false	Address line two.
lineThree	string	false	Address line three.
city	string	true	Address city.
state	string	true	Address state.
zipCode	string	true	Address zip code.
country	string	true	Address country.
note	string	false	Address 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

Name	Type	Required	Description
deviceId	integer(int64)	false	The ID of the device. Either this value or a Device Identifier are required to identify the Device.
deviceIdentifier	string	false	The Identifier, such as a Serial Number, of the device. Either this value or a Device Id are required to identify the Device.
patientId	integer(int64)	false	The 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.
patientExternalIdentifier	string	false	The 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

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	The patient who took the reading.
item	Item	false	The item used to take the reading.
device	Device	false	The device used to take the reading.
glucose	integer(int32)	false	The blood glucose measurement value.
glucoseUnit	BloodGlucoseUnit	false	none
beforeMeal	boolean	false	True if the reading was taken before a meal, false otherwise.
afterMeal	boolean	false	True if the reading was taken after a meal, false otherwise.

BloodGlucoseReading Model Sample

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

BloodGlucoseReadingRequest

This page describes Impilo’s blood glucose reading model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
glucose	integer(int32)	true	The blood glucose measurement value.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
beforeMeal	boolean	false	True if the reading was taken before a meal, false otherwise.
afterMeal	boolean	false	True 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   "deviceTimeZoneOffset": -14400,
7   "glucose": 0,
8   "manual": true,
9   "beforeMeal": true,
10   "afterMeal": true
11 }

BloodGlucoseUnit

Enumerated Values

Name	Desciption
mgdl	Blood glucose unit of measurement is milligrams per deciliter.

BloodGlucoseUnit Model Sample

1 "mgdl"

BloodOxygenReading

This page describes Impilo’s blood oxygen reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	The patient who took the reading.
item	Item	false	The item used to take the reading.
device	Device	false	The device used to take the reading.
bloodOxygen	integer(int32)	false	The blood oxygen (spo2) measurement value.
bloodOxygenUnit	BloodOxygenUnit	false	none
heartRate	integer(int32)	false	The heart rate measurement value.
heartRateUnit	HeartRateUnit	false	none

BloodOxygenReading Model Sample

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

BloodOxygenReadingRequest

This page describes Impilo’s blood oxygen reading model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
bloodOxygen	integer(int32)	true	The blood oxygen (spo2) measurement value.
heartRate	integer(int32)	false	The heart rate measurement value.
manual	boolean	false	True 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   "deviceTimeZoneOffset": -14400,
7   "bloodOxygen": 0,
8   "heartRate": 0,
9   "manual": true
10 }

BloodOxygenUnit

Enumerated Values

Name	Desciption
spo2	Blood glucose unit of measurement is milligrams per deciliter.

BloodOxygenUnit Model Sample

1 "spo2"

BloodPressureReading

This page describes Impilo’s blood pressure reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	The patient who took the reading.
item	Item	false	The item used to take the reading.
device	Device	false	The device used to take the reading.
systolic	integer(int32)	false	The systolic measurement value.
systolicUnit	BloodPressureUnit	false	none
diastolic	integer(int32)	false	The diastolic measurement value.
diastolicUnit	BloodPressureUnit	false	none
heartRate	integer(int32)	false	The heart rate measurement value.
heartRateUnit	HeartRateUnit	false	none

BloodPressureReading Model Sample

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

BloodPressureReadingRequest

This page describes Impilo’s blood pressure reading model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
systolic	integer(int32)	true	The systolic measurement value.
diastolic	integer(int32)	true	The diastolic measurement value.
heartRate	integer(int32)	false	The heart rate measurement value.
manual	boolean	false	True 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   "deviceTimeZoneOffset": -14400,
7   "systolic": 0,
8   "diastolic": 0,
9   "heartRate": 0,
10   "manual": true
11 }

BloodPressureUnit

Enumerated Values

Name	Desciption
mmhg	Pressure unit of measurement is millimeters of mercury.

BloodPressureUnit Model Sample

1 "mmhg"

ClinicalNote

Clinical note for patients.

Properties

Name	Type	Required	Description
id	integer(int64)	false	The unique identifier of the clinical note.
type	ClinicalNoteType	false	The type of the clinical note.
cptCode	CptCode	false	The CPT code associated with the clinical note.
createTimestamp	string(date-time)	false	The timestamp when the clinical note was created.
lastUpdateTimestamp	string(date-time)	false	The timestamp when the clinical note was last updated.
open	boolean	false	Indicates whether the clinical note is open.
mdCode	string	false	The MD code associated with the clinical note.
dxCode	string	false	The DX code associated with the clinical note.
description	string	false	The description of the clinical note.
createdBy	EndUser	false	The user who created the clinical note.
assignee	EndUser	false	The user assigned to the clinical note.
patient	Patient	false	The patient associated with the clinical note.
activity	[ClinicalNoteActivity]	false	List of activities associated with the clinical note.
totalTime	integer(int32)	false	Total time in minutes spent on the clinical note.

ClinicalNote Model Sample

1 {
2   "id": 0,
3   "type": "other",
4   "cptCode": {
5     "value": "string",
6     "displayAs": "string"
7   },
8   "createTimestamp": "2022-03-10T16:15:50Z",
9   "lastUpdateTimestamp": "2022-03-10T16:15:50Z",
10   "open": true,
11   "mdCode": "string",
12   "dxCode": "string",
13   "description": "string",
14   "createdBy": {
15     "id": 0,
16     "firstName": "string",
17     "lastName": "string",
18     "email": "string"
19   },
20   "assignee": {
21     "id": 0,
22     "firstName": "string",
23     "lastName": "string",
24     "email": "string"
25   },
26   "patient": {
27     "id": 1,
28     "externalIdentifier": "1234abcd",
29     "firstName": "John",
30     "lastName": "Doe",
31     "dateOfBirth": "1980-01-01",
32     "email": "john.doe@example.com",
33     "phoneNumber": "+1234567890",
34     "archived": true,
35     "address": {
36       "lineOne": "string",
37       "lineTwo": "string",
38       "lineThree": "string",
39       "city": "string",
40       "state": "string",
41       "zipCode": "string",
42       "country": "string",
43       "note": "string"
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     "enrolled": true,
61     "sex": "other"
62   },
63   "activity": [
64     {
65       "createTimestamp": "2022-03-10T16:15:50Z",
66       "comment": "string",
67       "minutesSpent": 0,
68       "createdBy": {
69         "id": 0,
70         "firstName": "string",
71         "lastName": "string",
72         "email": "string"
73       }
74     }
75   ],
76   "totalTime": 0
77 }

ClinicalNoteActivity

Clinical note activity.

Properties

Name	Type	Required	Description
createTimestamp	string(date-time)	false	The timestamp when the activity was created.
comment	string	false	The comment associated with the activity.
minutesSpent	integer(int32)	false	The number of minutes spent on the activity.
createdBy	EndUser	false	The user who created the activity.

ClinicalNoteActivity Model Sample

1 {
2   "createTimestamp": "2022-03-10T16:15:50Z",
3   "comment": "string",
4   "minutesSpent": 0,
5   "createdBy": {
6     "id": 0,
7     "firstName": "string",
8     "lastName": "string",
9     "email": "string"
10   }
11 }

ClinicalNoteSort

Enumerated Values

Name	Desciption
open	Undefined
createTimestamp	Undefined

ClinicalNoteSort Model Sample

1 "open"

ClinicalNoteType

Enumerated Values

Name	Desciption
other	Clinical note of other type.
cptCode	Clinical note related to a CPT code.

ClinicalNoteType Model Sample

1 "other"

CptCode

Properties

Name	Type	Required	Description
value	string	false	none
displayAs	string	false	none

CptCode Model Sample

1 {
2   "value": "string",
3   "displayAs": "string"
4 }

Customer

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
name	string	false	none

Customer Model Sample

1 {
2   "id": 0,
3   "name": "string"
4 }

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

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the device, managed by Impilo.
item	Item	false	The manufacturer for this item.
currentStatus	string	false	The current status of this device.
used	boolean	false	True if this device is used, false otherwise.
currentPatient	Patient	false	The patient currently in possession of this device. Null if this device is not currently with a patient.
site	Site	false	The site to which this device is assigned.
lastHealthCheck	string	false	Timestamp for the last time Impilo received a signal from this device.
deviceIdentifiers	[DeviceIdentifier]	false	An array of the device identifiers for this device.
deviceEvents	[DeviceEvent]	false	An array of the device events for this device.
externalIdentifier	string	false	The external identifier for this device.
disabledReadings	boolean	false	True 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     "orderable": true
13   },
14   "currentStatus": "string",
15   "used": true,
16   "currentPatient": {
17     "id": 1,
18     "externalIdentifier": "1234abcd",
19     "firstName": "John",
20     "lastName": "Doe",
21     "dateOfBirth": "1980-01-01",
22     "email": "john.doe@example.com",
23     "phoneNumber": "+1234567890",
24     "archived": 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     "site": {
36       "id": 1,
37       "name": "string",
38       "active": true,
39       "address": {
40         "lineOne": "string",
41         "lineTwo": "string",
42         "lineThree": "string",
43         "city": "string",
44         "state": "string",
45         "zipCode": "string",
46         "country": "string",
47         "note": "string"
48       }
49     },
50     "enrolled": true,
51     "sex": "other"
52   },
53   "site": {
54     "id": 1,
55     "name": "string",
56     "active": true,
57     "address": {
58       "lineOne": "string",
59       "lineTwo": "string",
60       "lineThree": "string",
61       "city": "string",
62       "state": "string",
63       "zipCode": "string",
64       "country": "string",
65       "note": "string"
66     }
67   },
68   "lastHealthCheck": "string",
69   "deviceIdentifiers": [
70     {
71       "type": "string",
72       "value": "string"
73     }
74   ],
75   "deviceEvents": [
76     {
77       "type": "string",
78       "eventTimestamp": "string"
79     }
80   ],
81   "externalIdentifier": "string",
82   "disabledReadings": true
83 }

DeviceAssociationWebhookPayload

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

Properties

Name	Type	Required	Description
patient	Patient	false	The Patient that the device was either associated with or disassociated from.
device	Device	false	The Device that was associated to or disassociated from the provided Patient.
action	string	false	The type of association that was performed — either ‘associate’ or ‘disassociate’.
eventTimestamp	string	false	The 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": "other"
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       "orderable": true
51     },
52     "currentStatus": "string",
53     "used": true,
54     "currentPatient": {
55       "id": 1,
56       "externalIdentifier": "1234abcd",
57       "firstName": "John",
58       "lastName": "Doe",
59       "dateOfBirth": "1980-01-01",
60       "email": "john.doe@example.com",
61       "phoneNumber": "+1234567890",
62       "archived": true,
63       "address": {
64         "lineOne": "string",
65         "lineTwo": "string",
66         "lineThree": "string",
67         "city": "string",
68         "state": "string",
69         "zipCode": "string",
70         "country": "string",
71         "note": "string"
72       },
73       "site": {
74         "id": 1,
75         "name": "string",
76         "active": true,
77         "address": {
78           "lineOne": "string",
79           "lineTwo": "string",
80           "lineThree": "string",
81           "city": "string",
82           "state": "string",
83           "zipCode": "string",
84           "country": "string",
85           "note": "string"
86         }
87       },
88       "enrolled": true,
89       "sex": "other"
90     },
91     "site": {
92       "id": 1,
93       "name": "string",
94       "active": true,
95       "address": {
96         "lineOne": "string",
97         "lineTwo": "string",
98         "lineThree": "string",
99         "city": "string",
100         "state": "string",
101         "zipCode": "string",
102         "country": "string",
103         "note": "string"
104       }
105     },
106     "lastHealthCheck": "string",
107     "deviceIdentifiers": [
108       {
109         "type": "string",
110         "value": "string"
111       }
112     ],
113     "deviceEvents": [
114       {
115         "type": "string",
116         "eventTimestamp": "string"
117       }
118     ],
119     "externalIdentifier": "string",
120     "disabledReadings": true
121   },
122   "action": "string",
123   "eventTimestamp": "string"
124 }

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

Name	Type	Required	Description
type	string	false	The event type for the Device Event.
eventTimestamp	string	false	The 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

Name	Type	Required	Description
type	string	false	The type of the Device Identifier.
value	string	false	The value of the Device Identifier, based on it’s type.

DeviceIdentifier Model Sample

1 {
2   "type": "string",
3   "value": "string"
4 }

DeviceIdentifierType

Enumerated Values

Name	Desciption
simCardNumber	Undefined
macAddress	Undefined
iccid	Undefined
serial	Undefined
imei	Undefined

DeviceIdentifierType Model Sample

1 "simCardNumber"

DeviceReferenceRequest

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

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The ID of the device. Either this value or a Device Identifier are required to identify the Device.
deviceIdentifier	string	false	The 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 }

DeviceSort

Enumerated Values

Name	Desciption
itemName	Undefined
itemModel	Undefined
itemSku	Undefined
deviceId	Undefined

DeviceSort Model Sample

1 "itemName"

DeviceStatus

Enumerated Values

Name	Desciption
initiated	Device initialization has been initiated.
awaitingShipment	Device is awaiting shipment.
available	Device is available for use.
withPatient	Device is currently with a patient.
availableAtSite	Device is available at a site.
delivered	Device has been delivered.
used	Device is currently in use.
refurbishing	Device is being refurbished.
packedAtSite	Device is packed in a kit at a site, ready to be assigned to a patient.
receivedInError	Device was received in error and is no longer available for use.
decommissioned	Device has been decommissioned.
shipped	Device has been shipped.
availableRepacked	Device is available and repacked.
returnedManufacturer	Device has been returned to the manufacturer.
packed	Device is packed and ready for shipment or use.

DeviceStatus Model Sample

1 "initiated"

DimensionUnit

Enumerated Values

Name	Desciption
in	Inches.
cm	Centimeters.

DimensionUnit Model Sample

1 "in"

DisenrollPatientRequest

Properties

Name	Type	Required	Description
archive	boolean	false	Whether or not the patient to be disenrolled should also be archived.
createReturns	boolean	false	Whether or not Returns should be placed for the patient to be disenrolled.

DisenrollPatientRequest Model Sample

1 {
2   "archive": true,
3   "createReturns": true
4 }

EndUser

User information.

Properties

Name	Type	Required	Description
id	integer(int64)	false	The unique identifier of the user.
firstName	string	false	The first name of the user.
lastName	string	false	The last name of the user.
email	string	false	The email address of the user.

EndUser Model Sample

1 {
2   "id": 0,
3   "firstName": "string",
4   "lastName": "string",
5   "email": "string"
6 }

HeartRateReading

Impilo’s heart rate model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	false	none
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
heartRate	integer(int32)	false	The heart rate measurement value.
patient	Patient	false	none
item	Item	false	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.
device	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.

HeartRateReading Model Sample

1 {
2   "id": 0,
3   "readingTimestamp": "2022-03-10T16:15:50Z",
4   "manual": true,
5   "deviceTimeZoneOffset": -14400,
6   "patientTimeZoneOffset": -14400,
7   "heartRate": 0,
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": "other"
44   },
45   "item": {
46     "id": 1,
47     "manufacturer": {
48       "id": 1,
49       "name": "string"
50     },
51     "name": "string",
52     "model": "string",
53     "sku": "string",
54     "orderable": true
55   },
56   "device": {
57     "id": 1,
58     "item": {
59       "id": 1,
60       "manufacturer": {
61         "id": 1,
62         "name": "string"
63       },
64       "name": "string",
65       "model": "string",
66       "sku": "string",
67       "orderable": true
68     },
69     "currentStatus": "string",
70     "used": true,
71     "currentPatient": {
72       "id": 1,
73       "externalIdentifier": "1234abcd",
74       "firstName": "John",
75       "lastName": "Doe",
76       "dateOfBirth": "1980-01-01",
77       "email": "john.doe@example.com",
78       "phoneNumber": "+1234567890",
79       "archived": true,
80       "address": {
81         "lineOne": "string",
82         "lineTwo": "string",
83         "lineThree": "string",
84         "city": "string",
85         "state": "string",
86         "zipCode": "string",
87         "country": "string",
88         "note": "string"
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       "enrolled": true,
106       "sex": "other"
107     },
108     "site": {
109       "id": 1,
110       "name": "string",
111       "active": true,
112       "address": {
113         "lineOne": "string",
114         "lineTwo": "string",
115         "lineThree": "string",
116         "city": "string",
117         "state": "string",
118         "zipCode": "string",
119         "country": "string",
120         "note": "string"
121       }
122     },
123     "lastHealthCheck": "string",
124     "deviceIdentifiers": [
125       {
126         "type": "string",
127         "value": "string"
128       }
129     ],
130     "deviceEvents": [
131       {
132         "type": "string",
133         "eventTimestamp": "string"
134       }
135     ],
136     "externalIdentifier": "string",
137     "disabledReadings": true
138   }
139 }

HeartRateReadingRequest

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	Instant	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
heartRate	integer(int32)	false	The heart rate measurement value.

HeartRateReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "manual": true,
8   "heartRate": 0
9 }

HeartRateUnit

Enumerated Values

Name	Desciption
bpm	Heart rate unit of measurement is beats per minute.

HeartRateUnit Model Sample

1 "bpm"

HeartRateVariabilityAlgorithmType

Enumerated Values

Name	Desciption
sdann	Standard deviation of the average NN intervals calculated over short periods.
sdnn	Standard deviation of all NN intervals.
sdrr	Standard deviation of the differences between adjacent NN intervals.

HeartRateVariabilityAlgorithmType Model Sample

1 "sdann"

HeartRateVariabilityReading

Impilo’s heart rate variability model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	false	none
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
heartRate	integer(int32)	false	The heart rate measurement value.
heartRateVariability	number(double)	true	The heart rate variability value.
heartRateVariabilityDuration	integer(int64)	false	The duration over which the heart rate variability was measured, in milliseconds.
patient	Patient	false	none
item	Item	false	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.
device	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.
heartRateVariabilityAlgorithmType	HeartRateVariabilityAlgorithmType	false	none

HeartRateVariabilityReading Model Sample

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

HeartRateVariabilityReadingRequest

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	Instant	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
heartRate	integer(int32)	false	The heart rate measurement value.
heartRateVariability	number(double)	true	The heart rate variability value.
heartRateVariabilityDuration	integer(int64)	false	The duration over which the heart rate variability was measured, in milliseconds.
heartRateVariabilityAlgorithmType	HeartRateVariabilityAlgorithmType	false	none

HeartRateVariabilityReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "manual": true,
8   "heartRate": 0,
9   "heartRateVariability": 0.1,
10   "heartRateVariabilityDuration": 0,
11   "heartRateVariabilityAlgorithmType": "sdann"
12 }

Instant

Instant Model Sample

1 "2022-03-10T16:15:50Z"

InventoryRecord

Properties

Name	Type	Required	Description
item	Item	false	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.
newCount	integer(int32)	false	none
usedCount	integer(int32)	false	none
site	Site	false	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.

InventoryRecord 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     "orderable": true
12   },
13   "newCount": 0,
14   "usedCount": 0,
15   "site": {
16     "id": 1,
17     "name": "string",
18     "active": true,
19     "address": {
20       "lineOne": "string",
21       "lineTwo": "string",
22       "lineThree": "string",
23       "city": "string",
24       "state": "string",
25       "zipCode": "string",
26       "country": "string",
27       "note": "string"
28     }
29   }
30 }

InventorySummaryRecord

Properties

Name	Type	Required	Description
item	Item	false	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.
newCount	integer(int32)	false	none
usedCount	integer(int32)	false	none

InventorySummaryRecord 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     "orderable": true
12   },
13   "newCount": 0,
14   "usedCount": 0
15 }

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

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the item, managed by Impilo.
manufacturer	Manufacturer	false	The manufacturer for this item.
name	string	false	The name for this item.
model	string	false	The manufacturer-assigned model for this item.
sku	string	false	The Impilo-assigned SKU for this item.
orderable	boolean	false	Whether an Item is able to be ordered.

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   "orderable": true
11 }

ItemClass

Enumerated Values

Name	Desciption
wearable	Items related to wearable devices.
glucose	Items related to glucose monitoring.
miscellaneous	Miscellaneous items.
circulatory	Items related to the circulatory system.
packaging	Items related to packaging.
lab	Items related to laboratory equipment.
body	Items related to the body.
familyPlanning	Items related to family planning.
cpap	Items related to Continuous Positive Airway Pressure (CPAP).
connectivity	Items related to connectivity.
generalHealth	Items related to general health.
service	Service-related items.
thermometer	Items related to thermometers.
power	Items related to power supply.
respiratory	Items related to the respiratory system.
info	Informational items.

ItemClass Model Sample

1 "wearable"

ItemDetailed

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the item, managed by Impilo.
manufacturer	Manufacturer	false	The manufacturer for this item.
name	string	false	The name for this item.
model	string	false	The manufacturer-assigned model for this item.
sku	string	false	The Impilo-assigned SKU for this item.
orderable	boolean	false	Whether an Item is able to be ordered.
deviceIdentifierType	DeviceIdentifierType	false	none
itemClass	ItemClass	false	none
itemClassType	string	false	The Class Type associated with this item.
size	ItemSize	false	none
dimensions	ItemDimensions	false	The physical dimensions of this item.
readingType	ReadingType	false	none

ItemDetailed 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   "orderable": true,
11   "deviceIdentifierType": "simCardNumber",
12   "itemClass": "wearable",
13   "itemClassType": "string",
14   "size": "standard",
15   "dimensions": {
16     "length": 0.1,
17     "width": 0.1,
18     "height": 0.1,
19     "unit": "in"
20   },
21   "readingType": "bloodPressure"
22 }

ItemDimensions

The length, width, height, and units of distance for the physical body of the Item.

Properties

Name	Type	Required	Description
length	number(double)	false	The length of the Item.
width	number(double)	false	The width of the Item.
height	number(double)	false	The height of the Item.
unit	DimensionUnit	false	none

ItemDimensions Model Sample

1 {
2   "length": 0.1,
3   "width": 0.1,
4   "height": 0.1,
5   "unit": "in"
6 }

ItemRequest

An ItemRequest object consists of a name (required), a model, and (if applicable) a deviceIdentifierType that is being requested to be created by a Manufacturer.

Device Identifier Types must match the DeviceIdentifierType model.

Properties

Name	Type	Required	Description
name	string	true	The name for this item.
model	string	false	The manufacturer-assigned model for this item.
deviceIdentifierType	DeviceIdentifierType	false	none

ItemRequest Model Sample

1 {
2   "name": "string",
3   "model": "string",
4   "deviceIdentifierType": "simCardNumber"
5 }

ItemSize

Enumerated Values

Name	Desciption
standard	Standard sized item.
small	Small sized item.
large	Large sized item.
extraLarge	Extra large sized item.
medium	Medium sized item.

ItemSize Model Sample

1 "standard"

ItemSort

Enumerated Values

Name	Desciption
itemId	Undefined
itemName	Undefined
itemModel	Undefined
itemSku	Undefined

ItemSort Model Sample

1 "itemId"

ItemTransferRequest

Properties

Name	Type	Required	Description
toCustomerId	integer(int64)	true	The ID of the Customer to transfer the Devices to.
transfers	[TransferItem]	true	A list of ItemTransfer objects containing the Item IDs and quantities to transfer.

ItemTransferRequest Model Sample

1 {
2   "toCustomerId": 0,
3   "transfers": [
4     {
5       "item": {
6         "id": 1,
7         "manufacturer": {
8           "id": 1,
9           "name": "string"
10         },
11         "name": "string",
12         "model": "string",
13         "sku": "string",
14         "orderable": true
15       },
16       "count": 0,
17       "devices": [
18         {
19           "id": 1,
20           "item": {
21             "id": 1,
22             "manufacturer": {
23               "id": 1,
24               "name": "string"
25             },
26             "name": "string",
27             "model": "string",
28             "sku": "string",
29             "orderable": true
30           },
31           "currentStatus": "string",
32           "used": true,
33           "currentPatient": {
34             "id": 1,
35             "externalIdentifier": "1234abcd",
36             "firstName": "John",
37             "lastName": "Doe",
38             "dateOfBirth": "1980-01-01",
39             "email": "john.doe@example.com",
40             "phoneNumber": "+1234567890",
41             "archived": true,
42             "address": {
43               "lineOne": "string",
44               "lineTwo": "string",
45               "lineThree": "string",
46               "city": "string",
47               "state": "string",
48               "zipCode": "string",
49               "country": "string",
50               "note": "string"
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             "enrolled": true,
68             "sex": "other"
69           },
70           "site": {
71             "id": 1,
72             "name": "string",
73             "active": true,
74             "address": {
75               "lineOne": "string",
76               "lineTwo": "string",
77               "lineThree": "string",
78               "city": "string",
79               "state": "string",
80               "zipCode": "string",
81               "country": "string",
82               "note": "string"
83             }
84           },
85           "lastHealthCheck": "string",
86           "deviceIdentifiers": [
87             {
88               "type": "string",
89               "value": "string"
90             }
91           ],
92           "deviceEvents": [
93             {
94               "type": "string",
95               "eventTimestamp": "string"
96             }
97           ],
98           "externalIdentifier": "string",
99           "disabledReadings": true
100         }
101       ]
102     }
103   ]
104 }

Kit

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

Properties

Name	Type	Required	Description
id	integer(int64)	false	none
name	string	false	The name of the kit.
archived	boolean	false	True if the kit is archived, false otherwise.
kitItems	[KitItem]	false	An 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         "orderable": true
17       },
18       "count": 0
19     }
20   ]
21 }

KitItem

Properties

Name	Type	Required	Description
item	Item	false	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.
count	integer(int32)	false	none

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     "orderable": true
12   },
13   "count": 0
14 }

LocalDate

LocalDate Model Sample

1 "2022-03-10"

Manufacturer

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

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the manufacturer, managed by Impilo.
name	string	false	The name of the manufacturer.

Manufacturer Model Sample

1 {
2   "id": 1,
3   "name": "string"
4 }

Order

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the order
externalOrderIds	[string]	false	An array of order ids specified by the client
patient	Patient	false	The patient receiving the order. Exactly one of patient or site must be not null.
site	Site	false	The site receiving the order. Exactly one of patient or site must be not null.
currentStatus	string	false	The current status of the order
orderItems	[OrderItem]	false	Array of items on the order. At least one of orderItems or orderKits must be not null.
orderKits	[OrderKit]	false	Array of order kits on the order. At least one of orderItems or orderKits must be not null.
orderEvents	[OrderEvent]	false	Array of order events. These are the status updates for the order.
trackingNumbers	[TrackingNumber]	false	Array of tracking numbers for the order.
devices	[Device]	false	The order item devices
packedKits	[PackedKit]	false	The kits packed in the order
shippingOption	ShippingOption	false	none

currentStatus Enumerated Values

The current status of the order

Name	Desciption
availableForPickup	Order is waiting for the recipient to pickup at the post office.
onHold	Order is on hold, possibly due to inventory or internal reviews.
unsuccessfulDelivery	Delivery of the order was attempted but unsuccessful.
awaitingShipment	Order is ready to be shipped but is waiting for the next shipment cycle.
returnIssued	A return process has been initiated for the order.
pendingInventory	Order is waiting for inventory to become available before it can be fulfilled.
delivered	Order has been successfully delivered to the recipient.
reconfirmAddress	Customer needs to reconfirm their address.
unableToFulfill	Order cannot be fulfilled due to current limitations or issues.
orderPlaced	Order has been successfully placed and is in the system.
shipped	Order has been shipped to the recipient.
voided	Order has been canceled and is no longer valid.
pendingAdditionalInformation	Order 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": "other"
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": "availableForPickup",
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         "orderable": true
71       },
72       "count": 0
73     }
74   ],
75   "orderKits": [
76     {
77       "kit": {
78         "id": 0,
79         "name": "string",
80         "archived": true,
81         "kitItems": [
82           {
83             "item": {
84               "id": 1,
85               "manufacturer": {
86                 "id": 1,
87                 "name": "string"
88               },
89               "name": "string",
90               "model": "string",
91               "sku": "string",
92               "orderable": true
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         "orderable": true
126       },
127       "currentStatus": "string",
128       "used": true,
129       "currentPatient": {
130         "id": 1,
131         "externalIdentifier": "1234abcd",
132         "firstName": "John",
133         "lastName": "Doe",
134         "dateOfBirth": "1980-01-01",
135         "email": "john.doe@example.com",
136         "phoneNumber": "+1234567890",
137         "archived": true,
138         "address": {
139           "lineOne": "string",
140           "lineTwo": "string",
141           "lineThree": "string",
142           "city": "string",
143           "state": "string",
144           "zipCode": "string",
145           "country": "string",
146           "note": "string"
147         },
148         "site": {
149           "id": 1,
150           "name": "string",
151           "active": true,
152           "address": {
153             "lineOne": "string",
154             "lineTwo": "string",
155             "lineThree": "string",
156             "city": "string",
157             "state": "string",
158             "zipCode": "string",
159             "country": "string",
160             "note": "string"
161           }
162         },
163         "enrolled": true,
164         "sex": "other"
165       },
166       "site": {
167         "id": 1,
168         "name": "string",
169         "active": true,
170         "address": {
171           "lineOne": "string",
172           "lineTwo": "string",
173           "lineThree": "string",
174           "city": "string",
175           "state": "string",
176           "zipCode": "string",
177           "country": "string",
178           "note": "string"
179         }
180       },
181       "lastHealthCheck": "string",
182       "deviceIdentifiers": [
183         {
184           "type": "string",
185           "value": "string"
186         }
187       ],
188       "deviceEvents": [
189         {
190           "type": "string",
191           "eventTimestamp": "string"
192         }
193       ],
194       "externalIdentifier": "string",
195       "disabledReadings": true
196     }
197   ],
198   "packedKits": [
199     {
200       "kit": {
201         "id": 0,
202         "name": "string",
203         "archived": true,
204         "kitItems": [
205           {
206             "item": {
207               "id": 1,
208               "manufacturer": {
209                 "id": 1,
210                 "name": "string"
211               },
212               "name": "string",
213               "model": "string",
214               "sku": "string",
215               "orderable": true
216             },
217             "count": 0
218           }
219         ]
220       },
221       "devices": [
222         {
223           "id": 1,
224           "item": {
225             "id": 1,
226             "manufacturer": {
227               "id": 1,
228               "name": "string"
229             },
230             "name": "string",
231             "model": "string",
232             "sku": "string",
233             "orderable": true
234           },
235           "currentStatus": "string",
236           "used": true,
237           "currentPatient": {
238             "id": 1,
239             "externalIdentifier": "1234abcd",
240             "firstName": "John",
241             "lastName": "Doe",
242             "dateOfBirth": "1980-01-01",
243             "email": "john.doe@example.com",
244             "phoneNumber": "+1234567890",
245             "archived": true,
246             "address": {
247               "lineOne": "string",
248               "lineTwo": "string",
249               "lineThree": "string",
250               "city": "string",
251               "state": "string",
252               "zipCode": "string",
253               "country": "string",
254               "note": "string"
255             },
256             "site": {
257               "id": 1,
258               "name": "string",
259               "active": true,
260               "address": {
261                 "lineOne": "string",
262                 "lineTwo": "string",
263                 "lineThree": "string",
264                 "city": "string",
265                 "state": "string",
266                 "zipCode": "string",
267                 "country": "string",
268                 "note": "string"
269               }
270             },
271             "enrolled": true,
272             "sex": "other"
273           },
274           "site": {
275             "id": 1,
276             "name": "string",
277             "active": true,
278             "address": {
279               "lineOne": "string",
280               "lineTwo": "string",
281               "lineThree": "string",
282               "city": "string",
283               "state": "string",
284               "zipCode": "string",
285               "country": "string",
286               "note": "string"
287             }
288           },
289           "lastHealthCheck": "string",
290           "deviceIdentifiers": [
291             {
292               "type": "string",
293               "value": "string"
294             }
295           ],
296           "deviceEvents": [
297             {
298               "type": "string",
299               "eventTimestamp": "string"
300             }
301           ],
302           "externalIdentifier": "string",
303           "disabledReadings": true
304         }
305       ]
306     }
307   ],
308   "shippingOption": "standard"
309 }

OrderEvent

Properties

Name	Type	Required	Description
name	string	false	none
eventTimestamp	string	false	none

OrderEvent Model Sample

1 {
2   "name": "string",
3   "eventTimestamp": "string"
4 }

OrderItem

Properties

Name	Type	Required	Description
item	Item	false	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.
count	integer(int32)	false	none

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     "orderable": true
12   },
13   "count": 0
14 }

OrderKit

Properties

Name	Type	Required	Description
kit	Kit	false	A kit is a named collection of items that can be ordered as one unit.
count	integer(int32)	false	none

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           "orderable": true
18         },
19         "count": 0
20       }
21     ]
22   },
23   "count": 0
24 }

PackedKit

Properties

Name	Type	Required	Description
kit	Kit	false	A 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           "orderable": true
18         },
19         "count": 0
20       }
21     ]
22   },
23   "devices": [
24     {
25       "id": 1,
26       "item": {
27         "id": 1,
28         "manufacturer": {
29           "id": 1,
30           "name": "string"
31         },
32         "name": "string",
33         "model": "string",
34         "sku": "string",
35         "orderable": true
36       },
37       "currentStatus": "string",
38       "used": true,
39       "currentPatient": {
40         "id": 1,
41         "externalIdentifier": "1234abcd",
42         "firstName": "John",
43         "lastName": "Doe",
44         "dateOfBirth": "1980-01-01",
45         "email": "john.doe@example.com",
46         "phoneNumber": "+1234567890",
47         "archived": true,
48         "address": {
49           "lineOne": "string",
50           "lineTwo": "string",
51           "lineThree": "string",
52           "city": "string",
53           "state": "string",
54           "zipCode": "string",
55           "country": "string",
56           "note": "string"
57         },
58         "site": {
59           "id": 1,
60           "name": "string",
61           "active": 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         },
73         "enrolled": true,
74         "sex": "other"
75       },
76       "site": {
77         "id": 1,
78         "name": "string",
79         "active": true,
80         "address": {
81           "lineOne": "string",
82           "lineTwo": "string",
83           "lineThree": "string",
84           "city": "string",
85           "state": "string",
86           "zipCode": "string",
87           "country": "string",
88           "note": "string"
89         }
90       },
91       "lastHealthCheck": "string",
92       "deviceIdentifiers": [
93         {
94           "type": "string",
95           "value": "string"
96         }
97       ],
98       "deviceEvents": [
99         {
100           "type": "string",
101           "eventTimestamp": "string"
102         }
103       ],
104       "externalIdentifier": "string",
105       "disabledReadings": true
106     }
107   ]
108 }

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

Name	Type	Required	Description
content	[any]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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

Properties

Name	Type	Required	Description
content	[BloodGlucoseReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageBloodGlucoseReading Model Sample

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

PageBloodOxygenReading

Properties

Name	Type	Required	Description
content	[BloodOxygenReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageBloodOxygenReading Model Sample

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

PageBloodPressureReading

Properties

Name	Type	Required	Description
content	[BloodPressureReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageBloodPressureReading Model Sample

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

PageClinicalNote

Properties

Name	Type	Required	Description
content	[ClinicalNote]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageClinicalNote Model Sample

1 {
2   "content": [
3     {
4       "id": 0,
5       "type": "other",
6       "cptCode": {
7         "value": "string",
8         "displayAs": "string"
9       },
10       "createTimestamp": "2022-03-10T16:15:50Z",
11       "lastUpdateTimestamp": "2022-03-10T16:15:50Z",
12       "open": true,
13       "mdCode": "string",
14       "dxCode": "string",
15       "description": "string",
16       "createdBy": {
17         "id": 0,
18         "firstName": "string",
19         "lastName": "string",
20         "email": "string"
21       },
22       "assignee": {
23         "id": 0,
24         "firstName": "string",
25         "lastName": "string",
26         "email": "string"
27       },
28       "patient": {
29         "id": 1,
30         "externalIdentifier": "1234abcd",
31         "firstName": "John",
32         "lastName": "Doe",
33         "dateOfBirth": "1980-01-01",
34         "email": "john.doe@example.com",
35         "phoneNumber": "+1234567890",
36         "archived": true,
37         "address": {
38           "lineOne": "string",
39           "lineTwo": "string",
40           "lineThree": "string",
41           "city": "string",
42           "state": "string",
43           "zipCode": "string",
44           "country": "string",
45           "note": "string"
46         },
47         "site": {
48           "id": 1,
49           "name": "string",
50           "active": true,
51           "address": {
52             "lineOne": "string",
53             "lineTwo": "string",
54             "lineThree": "string",
55             "city": "string",
56             "state": "string",
57             "zipCode": "string",
58             "country": "string",
59             "note": "string"
60           }
61         },
62         "enrolled": true,
63         "sex": "other"
64       },
65       "activity": [
66         {
67           "createTimestamp": "2022-03-10T16:15:50Z",
68           "comment": "string",
69           "minutesSpent": 0,
70           "createdBy": {
71             "id": 0,
72             "firstName": "string",
73             "lastName": "string",
74             "email": "string"
75           }
76         }
77       ],
78       "totalTime": 0
79     }
80   ],
81   "page": 0,
82   "size": 0,
83   "total": 0,
84   "first": true,
85   "last": true
86 }

PageDevice

Properties

Name	Type	Required	Description
content	[Device]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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         "orderable": true
15       },
16       "currentStatus": "string",
17       "used": true,
18       "currentPatient": {
19         "id": 1,
20         "externalIdentifier": "1234abcd",
21         "firstName": "John",
22         "lastName": "Doe",
23         "dateOfBirth": "1980-01-01",
24         "email": "john.doe@example.com",
25         "phoneNumber": "+1234567890",
26         "archived": true,
27         "address": {
28           "lineOne": "string",
29           "lineTwo": "string",
30           "lineThree": "string",
31           "city": "string",
32           "state": "string",
33           "zipCode": "string",
34           "country": "string",
35           "note": "string"
36         },
37         "site": {
38           "id": 1,
39           "name": "string",
40           "active": true,
41           "address": {
42             "lineOne": "string",
43             "lineTwo": "string",
44             "lineThree": "string",
45             "city": "string",
46             "state": "string",
47             "zipCode": "string",
48             "country": "string",
49             "note": "string"
50           }
51         },
52         "enrolled": true,
53         "sex": "other"
54       },
55       "site": {
56         "id": 1,
57         "name": "string",
58         "active": true,
59         "address": {
60           "lineOne": "string",
61           "lineTwo": "string",
62           "lineThree": "string",
63           "city": "string",
64           "state": "string",
65           "zipCode": "string",
66           "country": "string",
67           "note": "string"
68         }
69       },
70       "lastHealthCheck": "string",
71       "deviceIdentifiers": [
72         {
73           "type": "string",
74           "value": "string"
75         }
76       ],
77       "deviceEvents": [
78         {
79           "type": "string",
80           "eventTimestamp": "string"
81         }
82       ],
83       "externalIdentifier": "string",
84       "disabledReadings": true
85     }
86   ],
87   "page": 0,
88   "size": 0,
89   "total": 0,
90   "first": true,
91   "last": true
92 }

PageHeartRateReading

Properties

Name	Type	Required	Description
content	[HeartRateReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageHeartRateReading Model Sample

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

PageHeartRateVariabilityReading

Properties

Name	Type	Required	Description
content	[HeartRateVariabilityReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageHeartRateVariabilityReading Model Sample

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

PageInventoryRecord

Properties

Name	Type	Required	Description
content	[InventoryRecord]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageInventoryRecord Model Sample

1 {
2   "content": [
3     {
4       "item": {
5         "id": 1,
6         "manufacturer": {
7           "id": 1,
8           "name": "string"
9         },
10         "name": "string",
11         "model": "string",
12         "sku": "string",
13         "orderable": true
14       },
15       "newCount": 0,
16       "usedCount": 0,
17       "site": {
18         "id": 1,
19         "name": "string",
20         "active": true,
21         "address": {
22           "lineOne": "string",
23           "lineTwo": "string",
24           "lineThree": "string",
25           "city": "string",
26           "state": "string",
27           "zipCode": "string",
28           "country": "string",
29           "note": "string"
30         }
31       }
32     }
33   ],
34   "page": 0,
35   "size": 0,
36   "total": 0,
37   "first": true,
38   "last": true
39 }

PageInventorySummaryRecord

Properties

Name	Type	Required	Description
content	[InventorySummaryRecord]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageInventorySummaryRecord Model Sample

1 {
2   "content": [
3     {
4       "item": {
5         "id": 1,
6         "manufacturer": {
7           "id": 1,
8           "name": "string"
9         },
10         "name": "string",
11         "model": "string",
12         "sku": "string",
13         "orderable": true
14       },
15       "newCount": 0,
16       "usedCount": 0
17     }
18   ],
19   "page": 0,
20   "size": 0,
21   "total": 0,
22   "first": true,
23   "last": true
24 }

PageItemDetailed

Properties

Name	Type	Required	Description
content	[ItemDetailed]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageItemDetailed 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       "orderable": true,
13       "deviceIdentifierType": "simCardNumber",
14       "itemClass": "wearable",
15       "itemClassType": "string",
16       "size": "standard",
17       "dimensions": {
18         "length": 0.1,
19         "width": 0.1,
20         "height": 0.1,
21         "unit": "in"
22       },
23       "readingType": "bloodPressure"
24     }
25   ],
26   "page": 0,
27   "size": 0,
28   "total": 0,
29   "first": true,
30   "last": true
31 }

PageKit

Properties

Name	Type	Required	Description
content	[Kit]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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             "orderable": true
19           },
20           "count": 0
21         }
22       ]
23     }
24   ],
25   "page": 0,
26   "size": 0,
27   "total": 0,
28   "first": true,
29   "last": true
30 }

PageManufacturer

Properties

Name	Type	Required	Description
content	[Manufacturer]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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

Properties

Name	Type	Required	Description
content	[Order]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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": "other"
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": "availableForPickup",
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             "orderable": true
73           },
74           "count": 0
75         }
76       ],
77       "orderKits": [
78         {
79           "kit": {
80             "id": 0,
81             "name": "string",
82             "archived": true,
83             "kitItems": [
84               {
85                 "item": {
86                   "id": 1,
87                   "manufacturer": {
88                     "id": 1,
89                     "name": "string"
90                   },
91                   "name": "string",
92                   "model": "string",
93                   "sku": "string",
94                   "orderable": true
95                 },
96                 "count": 0
97               }
98             ]
99           },
100           "count": 0
101         }
102       ],
103       "orderEvents": [
104         {
105           "name": "string",
106           "eventTimestamp": "string"
107         }
108       ],
109       "trackingNumbers": [
110         {
111           "carrier": "string",
112           "value": "string"
113         }
114       ],
115       "devices": [
116         {
117           "id": 1,
118           "item": {
119             "id": 1,
120             "manufacturer": {
121               "id": 1,
122               "name": "string"
123             },
124             "name": "string",
125             "model": "string",
126             "sku": "string",
127             "orderable": true
128           },
129           "currentStatus": "string",
130           "used": true,
131           "currentPatient": {
132             "id": 1,
133             "externalIdentifier": "1234abcd",
134             "firstName": "John",
135             "lastName": "Doe",
136             "dateOfBirth": "1980-01-01",
137             "email": "john.doe@example.com",
138             "phoneNumber": "+1234567890",
139             "archived": true,
140             "address": {
141               "lineOne": "string",
142               "lineTwo": "string",
143               "lineThree": "string",
144               "city": "string",
145               "state": "string",
146               "zipCode": "string",
147               "country": "string",
148               "note": "string"
149             },
150             "site": {
151               "id": 1,
152               "name": "string",
153               "active": true,
154               "address": {
155                 "lineOne": "string",
156                 "lineTwo": "string",
157                 "lineThree": "string",
158                 "city": "string",
159                 "state": "string",
160                 "zipCode": "string",
161                 "country": "string",
162                 "note": "string"
163               }
164             },
165             "enrolled": true,
166             "sex": "other"
167           },
168           "site": {
169             "id": 1,
170             "name": "string",
171             "active": true,
172             "address": {
173               "lineOne": "string",
174               "lineTwo": "string",
175               "lineThree": "string",
176               "city": "string",
177               "state": "string",
178               "zipCode": "string",
179               "country": "string",
180               "note": "string"
181             }
182           },
183           "lastHealthCheck": "string",
184           "deviceIdentifiers": [
185             {
186               "type": "string",
187               "value": "string"
188             }
189           ],
190           "deviceEvents": [
191             {
192               "type": "string",
193               "eventTimestamp": "string"
194             }
195           ],
196           "externalIdentifier": "string",
197           "disabledReadings": true
198         }
199       ],
200       "packedKits": [
201         {
202           "kit": {
203             "id": 0,
204             "name": "string",
205             "archived": true,
206             "kitItems": [
207               {
208                 "item": {
209                   "id": 1,
210                   "manufacturer": {
211                     "id": 1,
212                     "name": "string"
213                   },
214                   "name": "string",
215                   "model": "string",
216                   "sku": "string",
217                   "orderable": true
218                 },
219                 "count": 0
220               }
221             ]
222           },
223           "devices": [
224             {
225               "id": 1,
226               "item": {
227                 "id": 1,
228                 "manufacturer": {
229                   "id": 1,
230                   "name": "string"
231                 },
232                 "name": "string",
233                 "model": "string",
234                 "sku": "string",
235                 "orderable": true
236               },
237               "currentStatus": "string",
238               "used": true,
239               "currentPatient": {
240                 "id": 1,
241                 "externalIdentifier": "1234abcd",
242                 "firstName": "John",
243                 "lastName": "Doe",
244                 "dateOfBirth": "1980-01-01",
245                 "email": "john.doe@example.com",
246                 "phoneNumber": "+1234567890",
247                 "archived": true,
248                 "address": {
249                   "lineOne": "string",
250                   "lineTwo": "string",
251                   "lineThree": "string",
252                   "city": "string",
253                   "state": "string",
254                   "zipCode": "string",
255                   "country": "string",
256                   "note": "string"
257                 },
258                 "site": {
259                   "id": 1,
260                   "name": "string",
261                   "active": true,
262                   "address": {
263                     "lineOne": "string",
264                     "lineTwo": "string",
265                     "lineThree": "string",
266                     "city": "string",
267                     "state": "string",
268                     "zipCode": "string",
269                     "country": "string",
270                     "note": "string"
271                   }
272                 },
273                 "enrolled": true,
274                 "sex": "other"
275               },
276               "site": {
277                 "id": 1,
278                 "name": "string",
279                 "active": true,
280                 "address": {
281                   "lineOne": "string",
282                   "lineTwo": "string",
283                   "lineThree": "string",
284                   "city": "string",
285                   "state": "string",
286                   "zipCode": "string",
287                   "country": "string",
288                   "note": "string"
289                 }
290               },
291               "lastHealthCheck": "string",
292               "deviceIdentifiers": [
293                 {
294                   "type": "string",
295                   "value": "string"
296                 }
297               ],
298               "deviceEvents": [
299                 {
300                   "type": "string",
301                   "eventTimestamp": "string"
302                 }
303               ],
304               "externalIdentifier": "string",
305               "disabledReadings": true
306             }
307           ]
308         }
309       ],
310       "shippingOption": "standard"
311     }
312   ],
313   "page": 0,
314   "size": 0,
315   "total": 0,
316   "first": true,
317   "last": true
318 }

PagePatient

Properties

Name	Type	Required	Description
content	[Patient]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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": "other"
39     }
40   ],
41   "page": 0,
42   "size": 0,
43   "total": 0,
44   "first": true,
45   "last": true
46 }

PagePeakFlowReading

Properties

Name	Type	Required	Description
content	[PeakFlowReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PagePeakFlowReading Model Sample

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

PageProcurement

Properties

Name	Type	Required	Description
content	[Procurement]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageProcurement Model Sample

1 {
2   "content": [
3     {
4       "id": 1,
5       "currentStatus": "string",
6       "procurementType": "string",
7       "procurementItems": [
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             "orderable": true
19           },
20           "quantityRequested": 0,
21           "quantityApproved": 0,
22           "costPerItem": 0.1,
23           "trackingNumbers": [
24             {
25               "carrier": "string",
26               "value": "string"
27             }
28           ]
29         }
30       ],
31       "procurementEvents": [
32         {
33           "name": "string",
34           "eventTimestamp": "string"
35         }
36       ]
37     }
38   ],
39   "page": 0,
40   "size": 0,
41   "total": 0,
42   "first": true,
43   "last": true
44 }

PageSite

Properties

Name	Type	Required	Description
content	[Site]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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 }

PageSleepMatActivityReading

Properties

Name	Type	Required	Description
content	[SleepMatActivityReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageSleepMatActivityReading Model Sample

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

PageSleepMatDurationReading

Properties

Name	Type	Required	Description
content	[SleepMatDurationReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageSleepMatDurationReading Model Sample

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

PageSupportTicket

Properties

Name	Type	Required	Description
content	[SupportTicket]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageSupportTicket Model Sample

1 {
2   "content": [
3     {
4       "id": 0,
5       "customer": {
6         "id": 0,
7         "name": "string"
8       },
9       "patient": {
10         "id": 1,
11         "externalIdentifier": "1234abcd",
12         "firstName": "John",
13         "lastName": "Doe",
14         "dateOfBirth": "1980-01-01",
15         "email": "john.doe@example.com",
16         "phoneNumber": "+1234567890",
17         "archived": true,
18         "address": {
19           "lineOne": "string",
20           "lineTwo": "string",
21           "lineThree": "string",
22           "city": "string",
23           "state": "string",
24           "zipCode": "string",
25           "country": "string",
26           "note": "string"
27         },
28         "site": {
29           "id": 1,
30           "name": "string",
31           "active": true,
32           "address": {
33             "lineOne": "string",
34             "lineTwo": "string",
35             "lineThree": "string",
36             "city": "string",
37             "state": "string",
38             "zipCode": "string",
39             "country": "string",
40             "note": "string"
41           }
42         },
43         "enrolled": true,
44         "sex": "other"
45       },
46       "order": {
47         "id": 0,
48         "externalOrderIds": [
49           "string"
50         ],
51         "patient": {
52           "id": 1,
53           "externalIdentifier": "1234abcd",
54           "firstName": "John",
55           "lastName": "Doe",
56           "dateOfBirth": "1980-01-01",
57           "email": "john.doe@example.com",
58           "phoneNumber": "+1234567890",
59           "archived": 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           "site": {
71             "id": 1,
72             "name": "string",
73             "active": true,
74             "address": {
75               "lineOne": "string",
76               "lineTwo": "string",
77               "lineThree": "string",
78               "city": "string",
79               "state": "string",
80               "zipCode": "string",
81               "country": "string",
82               "note": "string"
83             }
84           },
85           "enrolled": true,
86           "sex": "other"
87         },
88         "site": {
89           "id": 1,
90           "name": "string",
91           "active": 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         },
103         "currentStatus": "availableForPickup",
104         "orderItems": [
105           {
106             "item": {
107               "id": 1,
108               "manufacturer": {
109                 "id": 1,
110                 "name": "string"
111               },
112               "name": "string",
113               "model": "string",
114               "sku": "string",
115               "orderable": true
116             },
117             "count": 0
118           }
119         ],
120         "orderKits": [
121           {
122             "kit": {
123               "id": 0,
124               "name": "string",
125               "archived": true,
126               "kitItems": [
127                 {
128                   "item": {
129                     "id": 1,
130                     "manufacturer": {},
131                     "name": "string",
132                     "model": "string",
133                     "sku": "string",
134                     "orderable": true
135                   },
136                   "count": 0
137                 }
138               ]
139             },
140             "count": 0
141           }
142         ],
143         "orderEvents": [
144           {
145             "name": "string",
146             "eventTimestamp": "string"
147           }
148         ],
149         "trackingNumbers": [
150           {
151             "carrier": "string",
152             "value": "string"
153           }
154         ],
155         "devices": [
156           {
157             "id": 1,
158             "item": {
159               "id": 1,
160               "manufacturer": {
161                 "id": 1,
162                 "name": "string"
163               },
164               "name": "string",
165               "model": "string",
166               "sku": "string",
167               "orderable": true
168             },
169             "currentStatus": "string",
170             "used": true,
171             "currentPatient": {
172               "id": 1,
173               "externalIdentifier": "1234abcd",
174               "firstName": "John",
175               "lastName": "Doe",
176               "dateOfBirth": "1980-01-01",
177               "email": "john.doe@example.com",
178               "phoneNumber": "+1234567890",
179               "archived": true,
180               "address": {
181                 "lineOne": "string",
182                 "lineTwo": "string",
183                 "lineThree": "string",
184                 "city": "string",
185                 "state": "string",
186                 "zipCode": "string",
187                 "country": "string",
188                 "note": "string"
189               },
190               "site": {
191                 "id": 1,
192                 "name": "string",
193                 "active": true,
194                 "address": {
195                   "lineOne": "string",
196                   "lineTwo": "string",
197                   "lineThree": "string",
198                   "city": "string",
199                   "state": "string",
200                   "zipCode": "string",
201                   "country": "string",
202                   "note": "string"
203                 }
204               },
205               "enrolled": true,
206               "sex": "other"
207             },
208             "site": {
209               "id": 1,
210               "name": "string",
211               "active": true,
212               "address": {
213                 "lineOne": "string",
214                 "lineTwo": "string",
215                 "lineThree": "string",
216                 "city": "string",
217                 "state": "string",
218                 "zipCode": "string",
219                 "country": "string",
220                 "note": "string"
221               }
222             },
223             "lastHealthCheck": "string",
224             "deviceIdentifiers": [
225               {
226                 "type": "string",
227                 "value": "string"
228               }
229             ],
230             "deviceEvents": [
231               {
232                 "type": "string",
233                 "eventTimestamp": "string"
234               }
235             ],
236             "externalIdentifier": "string",
237             "disabledReadings": true
238           }
239         ],
240         "packedKits": [
241           {
242             "kit": {
243               "id": 0,
244               "name": "string",
245               "archived": true,
246               "kitItems": [
247                 {
248                   "item": {
249                     "id": 1,
250                     "manufacturer": {},
251                     "name": "string",
252                     "model": "string",
253                     "sku": "string",
254                     "orderable": true
255                   },
256                   "count": 0
257                 }
258               ]
259             },
260             "devices": [
261               {
262                 "id": 1,
263                 "item": {
264                   "id": 1,
265                   "manufacturer": {
266                     "id": 1,
267                     "name": "string"
268                   },
269                   "name": "string",
270                   "model": "string",
271                   "sku": "string",
272                   "orderable": true
273                 },
274                 "currentStatus": "string",
275                 "used": true,
276                 "currentPatient": {
277                   "id": 1,
278                   "externalIdentifier": "1234abcd",
279                   "firstName": "John",
280                   "lastName": "Doe",
281                   "dateOfBirth": "1980-01-01",
282                   "email": "john.doe@example.com",
283                   "phoneNumber": "+1234567890",
284                   "archived": true,
285                   "address": {
286                     "lineOne": "string",
287                     "lineTwo": "string",
288                     "lineThree": "string",
289                     "city": "string",
290                     "state": "string",
291                     "zipCode": "string",
292                     "country": "string",
293                     "note": "string"
294                   },
295                   "site": {
296                     "id": 1,
297                     "name": "string",
298                     "active": true,
299                     "address": {}
300                   },
301                   "enrolled": true,
302                   "sex": "other"
303                 },
304                 "site": {
305                   "id": 1,
306                   "name": "string",
307                   "active": true,
308                   "address": {
309                     "lineOne": "string",
310                     "lineTwo": "string",
311                     "lineThree": "string",
312                     "city": "string",
313                     "state": "string",
314                     "zipCode": "string",
315                     "country": "string",
316                     "note": "string"
317                   }
318                 },
319                 "lastHealthCheck": "string",
320                 "deviceIdentifiers": [
321                   {
322                     "type": "string",
323                     "value": "string"
324                   }
325                 ],
326                 "deviceEvents": [
327                   {
328                     "type": "string",
329                     "eventTimestamp": "string"
330                   }
331                 ],
332                 "externalIdentifier": "string",
333                 "disabledReadings": true
334               }
335             ]
336           }
337         ],
338         "shippingOption": "standard"
339       },
340       "device": {
341         "id": 1,
342         "item": {
343           "id": 1,
344           "manufacturer": {
345             "id": 1,
346             "name": "string"
347           },
348           "name": "string",
349           "model": "string",
350           "sku": "string",
351           "orderable": true
352         },
353         "currentStatus": "string",
354         "used": true,
355         "currentPatient": {
356           "id": 1,
357           "externalIdentifier": "1234abcd",
358           "firstName": "John",
359           "lastName": "Doe",
360           "dateOfBirth": "1980-01-01",
361           "email": "john.doe@example.com",
362           "phoneNumber": "+1234567890",
363           "archived": true,
364           "address": {
365             "lineOne": "string",
366             "lineTwo": "string",
367             "lineThree": "string",
368             "city": "string",
369             "state": "string",
370             "zipCode": "string",
371             "country": "string",
372             "note": "string"
373           },
374           "site": {
375             "id": 1,
376             "name": "string",
377             "active": true,
378             "address": {
379               "lineOne": "string",
380               "lineTwo": "string",
381               "lineThree": "string",
382               "city": "string",
383               "state": "string",
384               "zipCode": "string",
385               "country": "string",
386               "note": "string"
387             }
388           },
389           "enrolled": true,
390           "sex": "other"
391         },
392         "site": {
393           "id": 1,
394           "name": "string",
395           "active": true,
396           "address": {
397             "lineOne": "string",
398             "lineTwo": "string",
399             "lineThree": "string",
400             "city": "string",
401             "state": "string",
402             "zipCode": "string",
403             "country": "string",
404             "note": "string"
405           }
406         },
407         "lastHealthCheck": "string",
408         "deviceIdentifiers": [
409           {
410             "type": "string",
411             "value": "string"
412           }
413         ],
414         "deviceEvents": [
415           {
416             "type": "string",
417             "eventTimestamp": "string"
418           }
419         ],
420         "externalIdentifier": "string",
421         "disabledReadings": true
422       },
423       "site": {
424         "id": 1,
425         "name": "string",
426         "active": true,
427         "address": {
428           "lineOne": "string",
429           "lineTwo": "string",
430           "lineThree": "string",
431           "city": "string",
432           "state": "string",
433           "zipCode": "string",
434           "country": "string",
435           "note": "string"
436         }
437       },
438       "ticketType": "returnToSender",
439       "supportTicketNotes": [
440         {
441           "createdBy": {
442             "id": 0,
443             "firstName": "string",
444             "lastName": "string",
445             "email": "string"
446           },
447           "note": "string",
448           "createdAt": "2022-03-10T16:15:50Z"
449         }
450       ],
451       "supportTicketEvents": [
452         {
453           "eventType": "addressConfirmationAddressConfirmed",
454           "createdAt": "2022-03-10T16:15:50Z"
455         }
456       ],
457       "currentStatus": "closed",
458       "open": true,
459       "assignedTeam": "operations",
460       "assignee": {
461         "id": 0,
462         "firstName": "string",
463         "lastName": "string",
464         "email": "string"
465       },
466       "createdBy": {
467         "id": 0,
468         "firstName": "string",
469         "lastName": "string",
470         "email": "string"
471       },
472       "createdAt": "2022-03-10T16:15:50Z",
473       "lastUpdated": "2022-03-10T16:15:50Z"
474     }
475   ],
476   "page": 0,
477   "size": 0,
478   "total": 0,
479   "first": true,
480   "last": true
481 }

PageTemperatureReading

Properties

Name	Type	Required	Description
content	[TemperatureReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageTemperatureReading Model Sample

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

PageTransferRequest

Properties

Name	Type	Required	Description
content	[TransferRequest]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageTransferRequest Model Sample

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

PageWebhook

Properties

Name	Type	Required	Description
content	[Webhook]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True 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

Properties

Name	Type	Required	Description
content	[WebhookLog]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageWebhookLog Model Sample

1 {
2   "content": [
3     {
4       "id": 1,
5       "webhookId": 1,
6       "webhookType": "order.status",
7       "webhookUrl": "http://webhookserver.com",
8       "payload": "{'id':1234}",
9       "createTimestamp": "2023-08-22T14:15:30.345Z",
10       "lastResponseStatus": 200,
11       "retryAttempts": 3,
12       "lastRetryTimestamp": "2023-08-22T14:15:30.345Z"
13     }
14   ],
15   "page": 0,
16   "size": 0,
17   "total": 0,
18   "first": true,
19   "last": true
20 }

PageWeightReading

Properties

Name	Type	Required	Description
content	[WeightReading]	false	The content of the page, consisting of a list of objects.
page	integer(int32)	false	The current page number. The first page has value 1.
size	integer(int32)	false	The current page size. Default 15, maximum 250.
total	integer(int32)	false	The number of objects matching the request.
first	boolean	false	True if this is the first page, false otherwise.
last	boolean	false	True if this is the last page, false otherwise.

PageWeightReading Model Sample

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

Patient

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the patient, managed by Impilo.
externalIdentifier	string	false	Unique external identifier for the patient, managed by the customer.
firstName	string	true	The patient’s first name.
lastName	string	true	The patient’s last name.
dateOfBirth	string(date)	false	The patient’s date of birth in the format YYYY-MM-DD.
email	string(email)	false	The patient’s email.
phoneNumber	string	false	The patient’s phone number.
archived	boolean	false	True if the patient is archived, false otherwise.
address	Address	true	The patient’s shipping address. Required on all endpoints except PATCH patient.
site	Site	false	The site responsible for this patient.
enrolled	boolean	false	The enrollment status. False if disenrolled.
sex	Sex	false	none

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": "other"
37 }

PatientSort

Enumerated Values

Name	Desciption
firstName	Undefined
lastName	Undefined
patientId	Undefined

PatientSort Model Sample

1 "firstName"

PeakFlowReading

This page describes Impilo’s peak flow reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	false	none
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	none
item	Item	false	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.
device	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.
peakExpiratoryFlow	number(double)	false	none
forcedExpiratoryVolume	number(double)	false	none

PeakFlowReading Model Sample

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

PeakFlowReadingRequest

This page describes Impilo’s peak flow reading request model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
peakExpiratoryFlow	number(double)	true	The Peak Expiratory Flow, measured in L/min.
forcedExpiratoryVolumeInOneSecond	number(double)	false	The Forced Expiratory Volume in One Second value, in L.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.

PeakFlowReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "peakExpiratoryFlow": 0.1,
8   "forcedExpiratoryVolumeInOneSecond": 0.1,
9   "manual": true
10 }

Procurement

A procurement is a procurement of devices by a customer.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the site, managed by Impilo.
currentStatus	string	false	The current status of the procurement
procurementType	string	false	The type of the procurement.
procurementItems	[ProcurementItem]	false	List of items on the procurement
procurementEvents	[ProcurementEvent]	false	List of events attached to the procurement

Procurement Model Sample

1 {
2   "id": 1,
3   "currentStatus": "string",
4   "procurementType": "string",
5   "procurementItems": [
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         "orderable": true
17       },
18       "quantityRequested": 0,
19       "quantityApproved": 0,
20       "costPerItem": 0.1,
21       "trackingNumbers": [
22         {
23           "carrier": "string",
24           "value": "string"
25         }
26       ]
27     }
28   ],
29   "procurementEvents": [
30     {
31       "name": "string",
32       "eventTimestamp": "string"
33     }
34   ]
35 }

ProcurementEvent

Properties

Name	Type	Required	Description
name	string	false	none
eventTimestamp	string	false	none

ProcurementEvent Model Sample

1 {
2   "name": "string",
3   "eventTimestamp": "string"
4 }

ProcurementItem

Properties

Name	Type	Required	Description
item	Item	false	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.
quantityRequested	integer(int32)	false	none
quantityApproved	integer(int32)	false	none
costPerItem	number(double)	false	none
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     "orderable": true
12   },
13   "quantityRequested": 0,
14   "quantityApproved": 0,
15   "costPerItem": 0.1,
16   "trackingNumbers": [
17     {
18       "carrier": "string",
19       "value": "string"
20     }
21   ]
22 }

ReadingType

Enumerated Values

Name	Desciption
bloodPressure	Blood pressure reading type.
sleepMatActivity	Sleep Mat Activity reading type.
heartRateVariability	Heart rate variability reading type.
heartRate	Heart rate reading type.
spo2	SPO2 (oxygen saturation) reading type.
temperature	Temperature reading type.
weight	Weight reading type.
peakFlow	Peak Flow expiratory reading type.
continuousBloodGlucose	Continuous blood glucose reading type.
sleepMatDuration	Sleep Mat Duration reading type.
bloodGlucose	Blood glucose reading type.

ReadingType Model Sample

1 "bloodPressure"

Return

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

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the return, managed by Impilo.
patient	Patient	false	The patient that is making the return.
currentStatus	string	false	The current status of this return.
returnKits	[Kit]	false	An array of kits related to items expected on this return.
returnItems	[ReturnItem]	false	An array of non-tracked items expected on this return.
returnEvents	[ReturnEvent]	false	An array of the return events for this return.
trackingNumbers	[TrackingNumber]	false	An array of tracking numbers associated with this return.
returnDevices	[Device]	false	An array of devices expected on this return.
relatedOrderId	integer(int64)	false	The 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": "other"
39   },
40   "currentStatus": "string",
41   "returnKits": [
42     {
43       "id": 0,
44       "name": "string",
45       "archived": true,
46       "kitItems": [
47         {
48           "item": {
49             "id": 1,
50             "manufacturer": {
51               "id": 1,
52               "name": "string"
53             },
54             "name": "string",
55             "model": "string",
56             "sku": "string",
57             "orderable": true
58           },
59           "count": 0
60         }
61       ]
62     }
63   ],
64   "returnItems": [
65     {
66       "item": {
67         "id": 1,
68         "manufacturer": {
69           "id": 1,
70           "name": "string"
71         },
72         "name": "string",
73         "model": "string",
74         "sku": "string",
75         "orderable": true
76       },
77       "count": 0
78     }
79   ],
80   "returnEvents": [
81     {
82       "type": "string",
83       "eventTimestamp": "string"
84     }
85   ],
86   "trackingNumbers": [
87     {
88       "carrier": "string",
89       "value": "string"
90     }
91   ],
92   "returnDevices": [
93     {
94       "id": 1,
95       "item": {
96         "id": 1,
97         "manufacturer": {
98           "id": 1,
99           "name": "string"
100         },
101         "name": "string",
102         "model": "string",
103         "sku": "string",
104         "orderable": true
105       },
106       "currentStatus": "string",
107       "used": true,
108       "currentPatient": {
109         "id": 1,
110         "externalIdentifier": "1234abcd",
111         "firstName": "John",
112         "lastName": "Doe",
113         "dateOfBirth": "1980-01-01",
114         "email": "john.doe@example.com",
115         "phoneNumber": "+1234567890",
116         "archived": true,
117         "address": {
118           "lineOne": "string",
119           "lineTwo": "string",
120           "lineThree": "string",
121           "city": "string",
122           "state": "string",
123           "zipCode": "string",
124           "country": "string",
125           "note": "string"
126         },
127         "site": {
128           "id": 1,
129           "name": "string",
130           "active": true,
131           "address": {
132             "lineOne": "string",
133             "lineTwo": "string",
134             "lineThree": "string",
135             "city": "string",
136             "state": "string",
137             "zipCode": "string",
138             "country": "string",
139             "note": "string"
140           }
141         },
142         "enrolled": true,
143         "sex": "other"
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       "lastHealthCheck": "string",
161       "deviceIdentifiers": [
162         {
163           "type": "string",
164           "value": "string"
165         }
166       ],
167       "deviceEvents": [
168         {
169           "type": "string",
170           "eventTimestamp": "string"
171         }
172       ],
173       "externalIdentifier": "string",
174       "disabledReadings": true
175     }
176   ],
177   "relatedOrderId": 0
178 }

ReturnEvent

Properties

Name	Type	Required	Description
type	string	false	The event type for the Return Event.
eventTimestamp	string	false	The timestamp when the Return Event was created.

ReturnEvent Model Sample

1 {
2   "type": "string",
3   "eventTimestamp": "string"
4 }

ReturnItem

Properties

Name	Type	Required	Description
item	Item	false	The item type extected on this return.
count	integer(int32)	false	The 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     "orderable": true
12   },
13   "count": 0
14 }

Sex

Enumerated Values

Name	Desciption
other	Sex other than male or female.
female	Female sex.
male	Male sex.
unknown	Sex is unknown.

Sex Model Sample

1 "other"

ShippingOption

Enumerated Values

Name	Desciption
standard	Standard shipping option.
overnight	Overnight shipping option.

ShippingOption Model Sample

1 "standard"

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

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the site, managed by Impilo.
name	string	false	The name of the site.
active	boolean	false	True if the site is active, false otherwise.
address	Address	false	The shipping address for the site.

Site Model Sample

1 {
2   "id": 1,
3   "name": "string",
4   "active": true,
5   "address": {
6     "lineOne": "string",
7     "lineTwo": "string",
8     "lineThree": "string",
9     "city": "string",
10     "state": "string",
11     "zipCode": "string",
12     "country": "string",
13     "note": "string"
14   }
15 }

SleepMatActivityReading

This page describes Impilo’s sleep mat activity reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	false	none
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	none
item	Item	false	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.
device	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.
respiration	integer(int32)	false	none
heartRate	integer(int32)	false	none
bodyTurnOver	integer(int32)	false	none
duration	string	false	none
bedTime	[string]	false	none
getUpTime	[string]	false	none

SleepMatActivityReading Model Sample

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

SleepMatActivityReadingRequest

This page describes Impilo’s sleep mat activity reading request model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
respiration	integer(int32)	true	Respiratory rate per minute during sleep.
heartRate	integer(int32)	true	Average heart rate per minutes during recorded period.
bodyTurnOver	integer(int32)	true	Number of times the subject rolled over during the recorded period.
duration	string	true	Duration of sleep during tracked period.
bedTime	[string]	true	List of times sleep started during the period.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
upTime	[string]	true	List of times sleep was disrupted due to subject getting up during the period.
getUpTime	[string]	false	none

SleepMatActivityReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "respiration": 0,
8   "heartRate": 0,
9   "bodyTurnOver": 0,
10   "duration": "string",
11   "bedTime": [
12     "string"
13   ],
14   "manual": true,
15   "upTime": [
16     "string"
17   ],
18   "getUpTime": [
19     "string"
20   ]
21 }

SleepMatDurationReading

This page describes Impilo’s sleep mat duration reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	false	none
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	none
item	Item	false	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.
device	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.
respiration	integer(int32)	false	none
heartRate	integer(int32)	false	none
bodyTurnOver	integer(int32)	false	none
duration	string	false	none
rem	integer(int32)	false	none
deepSleep	integer(int32)	false	none
lightSleep	integer(int32)	false	none

SleepMatDurationReading Model Sample

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

SleepMatDurationReadingRequest

This page describes Impilo’s sleep mat duration reading request model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
respiration	integer(int32)	true	Respiratory rate per minute during sleep.
heartRate	integer(int32)	true	Average heart rate per minutes during recorded period.
bodyTurnOver	integer(int32)	true	Number of times the subject rolled over during the recorded period.
duration	string	true	Duration of sleep during tracked period.
rem	integer(int32)	true	Number of minutes of detected rem sleep.
deepSleep	integer(int32)	true	Number of minutes of detected deep sleep.
lightSleep	integer(int32)	true	Number of minutes of detected light sleep.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.

SleepMatDurationReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "respiration": 0,
8   "heartRate": 0,
9   "bodyTurnOver": 0,
10   "duration": "string",
11   "rem": 0,
12   "deepSleep": 0,
13   "lightSleep": 0,
14   "manual": true
15 }

SupportTicket

A Support Ticket is a case that’s been opened by either an Impilo team member, a Customer team member, or a Patient.

Properties

Name	Type	Required	Description
id	integer(int64)	false	The ID of the Support Ticket.
customer	Customer	false	The Customer to whom this Support Ticket belongs.
patient	Patient	false	The Patient that the Support Ticket involves, if applicable.
order	Order	false	The Order that the Support Ticket involves, if applicable.
device	Device	false	The Device that the Support Ticket involves, if applicable.
site	Site	false	The Site that the Support Ticket involves, if applicable.
ticketType	SupportTicketType	false	The type of Support Ticket.
supportTicketNotes	[SupportTicketNote]	false	A list of all SupportTicketNotes attached to this Support Ticket.
supportTicketEvents	[SupportTicketEvent]	false	A list of all SupportTicketEvents attached to this Support Ticket.
currentStatus	SupportTicketStatus	false	The current status of the Support Ticket.
open	boolean	false	Whether or not the ticket is considered open or closed.
assignedTeam	Team	false	The team that’s assigned this Support Ticket, if any.
assignee	EndUser	false	The EndUser assigned to this Support Ticket, if any.
createdBy	EndUser	false	The creator of this Support Ticket.
createdAt	string(date-time)	false	The timestamp when the Support Ticket was created.
lastUpdated	string(date-time)	false	The most recent time that this Support Ticket was updated in some form.

SupportTicket Model Sample

1 {
2   "id": 0,
3   "customer": {
4     "id": 0,
5     "name": "string"
6   },
7   "patient": {
8     "id": 1,
9     "externalIdentifier": "1234abcd",
10     "firstName": "John",
11     "lastName": "Doe",
12     "dateOfBirth": "1980-01-01",
13     "email": "john.doe@example.com",
14     "phoneNumber": "+1234567890",
15     "archived": true,
16     "address": {
17       "lineOne": "string",
18       "lineTwo": "string",
19       "lineThree": "string",
20       "city": "string",
21       "state": "string",
22       "zipCode": "string",
23       "country": "string",
24       "note": "string"
25     },
26     "site": {
27       "id": 1,
28       "name": "string",
29       "active": true,
30       "address": {
31         "lineOne": "string",
32         "lineTwo": "string",
33         "lineThree": "string",
34         "city": "string",
35         "state": "string",
36         "zipCode": "string",
37         "country": "string",
38         "note": "string"
39       }
40     },
41     "enrolled": true,
42     "sex": "other"
43   },
44   "order": {
45     "id": 0,
46     "externalOrderIds": [
47       "string"
48     ],
49     "patient": {
50       "id": 1,
51       "externalIdentifier": "1234abcd",
52       "firstName": "John",
53       "lastName": "Doe",
54       "dateOfBirth": "1980-01-01",
55       "email": "john.doe@example.com",
56       "phoneNumber": "+1234567890",
57       "archived": 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       "site": {
69         "id": 1,
70         "name": "string",
71         "active": true,
72         "address": {
73           "lineOne": "string",
74           "lineTwo": "string",
75           "lineThree": "string",
76           "city": "string",
77           "state": "string",
78           "zipCode": "string",
79           "country": "string",
80           "note": "string"
81         }
82       },
83       "enrolled": true,
84       "sex": "other"
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     "currentStatus": "availableForPickup",
102     "orderItems": [
103       {
104         "item": {
105           "id": 1,
106           "manufacturer": {
107             "id": 1,
108             "name": "string"
109           },
110           "name": "string",
111           "model": "string",
112           "sku": "string",
113           "orderable": true
114         },
115         "count": 0
116       }
117     ],
118     "orderKits": [
119       {
120         "kit": {
121           "id": 0,
122           "name": "string",
123           "archived": true,
124           "kitItems": [
125             {
126               "item": {
127                 "id": 1,
128                 "manufacturer": {
129                   "id": 1,
130                   "name": "string"
131                 },
132                 "name": "string",
133                 "model": "string",
134                 "sku": "string",
135                 "orderable": true
136               },
137               "count": 0
138             }
139           ]
140         },
141         "count": 0
142       }
143     ],
144     "orderEvents": [
145       {
146         "name": "string",
147         "eventTimestamp": "string"
148       }
149     ],
150     "trackingNumbers": [
151       {
152         "carrier": "string",
153         "value": "string"
154       }
155     ],
156     "devices": [
157       {
158         "id": 1,
159         "item": {
160           "id": 1,
161           "manufacturer": {
162             "id": 1,
163             "name": "string"
164           },
165           "name": "string",
166           "model": "string",
167           "sku": "string",
168           "orderable": true
169         },
170         "currentStatus": "string",
171         "used": true,
172         "currentPatient": {
173           "id": 1,
174           "externalIdentifier": "1234abcd",
175           "firstName": "John",
176           "lastName": "Doe",
177           "dateOfBirth": "1980-01-01",
178           "email": "john.doe@example.com",
179           "phoneNumber": "+1234567890",
180           "archived": true,
181           "address": {
182             "lineOne": "string",
183             "lineTwo": "string",
184             "lineThree": "string",
185             "city": "string",
186             "state": "string",
187             "zipCode": "string",
188             "country": "string",
189             "note": "string"
190           },
191           "site": {
192             "id": 1,
193             "name": "string",
194             "active": true,
195             "address": {
196               "lineOne": "string",
197               "lineTwo": "string",
198               "lineThree": "string",
199               "city": "string",
200               "state": "string",
201               "zipCode": "string",
202               "country": "string",
203               "note": "string"
204             }
205           },
206           "enrolled": true,
207           "sex": "other"
208         },
209         "site": {
210           "id": 1,
211           "name": "string",
212           "active": true,
213           "address": {
214             "lineOne": "string",
215             "lineTwo": "string",
216             "lineThree": "string",
217             "city": "string",
218             "state": "string",
219             "zipCode": "string",
220             "country": "string",
221             "note": "string"
222           }
223         },
224         "lastHealthCheck": "string",
225         "deviceIdentifiers": [
226           {
227             "type": "string",
228             "value": "string"
229           }
230         ],
231         "deviceEvents": [
232           {
233             "type": "string",
234             "eventTimestamp": "string"
235           }
236         ],
237         "externalIdentifier": "string",
238         "disabledReadings": true
239       }
240     ],
241     "packedKits": [
242       {
243         "kit": {
244           "id": 0,
245           "name": "string",
246           "archived": true,
247           "kitItems": [
248             {
249               "item": {
250                 "id": 1,
251                 "manufacturer": {
252                   "id": 1,
253                   "name": "string"
254                 },
255                 "name": "string",
256                 "model": "string",
257                 "sku": "string",
258                 "orderable": true
259               },
260               "count": 0
261             }
262           ]
263         },
264         "devices": [
265           {
266             "id": 1,
267             "item": {
268               "id": 1,
269               "manufacturer": {
270                 "id": 1,
271                 "name": "string"
272               },
273               "name": "string",
274               "model": "string",
275               "sku": "string",
276               "orderable": true
277             },
278             "currentStatus": "string",
279             "used": true,
280             "currentPatient": {
281               "id": 1,
282               "externalIdentifier": "1234abcd",
283               "firstName": "John",
284               "lastName": "Doe",
285               "dateOfBirth": "1980-01-01",
286               "email": "john.doe@example.com",
287               "phoneNumber": "+1234567890",
288               "archived": true,
289               "address": {
290                 "lineOne": "string",
291                 "lineTwo": "string",
292                 "lineThree": "string",
293                 "city": "string",
294                 "state": "string",
295                 "zipCode": "string",
296                 "country": "string",
297                 "note": "string"
298               },
299               "site": {
300                 "id": 1,
301                 "name": "string",
302                 "active": true,
303                 "address": {
304                   "lineOne": "string",
305                   "lineTwo": "string",
306                   "lineThree": "string",
307                   "city": "string",
308                   "state": "string",
309                   "zipCode": "string",
310                   "country": "string",
311                   "note": "string"
312                 }
313               },
314               "enrolled": true,
315               "sex": "other"
316             },
317             "site": {
318               "id": 1,
319               "name": "string",
320               "active": true,
321               "address": {
322                 "lineOne": "string",
323                 "lineTwo": "string",
324                 "lineThree": "string",
325                 "city": "string",
326                 "state": "string",
327                 "zipCode": "string",
328                 "country": "string",
329                 "note": "string"
330               }
331             },
332             "lastHealthCheck": "string",
333             "deviceIdentifiers": [
334               {
335                 "type": "string",
336                 "value": "string"
337               }
338             ],
339             "deviceEvents": [
340               {
341                 "type": "string",
342                 "eventTimestamp": "string"
343               }
344             ],
345             "externalIdentifier": "string",
346             "disabledReadings": true
347           }
348         ]
349       }
350     ],
351     "shippingOption": "standard"
352   },
353   "device": {
354     "id": 1,
355     "item": {
356       "id": 1,
357       "manufacturer": {
358         "id": 1,
359         "name": "string"
360       },
361       "name": "string",
362       "model": "string",
363       "sku": "string",
364       "orderable": true
365     },
366     "currentStatus": "string",
367     "used": true,
368     "currentPatient": {
369       "id": 1,
370       "externalIdentifier": "1234abcd",
371       "firstName": "John",
372       "lastName": "Doe",
373       "dateOfBirth": "1980-01-01",
374       "email": "john.doe@example.com",
375       "phoneNumber": "+1234567890",
376       "archived": true,
377       "address": {
378         "lineOne": "string",
379         "lineTwo": "string",
380         "lineThree": "string",
381         "city": "string",
382         "state": "string",
383         "zipCode": "string",
384         "country": "string",
385         "note": "string"
386       },
387       "site": {
388         "id": 1,
389         "name": "string",
390         "active": true,
391         "address": {
392           "lineOne": "string",
393           "lineTwo": "string",
394           "lineThree": "string",
395           "city": "string",
396           "state": "string",
397           "zipCode": "string",
398           "country": "string",
399           "note": "string"
400         }
401       },
402       "enrolled": true,
403       "sex": "other"
404     },
405     "site": {
406       "id": 1,
407       "name": "string",
408       "active": true,
409       "address": {
410         "lineOne": "string",
411         "lineTwo": "string",
412         "lineThree": "string",
413         "city": "string",
414         "state": "string",
415         "zipCode": "string",
416         "country": "string",
417         "note": "string"
418       }
419     },
420     "lastHealthCheck": "string",
421     "deviceIdentifiers": [
422       {
423         "type": "string",
424         "value": "string"
425       }
426     ],
427     "deviceEvents": [
428       {
429         "type": "string",
430         "eventTimestamp": "string"
431       }
432     ],
433     "externalIdentifier": "string",
434     "disabledReadings": true
435   },
436   "site": {
437     "id": 1,
438     "name": "string",
439     "active": true,
440     "address": {
441       "lineOne": "string",
442       "lineTwo": "string",
443       "lineThree": "string",
444       "city": "string",
445       "state": "string",
446       "zipCode": "string",
447       "country": "string",
448       "note": "string"
449     }
450   },
451   "ticketType": "returnToSender",
452   "supportTicketNotes": [
453     {
454       "createdBy": {
455         "id": 0,
456         "firstName": "string",
457         "lastName": "string",
458         "email": "string"
459       },
460       "note": "string",
461       "createdAt": "2022-03-10T16:15:50Z"
462     }
463   ],
464   "supportTicketEvents": [
465     {
466       "eventType": "addressConfirmationAddressConfirmed",
467       "createdAt": "2022-03-10T16:15:50Z"
468     }
469   ],
470   "currentStatus": "closed",
471   "open": true,
472   "assignedTeam": "operations",
473   "assignee": {
474     "id": 0,
475     "firstName": "string",
476     "lastName": "string",
477     "email": "string"
478   },
479   "createdBy": {
480     "id": 0,
481     "firstName": "string",
482     "lastName": "string",
483     "email": "string"
484   },
485   "createdAt": "2022-03-10T16:15:50Z",
486   "lastUpdated": "2022-03-10T16:15:50Z"
487 }

SupportTicketAssigneeRequest

Properties

Name	Type	Required	Description
email	string	true	The email address to note as the assignee for the Support Ticket.

SupportTicketAssigneeRequest Model Sample

1 {
2   "email": "string"
3 }

SupportTicketEvent

A representation of an event occurrence for a Support Ticket.

Properties

Name	Type	Required	Description
eventType	SupportTicketEventType	false	The type of event that occurred.
createdAt	string(date-time)	false	The timestamp of the event occurrence.

SupportTicketEvent Model Sample

1 {
2   "eventType": "addressConfirmationAddressConfirmed",
3   "createdAt": "2022-03-10T16:15:50Z"
4 }

SupportTicketEventRequest

Properties

Name	Type	Required	Description
event	SupportTicketEventType	true	The requested event to add to the Support Ticket.
note	string	false	The note to attach alongside the event.

SupportTicketEventRequest Model Sample

1 {
2   "event": "addressConfirmationAddressConfirmed",
3   "note": "string"
4 }

SupportTicketEventType

Enumerated Values

Name	Desciption
addressConfirmationAddressConfirmed	Undefined
patientSetupMeetingNotConducted	Undefined
customerDeviceInquiryManufacturerUnresolvedRmaIssued	Undefined
customerDeviceInquiryNoDataReadingsCheckSerialSim	Undefined
deviceTechnicalSupportMeetingScheduled	Undefined
operationsPatientUnresponsive	Undefined
returnMerchandiseAuthorizationLostClaim	Undefined
finalContactAttempt	Undefined
addressConfirmationEscalatedToCustomer	Undefined
customerEscalationContactAttemptedFinal	Undefined
deviceTechnicalSupportErrorCodeDeviceMalfunction	Undefined
otherOrderNotProcessed	Undefined
secondContactAttemptSms	Undefined
deviceTechnicalSupportMeetingNotConducted	Undefined
returnMerchandiseAuthorizationNewRmaDeliveredOutboundEmail	Undefined
patientSetupWelcomeConductedRmaIssued	Undefined
operationsCustomerUnresponsive	Undefined
deviceTechnicalSupportMeetingRescheduledFirst	Undefined
patientSetupPatientDevicesDelivered	Undefined
customerEscalationContactAttemptedAdditional	Undefined
otherCheckOnClaimStatus	Undefined
deviceTechnicalSupportResolvedSerialNumberAdded	Undefined
deviceTechnicalSupportMeetingRescheduledSecond	Undefined
firstContactAttemptSms	Undefined
operationsPushedToOpsForSupport	Undefined
returnMerchandiseAuthorizationRmaToSendToPatient	Undefined
assigneeModified	Undefined
deviceTechnicalSupportStillInvestigating	Undefined
thirdContactAttemptSms	Undefined
statusModified	Undefined
patientSetupMeetingScheduled	Undefined
finalContactAttemptSms	Undefined
returnMerchandiseAuthorizationPatientConfirmed	Undefined
unresolvedCustomerOrPatientUnresponsive	Undefined
firstContactAttempt	Undefined
customerDeviceInquiryCustomerPatientUnresponsive	Undefined
ticketReopened	Undefined
operationsWrongDeviceReceived	Undefined
thirdContactAttempt	Undefined
operationsFUViaSlackToOpsTeam	Undefined
addressConfirmationPatientRefusedRts	Undefined
addressConfirmationUnableToConfirmAddress	Undefined
otherNeedAdditionalInformationFromCustomer	Undefined
otherClaimCreated	Undefined
returnMerchandiseAuthorizationInTransit	Undefined
other	Undefined
deviceTechnicalSupportFollowedUpWithEngineeringSlackFU	Undefined
customerEscalationContactAttemptedSecond	Undefined
otherMissingPackage	Undefined
customerEscalationContactAttemptedFirst	Undefined
deviceTechnicalSupportUnresolvedPatientCustomerUnresponsive	Undefined
deviceTechnicalSupportBluetoothConnectivityError	Undefined
returnMerchandiseAuthorizationResendRma	Undefined
additionalContactAttempt	Undefined
patientSetupOrderShipped	Undefined
additionalContactAttemptEmail	Undefined
ticketCreated	Undefined
otherSpecialRequest	Undefined
addressConfirmationInvalidAddressPreShip	Undefined
secondContactAttemptEmail	Undefined
customerDeviceInquiryManufacturerResolvedReadingTaken	Undefined
finalContactAttemptEmail	Undefined
patientSetupWelcomeConductedDeviceInquiryRqrd	Undefined
customerEscalationContactAttemptedThird	Undefined
deviceTechnicalSupportResolvedReadingTaken	Undefined
deviceTechnicalSupportUnresolvedRmaIssued	Undefined
returnMerchandiseAuthorizationRmaWithPatientNoAction	Undefined
addressConfirmationReturnToSenderRts	Undefined
operationsEscalatedToOpsManagerForResolution	Undefined
operationsPatientAgreedToSendRightDeviceBack	Undefined
operationsPatientRefusedToSendDeviceBack	Undefined
secondContactAttempt	Undefined
addressConfirmationShipmentCancelled	Undefined
returnMerchandiseAuthorizationUnresolved	Undefined
thirdContactAttemptEmail	Undefined
patientSetupMeetingRescheduledFirst	Undefined
deviceTechnicalSupportResolvedDataPushedByEngineering	Undefined
returnMerchandiseAuthorizationInformationRequired	Undefined
additionalContactAttemptSms	Undefined
ticketClosed	Undefined
returnMerchandiseAuthorizationReceived	Undefined
firstContactAttemptEmail	Undefined
operationsDeviceNotOnInventoryTrackingReceived	Undefined
deviceTechnicalSupportNeedSerialNumberAdded	Undefined
operationsNeedAdditionalSupportFromOps	Undefined
deviceTechnicalSupportEscalatedToEngineering	Undefined
returnMerchandiseAuthorizationRequestForRmaFulfilled	Undefined
patientSetupMeetingRescheduledSecond	Undefined
patientSetupWelcomeConductedReadingTaken	Undefined
returnMerchandiseAuthorizationNewDisenrollment	Undefined
otherIncorrectDevicesShipped	Undefined
otherUnresolved	Undefined
deviceTechnicalSupportUnresolvedDeviceInquiryRequired	Undefined
otherEscalatedToAppropriateTeam	Undefined

SupportTicketEventType Model Sample

1 "addressConfirmationAddressConfirmed"

SupportTicketNote

A note that’s attached to a given Support Ticket.

Properties

Name	Type	Required	Description
createdBy	EndUser	false	The user that created the note.
note	string	false	The actual text of the note.
createdAt	string(date-time)	false	The timestamp when the note was created.

SupportTicketNote Model Sample

1 {
2   "createdBy": {
3     "id": 0,
4     "firstName": "string",
5     "lastName": "string",
6     "email": "string"
7   },
8   "note": "string",
9   "createdAt": "2022-03-10T16:15:50Z"
10 }

SupportTicketNoteRequest

Properties

Name	Type	Required	Description
note	string	true	The note to post to the Support Ticket.

SupportTicketNoteRequest Model Sample

1 {
2   "note": "string"
3 }

SupportTicketRequest

A Support Ticket is a case that’s been opened by either an Impilo team member, a Customer team member, or a Patient.

Properties

Name	Type	Required	Description
patient	Patient	false	The Patient that the Support Ticket involves, if applicable. Only the ID is required.
order	Order	false	The Order that the Support Ticket involves, if applicable. Only the ID is required.
device	Device	false	The Device that the Support Ticket involves, if applicable. Only the ID is required.
site	Site	false	The Site that the Support Ticket involves, if applicable. Only the ID is required.
ticketType	SupportTicketType	false	The type of Support Ticket.
note	string	false	A list of all SupportTicketNotes attached to this Support Ticket.

SupportTicketRequest 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": "other"
38   },
39   "order": {
40     "id": 0,
41     "externalOrderIds": [
42       "string"
43     ],
44     "patient": {
45       "id": 1,
46       "externalIdentifier": "1234abcd",
47       "firstName": "John",
48       "lastName": "Doe",
49       "dateOfBirth": "1980-01-01",
50       "email": "john.doe@example.com",
51       "phoneNumber": "+1234567890",
52       "archived": true,
53       "address": {
54         "lineOne": "string",
55         "lineTwo": "string",
56         "lineThree": "string",
57         "city": "string",
58         "state": "string",
59         "zipCode": "string",
60         "country": "string",
61         "note": "string"
62       },
63       "site": {
64         "id": 1,
65         "name": "string",
66         "active": true,
67         "address": {
68           "lineOne": "string",
69           "lineTwo": "string",
70           "lineThree": "string",
71           "city": "string",
72           "state": "string",
73           "zipCode": "string",
74           "country": "string",
75           "note": "string"
76         }
77       },
78       "enrolled": true,
79       "sex": "other"
80     },
81     "site": {
82       "id": 1,
83       "name": "string",
84       "active": true,
85       "address": {
86         "lineOne": "string",
87         "lineTwo": "string",
88         "lineThree": "string",
89         "city": "string",
90         "state": "string",
91         "zipCode": "string",
92         "country": "string",
93         "note": "string"
94       }
95     },
96     "currentStatus": "availableForPickup",
97     "orderItems": [
98       {
99         "item": {
100           "id": 1,
101           "manufacturer": {
102             "id": 1,
103             "name": "string"
104           },
105           "name": "string",
106           "model": "string",
107           "sku": "string",
108           "orderable": true
109         },
110         "count": 0
111       }
112     ],
113     "orderKits": [
114       {
115         "kit": {
116           "id": 0,
117           "name": "string",
118           "archived": true,
119           "kitItems": [
120             {
121               "item": {
122                 "id": 1,
123                 "manufacturer": {
124                   "id": 1,
125                   "name": "string"
126                 },
127                 "name": "string",
128                 "model": "string",
129                 "sku": "string",
130                 "orderable": true
131               },
132               "count": 0
133             }
134           ]
135         },
136         "count": 0
137       }
138     ],
139     "orderEvents": [
140       {
141         "name": "string",
142         "eventTimestamp": "string"
143       }
144     ],
145     "trackingNumbers": [
146       {
147         "carrier": "string",
148         "value": "string"
149       }
150     ],
151     "devices": [
152       {
153         "id": 1,
154         "item": {
155           "id": 1,
156           "manufacturer": {
157             "id": 1,
158             "name": "string"
159           },
160           "name": "string",
161           "model": "string",
162           "sku": "string",
163           "orderable": true
164         },
165         "currentStatus": "string",
166         "used": true,
167         "currentPatient": {
168           "id": 1,
169           "externalIdentifier": "1234abcd",
170           "firstName": "John",
171           "lastName": "Doe",
172           "dateOfBirth": "1980-01-01",
173           "email": "john.doe@example.com",
174           "phoneNumber": "+1234567890",
175           "archived": true,
176           "address": {
177             "lineOne": "string",
178             "lineTwo": "string",
179             "lineThree": "string",
180             "city": "string",
181             "state": "string",
182             "zipCode": "string",
183             "country": "string",
184             "note": "string"
185           },
186           "site": {
187             "id": 1,
188             "name": "string",
189             "active": true,
190             "address": {
191               "lineOne": "string",
192               "lineTwo": "string",
193               "lineThree": "string",
194               "city": "string",
195               "state": "string",
196               "zipCode": "string",
197               "country": "string",
198               "note": "string"
199             }
200           },
201           "enrolled": true,
202           "sex": "other"
203         },
204         "site": {
205           "id": 1,
206           "name": "string",
207           "active": true,
208           "address": {
209             "lineOne": "string",
210             "lineTwo": "string",
211             "lineThree": "string",
212             "city": "string",
213             "state": "string",
214             "zipCode": "string",
215             "country": "string",
216             "note": "string"
217           }
218         },
219         "lastHealthCheck": "string",
220         "deviceIdentifiers": [
221           {
222             "type": "string",
223             "value": "string"
224           }
225         ],
226         "deviceEvents": [
227           {
228             "type": "string",
229             "eventTimestamp": "string"
230           }
231         ],
232         "externalIdentifier": "string",
233         "disabledReadings": true
234       }
235     ],
236     "packedKits": [
237       {
238         "kit": {
239           "id": 0,
240           "name": "string",
241           "archived": true,
242           "kitItems": [
243             {
244               "item": {
245                 "id": 1,
246                 "manufacturer": {
247                   "id": 1,
248                   "name": "string"
249                 },
250                 "name": "string",
251                 "model": "string",
252                 "sku": "string",
253                 "orderable": true
254               },
255               "count": 0
256             }
257           ]
258         },
259         "devices": [
260           {
261             "id": 1,
262             "item": {
263               "id": 1,
264               "manufacturer": {
265                 "id": 1,
266                 "name": "string"
267               },
268               "name": "string",
269               "model": "string",
270               "sku": "string",
271               "orderable": true
272             },
273             "currentStatus": "string",
274             "used": true,
275             "currentPatient": {
276               "id": 1,
277               "externalIdentifier": "1234abcd",
278               "firstName": "John",
279               "lastName": "Doe",
280               "dateOfBirth": "1980-01-01",
281               "email": "john.doe@example.com",
282               "phoneNumber": "+1234567890",
283               "archived": true,
284               "address": {
285                 "lineOne": "string",
286                 "lineTwo": "string",
287                 "lineThree": "string",
288                 "city": "string",
289                 "state": "string",
290                 "zipCode": "string",
291                 "country": "string",
292                 "note": "string"
293               },
294               "site": {
295                 "id": 1,
296                 "name": "string",
297                 "active": true,
298                 "address": {
299                   "lineOne": "string",
300                   "lineTwo": "string",
301                   "lineThree": "string",
302                   "city": "string",
303                   "state": "string",
304                   "zipCode": "string",
305                   "country": "string",
306                   "note": "string"
307                 }
308               },
309               "enrolled": true,
310               "sex": "other"
311             },
312             "site": {
313               "id": 1,
314               "name": "string",
315               "active": true,
316               "address": {
317                 "lineOne": "string",
318                 "lineTwo": "string",
319                 "lineThree": "string",
320                 "city": "string",
321                 "state": "string",
322                 "zipCode": "string",
323                 "country": "string",
324                 "note": "string"
325               }
326             },
327             "lastHealthCheck": "string",
328             "deviceIdentifiers": [
329               {
330                 "type": "string",
331                 "value": "string"
332               }
333             ],
334             "deviceEvents": [
335               {
336                 "type": "string",
337                 "eventTimestamp": "string"
338               }
339             ],
340             "externalIdentifier": "string",
341             "disabledReadings": true
342           }
343         ]
344       }
345     ],
346     "shippingOption": "standard"
347   },
348   "device": {
349     "id": 1,
350     "item": {
351       "id": 1,
352       "manufacturer": {
353         "id": 1,
354         "name": "string"
355       },
356       "name": "string",
357       "model": "string",
358       "sku": "string",
359       "orderable": true
360     },
361     "currentStatus": "string",
362     "used": true,
363     "currentPatient": {
364       "id": 1,
365       "externalIdentifier": "1234abcd",
366       "firstName": "John",
367       "lastName": "Doe",
368       "dateOfBirth": "1980-01-01",
369       "email": "john.doe@example.com",
370       "phoneNumber": "+1234567890",
371       "archived": true,
372       "address": {
373         "lineOne": "string",
374         "lineTwo": "string",
375         "lineThree": "string",
376         "city": "string",
377         "state": "string",
378         "zipCode": "string",
379         "country": "string",
380         "note": "string"
381       },
382       "site": {
383         "id": 1,
384         "name": "string",
385         "active": true,
386         "address": {
387           "lineOne": "string",
388           "lineTwo": "string",
389           "lineThree": "string",
390           "city": "string",
391           "state": "string",
392           "zipCode": "string",
393           "country": "string",
394           "note": "string"
395         }
396       },
397       "enrolled": true,
398       "sex": "other"
399     },
400     "site": {
401       "id": 1,
402       "name": "string",
403       "active": true,
404       "address": {
405         "lineOne": "string",
406         "lineTwo": "string",
407         "lineThree": "string",
408         "city": "string",
409         "state": "string",
410         "zipCode": "string",
411         "country": "string",
412         "note": "string"
413       }
414     },
415     "lastHealthCheck": "string",
416     "deviceIdentifiers": [
417       {
418         "type": "string",
419         "value": "string"
420       }
421     ],
422     "deviceEvents": [
423       {
424         "type": "string",
425         "eventTimestamp": "string"
426       }
427     ],
428     "externalIdentifier": "string",
429     "disabledReadings": true
430   },
431   "site": {
432     "id": 1,
433     "name": "string",
434     "active": true,
435     "address": {
436       "lineOne": "string",
437       "lineTwo": "string",
438       "lineThree": "string",
439       "city": "string",
440       "state": "string",
441       "zipCode": "string",
442       "country": "string",
443       "note": "string"
444     }
445   },
446   "ticketType": "returnToSender",
447   "note": "string"
448 }

SupportTicketStatus

Enumerated Values

Name	Desciption
closed	Undefined
open	Undefined
needsIntake	Undefined

SupportTicketStatus Model Sample

1 "closed"

SupportTicketType

Enumerated Values

Name	Desciption
returnToSender	Return to sender support ticket.
mobileSupport	Mobile support ticket.
other	Other general inquiries support ticket.
engagement	Engagement-related support ticket.
customerDeviceInquiry	Customer device inquiry support ticket.
operations	Operations-related support ticket.
labOrder	Lab order support ticket.
clinicalSupport	Clinical support ticket.
deviceTechnicalSupport	Device technical support ticket.
patientSetup	Patient setup support ticket.
addressConfirmation	Address confirmation support ticket.
returnMerchandiseAuthorization	Return merchandise authorization support ticket.

SupportTicketType Model Sample

1 "returnToSender"

Team

Enumerated Values

Name	Desciption
operations	Undefined
engineering	Undefined
accounts	Undefined
support	Undefined
sales	Undefined

Team Model Sample

1 "operations"

TemperatureReading

This page describes Impilo’s temperature reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	The patient who took the reading.
item	Item	false	The item used to take the reading.
device	Device	false	The device used to take the reading.
temperatureUnit	string	false	The unit in which the temperature was measured.
temperature	number(double)	false	The temperature measurement value.

TemperatureReading Model Sample

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

TemperatureReadingRequest

This page describes Impilo’s temperature reading model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
temperatureUnit	TemperatureUnit	true	The unit in which the temperature was measured.
temperature	number(double)	true	The temperature measurement value.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.

TemperatureReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "temperatureUnit": "C",
8   "temperature": 0.1,
9   "manual": true
10 }

TemperatureUnit

Enumerated Values

Name	Desciption
C	Temperature unit of measurement is Celsius.
F	Temperature unit of measurement is Fahrenheit.

TemperatureUnit Model Sample

1 "C"

TestBloodGlucoseWebhookRequest

Request model for testing blood glucose webhook.

Properties

Name	Type	Required	Description
patientId	integer(int64)	false	Unique identifier for the patient.
glucose	integer(int32)	false	The blood glucose measurement value.

TestBloodGlucoseWebhookRequest Model Sample

1 {
2   "patientId": 0,
3   "glucose": 0
4 }

TestBloodOxygenWebhookRequest

Request model for testing blood oxygen webhook.

Properties

Name	Type	Required	Description
patientId	integer(int64)	false	Unique identifier for the patient.
bloodOxygen	integer(int32)	false	The blood oxygen (spo2) measurement value.
heartRate	integer(int32)	false	The heart rate measurement value.

TestBloodOxygenWebhookRequest Model Sample

1 {
2   "patientId": 0,
3   "bloodOxygen": 0,
4   "heartRate": 0
5 }

TestBloodPressureWebhookRequest

Request model for testing blood pressure webhook.

Properties

Name	Type	Required	Description
patientId	integer(int64)	false	Unique identifier for the patient.
systolic	integer(int32)	false	The systolic blood pressure measurement value.
diastolic	integer(int32)	false	The diastolic blood pressure measurement value.
heartRate	integer(int32)	false	The heart rate measurement value.

TestBloodPressureWebhookRequest Model Sample

1 {
2   "patientId": 0,
3   "systolic": 0,
4   "diastolic": 0,
5   "heartRate": 0
6 }

TestDeviceAssociationWebhook

Request model for testing device association webhook.

Properties

Name	Type	Required	Description
patientId	integer(int64)	false	Unique identifier for the patient.
deviceId	integer(int64)	false	Unique identifier for the device.
deviceIdentifier	string	false	The identifier of the device.

TestDeviceAssociationWebhook Model Sample

1 {
2   "patientId": 0,
3   "deviceId": 0,
4   "deviceIdentifier": "string"
5 }

TestOrderStatusFullWebhook

Request model for testing order status webhook.

Properties

Name	Type	Required	Description
orderId	integer(int64)	false	Unique identifier for the order.
externalOrderIds	[string]	false	List of external order identifiers.
patientId	integer(int64)	false	Unique identifier for the patient.
orderStatus	string	false	Current status of the order.
trackingNumber	string	false	Tracking number for the order shipment.

TestOrderStatusFullWebhook Model Sample

1 {
2   "orderId": 0,
3   "externalOrderIds": [
4     "string"
5   ],
6   "patientId": 0,
7   "orderStatus": "string",
8   "trackingNumber": "string"
9 }

TestOrderStatusWebhookRequest

Properties

Name	Type	Required	Description
orderId	integer(int64)	false	Unique identifier for the order, managed by Impilo. Randomly generated for test webhooks.
externalOrderIds	[string]	false	List of order ids
orderStatusName	string	true	Order status name

TestOrderStatusWebhookRequest Model Sample

1 {
2   "orderId": 1,
3   "externalOrderIds": [
4     1,
5     2
6   ],
7   "orderStatusName": "ORDER_PLACED"
8 }

TestWeightWebhookRequest

Request model for testing weight webhook.

Properties

Name	Type	Required	Description
patientId	integer(int64)	false	Unique identifier for the patient.
weight	number(double)	false	The weight measurement value.

TestWeightWebhookRequest Model Sample

1 {
2   "patientId": 0,
3   "weight": 0.1
4 }

TrackingNumber

The tracking number model includes details about the shipping carrier and the tracking number value.

Properties

Name	Type	Required	Description
carrier	string	false	The shipping carrier for this tracking number.
value	string	false	The tracking number value.

TrackingNumber Model Sample

1 {
2   "carrier": "string",
3   "value": "string"
4 }

TransferItem

Properties

Name	Type	Required	Description
item	Item	true	The Item being requested to transfer. Only the ID of the item is required.
count	integer(int32)	true	The number of Items being requested for transfer.
devices	[Device]	false	The actual Devices being transferred. Only populated once the Transfer Request is completed.

TransferItem 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     "orderable": true
12   },
13   "count": 0,
14   "devices": [
15     {
16       "id": 1,
17       "item": {
18         "id": 1,
19         "manufacturer": {
20           "id": 1,
21           "name": "string"
22         },
23         "name": "string",
24         "model": "string",
25         "sku": "string",
26         "orderable": true
27       },
28       "currentStatus": "string",
29       "used": true,
30       "currentPatient": {
31         "id": 1,
32         "externalIdentifier": "1234abcd",
33         "firstName": "John",
34         "lastName": "Doe",
35         "dateOfBirth": "1980-01-01",
36         "email": "john.doe@example.com",
37         "phoneNumber": "+1234567890",
38         "archived": true,
39         "address": {
40           "lineOne": "string",
41           "lineTwo": "string",
42           "lineThree": "string",
43           "city": "string",
44           "state": "string",
45           "zipCode": "string",
46           "country": "string",
47           "note": "string"
48         },
49         "site": {
50           "id": 1,
51           "name": "string",
52           "active": true,
53           "address": {
54             "lineOne": "string",
55             "lineTwo": "string",
56             "lineThree": "string",
57             "city": "string",
58             "state": "string",
59             "zipCode": "string",
60             "country": "string",
61             "note": "string"
62           }
63         },
64         "enrolled": true,
65         "sex": "other"
66       },
67       "site": {
68         "id": 1,
69         "name": "string",
70         "active": true,
71         "address": {
72           "lineOne": "string",
73           "lineTwo": "string",
74           "lineThree": "string",
75           "city": "string",
76           "state": "string",
77           "zipCode": "string",
78           "country": "string",
79           "note": "string"
80         }
81       },
82       "lastHealthCheck": "string",
83       "deviceIdentifiers": [
84         {
85           "type": "string",
86           "value": "string"
87         }
88       ],
89       "deviceEvents": [
90         {
91           "type": "string",
92           "eventTimestamp": "string"
93         }
94       ],
95       "externalIdentifier": "string",
96       "disabledReadings": true
97     }
98   ]
99 }

TransferRequest

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the TransferRequest.
fromCustomer	Customer	false	Customer from which the Inventory will be transferred away from. Typically auto-set to the caller of the TransferRequest endpoints.
toCustomer	Customer	false	The target Customer to send the requested Inventory to.
currentStatus	TransferRequestStatus	false	none
createdAt	string(date-time)	false	The timestamp when the Transfer Request was first created.
transferRequestNotes	[TransferRequestNote]	false	Notes attached to this Transfer Request.
transferRequestEvents	[TransferRequestEvent]	false	The sequence of events that this Transfer Request has undergone. Sorted most recent event first.
transferItems	[TransferItem]	false	The Inventory that’s being requested to transfer.

TransferRequest Model Sample

1 {
2   "id": 0,
3   "fromCustomer": {
4     "id": 0,
5     "name": "string"
6   },
7   "toCustomer": {
8     "id": 0,
9     "name": "string"
10   },
11   "currentStatus": "requested",
12   "createdAt": "2019-08-24T14:15:22Z",
13   "transferRequestNotes": [
14     {
15       "note": "string",
16       "createdAt": "2022-03-10T16:15:50Z"
17     }
18   ],
19   "transferRequestEvents": [
20     {
21       "name": "requested",
22       "eventTimestamp": "2019-08-24T14:15:22Z"
23     }
24   ],
25   "transferItems": [
26     {
27       "item": {
28         "id": 1,
29         "manufacturer": {
30           "id": 1,
31           "name": "string"
32         },
33         "name": "string",
34         "model": "string",
35         "sku": "string",
36         "orderable": true
37       },
38       "count": 0,
39       "devices": [
40         {
41           "id": 1,
42           "item": {
43             "id": 1,
44             "manufacturer": {
45               "id": 1,
46               "name": "string"
47             },
48             "name": "string",
49             "model": "string",
50             "sku": "string",
51             "orderable": true
52           },
53           "currentStatus": "string",
54           "used": true,
55           "currentPatient": {
56             "id": 1,
57             "externalIdentifier": "1234abcd",
58             "firstName": "John",
59             "lastName": "Doe",
60             "dateOfBirth": "1980-01-01",
61             "email": "john.doe@example.com",
62             "phoneNumber": "+1234567890",
63             "archived": true,
64             "address": {
65               "lineOne": "string",
66               "lineTwo": "string",
67               "lineThree": "string",
68               "city": "string",
69               "state": "string",
70               "zipCode": "string",
71               "country": "string",
72               "note": "string"
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             "enrolled": true,
90             "sex": "other"
91           },
92           "site": {
93             "id": 1,
94             "name": "string",
95             "active": true,
96             "address": {
97               "lineOne": "string",
98               "lineTwo": "string",
99               "lineThree": "string",
100               "city": "string",
101               "state": "string",
102               "zipCode": "string",
103               "country": "string",
104               "note": "string"
105             }
106           },
107           "lastHealthCheck": "string",
108           "deviceIdentifiers": [
109             {
110               "type": "string",
111               "value": "string"
112             }
113           ],
114           "deviceEvents": [
115             {
116               "type": "string",
117               "eventTimestamp": "string"
118             }
119           ],
120           "externalIdentifier": "string",
121           "disabledReadings": true
122         }
123       ]
124     }
125   ]
126 }

TransferRequestEvent

Properties

Name	Type	Required	Description
name	TransferRequestStatus	false	none
eventTimestamp	string(date-time)	false	The timestamp when this event took place.

TransferRequestEvent Model Sample

1 {
2   "name": "requested",
3   "eventTimestamp": "2019-08-24T14:15:22Z"
4 }

TransferRequestNote

Properties

Name	Type	Required	Description
note	string	false	The note that is linked to a Transfer Request.
createdAt	Instant	false	The timestamp when the note was created.

TransferRequestNote Model Sample

1 {
2   "note": "string",
3   "createdAt": "2022-03-10T16:15:50Z"
4 }

TransferRequestStatus

Enumerated Values

Name	Desciption
requested	Transfer request has been requested.
approved	Transfer request has been approved.
pendingInventory	Transfer request is pending inventory.
voided	Transfer request has been voided.
completed	Transfer request has been completed.

TransferRequestStatus Model Sample

1 "requested"

ValidateDeviceResponse

Properties

Name	Type	Required	Description
valid	boolean	false	A Boolean value of whether this device identifier is validated or not.
device	Device	false	The Device associated with the provided Device Identifier, if exists.

ValidateDeviceResponse Model Sample

1 {
2   "valid": true,
3   "device": {
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       "orderable": true
15     },
16     "currentStatus": "string",
17     "used": true,
18     "currentPatient": {
19       "id": 1,
20       "externalIdentifier": "1234abcd",
21       "firstName": "John",
22       "lastName": "Doe",
23       "dateOfBirth": "1980-01-01",
24       "email": "john.doe@example.com",
25       "phoneNumber": "+1234567890",
26       "archived": true,
27       "address": {
28         "lineOne": "string",
29         "lineTwo": "string",
30         "lineThree": "string",
31         "city": "string",
32         "state": "string",
33         "zipCode": "string",
34         "country": "string",
35         "note": "string"
36       },
37       "site": {
38         "id": 1,
39         "name": "string",
40         "active": true,
41         "address": {
42           "lineOne": "string",
43           "lineTwo": "string",
44           "lineThree": "string",
45           "city": "string",
46           "state": "string",
47           "zipCode": "string",
48           "country": "string",
49           "note": "string"
50         }
51       },
52       "enrolled": true,
53       "sex": "other"
54     },
55     "site": {
56       "id": 1,
57       "name": "string",
58       "active": true,
59       "address": {
60         "lineOne": "string",
61         "lineTwo": "string",
62         "lineThree": "string",
63         "city": "string",
64         "state": "string",
65         "zipCode": "string",
66         "country": "string",
67         "note": "string"
68       }
69     },
70     "lastHealthCheck": "string",
71     "deviceIdentifiers": [
72       {
73         "type": "string",
74         "value": "string"
75       }
76     ],
77     "deviceEvents": [
78       {
79         "type": "string",
80         "eventTimestamp": "string"
81       }
82     ],
83     "externalIdentifier": "string",
84     "disabledReadings": true
85   }
86 }

Webhook

Impilo supports various types of webhooks. This page describes the endpoints available for managing your webhooks.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the webhook managed by Impilo.
type	string	true	The event type for the webhook.
url	string	true	The URL where events for this webhook will be sent.

Webhook Model Sample

1 {
2   "id": 1,
3   "type": "eventType",
4   "url": "http://example.com"
5 }

WebhookLog

Represents a log for a webhook.

Properties

Name	Type	Required	Description
id	integer(int64)	false	ID of the webhook log event
webhookId	integer(int64)	false	ID of the webhook
webhookType	WebhookType	false	Type of the webhook
webhookUrl	string	false	URL of the webhook
payload	string	false	Payload sent with the webhook
createTimestamp	string(date-time)	false	Timestamp when the webhook was sent
lastResponseStatus	integer(int32)	false	Last response status for the webhook
retryAttempts	integer(int32)	false	Number of retry attempts for the webhook
lastRetryTimestamp	string(date-time)	false	Timestamp of the last retry attempt for the webhook

WebhookLog Model Sample

1 {
2   "id": 1,
3   "webhookId": 1,
4   "webhookType": "order.status",
5   "webhookUrl": "http://webhookserver.com",
6   "payload": "{'id':1234}",
7   "createTimestamp": "2023-08-22T14:15:30.345Z",
8   "lastResponseStatus": 200,
9   "retryAttempts": 3,
10   "lastRetryTimestamp": "2023-08-22T14:15:30.345Z"
11 }

WebhookPayload

Impilo supports various types of webhooks. This page describes the endpoints available for managing your webhooks.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the webhook payload, managed by Impilo.
type	string	false	The event type for the webhook.
payload	any	false	The payload of the webhook.

WebhookPayload Model Sample

1 {
2   "id": 1,
3   "type": "string",
4   "payload": null
5 }

WebhookSecret

Properties

Name	Type	Required	Description
secret	string	false	Secret we will pass along with any Webhooks we send to your subscribed endpoints.

WebhookSecret Model Sample

1 {
2   "secret": "string"
3 }

WebhookType

Enumerated Values

Name	Desciption
procurement.statusFull	A procurement status event occurred. The payload includes the full procurement model.
supportTicket.event	A support ticket event took place.
reading.bloodOxygen	A reading of blood oxygen was taken.
order.status	An order status event occurred. The payload only includes order id and order event type.
reading.peakFlow	A peak flow reading was taken.
transferRequest.statusFull	A transfer request status event occurred. The payload includes the full transfer request model.
device.lowBattery	A device sent a low battery signal.
return.statusFull	A return status event was triggered.
patient.updated	A patient’s details were updated.
reading.sleepMatActivity	A sleep mat activity reading was taken.
reading.bloodPressure	A reading of blood pressure was taken.
reading.sleepMatDuration	A sleep mat duration reading was taken.
procurement.status	A procurement status event occurred. The payload only includes procurement id and event type.
device.associationCreated	A patient-device association was created.
device.associationRemoved	A patient-device association was removed.
patient.created	A new patient was created.
reading.weight	A body weight reading was taken.
reading.temperature	A body temperature reading was taken.
transferRequest.status	A transfer request status event occurred. The payload only includes transfer request id and transfer request event type.
return.status	A return status event was triggered.
reading.bloodGlucose	A reading of blood glucose was taken.
device.weakSignal	A device sent a weak signal.
order.statusFull	An order status event occurred. The payload includes the full order model.

WebhookType Model Sample

1 "procurement.statusFull"

WeightReading

This page describes Impilo’s weight reading model.

Properties

Name	Type	Required	Description
id	integer(int64)	false	Unique identifier for the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
patientTimeZoneOffset	integer(int32)	false	The offset of the patient’s timezone from UTC in seconds. Null if unavailable.
patient	Patient	false	The patient who took the reading.
item	Item	false	The item used to take the reading.
device	Device	false	The device used to take the reading.
weight	number(double)	true	The weight reading in lbs.
weightUnit	WeightUnit	false	none

WeightReading Model Sample

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

WeightReadingRequest

This page describes Impilo’s weight reading model.

Properties

Name	Type	Required	Description
deviceId	integer(int64)	false	The id of the device that took the reading.
deviceIdentifier	string	false	The device identifier of the device that took the reading.
patientId	integer(int64)	false	The id of the patient that took the reading.
readingTimestamp	string(date-time)	true	The UTC timestamp at which the reading was taken.
deviceTimeZoneOffset	integer(int32)	false	The offset of the device’s timezone from UTC in seconds. Null if unavailable.
weight	number(double)	true	The weight reading value in lbs.
manual	boolean	false	True if the reading value was entered manually, false or null otherwise.

WeightReadingRequest Model Sample

1 {
2   "deviceId": 0,
3   "deviceIdentifier": "string",
4   "patientId": 0,
5   "readingTimestamp": "2022-03-10T16:15:50Z",
6   "deviceTimeZoneOffset": -14400,
7   "weight": 0.1,
8   "manual": true
9 }

WeightUnit

Enumerated Values

Name	Desciption
lbs	Weight unit of measurement is pounds.

WeightUnit Model Sample

1 "lbs"

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	}

1	{
2	"deviceId": 1,
3	"deviceIdentifier": "ABC123",
4	"patientId": 0,
5	"patientExternalIdentifier": "string"
6	}

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

1	{
2	"deviceId": 0,
3	"deviceIdentifier": "string",
4	"patientId": 0,
5	"readingTimestamp": "2022-03-10T16:15:50Z",
6	"deviceTimeZoneOffset": -14400,
7	"glucose": 0,
8	"manual": true,
9	"beforeMeal": true,
10	"afterMeal": true
11	}

1	{
2	"id": 0,
3	"type": "other",
4	"cptCode": {
5	"value": "string",
6	"displayAs": "string"
7	},
8	"createTimestamp": "2022-03-10T16:15:50Z",
9	"lastUpdateTimestamp": "2022-03-10T16:15:50Z",
10	"open": true,
11	"mdCode": "string",
12	"dxCode": "string",
13	"description": "string",
14	"createdBy": {
15	"id": 0,
16	"firstName": "string",
17	"lastName": "string",
18	"email": "string"
19	},
20	"assignee": {
21	"id": 0,
22	"firstName": "string",
23	"lastName": "string",
24	"email": "string"
25	},
26	"patient": {
27	"id": 1,
28	"externalIdentifier": "1234abcd",
29	"firstName": "John",
30	"lastName": "Doe",
31	"dateOfBirth": "1980-01-01",
32	"email": "john.doe@example.com",
33	"phoneNumber": "+1234567890",
34	"archived": true,
35	"address": {
36	"lineOne": "string",
37	"lineTwo": "string",
38	"lineThree": "string",
39	"city": "string",
40	"state": "string",
41	"zipCode": "string",
42	"country": "string",
43	"note": "string"
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	"enrolled": true,
61	"sex": "other"
62	},
63	"activity": [
64	{
65	"createTimestamp": "2022-03-10T16:15:50Z",
66	"comment": "string",
67	"minutesSpent": 0,
68	"createdBy": {
69	"id": 0,
70	"firstName": "string",
71	"lastName": "string",
72	"email": "string"
73	}
74	}
75	],
76	"totalTime": 0
77	}

1	{
2	"length": 0.1,
3	"width": 0.1,
4	"height": 0.1,
5	"unit": "in"
6	}

1	{
2	"name": "string",
3	"model": "string",
4	"deviceIdentifierType": "simCardNumber"
5	}

1	{
2	"toCustomerId": 0,
3	"transfers": [
4	{
5	"item": {
6	"id": 1,
7	"manufacturer": {
8	"id": 1,
9	"name": "string"
10	},
11	"name": "string",
12	"model": "string",
13	"sku": "string",
14	"orderable": true
15	},
16	"count": 0,
17	"devices": [
18	{
19	"id": 1,
20	"item": {
21	"id": 1,
22	"manufacturer": {
23	"id": 1,
24	"name": "string"
25	},
26	"name": "string",
27	"model": "string",
28	"sku": "string",
29	"orderable": true
30	},
31	"currentStatus": "string",
32	"used": true,
33	"currentPatient": {
34	"id": 1,
35	"externalIdentifier": "1234abcd",
36	"firstName": "John",
37	"lastName": "Doe",
38	"dateOfBirth": "1980-01-01",
39	"email": "john.doe@example.com",
40	"phoneNumber": "+1234567890",
41	"archived": true,
42	"address": {
43	"lineOne": "string",
44	"lineTwo": "string",
45	"lineThree": "string",
46	"city": "string",
47	"state": "string",
48	"zipCode": "string",
49	"country": "string",
50	"note": "string"
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	"enrolled": true,
68	"sex": "other"
69	},
70	"site": {
71	"id": 1,
72	"name": "string",
73	"active": true,
74	"address": {
75	"lineOne": "string",
76	"lineTwo": "string",
77	"lineThree": "string",
78	"city": "string",
79	"state": "string",
80	"zipCode": "string",
81	"country": "string",
82	"note": "string"
83	}
84	},
85	"lastHealthCheck": "string",
86	"deviceIdentifiers": [
87	{
88	"type": "string",
89	"value": "string"
90	}
91	],
92	"deviceEvents": [
93	{
94	"type": "string",
95	"eventTimestamp": "string"
96	}
97	],
98	"externalIdentifier": "string",
99	"disabledReadings": true
100	}
101	]
102	}
103	]
104	}

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": "other"
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": "availableForPickup",
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	"orderable": true
71	},
72	"count": 0
73	}
74	],
75	"orderKits": [
76	{
77	"kit": {
78	"id": 0,
79	"name": "string",
80	"archived": true,
81	"kitItems": [
82	{
83	"item": {
84	"id": 1,
85	"manufacturer": {
86	"id": 1,
87	"name": "string"
88	},
89	"name": "string",
90	"model": "string",
91	"sku": "string",
92	"orderable": true
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	"orderable": true
126	},
127	"currentStatus": "string",
128	"used": true,
129	"currentPatient": {
130	"id": 1,
131	"externalIdentifier": "1234abcd",
132	"firstName": "John",
133	"lastName": "Doe",
134	"dateOfBirth": "1980-01-01",
135	"email": "john.doe@example.com",
136	"phoneNumber": "+1234567890",
137	"archived": true,
138	"address": {
139	"lineOne": "string",
140	"lineTwo": "string",
141	"lineThree": "string",
142	"city": "string",
143	"state": "string",
144	"zipCode": "string",
145	"country": "string",
146	"note": "string"
147	},
148	"site": {
149	"id": 1,
150	"name": "string",
151	"active": true,
152	"address": {
153	"lineOne": "string",
154	"lineTwo": "string",
155	"lineThree": "string",
156	"city": "string",
157	"state": "string",
158	"zipCode": "string",
159	"country": "string",
160	"note": "string"
161	}
162	},
163	"enrolled": true,
164	"sex": "other"
165	},
166	"site": {
167	"id": 1,
168	"name": "string",
169	"active": true,
170	"address": {
171	"lineOne": "string",
172	"lineTwo": "string",
173	"lineThree": "string",
174	"city": "string",
175	"state": "string",
176	"zipCode": "string",
177	"country": "string",
178	"note": "string"
179	}
180	},
181	"lastHealthCheck": "string",
182	"deviceIdentifiers": [
183	{
184	"type": "string",
185	"value": "string"
186	}
187	],
188	"deviceEvents": [
189	{
190	"type": "string",
191	"eventTimestamp": "string"
192	}
193	],
194	"externalIdentifier": "string",
195	"disabledReadings": true
196	}
197	],
198	"packedKits": [
199	{
200	"kit": {
201	"id": 0,
202	"name": "string",
203	"archived": true,
204	"kitItems": [
205	{
206	"item": {
207	"id": 1,
208	"manufacturer": {
209	"id": 1,
210	"name": "string"
211	},
212	"name": "string",
213	"model": "string",
214	"sku": "string",
215	"orderable": true
216	},
217	"count": 0
218	}
219	]
220	},
221	"devices": [
222	{
223	"id": 1,
224	"item": {
225	"id": 1,
226	"manufacturer": {
227	"id": 1,
228	"name": "string"
229	},
230	"name": "string",
231	"model": "string",
232	"sku": "string",
233	"orderable": true
234	},
235	"currentStatus": "string",
236	"used": true,
237	"currentPatient": {
238	"id": 1,
239	"externalIdentifier": "1234abcd",
240	"firstName": "John",
241	"lastName": "Doe",
242	"dateOfBirth": "1980-01-01",
243	"email": "john.doe@example.com",
244	"phoneNumber": "+1234567890",
245	"archived": true,
246	"address": {
247	"lineOne": "string",
248	"lineTwo": "string",
249	"lineThree": "string",
250	"city": "string",
251	"state": "string",
252	"zipCode": "string",
253	"country": "string",
254	"note": "string"
255	},
256	"site": {
257	"id": 1,
258	"name": "string",
259	"active": true,
260	"address": {
261	"lineOne": "string",
262	"lineTwo": "string",
263	"lineThree": "string",
264	"city": "string",
265	"state": "string",
266	"zipCode": "string",
267	"country": "string",
268	"note": "string"
269	}
270	},
271	"enrolled": true,
272	"sex": "other"
273	},
274	"site": {
275	"id": 1,
276	"name": "string",
277	"active": true,
278	"address": {
279	"lineOne": "string",
280	"lineTwo": "string",
281	"lineThree": "string",
282	"city": "string",
283	"state": "string",
284	"zipCode": "string",
285	"country": "string",
286	"note": "string"
287	}
288	},
289	"lastHealthCheck": "string",
290	"deviceIdentifiers": [
291	{
292	"type": "string",
293	"value": "string"
294	}
295	],
296	"deviceEvents": [
297	{
298	"type": "string",
299	"eventTimestamp": "string"
300	}
301	],
302	"externalIdentifier": "string",
303	"disabledReadings": true
304	}
305	]
306	}
307	],
308	"shippingOption": "standard"
309	}

1	{
2	"content": [
3	null
4	],
5	"page": 0,
6	"size": 0,
7	"total": 0,
8	"first": true,
9	"last": true
10	}

1	{
2	"content": [
3	{
4	"id": 0,
5	"customer": {
6	"id": 0,
7	"name": "string"
8	},
9	"patient": {
10	"id": 1,
11	"externalIdentifier": "1234abcd",
12	"firstName": "John",
13	"lastName": "Doe",
14	"dateOfBirth": "1980-01-01",
15	"email": "john.doe@example.com",
16	"phoneNumber": "+1234567890",
17	"archived": true,
18	"address": {
19	"lineOne": "string",
20	"lineTwo": "string",
21	"lineThree": "string",
22	"city": "string",
23	"state": "string",
24	"zipCode": "string",
25	"country": "string",
26	"note": "string"
27	},
28	"site": {
29	"id": 1,
30	"name": "string",
31	"active": true,
32	"address": {
33	"lineOne": "string",
34	"lineTwo": "string",
35	"lineThree": "string",
36	"city": "string",
37	"state": "string",
38	"zipCode": "string",
39	"country": "string",
40	"note": "string"
41	}
42	},
43	"enrolled": true,
44	"sex": "other"
45	},
46	"order": {
47	"id": 0,
48	"externalOrderIds": [
49	"string"
50	],
51	"patient": {
52	"id": 1,
53	"externalIdentifier": "1234abcd",
54	"firstName": "John",
55	"lastName": "Doe",
56	"dateOfBirth": "1980-01-01",
57	"email": "john.doe@example.com",
58	"phoneNumber": "+1234567890",
59	"archived": 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	"site": {
71	"id": 1,
72	"name": "string",
73	"active": true,
74	"address": {
75	"lineOne": "string",
76	"lineTwo": "string",
77	"lineThree": "string",
78	"city": "string",
79	"state": "string",
80	"zipCode": "string",
81	"country": "string",
82	"note": "string"
83	}
84	},
85	"enrolled": true,
86	"sex": "other"
87	},
88	"site": {
89	"id": 1,
90	"name": "string",
91	"active": 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	},
103	"currentStatus": "availableForPickup",
104	"orderItems": [
105	{
106	"item": {
107	"id": 1,
108	"manufacturer": {
109	"id": 1,
110	"name": "string"
111	},
112	"name": "string",
113	"model": "string",
114	"sku": "string",
115	"orderable": true
116	},
117	"count": 0
118	}
119	],
120	"orderKits": [
121	{
122	"kit": {
123	"id": 0,
124	"name": "string",
125	"archived": true,
126	"kitItems": [
127	{
128	"item": {
129	"id": 1,
130	"manufacturer": {},
131	"name": "string",
132	"model": "string",
133	"sku": "string",
134	"orderable": true
135	},
136	"count": 0
137	}
138	]
139	},
140	"count": 0
141	}
142	],
143	"orderEvents": [
144	{
145	"name": "string",
146	"eventTimestamp": "string"
147	}
148	],
149	"trackingNumbers": [
150	{
151	"carrier": "string",
152	"value": "string"
153	}
154	],
155	"devices": [
156	{
157	"id": 1,
158	"item": {
159	"id": 1,
160	"manufacturer": {
161	"id": 1,
162	"name": "string"
163	},
164	"name": "string",
165	"model": "string",
166	"sku": "string",
167	"orderable": true
168	},
169	"currentStatus": "string",
170	"used": true,
171	"currentPatient": {
172	"id": 1,
173	"externalIdentifier": "1234abcd",
174	"firstName": "John",
175	"lastName": "Doe",
176	"dateOfBirth": "1980-01-01",
177	"email": "john.doe@example.com",
178	"phoneNumber": "+1234567890",
179	"archived": true,
180	"address": {
181	"lineOne": "string",
182	"lineTwo": "string",
183	"lineThree": "string",
184	"city": "string",
185	"state": "string",
186	"zipCode": "string",
187	"country": "string",
188	"note": "string"
189	},
190	"site": {
191	"id": 1,
192	"name": "string",
193	"active": true,
194	"address": {
195	"lineOne": "string",
196	"lineTwo": "string",
197	"lineThree": "string",
198	"city": "string",
199	"state": "string",
200	"zipCode": "string",
201	"country": "string",
202	"note": "string"
203	}
204	},
205	"enrolled": true,
206	"sex": "other"
207	},
208	"site": {
209	"id": 1,
210	"name": "string",
211	"active": true,
212	"address": {
213	"lineOne": "string",
214	"lineTwo": "string",
215	"lineThree": "string",
216	"city": "string",
217	"state": "string",
218	"zipCode": "string",
219	"country": "string",
220	"note": "string"
221	}
222	},
223	"lastHealthCheck": "string",
224	"deviceIdentifiers": [
225	{
226	"type": "string",
227	"value": "string"
228	}
229	],
230	"deviceEvents": [
231	{
232	"type": "string",
233	"eventTimestamp": "string"
234	}
235	],
236	"externalIdentifier": "string",
237	"disabledReadings": true
238	}
239	],
240	"packedKits": [
241	{
242	"kit": {
243	"id": 0,
244	"name": "string",
245	"archived": true,
246	"kitItems": [
247	{
248	"item": {
249	"id": 1,
250	"manufacturer": {},
251	"name": "string",
252	"model": "string",
253	"sku": "string",
254	"orderable": true
255	},
256	"count": 0
257	}
258	]
259	},
260	"devices": [
261	{
262	"id": 1,
263	"item": {
264	"id": 1,
265	"manufacturer": {
266	"id": 1,
267	"name": "string"
268	},
269	"name": "string",
270	"model": "string",
271	"sku": "string",
272	"orderable": true
273	},
274	"currentStatus": "string",
275	"used": true,
276	"currentPatient": {
277	"id": 1,
278	"externalIdentifier": "1234abcd",
279	"firstName": "John",
280	"lastName": "Doe",
281	"dateOfBirth": "1980-01-01",
282	"email": "john.doe@example.com",
283	"phoneNumber": "+1234567890",
284	"archived": true,
285	"address": {
286	"lineOne": "string",
287	"lineTwo": "string",
288	"lineThree": "string",
289	"city": "string",
290	"state": "string",
291	"zipCode": "string",
292	"country": "string",
293	"note": "string"
294	},
295	"site": {
296	"id": 1,
297	"name": "string",
298	"active": true,
299	"address": {}
300	},
301	"enrolled": true,
302	"sex": "other"
303	},
304	"site": {
305	"id": 1,
306	"name": "string",
307	"active": true,
308	"address": {
309	"lineOne": "string",
310	"lineTwo": "string",
311	"lineThree": "string",
312	"city": "string",
313	"state": "string",
314	"zipCode": "string",
315	"country": "string",
316	"note": "string"
317	}
318	},
319	"lastHealthCheck": "string",
320	"deviceIdentifiers": [
321	{
322	"type": "string",
323	"value": "string"
324	}
325	],
326	"deviceEvents": [
327	{
328	"type": "string",
329	"eventTimestamp": "string"
330	}
331	],
332	"externalIdentifier": "string",
333	"disabledReadings": true
334	}
335	]
336	}
337	],
338	"shippingOption": "standard"
339	},
340	"device": {
341	"id": 1,
342	"item": {
343	"id": 1,
344	"manufacturer": {
345	"id": 1,
346	"name": "string"
347	},
348	"name": "string",
349	"model": "string",
350	"sku": "string",
351	"orderable": true
352	},
353	"currentStatus": "string",
354	"used": true,
355	"currentPatient": {
356	"id": 1,
357	"externalIdentifier": "1234abcd",
358	"firstName": "John",
359	"lastName": "Doe",
360	"dateOfBirth": "1980-01-01",
361	"email": "john.doe@example.com",
362	"phoneNumber": "+1234567890",
363	"archived": true,
364	"address": {
365	"lineOne": "string",
366	"lineTwo": "string",
367	"lineThree": "string",
368	"city": "string",
369	"state": "string",
370	"zipCode": "string",
371	"country": "string",
372	"note": "string"
373	},
374	"site": {
375	"id": 1,
376	"name": "string",
377	"active": true,
378	"address": {
379	"lineOne": "string",
380	"lineTwo": "string",
381	"lineThree": "string",
382	"city": "string",
383	"state": "string",
384	"zipCode": "string",
385	"country": "string",
386	"note": "string"
387	}
388	},
389	"enrolled": true,
390	"sex": "other"
391	},
392	"site": {
393	"id": 1,
394	"name": "string",
395	"active": true,
396	"address": {
397	"lineOne": "string",
398	"lineTwo": "string",
399	"lineThree": "string",
400	"city": "string",
401	"state": "string",
402	"zipCode": "string",
403	"country": "string",
404	"note": "string"
405	}
406	},
407	"lastHealthCheck": "string",
408	"deviceIdentifiers": [
409	{
410	"type": "string",
411	"value": "string"
412	}
413	],
414	"deviceEvents": [
415	{
416	"type": "string",
417	"eventTimestamp": "string"
418	}
419	],
420	"externalIdentifier": "string",
421	"disabledReadings": true
422	},
423	"site": {
424	"id": 1,
425	"name": "string",
426	"active": true,
427	"address": {
428	"lineOne": "string",
429	"lineTwo": "string",
430	"lineThree": "string",
431	"city": "string",
432	"state": "string",
433	"zipCode": "string",
434	"country": "string",
435	"note": "string"
436	}
437	},
438	"ticketType": "returnToSender",
439	"supportTicketNotes": [
440	{
441	"createdBy": {
442	"id": 0,
443	"firstName": "string",
444	"lastName": "string",
445	"email": "string"
446	},
447	"note": "string",
448	"createdAt": "2022-03-10T16:15:50Z"
449	}
450	],
451	"supportTicketEvents": [
452	{
453	"eventType": "addressConfirmationAddressConfirmed",
454	"createdAt": "2022-03-10T16:15:50Z"
455	}
456	],
457	"currentStatus": "closed",
458	"open": true,
459	"assignedTeam": "operations",
460	"assignee": {
461	"id": 0,
462	"firstName": "string",
463	"lastName": "string",
464	"email": "string"
465	},
466	"createdBy": {
467	"id": 0,
468	"firstName": "string",
469	"lastName": "string",
470	"email": "string"
471	},
472	"createdAt": "2022-03-10T16:15:50Z",
473	"lastUpdated": "2022-03-10T16:15:50Z"
474	}
475	],
476	"page": 0,
477	"size": 0,
478	"total": 0,
479	"first": true,
480	"last": true
481	}

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

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	}

1	{
2	"content": [
3	{
4	"id": 1,
5	"webhookId": 1,
6	"webhookType": "order.status",
7	"webhookUrl": "http://webhookserver.com",
8	"payload": "{'id':1234}",
9	"createTimestamp": "2023-08-22T14:15:30.345Z",
10	"lastResponseStatus": 200,
11	"retryAttempts": 3,
12	"lastRetryTimestamp": "2023-08-22T14:15:30.345Z"
13	}
14	],
15	"page": 0,
16	"size": 0,
17	"total": 0,
18	"first": true,
19	"last": true
20	}

1	{
2	"id": 1,
3	"currentStatus": "string",
4	"procurementType": "string",
5	"procurementItems": [
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	"orderable": true
17	},
18	"quantityRequested": 0,
19	"quantityApproved": 0,
20	"costPerItem": 0.1,
21	"trackingNumbers": [
22	{
23	"carrier": "string",
24	"value": "string"
25	}
26	]
27	}
28	],
29	"procurementEvents": [
30	{
31	"name": "string",
32	"eventTimestamp": "string"
33	}
34	]
35	}

1	{
2	"event": "addressConfirmationAddressConfirmed",
3	"note": "string"
4	}

1	{
2	"patientId": 0,
3	"systolic": 0,
4	"diastolic": 0,
5	"heartRate": 0
6	}

1	{
2	"patientId": 0,
3	"deviceId": 0,
4	"deviceIdentifier": "string"
5	}

1	{
2	"orderId": 0,
3	"externalOrderIds": [
4	"string"
5	],
6	"patientId": 0,
7	"orderStatus": "string",
8	"trackingNumber": "string"
9	}

1	{
2	"orderId": 1,
3	"externalOrderIds": [
4	1,
5	2
6	],
7	"orderStatusName": "ORDER_PLACED"
8	}

1	{
2	"valid": true,
3	"device": {
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	"orderable": true
15	},
16	"currentStatus": "string",
17	"used": true,
18	"currentPatient": {
19	"id": 1,
20	"externalIdentifier": "1234abcd",
21	"firstName": "John",
22	"lastName": "Doe",
23	"dateOfBirth": "1980-01-01",
24	"email": "john.doe@example.com",
25	"phoneNumber": "+1234567890",
26	"archived": true,
27	"address": {
28	"lineOne": "string",
29	"lineTwo": "string",
30	"lineThree": "string",
31	"city": "string",
32	"state": "string",
33	"zipCode": "string",
34	"country": "string",
35	"note": "string"
36	},
37	"site": {
38	"id": 1,
39	"name": "string",
40	"active": true,
41	"address": {
42	"lineOne": "string",
43	"lineTwo": "string",
44	"lineThree": "string",
45	"city": "string",
46	"state": "string",
47	"zipCode": "string",
48	"country": "string",
49	"note": "string"
50	}
51	},
52	"enrolled": true,
53	"sex": "other"
54	},
55	"site": {
56	"id": 1,
57	"name": "string",
58	"active": true,
59	"address": {
60	"lineOne": "string",
61	"lineTwo": "string",
62	"lineThree": "string",
63	"city": "string",
64	"state": "string",
65	"zipCode": "string",
66	"country": "string",
67	"note": "string"
68	}
69	},
70	"lastHealthCheck": "string",
71	"deviceIdentifiers": [
72	{
73	"type": "string",
74	"value": "string"
75	}
76	],
77	"deviceEvents": [
78	{
79	"type": "string",
80	"eventTimestamp": "string"
81	}
82	],
83	"externalIdentifier": "string",
84	"disabledReadings": true
85	}
86	}