Document requirements and verification
Configure the patient document checklist with groups and requirements, and set up identity checks and eSign providers on the Verification screen.
This page covers two setup screens that decide what documents and identity checks LeapHealthOS asks of patients:
- Document Requirements defines the patient document checklist: the sections and the document slots staff work through, such as "Aadhaar Card" or "Previous reports".
- Verification connects identity-check and eSign providers and lets you build reusable verification setups.
Both are for administrators. Front-desk and clinical staff use the resulting checklist on the patient profile; see Document checklist and consents.
Document Requirements
Open SettingsPlatform ConfigurationDocument Requirements. The page describes itself as "Checklist sections and the document slots patients are asked to satisfy." You need the Read permission on Settings to view it and the Configure permission on Settings to change it.
The checklist is built from two things:
Item | What it is |
|---|---|
Group | A section of the checklist, such as "KYC Documents". It has a code, a label, an optional description and a sort order. |
Requirement | One document slot inside a group, such as "Aadhaar Card". It names a document category and says who it is for, which journeys need it, whether it is mandatory, how many documents are expected and when they go stale. |
Before you begin
Requirements use the Document Categories registry. Add the categories you need in the Tenant registry first. Until there is at least one category, the group form shows "Configure document categories before seeding requirements."
Create a group
Start a new group
Settings > Platform Configuration > Document Requirements
Select New group.
Expected result: The New document group dialog opens.
Fill in the group
Enter a Code (up to 64 characters, for example KYC), a Label (up to 120 characters), an optional Description (up to 255 characters) and a Sort order. The sort order decides where the section appears on the checklist.
Add requirements now (optional)
Under Seed requirements (optional), select Add to add requirements to the new group in the same step. Each one opens the requirement form; finish it with Add to group.
Save
Select Create group.
Expected result: You see "Group created".
The group code cannot be changed later. If you enter the code of a group that was retired, LeapHealthOS restores that group instead of creating a new one.
Add a requirement to a group
On the group's card, select Requirement. Fill in the form and select Create requirement.
Field | What it means |
|---|---|
Document category | Required. Taken from the tenant document categories. It cannot be changed after the requirement is created; to use a different category, retire the requirement and create a new one. |
Label | Required, up to 120 characters, for example "Aadhaar Card". |
Subject | Self (the patient) or Partner (the patient's partner). |
Journey | All journeys, or one journey type from your registry. The requirement appears only for patients on that journey type. |
Group | The group the requirement sits in. |
Mandatory | Whether the slot counts towards checklist completion. |
Expected documents | How many verified documents satisfy the slot. At least 1. |
Goes stale after (days) | After this many days an uploaded document counts as expired. Leave blank for Never. |
Any-of key | A shared key, for example |
Sort order | The position of the requirement inside its group. |
Two requirements cannot share the same journey, category, subject and label. Each organisation can have up to 200 active requirements; at the limit you see "This tenant has reached the limit of 200 active requirements. Retire a requirement before adding another."
How a slot's status is worked out
Each requirement becomes a slot on the patient's checklist with one of these statuses:
Status | When |
|---|---|
Missing | No document has been uploaded for the slot. |
Pending | A document is uploaded but not yet verified. |
Verified | At least the expected number of documents are verified. |
Rejected | A document was rejected and the slot is not yet satisfied. |
Expired | The document is past its own expiry date, or older than the staleness window. A document's own expiry date takes priority over the window. |
The checklist counts as complete when every mandatory requirement is verified. Mandatory requirements that share an any-of key (for the same subject) count as one item, satisfied as soon as any one of them is verified. For example, give "Aadhaar Card" and "PAN Card" the any-of key IDENTITY to accept either.
Edit, retire and restore
- Select Edit on a group or requirement to change it. Codes and categories stay fixed.
- Select Retire to take a group or requirement out of use. A retired requirement stops appearing on the patient checklist immediately; documents already uploaded are kept.
- Retiring a group does not retire its requirements. They keep appearing on the checklist, listed under Requirements without a listed group, until you retire them one by one.
- Turn on Show retired to see retired items, and select Restore to bring one back.
Verification (KYC and eSign)
Open SettingsPlatform ConfigurationVerification. It has four tabs.
Tab | What you do there |
|---|---|
Providers | Your verification provider connection for the Sandbox (testing) and Production (live) environments, and which products it gives you: eSign, Aadhaar eKYC, DigiLocker and PAN. Select Re-check to refresh the Product access status. Your implementation team sets up the provider connection with you. |
Sandbox tests | Run test eSign, Aadhaar and PAN checks in the sandbox. For eSign you can use a sample document, a PDF template, or upload a PDF. Recent tests lists earlier runs. |
Setups | Build reusable verification setups: the parties involved (for example "Patient"), the steps (Identity check or Document signing), and the order (One party after another or All parties at once). Archive setups you no longer use; Show archived lists them. |
Sessions | Follow verifications that are running or finished, and filter them by setup and status. Open a session to see each step and the signed document, retry a failed step or cancel the session. |
Product access shows as Active, Unauthorised, Not enabled or Unreachable.
Sandbox and production
Use the sandbox to test before you go live. Real patient verifications run in production.
Verification setups are used by journey steps that ask a patient to verify their identity or sign a document. See What patients receive: messages, action links and signing.
Related pages
Last updated on