API Reference

Generate CSV export

post
https://vitalsapi.luscii.com/v1/csvexport/

Generate a CSV export to be received via email

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

The Export API allows you to programmatically queue an export job. By requesting a CSV export you receive a download uri in the response body where eventually the file will be available for download. All CSV report types supported in the Web Application are supported as Export API jobs.

🚧

Exports are generated asynchronously. There is no guarantee that on receiving the response the export file is immediately ready for download. Depending on size of the export the generation process can take from a couple of seconds to a couple of minutes.

Accessible by HC_ADMIN and HC_SUPPORTER.

Structure of the export

The downloaded csv file will have the following structure depending on the type of export which was requested.

patients
  • Patient_UUID
  • First_Name
  • Middle_Name
  • Last_Name
  • Sex
  • Patient_Number
  • BSN
  • Email
  • Phone
  • Date_Of_Birth
  • Status
  • Group_Name
  • Program_Name
  • Created_Date
  • Activated_Date
  • Stopped_Date
  • Stopped_Reason
  • Grey_Alerts
  • Orange_Alerts
  • Red_Alerts
  • Measurements_Alerts
  • Combination_Alerts
  • Remark_Alerts
  • Overdues_Alerts
  • Average_Alerts
  • Total_Alerts
measurements
  • Patient_UUID
  • First_Name
  • Middle_Name
  • Last_Name
  • Patient_Number
  • Group
  • Program
  • Measurement_Date
  • Measurement_Name
  • Measurement_Value
  • Alert_Flag
  • Alert_Type
  • Alert_Created_Date
  • Alert_Processed_Type
  • Alert_Processed_Action
  • Alert_Processed_At
  • Alert_Processed_By_UUID
alerts
  • Patient_UUID
  • Group
  • Program
  • Alert_Flag
  • Alert_Type
  • Measurement_Name
  • Alert_Created_Date
  • Alert_Processed_Type
  • Alert_Processed_Action
  • Alert_Processed_At
  • Alert_Processed_By_UUID
hcps
  • UUID
  • First_Name
  • Middle_Name
  • Last_Name
  • Email
  • User_Name
  • Language
  • Role
  • Status
  • Last_Login_At
  • Last_Logout_At
  • Groups (comma separated list)
  • Processed_Alerts (the amount of alerts the HCP has processed)
patientsMutations
  • Patient_UUID
  • First_Name
  • Middle_Name
  • Last_Name
  • Patient_Number
  • Type (Group or Program)
  • Mutation_Date
starRatings
  • Group
  • Date
  • Patient_UUID
  • Score
  • Remarks
Path Params
string
enum
required

Report type

Allowed:
Query Params
date

First day of the selected data. Must be given if the reportType is 'alerts' or 'measurements'. Optional if reportType is 'measurementsWithQuestionnaires'. Forbidden for other values of reportType.

date

Last day of the selected data. Must be given if the reportType is 'alerts' or 'measurements'. Optional if reportType is 'measurementsWithQuestionnaires'. Forbidden for other values of reportType.

string
enum
Defaults to false

Whether to send a link to the exported file to the email of the user. Can be true or false, defaults to false.

Allowed:
Responses

422

Unprocessable entity, i.e. Validation error

503

Service unavailable, e.g. when the functionality is disabled

Updated about 1 month ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago

Did this page help you?