LUlumahealth
insurances

Archive a list of insurances

Bulk-archives the given insurances, marking each as inactive and no longer primary.

put/insurances/archive

Request

Request body

insurancesstring[] required

IDs of the insurances to archive.

appointmentstring

ID of an appointment to stamp onto each archived insurance.

Response

The updated insurances

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

planNamestring

Name of the insurance plan.

memberNamestring

The person's name as printed on the insurance card.

memberNumberstring

The subscriber's ID number on the insurance card.

insuranceGroupNamestring

Group name or code printed on the insurance card.

urlstring

URL of the front-of-card image.

urlBackstring

URL of the back-of-card image.

fileUploadstring

ID of the FileUpload for the front-of-card image.

fileUploadBackstring

ID of the FileUpload for the back-of-card image.

activeboolean

Whether this insurance is currently active for the patient.

status'archived' | 'active' | 'cancelled' | 'draft' | 'entered-in-error'

Lifecycle status of the insurance record, aligned with the HL7 FHIR fm-status value set.

patientstring

ID of the patient this insurance belongs to.

payerIdstring

The payer identifier, as required by third-party eligibility/verification APIs.

payerNamestring

The payer's display name.

payorstring

ID of the InsurancePayor this insurance's payer is matched to.

dependentIdstring

The patient's dependent identification string, if the patient is a dependent of the subscriber.

startDatestring date-time
endDatestring date-time
primaryboolean

Whether this is the patient's primary insurance. Only one insurance per patient can be primary.

integratorStatus'success' | 'pending' | 'failed' | 'skipped'

Status of writing this insurance back to the EHR integrator.

source'sync' | 'patient' | 'staff'

How this insurance was created.

lastSyncedAtstring date-time

When this insurance was last synced from the integrator.

Changes

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