latestOpenAPI 3.0.02026-08-232861531.0 MB

d3c75c2a2f1d

patientForms

Show a list of patientForms

get/patientForms

Query parameters

patientstring

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

status'pending' | 'unstarted' | 'started' | 'completed'

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

  • pending: the initial status, not seen by the patient, created when a message is sent out with the form link;
  • unstarted: set when the patient clicked on the link to open the form but only saw the welcome screen, without actually answering any questions;
  • 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.
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 form, serving the purpose of organizing which answers were analysed by a staff member or not.

  • open: the form was completed by a patient but not seen by any staff member yet;
  • in-progress: a staff user is analysing the answers;
  • closed: the form 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 patient form and changed its processingStatus.

processingStatusUpdatedAtstring date-time

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

lumabotboolean

flag to signal whether a form was filled out in the shape of a patient chat with a bot.

appointmentstring

the ID of an appointment related to this form.

fileUploadstring

the ID of a fileUpload related to this form.

durationnumber

the time it took (in minutes) for the patient to complete this form.

urlstring

deprecated: custom patient form 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.

patientFormTemplatestring

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

patientFormTemplateNamestring

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

patientFormTemplateType'intake' | 'pre-qualification' | 'feedback' | 'ccda'

A flag to help filter forms by their originally desired purpose. The form structure and behavior is identical, but depending on the settings screen, some forms may be displayed as a selectable option or not.

  • intake: a regular form, intended to be sent to patients manually, or in reminders, or even custom actions.
  • pre-qualification: a form to be displayed before the scheduler is shown to patients. In the scheduler settings page, you can only select a pre-qualification form to be displayed before the patient actually schedules an appointment.
  • feedback: a form to be sent to patients after their visits, to rate the service they've received. On the feedback settings page, you can only select a form with this flag.
  • ccda: a form containing special questions that conform to the standard format which can be read by EHR Systems.
ref'reminder' | 'referral-reminder' | 'feedback-reminder' | 'followup' | 'outbound-referral-reminder' | 'form-reminder' | 'reschedule' | 'waitlist' | 'appointment-offer' | 'chat-notification' | 'pin-verification' | 'chat' | 'chat-audit' | 'chat-audit-tz' | 'feedback' | 'waitlist-offer' | 'referral-followup' | 'outbound-referral-outreach' | 'referral-redirect' | 'broadcast' | 'generic' | 'stop' | 'bot:followup' | 'telehealth' | 'waiting-room-patient'

Indicates what this is about. Depending on this value, you also know what the parameter refId refers to.<br/>

  • reminder (refId will be the ID of a Reminder)<br/>
  • referral-reminder (refId will be the ID of a Reminder)<br/>
  • feedback-reminder (refId will be the ID of a Reminder)<br/>
  • followup (refId will be the ID of a Reminder)<br/>
  • outbound-referral-reminder (refId will be the ID of a Reminder)<br/>
  • form-reminder (refId will be the ID of a Reminder)<br/>
  • reschedule (refId will be the ID of a Reminder)<br/>
  • waitlist (refId will be the ID of a Waitlist)<br/>
  • appointment-offer (refId will be the ID of a Offer)<br/>
  • chat-notification (refId will be the ID of a Message)<br/>
  • pin-verification (refId will be the ID of a Message)<br/>
  • chat (refId will be the ID of a ChatActivity)<br/>
  • chat-audit (refId will be the ID of a ChatActivity)<br/>
  • chat-audit-tz (refId will be the ID of a ChatActivity)<br/>
  • feedback (refId will be the ID of a Feedback request)<br/>
  • waitlist-offer (refId will be the ID of an Appointment)<br/>
  • referral-followup (refId will be the ID of a Referral)<br/>
  • outbound-referral-outreach (refId will be the ID of a Referral)<br/>
  • referral-redirect (refId will be the ID of a Referral)<br/>
  • broadcast (refId will be the ID of a Broadcast)<br/>
  • generic (refId will refer to the same object of the previous message to this same patient)<br/>
  • stop (refId will refer to the same object of the previous message to this same patient)<br/>
  • bot:followup (refId will be the ID of a Patient)<br/>
  • telehealth (refId will be the ID of a Telehealth object)<br/>
  • waiting-room-patient (refId will be the ID of a WaitingRoomPatient object)<br/>

Indicates what this is about. Depending on this value, you also know what the parameter refId refers to.

refIdstring

The ID of the Object refereced by the ref field.

offerstring

The ID of an appointment Offer related to these form answers.

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.

PreviousPatientForm and nextPatientForm 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 patientForm and set the previous form ID on its previousPatientForm property.

nextPatientFormstring

PreviousPatientForm and nextPatientForm 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 patientForm and set the new form ID on the first form's nextPatientForm 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 patientForms

pageinteger required
sizeinteger required