latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

lumabotFlows

Get lumabotFlow by id

get/lumabotFlows/{lumabotFlowId}

Path parameters

lumabotFlowIdstring required

LumabotFlows' unique identifier in Luma's database.

Response

LumabotFlow

_idstring

Luma's internal ID of an object.

userstring

The ID of the root account user.

deleted0 | 1

Flag for logical deletion where 1 means deleted.

createdBystring

The ID of the user who created this object.

updatedBystring

The ID of the user who updated this object.

createdAtstring date-time

The date/time when this object was created.

updatedAtstring date-time

The date/time when this object was updated.

patientstring

the ID of the patient who filled out the answers for this form.

status'started' | 'completed'

The completion status of the lumabot flow under the patient's perspective, knowingly:

  • started: when the patient started answering at least one question, but hasn't finished the form yet;
  • completed: the patient has finished answering all the questions and cannot edit the form anymore.
flowType'welcome' | 'authenticate-patient' | 'speak-with-staff' | 'session-timeout' | 'knock-knock' | 'cul-de-sac' | 'feedback' | 'error' | 'no-availabilities' | 'regular'

type of the lumabot flow template

completedAtstring date-time

the date/time when the patient finished all the responses of this form.

processingStatus'open' | 'in-progress' | 'closed'

The internal staff's management status for a completed flow, serving the purpose of organizing which answers were analysed by a staff member or not.

  • open: the flow was completed by a patient but not seen by any staff member yet;
  • in-progress: a staff user is analysing the answers;
  • closed: the flow has been completely analysed by a member of the staff team.
processingStatusUpdatedBystring

the ID of a staff user who analysed the responses of this completed flow and changed its processingStatus.

processingStatusUpdatedAtstring date-time

the date/time when a staff user analysed the responses of this completed flow and changed its processingStatus.

appointmentstring

the ID of an appointment related to this form.

urlstring

deprecated: custom lumabot flow url, basically to identify any patient in survey monkey, an external forms service that's not being used anymore by Luma.

currentItemIdstring

The code of the current question the patient was last shown, before answering it. Such a code must be the content of any responses.page[0].questions[x].id, or success. Usually this will contain each id, in sequence, but patients can go back and forth. Also, forms can have jump logic, and some questions might not be displayed to the patient. When the form is completed, this is updated to success.

lumabotFlowTemplatestring

the ID of the template of questions that was displayed for the patient.

lumabotFlowTemplateNamestring

the name of the template of questions used as a basis for these form answers. See lumabotFlowTemplates.

language'en' | 'es' | 'pt'

The language in which the form was answered by the patient.

accessedFromstring

IP address of the patient who filled out the form.

previousLumabotFlowstring

PreviousLumabotFlow and nextLumabotFlow will be used to make it possible for forms to be able to jump to another form with another template so we can reduce the number of unecessary questions in a single form, which should help with organization and performance. One form must call the jump template, at which time we create a new lumabotFlow and set the previous form ID on its previousLumabotFlow property.

nextLumabotFlowstring

PreviousLumabotFlow and nextLumabotFlow will be used to make it possible for forms to be able to jump to another form with another template so we can reduce the number of unecessary questions in a single form, which should help with organization and performance. One form must call the jump template, at which time we create a new lumabotFlow and set the new form ID on the first form's nextLumabotFlow property.

availabilitiesstring[]

availabilities

facilitiesstring[]

facilities