Export API

The Export API allows you to directly access data from your organization.

🚧
NOTE: The Export API is not intended or designed for the use in a clinical setting where the data is used to provide care to patients.
Data can be used for business intelligence purposes, for example to analyse the use and effectiveness of Luscii in your organization.

Request

Endpoint

POST /v1/export/{reportType}

Path Parameters

Name	Type	Description
reportType `required`	enum	Resource type to export. Available values: `patients`, `measurements`, `measurementsWithQuestionnaires`, `measurementsForQuestionnaires`,`alerts`, `hcps`, `patientsMutations`, `starRatings`, `plannedActions`, `patientsWorkflowHistory`, `patientsProgramsHistory`, `patientsSettingsHistory`, `usersStatusChangeReasons`

Query Parameters

Name	Type	Description
startDate `required`, `optional` or `forbidden`	string	Minimum creation date of resources to include in the export. Date string in format of `YYYY-MM-DD` e.g. `2024-01-14`. `required` for reportType of `measurements`, `alerts`, `plannedActions`, `patientsWorkflowHistory`, `patientsProgramsHistory`, `patientsSettingsHistory` and `usersStatusChangeReasons`. `optional` for reportType of `measurementsWithQuestionnaires` and `measurementsForQuestionnaires`. `forbidden` for reportType of `patients`,`hcps`,`patientsMutations` and `starRatings`.
endDate `required`, `optional` or `forbidden`	string	Maximum creation date of resources to include in the export. Date string in format of `YYYY-MM-DD` e.g. `2024-01-14`. `required` for reportType of `measurements`, `alerts`, `plannedActions`, `patientsWorkflowHistory`, `patientsProgramsHistory`, `patientsSettingsHistory` and `usersStatusChangeReasons`. `optional` for reportType of `measurementsWithQuestionnaires` and `measurementsForQuestionnaires`. `forbidden` for reportType of `patients`,`hcps`,`patientsMutations` and `starRatings`.
cursor `optional`	string	Cursor for pagination purposes.

Response

HTTP status code

200

Body

{
  "data": [
    {
      // ... data for your reportType
    }
  ],
  "meta": {
    "perPage": 50,
    "nextCursor": "eyJBbGVyd...",
    "nextPageUrl": "https://next.page/?cursor=eyJBbGVyd...",
    "prevCursor": "eyJBbGVyd...",
    "prevPageUrl": "https://next.page/?cursor=eyJBbGVyd..."
  },
  "errors": [
    {
      "code": "string",
      "message": "string",
      "attribute": "string"
    }
  ]
}

Example

GET /v1/export/starRatings?startDate=2024-05-01&endDate=2024-01-05 HTTP/1.1
Authorization: Bearer <api-key>
Host: api.luscii.com
Content-Type: application/json
Content-Length: 0

HTTP/1.1 200 Accepted
Date: Wed, 14 Feb 2024 11:03:24 GMT
Content-Type: application/json

{"meta":{"perPage":50,"nextCursor":null,"nextPageUrl":null,"prevCursor":null,
"prevPageUrl":null},"data":[{"Group":"A Group","Date":"2024-05-02 15:08:30","
Patient_UUID":"36f35743-a7ff-420b-bb61-537d21a817e1","Score":"246","Remarks":
null}]}

Structure of the export

The data will have the following structure depending on the type of export which was requested.

