Order Management
This guide is designed to help you understand how orders can be created and linked with either an existing patient or an existing site, and the required as well as optional attributes for order creation.
Understanding Patients and Sites
Before we dive into the order creation process, it's important to understand the entities associated with an order:
-
Patient: A patient profile is stored within Impilo and is managed by the customer. These profiles are essential for personalizing and managing patient-related orders.
-
Site: A site represents a customer-managed location that engages with Impilo’s services. Patients can be associated with a site for the purpose of orders and inventory management. The customer is responsible for managing the set of sites within their account, which can interact with Impilo’s services.
Create Order Endpoint
To create an order, you'll interact with a specific endpoint designed for this purpose. This endpoint allows you to initiate and configure orders based on your requirements.
Required Attributes
For a successful order creation, you must ensure the following required attributes are correctly provided:
-
Association: Your order must be associated with either an existing patient or an site. It is crucial that exactly one of these is specified for an order, and only the
idproperty of the patient or site is required. -
Order Content: Your order must include at least one of the following:
-
orderItems: A list of items to be ordered. You must provide at least one item with only theidproperty required. -
orderKits: A list of kits to be ordered. Similar to order items, at least one kit must be specified with only theidproperty required.
Create Patient Order Example
The following request contains the bare minimum for creating an order for an existing patient.
POST /api/v3/order
curl -X POST https://app.impiloplatform.com/api/v3/order \
-H "Impilo-API-Key: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"emailLabel": false,
"externalOrderIds": [
"order_789_0",
"order_789_1",
"order_789_2",
"order_789_3"
],
"orderItems": [
{
"count": 10,
"item": {
"id": 1010
}
},
{
"count": 10,
"item": {
"id": 1011
}
},
{
"count": 10,
"item": {
"id": 1012
}
},
{
"count": 10,
"item": {
"id": 1013
}
}
],
"orderKits": [
{
"count": 10,
"kit": {
"id": 1000,
"kitItems": []
}
},
{
"count": 10,
"kit": {
"id": 1001,
"kitItems": []
}
},
{
"count": 10,
"kit": {
"id": 1002,
"kitItems": []
}
},
{
"count": 10,
"kit": {
"id": 1003,
"kitItems": []
}
}
],
"orderNotes": [],
"patient": {
"firstName": "Steven",
"lastName": "Glansberg",
"address": {
"city": "Anytown",
"country": "USA",
"lineOne": "123 Main Street",
"state": "PA",
"zipCode": "19334"
},
"email": "steve.g@gmail.com",
"sex": "unknown"
},
"returnDevices": [],
"returnItems": [],
"returnPackedKits": [],
"shippingOption": "standard"
}'
Below is an example response containing sample data.
Response
{
"currentStatus": "reconfirmAddress",
"devices": [
{
"currentPatient": {
"firstName": "Jane",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "456 Elm Street",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave at front desk"
},
"archived": false,
"dateOfBirth": "1975-06-15",
"email": "jane.doe@example.com",
"enrolled": true,
"externalIdentifier": "pat_5678",
"id": 42,
"phoneNumber": "+14155552671",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
}
},
"currentStatus": "shipped",
"deviceEvents": [
{
"eventTimestamp": "2024-05-10T09:30:00Z",
"type": "shipped"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN123456789"
}
],
"disabledReadings": false,
"externalIdentifier": "1d23-4567-89ab-cdef",
"id": 101,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-05-09T18:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
},
"used": true
}
],
"emailLabel": true,
"externalOrderIds": [
"order_789_0"
],
"id": 5555,
"orderEvents": [
{
"eventTimestamp": "2024-05-10T08:00:00Z",
"name": "orderPlaced"
}
],
"orderItems": [
{
"count": 10,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"orderKits": [
{
"count": 10,
"kit": {
"archived": false,
"id": 1000,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": false,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"name": "Basic Health Kit"
}
}
],
"orderNotes": [
{
"createdAt": "2024-05-09T07:45:00Z",
"createdBy": {
"email": "admin@healthcare.org",
"firstName": "Alice",
"id": 10,
"lastName": "Smith"
},
"note": "Urgent order, please prioritize."
}
],
"packedKits": [
{
"devices": [
{
"currentPatient": {
"firstName": "Jane",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "456 Elm Street",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave at front desk"
},
"archived": false,
"dateOfBirth": "1975-06-15",
"email": "jane.doe@example.com",
"enrolled": true,
"externalIdentifier": "pat_5678",
"id": 42,
"phoneNumber": "+14155552671",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
}
},
"currentStatus": "shipped",
"deviceEvents": [
{
"eventTimestamp": "2024-05-10T09:30:00Z",
"type": "shipped"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN123456789"
}
],
"disabledReadings": false,
"externalIdentifier": "1d23-4567-89ab-cdef",
"id": 101,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-05-09T18:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
},
"used": true
}
],
"externalIdentifier": "kit_789",
"id": 2001,
"kit": {
"archived": false,
"id": 1000,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": false,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"name": "Basic Health Kit"
}
}
],
"patient": {
"firstName": "Jane",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "456 Elm Street",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave at front desk"
},
"archived": false,
"dateOfBirth": "1975-06-15",
"email": "jane.doe@example.com",
"enrolled": true,
"externalIdentifier": "pat_5678",
"id": 42,
"phoneNumber": "+14155552671",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
}
},
"returnDevices": [
{
"id": 101
}
],
"returnItems": [
{
"count": 1,
"id": 1010
}
],
"returnPackedKits": [
{
"id": 2001,
"quantity": 1
}
],
"shippingOption": "standard",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
},
"trackingNumbers": [
{
"carrier": "usps",
"value": "9400110898825022579493"
}
]
}
Create Site Order Example
The following request contains the bare minimum for creating an order for an existing site.
POST /api/v3/order
curl -X POST https://app.impiloplatform.com/api/v3/order \
-H "Impilo-API-Key: <apiKey>" \
-H "Content-Type: application/json" \
-d '{
"emailLabel": false,
"externalOrderIds": [
"order_789_0",
"order_789_1",
"order_789_2",
"order_789_3"
],
"orderItems": [
{
"count": 10,
"item": {
"id": 1010
}
},
{
"count": 10,
"item": {
"id": 1011
}
},
{
"count": 10,
"item": {
"id": 1012
}
},
{
"count": 10,
"item": {
"id": 1013
}
}
],
"orderKits": [
{
"count": 10,
"kit": {
"id": 1000,
"kitItems": []
}
},
{
"count": 10,
"kit": {
"id": 1001,
"kitItems": []
}
},
{
"count": 10,
"kit": {
"id": 1002,
"kitItems": []
}
},
{
"count": 10,
"kit": {
"id": 1003,
"kitItems": []
}
}
],
"orderNotes": [],
"patient": {
"firstName": "Steven",
"lastName": "Glansberg",
"address": {
"city": "Anytown",
"country": "USA",
"lineOne": "123 Main Street",
"state": "PA",
"zipCode": "19334"
},
"email": "steve.g@gmail.com",
"sex": "unknown"
},
"returnDevices": [],
"returnItems": [],
"returnPackedKits": [],
"shippingOption": "standard"
}'
Below is an example response containing sample data.
Response
{
"currentStatus": "reconfirmAddress",
"devices": [
{
"currentPatient": {
"firstName": "Jane",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "456 Elm Street",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave at front desk"
},
"archived": false,
"dateOfBirth": "1975-06-15",
"email": "jane.doe@example.com",
"enrolled": true,
"externalIdentifier": "pat_5678",
"id": 42,
"phoneNumber": "+14155552671",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
}
},
"currentStatus": "shipped",
"deviceEvents": [
{
"eventTimestamp": "2024-05-10T09:30:00Z",
"type": "shipped"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN123456789"
}
],
"disabledReadings": false,
"externalIdentifier": "1d23-4567-89ab-cdef",
"id": 101,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-05-09T18:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
},
"used": true
}
],
"emailLabel": true,
"externalOrderIds": [
"order_789_0"
],
"id": 5555,
"orderEvents": [
{
"eventTimestamp": "2024-05-10T08:00:00Z",
"name": "orderPlaced"
}
],
"orderItems": [
{
"count": 10,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"orderKits": [
{
"count": 10,
"kit": {
"archived": false,
"id": 1000,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": false,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"name": "Basic Health Kit"
}
}
],
"orderNotes": [
{
"createdAt": "2024-05-09T07:45:00Z",
"createdBy": {
"email": "admin@healthcare.org",
"firstName": "Alice",
"id": 10,
"lastName": "Smith"
},
"note": "Urgent order, please prioritize."
}
],
"packedKits": [
{
"devices": [
{
"currentPatient": {
"firstName": "Jane",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "456 Elm Street",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave at front desk"
},
"archived": false,
"dateOfBirth": "1975-06-15",
"email": "jane.doe@example.com",
"enrolled": true,
"externalIdentifier": "pat_5678",
"id": 42,
"phoneNumber": "+14155552671",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
}
},
"currentStatus": "shipped",
"deviceEvents": [
{
"eventTimestamp": "2024-05-10T09:30:00Z",
"type": "shipped"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN123456789"
}
],
"disabledReadings": false,
"externalIdentifier": "1d23-4567-89ab-cdef",
"id": 101,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-05-09T18:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
},
"used": true
}
],
"externalIdentifier": "kit_789",
"id": 2001,
"kit": {
"archived": false,
"id": 1000,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": false,
"item": {
"id": 1010,
"manufacturer": {
"id": 5,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"name": "Basic Health Kit"
}
}
],
"patient": {
"firstName": "Jane",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "456 Elm Street",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave at front desk"
},
"archived": false,
"dateOfBirth": "1975-06-15",
"email": "jane.doe@example.com",
"enrolled": true,
"externalIdentifier": "pat_5678",
"id": 42,
"phoneNumber": "+14155552671",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
}
},
"returnDevices": [
{
"id": 101
}
],
"returnItems": [
{
"count": 1,
"id": 1010
}
],
"returnPackedKits": [
{
"id": 2001,
"quantity": 1
}
],
"shippingOption": "standard",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "789 Health Blvd",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "",
"note": "Main clinic"
},
"id": 7,
"name": "Springfield Health Center",
"phoneNumber": "+14155550000"
},
"trackingNumbers": [
{
"carrier": "usps",
"value": "9400110898825022579493"
}
]
}
Optional Attributes
In addition to the required attributes, the following optional attributes can be specified to further customize your order:
- External Order IDs (
externalOrderIds): An array of strings allowing the client to associate one or more of their own order IDs with the Impilo order record. This is particularly useful for tracking and management purposes on the client’s end.
Listing Orders
This functionality allows you to retrieve a list of orders made within the system. It supports pagination to help manage and navigate through large sets of orders effectively. This endpoint is particularly useful for overviewing all orders and analyzing order trends or statuses within a specific timeframe or criteria.
GET /api/v3/order
curl https://app.impiloplatform.com/api/v3/order \
-H "Impilo-API-Key: <apiKey>" \
-H "Content-Type: application/json"
Response
{
"content": [
{
"currentStatus": "reconfirmAddress",
"devices": [
{
"currentPatient": {
"firstName": "Lisa",
"lastName": "Simpson",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "742 Evergreen Terrace",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave package at front desk"
},
"archived": false,
"dateOfBirth": "1975-05-20",
"email": "lisa.simpson@example.com",
"enrolled": true,
"externalIdentifier": "pat-987654",
"id": 1024,
"phoneNumber": "+13125551234",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Main St",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "Floor 2",
"note": "Reception on 2nd floor"
},
"id": 12,
"name": "Springfield Health Clinic",
"phoneNumber": "+13125550000"
}
},
"currentStatus": "active",
"deviceEvents": [
{
"eventTimestamp": "2024-06-10T09:15:00Z",
"type": "batteryLow"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN1234567890"
}
],
"disabledReadings": false,
"externalIdentifier": "dev-1d23-4567-89ab-cdef",
"id": 501,
"item": {
"id": 301,
"manufacturer": {
"id": 45,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-06-10T08:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Main St",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "Floor 2",
"note": "Reception on 2nd floor"
},
"id": 12,
"name": "Springfield Health Clinic",
"phoneNumber": "+13125550000"
},
"used": true
}
],
"emailLabel": true,
"externalOrderIds": [
"ORD-20240610-0001"
],
"id": 10001,
"orderEvents": [
{
"eventTimestamp": "2024-06-09T14:00:00Z",
"name": "orderPlaced"
}
],
"orderItems": [
{
"count": 2,
"item": {
"id": 301,
"manufacturer": {
"id": 45,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"orderKits": [
{
"count": 1,
"kit": {
"archived": false,
"id": 210,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": true,
"item": {
"id": 301,
"manufacturer": {
"id": 45,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"name": "Basic Health Monitoring Kit"
}
}
],
"orderNotes": [
{
"createdAt": "2024-06-09T15:30:00Z",
"createdBy": {
"email": "nurse.joy@springfieldclinic.com",
"firstName": "Joy",
"id": 77,
"lastName": "Smith"
},
"note": "Patient requested expedited shipping."
}
],
"packedKits": [
{
"devices": [
{
"currentPatient": {
"firstName": "Lisa",
"lastName": "Simpson",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "742 Evergreen Terrace",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave package at front desk"
},
"archived": false,
"dateOfBirth": "1975-05-20",
"email": "lisa.simpson@example.com",
"enrolled": true,
"externalIdentifier": "pat-987654",
"id": 1024,
"phoneNumber": "+13125551234",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Main St",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "Floor 2",
"note": "Reception on 2nd floor"
},
"id": 12,
"name": "Springfield Health Clinic",
"phoneNumber": "+13125550000"
}
},
"currentStatus": "active",
"deviceEvents": [
{
"eventTimestamp": "2024-06-10T09:15:00Z",
"type": "batteryLow"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN1234567890"
}
],
"disabledReadings": false,
"externalIdentifier": "dev-1d23-4567-89ab-cdef",
"id": 501,
"item": {
"id": 301,
"manufacturer": {
"id": 45,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-06-10T08:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Main St",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "Floor 2",
"note": "Reception on 2nd floor"
},
"id": 12,
"name": "Springfield Health Clinic",
"phoneNumber": "+13125550000"
},
"used": true
}
],
"externalIdentifier": "kit-EXT-20240610",
"id": 9001,
"kit": {
"archived": false,
"id": 210,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": true,
"item": {
"id": 301,
"manufacturer": {
"id": 45,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"name": "Basic Health Monitoring Kit"
}
}
],
"patient": {
"firstName": "Lisa",
"lastName": "Simpson",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "742 Evergreen Terrace",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave package at front desk"
},
"archived": false,
"dateOfBirth": "1975-05-20",
"email": "lisa.simpson@example.com",
"enrolled": true,
"externalIdentifier": "pat-987654",
"id": 1024,
"phoneNumber": "+13125551234",
"sex": "female",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Main St",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "Floor 2",
"note": "Reception on 2nd floor"
},
"id": 12,
"name": "Springfield Health Clinic",
"phoneNumber": "+13125550000"
}
},
"returnDevices": [
{
"id": 501
}
],
"returnItems": [
{
"count": 1,
"id": 301
}
],
"returnPackedKits": [
{
"id": 9001,
"quantity": 1
}
],
"shippingOption": "standard",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Main St",
"state": "IL",
"zipCode": "62701",
"lineThree": "",
"lineTwo": "Floor 2",
"note": "Reception on 2nd floor"
},
"id": 12,
"name": "Springfield Health Clinic",
"phoneNumber": "+13125550000"
},
"trackingNumbers": [
{
"carrier": "usps",
"value": "9400110898825022579493"
}
]
}
],
"first": true,
"last": true,
"page": 1,
"size": 1,
"total": 1
}
Fetching a Single Order
For detailed analysis or management of a specific order, the system provides an endpoint to fetch the details of a single order using its unique identifier.
GET /api/v3/order/:orderId
curl https://app.impiloplatform.com/api/v3/order/1 \
-H "Impilo-API-Key: <apiKey>" \
-H "Content-Type: application/json"
Response
{
"currentStatus": "reconfirmAddress",
"devices": [
{
"currentPatient": {
"firstName": "John",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "742 Evergreen Terrace",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave package at front desk"
},
"archived": false,
"dateOfBirth": "1980-01-01",
"email": "john.doe@example.com",
"enrolled": true,
"externalIdentifier": "1234abcd",
"id": 1,
"phoneNumber": "+1234567890",
"sex": "male",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Health St",
"state": "IL",
"zipCode": "62701",
"lineThree": "Floor 2",
"lineTwo": "Suite 210",
"note": "Main clinic entrance"
},
"id": 1,
"name": "Springfield Health Clinic",
"phoneNumber": "+11234567890"
}
},
"currentStatus": "inUse",
"deviceEvents": [
{
"eventTimestamp": "2024-05-20T09:30:00Z",
"type": "batteryLow"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN123456789"
}
],
"disabledReadings": false,
"externalIdentifier": "1d23-4567-89ab-cdef",
"id": 101,
"item": {
"id": 501,
"manufacturer": {
"id": 301,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-05-21T08:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Health St",
"state": "IL",
"zipCode": "62701",
"lineThree": "Floor 2",
"lineTwo": "Suite 210",
"note": "Main clinic entrance"
},
"id": 1,
"name": "Springfield Health Clinic",
"phoneNumber": "+11234567890"
},
"used": true
}
],
"emailLabel": true,
"externalOrderIds": [
"ORD-20240521-001"
],
"id": 1,
"orderEvents": [
{
"eventTimestamp": "2024-05-20T08:00:00Z",
"name": "orderPlaced"
}
],
"orderItems": [
{
"count": 2,
"item": {
"id": 501,
"manufacturer": {
"id": 301,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
}
}
],
"orderKits": [
{
"count": 1,
"kit": {
"archived": false,
"id": 201,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": true,
"item": {
"id": 502,
"manufacturer": {
"id": 302,
"name": "MediEquip Co."
},
"model": "ME-100",
"name": "Pulse Oximeter",
"orderable": true,
"sku": "ME-POX-100"
}
}
],
"name": "Basic Vital Signs Kit"
}
}
],
"orderNotes": [
{
"createdAt": "2024-05-20T08:15:00Z",
"createdBy": {
"email": "nurse.jane@healthclinic.com",
"firstName": "Jane",
"id": 10,
"lastName": "Smith"
},
"note": "Patient requested overnight shipping."
}
],
"packedKits": [
{
"devices": [
{
"currentPatient": {
"firstName": "John",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "742 Evergreen Terrace",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave package at front desk"
},
"archived": false,
"dateOfBirth": "1980-01-01",
"email": "john.doe@example.com",
"enrolled": true,
"externalIdentifier": "1234abcd",
"id": 1,
"phoneNumber": "+1234567890",
"sex": "male",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Health St",
"state": "IL",
"zipCode": "62701",
"lineThree": "Floor 2",
"lineTwo": "Suite 210",
"note": "Main clinic entrance"
},
"id": 1,
"name": "Springfield Health Clinic",
"phoneNumber": "+11234567890"
}
},
"currentStatus": "inUse",
"deviceEvents": [
{
"eventTimestamp": "2024-05-20T09:30:00Z",
"type": "batteryLow"
}
],
"deviceIdentifiers": [
{
"type": "serialNumber",
"value": "SN123456789"
}
],
"disabledReadings": false,
"externalIdentifier": "1d23-4567-89ab-cdef",
"id": 101,
"item": {
"id": 501,
"manufacturer": {
"id": 301,
"name": "HealthTech Inc."
},
"model": "HT-2000",
"name": "Blood Pressure Monitor",
"orderable": true,
"sku": "HT-BPM-2000"
},
"lastHealthCheck": "2024-05-21T08:00:00Z",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Health St",
"state": "IL",
"zipCode": "62701",
"lineThree": "Floor 2",
"lineTwo": "Suite 210",
"note": "Main clinic entrance"
},
"id": 1,
"name": "Springfield Health Clinic",
"phoneNumber": "+11234567890"
},
"used": true
}
],
"externalIdentifier": "KIT-20240521-001",
"id": 301,
"kit": {
"archived": false,
"id": 201,
"kitItems": [
{
"count": 1,
"drivesExternalIdentifier": true,
"item": {
"id": 502,
"manufacturer": {
"id": 302,
"name": "MediEquip Co."
},
"model": "ME-100",
"name": "Pulse Oximeter",
"orderable": true,
"sku": "ME-POX-100"
}
}
],
"name": "Basic Vital Signs Kit"
}
}
],
"patient": {
"firstName": "John",
"lastName": "Doe",
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "742 Evergreen Terrace",
"state": "IL",
"zipCode": "62704",
"lineThree": "Suite 5B",
"lineTwo": "Building 3",
"note": "Leave package at front desk"
},
"archived": false,
"dateOfBirth": "1980-01-01",
"email": "john.doe@example.com",
"enrolled": true,
"externalIdentifier": "1234abcd",
"id": 1,
"phoneNumber": "+1234567890",
"sex": "male",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Health St",
"state": "IL",
"zipCode": "62701",
"lineThree": "Floor 2",
"lineTwo": "Suite 210",
"note": "Main clinic entrance"
},
"id": 1,
"name": "Springfield Health Clinic",
"phoneNumber": "+11234567890"
}
},
"returnDevices": [
{
"id": 101
}
],
"returnItems": [
{
"count": 1,
"id": 501
}
],
"returnPackedKits": [
{
"id": 301,
"quantity": 1
}
],
"shippingOption": "standard",
"site": {
"active": true,
"address": {
"city": "Springfield",
"country": "USA",
"lineOne": "100 Health St",
"state": "IL",
"zipCode": "62701",
"lineThree": "Floor 2",
"lineTwo": "Suite 210",
"note": "Main clinic entrance"
},
"id": 1,
"name": "Springfield Health Clinic",
"phoneNumber": "+11234567890"
},
"trackingNumbers": [
{
"carrier": "usps",
"value": "9400110200881234567890"
}
]
}