LUlumahealth
checklists

Build a checklist from a template, replacing an appointment's checklist

Builds a new checklist from a ChecklistTemplate for a given appointment and patient, evaluating the template's filters against that appointment and patient, and replaces any checklist currently attached to the appointment.

post/checklists/replace

Request

Request body

checklistTemplatestring required

ID of the ChecklistTemplate to build from.

appointmentstring required

ID of the appointment to attach the new checklist to.

patientstring required

ID of the patient the checklist is for.

sendMessageboolean

Whether to send the patient a message about the new checklist.

Response

The newly built checklist

_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.

namestring

Name of the checklist.

templatestring

ID of the ChecklistTemplate this checklist was generated from.

appointmentstring

ID of the appointment this checklist belongs to.

patientstring

ID of the patient this checklist belongs to.

status'empty' | 'pending' | 'sent' | 'in-progress' | 'completed'

Overall status of the checklist.

source'appointment' | 'message' | 'manual'

How this checklist was created.

completedAtstring date-time

When the entire checklist was completed.

Changes

No recorded changes to this operation across all 6 revisions of this API.