{
  // ...
  "data": [
    {
      "Patient_UUID": "92aed2c3-3986-4477-af1a-15174f464644",
      "First_Name": "John",
      "Middle_Name": null,
      "Last_Name": "Doe",
      "Sex": "male",
      "Patient_Number": "123456789",
      "BSN": "123456789",
      "Email": "[email protected]",
      "Phone": "+31 6 12345678",
      "Date_Of_Birth": "1970-01-01",
      "Status": "active",
      "Group_Name": "A Group",
      "Program_Name": "A Program",
      "Protocol": "A Protocol",
      "Created_Date": "2024-05-02 14:46:11",
      "Activated_Date": "2024-05-02 14:50:11",
      "Stopped_Date": null,
      "Stopped_Reason": null,
      "Grey_Alerts": "0",
      "Orange_Alerts": "0",
      "Red_Alerts": "0",
      "Measurements_Alerts": "0",
      "Combination_Alerts": "0",
      "Remark_Alerts": "0",
      "Overdues_Alerts": "0",
      "Average_Alerts": "0",
      "Total_Alerts": 0
    },
    // ...
  ]
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "9ba6c627-25b7-45bc-936b-36b1a45da8a3",
      "First_Name": "John",
      "Middle_Name": null,
      "Last_Name": "Doe",
      "Patient_Number": "123456789",
      "Group": "A Group",
      "Program": "A Program",
      "Protocol": "A Protocol",
      "Measurement_Date": "2024-05-02 14:56:08",
      "Measurement_Name": "Heart rate",
      "Measurement_Value": "72",
      "Alert_Flag": null,
      "Alert_Type": null,
      "Alert_Created_Date": null,
      "Alert_Processed_Type": null,
      "Alert_Processed_Action": null,
      "Alert_Processed_At": null,
      "Alert_Processed_By_UUID": null,
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "9ba6c627-25b7-45bc-936b-36b1a45da8a3",
      "First_Name": "John",
      "Middle_Name": null,
      "Last_Name": "Doe",
      "Patient_Number": "123456789",
      "Group": "A Group",
      "Program": "A Program",
      "Protocol": "A Protocol",
      "Measurement_Date": "2024-05-02 14:56:08",
      "Measurement_Name": "Heart rate",
      "Measurement_Value": "72",
      "Alert_Flag": null,
      "Alert_Type": null,
      "Alert_Created_Date": null,
      "Alert_Processed_Type": null,
      "Alert_Processed_Action": null,
      "Alert_Processed_At": null,
      "Alert_Processed_By_UUID": null,
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "patientId": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "plannedActionId": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "groupId": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "organizationId": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "instrumentId": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "instrumentVersion": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "createdByUserId": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "measurementDate": "2023-05-23T10:20:30+02:00",
      "details": "[{\"item_id\":\"7659dfb3-c089-4d12-95b7-46ff8ce1e7dd\",\"item_version\":\"7659dfb3-c089-4d12-95b7-46ff8ce1e7dd\",\"value\":\"151\",\"response_ids\":[\"7659dfb3-c089-4d12-95b7-46ff8ce1e7dd\"],\"file_name\":null}]"
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "ca82dd4e-df0e-41a3-a904-0e524d78397d",
      "Group": "A Group",
      "Program": "A Program",
      "Protocol": "A Protocol",
      "Alert_Flag": "red",
      "Alert_Type": "Measurement",
      "Measurement_Name": "Heart rate",
      "Alert_Created_Date": "2024-05-02 14:59:32",
      "Alert_Processed_Type": null,
      "Alert_Processed_Action": null,
      "Alert_Processed_At": null,
      "Alert_Processed_By_UUID": null,
      "Alert_Processed_By_Role": null,
      "Alert_Processed_Additional_Info": null,
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "UUID": "164d8d3a-a745-4c35-8c93-bec8c356e798",
      "First_Name": "John",
      "Middle_Name": null,
      "Last_Name": "Doe",
      "Email": "[email protected]",
      "User_Name": "[email protected]",
      "Language": "nl",
      "Role": "hc_primary",
      "Status": "active",
      "Last_Login_At": "2024-05-02 15:01:43",
      "Last_Logout_At": null,
      "Groups": "A Group",
      "Processed_Alerts": 0
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "8f35792b-080f-4189-a64f-14ef06086f99",
      "First_Name": "John",
      "Middle_Name": null,
      "Last_Name": "Doe",
      "Patient_Number": null,
      "Type": "program",
      "Name": "A program name",
      "Mutation_Date": "2024-05-02 15:05:11",
      "Mutation_ID": 1
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Group": "A Group",
      "Date": "2024-05-02 15:08:30",
      "Patient_UUID": "36f35743-a7ff-420b-bb61-537d21a817e1",
      "Score": "246",
      "Remarks": null,
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "UUID": "9890ed24-405d-4688-abcd-b7f829d75939",
      "Program_Action_UUID": "5ad2dcf7-6a3f-43bf-a940-ff706f546f6e",
      "Patient_UUID": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "Planned_Via": "rec",
      "Self_Planned": 1,
      "Not_Before": "2023-05-23 10:20:30",
      "Expires_At": "2023-05-23 10:20:30",
      "Valid_Period_Timezone": "Europe/Amsterdam",
      "Completed_At": "2023-05-23 10:20:30",
      "Completed_At_Timezone": "Europe/Amsterdam",
      "Created_Date": "2023-05-23 10:20:30"
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "Workflow_UUID": "5ad2dcf7-6a3f-43bf-a940-ff706f546f6e",
      "Trigger_Day": "2023-05-23",
      "Trigger_Count": 1,
      "Created_Date": "2023-05-23 10:20:30"
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "Program_UUID": "5ad2dcf7-6a3f-43bf-a940-ff706f546f6e",
      "Created_By": "9890ed24-405d-4688-abcd-b7f829d75939",
      "Created_Date": "2023-05-23 10:20:30"
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "Patient_UUID": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "Key": "timezone",
      "Value": "Europe/Amsterdam",
      "Created_By": "9890ed24-405d-4688-abcd-b7f829d75939",
      "Created_Date": "2023-05-23 10:20:30"
    },
    // ...
  ],
  // ...
}

{
  // ...
  "data": [
    {
      "User_UUID": "9890ed24-405d-4688-abcd-b7f829d75939",
      "From_Status": "created",
      "To_Status": "active",
      "Reason": "User is now verified.",
      "Created_By": "7659dfb3-c089-4d12-95b7-46ff8ce1e7dd",
      "Created_Date": "2023-05-23 10:20:30",
      "Processed_Date": "2023-05-23 10:20:30"
    },
    // ...
  ],
  // ...
}

🚧NOTE: The Export API is not intended or designed for the use in a clinical setting where the data is used to provide care to patients.

Request

Endpoint

Path Parameters

Query Parameters

Response

HTTP status code

Body

Example

Structure of the export

🚧
NOTE: The Export API is not intended or designed for the use in a clinical setting where the data is used to provide care to patients.