lumabotFlows

Show a list of lumabotFlows

get/lumabotFlows

Query parameters

patientstring

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

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 flow yet;
  • completed: the patient has finished answering all the questions and cannot edit the flow anymore.
completedAtstring

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

appointmentstring

the ID of an appointment related to this flow.

fileUploadstring

the ID of a fileUpload related to this flow.

urlstring

deprecated: custom lumabot flow url, basically to identify any patient in survey monkey, an external flows 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 questions[x].id, or success. Usually this will contain each id, in sequence, but patients can go back and forth. Also, flows can have jump logic, and some questions might not be displayed to the patient. When the flow 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 flow answers. See lumabotFlowTemplates.

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

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

accessedFromstring

IP address of the patient who filled out the flow.

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

nextLumabotFlowstring

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

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.

pageinteger
limitinteger

How many items to fetch per page

_populatestring

Response properties which will be replaced by the referenced objects, separated by commas.

_selectstring

Response properties that should be returned, separated by commas.

Response

Returns a list of lumabotFlows

pageinteger required
sizeinteger required