Documentation/Intro: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 15:33, 10 August 2026

guideCARE 3.0+

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

Layer	Question	Audience	Example
Concept	What is it?	Everyone	Concepts/Patient
Flow	How do I do it?	Operators, implementers	Flows/Register a patient
Reference	How is it built?	Developers, integrators	References/Patient
Playbook	How does my site run it?	Deployment teams	Playbooks/HMIS/Playbooks/Outpatient registration

@@ Line 21: / Line 21: @@
 '''Flows answer: ''How do I…?'''''
-Step-by-step guides for tasks in Care — for example, [[Flows/Create a patient|how to create a patient]]. Flows describe the happy path in the product UI and API; they stay deployment-agnostic unless noted.
+Step-by-step guides for tasks in Care — for example, [[Flows/Register a patient|how to register a patient]]. Flows describe the happy path in the product UI and API; they stay deployment-agnostic unless noted.
-→ Browse [[Flows/Create a patient|Flows]]
+→ Browse [[Flows/Register a patient|Flows]]
 == References ==
@@ Line 37: / Line 37: @@
 '''Playbooks answer: ''How does this work in my deployment?'''''
-Playbooks live under each [[Hmis|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.
+Playbooks live under each [[Playbooks/HMIS|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 [[Outpatient registration|HMIS playbooks]]
+→ Browse [[Playbooks/HMIS/Playbooks/Outpatient registration|HMIS playbooks]]
 == How to read a page ==
@@ Line 58: / Line 58: @@
 | How do I do it?
 | Operators, implementers
-| [[Flows/Create a patient]]
+| [[Flows/Register a patient]]
 |-
 | Reference
 | How is it built?
 | Developers, integrators
-| [[References/Patient
+| [[References/Patient]]
 |-
 | Playbook
 | How does my site run it?
 | Deployment teams
-| [[Outpatient registration
+| [[Playbooks/HMIS/Playbooks/Outpatient registration]]
 |}