MANSOQ Getting started
MANSOQ documentation
MANSOQ documentation is organized in four layers. Start with concepts to build mental models, follow flows when you need to do something in the product, use references for technical module detail, and use playbooks when a deployment combines…
3.1 · versioned documentation · 2 min read
MANSOQ documentation is organized in four layers. Start with concepts to build mental models, follow flows when you need to do something in the product, use references for technical module detail, and use playbooks when a deployment combines flows into a real-world scenario.
Concepts
Concepts answer: What is…?
Plain-language explanations of MANSOQ's primitives — for example, what a patient is. Concepts are grouped by domain (clinical, definitions & terminology, access & governance, and more), versioned with the core MANSOQ release, and apply across deployments.
→ Browse Concepts
Flows
Flows answer: How do I…?
Step-by-step guides for tasks in MANSOQ — for example, how to register a patient. Flows describe the happy path in the product UI and API; they stay deployment-agnostic unless noted.
→ Browse Flows
References
References answer: How is it built?
Module-level technical documentation for developers and integrators — models, fields, relationships, enums, API schemas, and save behaviour, grouped by domain. For example, the Patient reference maps to mansoq.emr.models.patient.
→ Browse References
Playbooks
Playbooks answer: How does this work in my deployment?
Playbooks live under each deployment playbook (HMIS and others). They wire flows together for concrete use cases — registration desks, emergency intake, and ward workflows — and document edge cases, local configuration, and operational expectations.
→ Browse HMIS playbooks
How to read a page
| Layer | Question | Audience | Example |
|---|---|---|---|
| Concept | What is it? | Everyone | Patient |
| Flow | How do I do it? | Operators, implementers | Register a patient |
| Reference | How is it built? | Developers, integrators | Patient (technical) |
| Playbook | How does my site run it? | Deployment teams | Outpatient registration |
Source evidence
References are pinned to the private MANSOQ source repository. Repository access is required to open these links.