Usage Guide

A start-to-finish walkthrough: onboard a clinical trial, put Carmen in front of patients, and review what happened. Written for study coordinators and clinical staff; no programming required.

Getting started

How it works

MediMentor runs patient consultations through Carmen, a virtual health advocate with a video avatar (that is how Carmen introduces herself to patients). The whole pipeline looks like this:

  1. Onboard a trial. Staff creates the trial, uploads its documents, extracts and verifies the structured record, and activates it.
  2. Invite a patient. Staff sends the patient a one-time link tied to that trial.
  3. The consultation. The patient talks to Carmen, who answers from the trial's reviewed content.
  4. Review. Staff reads each conversation on the dashboard, including the full transcript.

The rest of this guide follows that exact order.

Signing in

All staff pages are protected with a shared password. When you open any admin page your browser shows a sign-in prompt:

PageWhat it's for
/adminTrial list, the starting point for everything below
/admin/invitesCreate and track patient invite links
/dashboardReview patient conversations and read transcripts
/docsThis documentation

Patients never sign in. They use a one-time invite link (see Invite a patient).

Onboarding a trial

Draft vs. active

Every trial is in one of two states:

A new trial starts as a draft and becomes active in five steps: create, upload documents, extract, review, activate. Each step is described below in order.

Step 1: Create the trial

On /admin, choose New trial. You only need a trial ID: a short, permanent identifier such as acadabra-her2-nsclc (letters, digits, dots, dashes, underscores; it cannot be changed later). The ID must be unique: if it is already taken, the form warns "Trial ID already exists" and nothing is created. Then pick one of the two buttons:

New trial form
img/trial-new.png: the "New trial" form at /admin/trials/new.

Step 2: Upload documents

On the trial's onboarding or detail page, upload the source documents (protocol synopsis, prescribing information, consent forms, and so on).

Each document row shows a colored status label:

StatusMeaning
uploadedStored, but Carmen can't use it yet (not indexed)
indexedSearchable by Carmen during consultations
failedIndexing failed; the row shows the error. To fix it: delete the failed document, correct the file on your computer, upload the corrected file, then click Index & Activate again.

You can download the original file or delete a document at any time. You can also add documents later, after the trial is already set up or live: open the trial's Documents tab, upload the file, and click Index & Activate so the new document is indexed. Any document change puts the trial back into draft until you do.

Document list with status labels
img/documents.png: uploaded documents with their status labels.

Step 3: Extract trial information

Extract reads the uploaded documents with an AI model and pre-fills the trial's structured sections: general info, study details, dosing, visit schedule, inclusion/exclusion criteria, prohibited medications, and side effects.

Step 4: Review and edit the record

Always review extracted content. The structured record is what Carmen treats as the authoritative source of truth during consultations. Clinical staff must verify every extracted criterion, dose, and side effect before activating.

The trial detail page shows the record in tabs: General (trial and study information), Criteria (inclusion and exclusion), Treatment (dosing and prohibited medications), Visit Schedule, Side Effects, and Documents. Edit any tab and save. Each save checks the values (for example, visit days must be positive whole numbers and criterion IDs must not repeat). If something is invalid, a warning appears at the top of that section naming the exact field.

Trial detail tabs
img/trial-detail.png: trial detail page with section tabs.

Step 5: Activate

Activate does two things in one step: it indexes every uploaded document so Carmen can search them, then flips the trial to active. If any document fails to index, the trial stays in draft and the error is shown. Nothing goes half-live.

Once active, the trial appears in the invite page's trial list and Carmen starts using its content. You're ready to invite a patient.

Running consultations

Invite a patient

Patients access Carmen through one-time invite links created on /admin/invites:

  1. Pick the (active) trial the patient belongs to.
  2. Optionally add a label for your own bookkeeping, e.g. "Pt. 0142 (Dr. Weber's clinic)". The patient never sees it.
  3. Copy the generated link and send it to the patient through your usual channel.

Invite links are:

StatusMeaning
availableNot yet used, not expired
usedRedeemed (shows when)
expiredNever used within 7 days; create a new one
"This invitation has already been used." If the patient started their consultation and got cut off (closed the tab, refreshed, clicked the link again), they can just open the same link on the same device. Their conversation continues where it left off. Sessions stay valid for 7 days, so they can come back later the same way. On a different device the link will not work; send a new invite.
Invite management page
img/invites.png: creating and tracking invites at /admin/invites.

Test it yourself

To experience exactly what the patient will, use the test session button on the admin pages: it opens the consultation console for a chosen trial without consuming an invite. Test conversations show up on the dashboard like real ones, so end them properly (or note the time) to keep them easy to tell apart.

The patient experience

What the patient experiences after opening their invite link:

  1. A welcome page introduces the trial; they press start.
  2. Carmen appears as a video avatar and greets them with a short introduction.
  3. They talk naturally (or type). Carmen answers from the trial's curated record and documents: side effects, visit schedule, dosing, eligibility questions, practical concerns.
  4. The patient can interrupt Carmen mid-sentence (barge-in) just like a phone call; Carmen stops and listens.
  5. Ending the consultation finalizes it (see Reviewing) and their link cannot be used again.
Patient consultation console
img/consultation.png: the consultation console with Carmen's avatar.

Reviewing

Conversations

/dashboard lists every conversation that has stored history, including ones still in progress. Each row shows the trial, the start time, and the message count. Open a conversation to read its full transcript.

The top of the page shows four totals across all conversations: how many there are, the average number of messages, how many started today, and the average duration. You can filter the list by minimum message count, or search by trial or conversation ID.

Dashboard listing patient conversations
img/dashboard.png: the review dashboard.

Upkeep

Updating a live trial

Any change to an active trial (editing a section, uploading or deleting a document) automatically puts it back into draft. This is a safety feature: staff must explicitly re-activate (and thereby re-index) before patients see the changed content.

Resets

Two administrative reset operations exist for recovery scenarios. Both are irreversible, so read carefully:

OperationDeletesKeeps
Reset vectors Carmen's document search index (all trials) Trials, documents, conversations
Reset all All trials, all documents and files, the search index Conversations (audit trail)
After "Reset vectors", Carmen answers from structured data only until each trial is re-indexed (open each trial and click Index & Activate). Do resets outside consultation hours.

Troubleshooting

SymptomLikely cause and fix
Carmen doesn't mention newly uploaded content Documents are uploaded but not indexed. Open the trial and click Index & Activate.
Patient link says "invitation expired" The 7-day window passed. Create a new invite.
Patient link says "already used" on a new device Links are single-use per device. Create a new invite.
Trial missing from the invite page's trial list Only active trials can be used to invite patients. Activate the trial first.
Activation fails with an indexing error One or more documents could not be read or indexed. Open the Documents tab and find the row marked failed. Delete that document, fix the file itself on your computer, upload the corrected version, then click Index & Activate again.
"Invitation required" when opening the consultation directly The console needs a session. Enter via an invite link or a test session, not the bare URL.