Skip to main content
Version: 3.1

Care documentation

Care 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 Care's primitives — for example, what a patient is. Concepts are grouped by domain (clinical, definitions & terminology, access & governance, and more), versioned with the core Care release, and apply across deployments.

→ Browse Concepts

Flows

Flows answer: How do I…?

Step-by-step guides for tasks in Care — for example, how to create 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 care.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

LayerQuestionAudienceExample
ConceptWhat is it?EveryonePatient
FlowHow do I do it?Operators, implementersCreate a patient
ReferenceHow is it built?Developers, integratorsPatient (technical)
PlaybookHow does my site run it?Deployment teamsOutpatient registration