docs: add TEI ownership and breaking-the-glass documentation - #4705
Open
karolinelien wants to merge 5 commits into
Open
docs: add TEI ownership and breaking-the-glass documentation#4705karolinelien wants to merge 5 commits into
karolinelien wants to merge 5 commits into
Conversation
Document tracked entity ownership, how the four program access levels (Open/Audited/Closed/Protected) affect what a user can see and open, and the breaking-the-glass override flow with its actual in-app copy and behavior. Also fixes a stale line claiming enrollment still opens in the separate Tracker Capture app. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Move the ownership caveat earlier so it applies to the whole search result list rather than being buried at the end of the View dashboard bullet, spell out what a Closed vs Protected program actually shows when access is denied, and drop em-dashes in favor of periods/colons. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
"Capture scope"/"search scope" are internal variable names, not terms used anywhere else in this doc or in DHIS2's own user-facing guides, which spell out "data capture access" and "search access" to an organisation unit instead. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
ameenhere
reviewed
Aug 18, 2026
|
|
||
| ### Tracked entity ownership { #capture_tei_ownership } | ||
|
|
||
| Every enrollment of a tracked entity in a program has an **owning organisation unit**. Ownership starts out as the organisation unit that first enrolled the tracked entity into that program, and changes if the enrollment is later [transferred to another organisation unit](#transfer-the-enrollment-to-another-organisation-unit). Ownership is tracked per tracked entity/program combination: the same tracked entity can be owned by different organisation units for different programs (for example, one facility could own a person's HIV programme enrollment, while a different facility owns the same person's MCH programme enrollment). |
ameenhere
reviewed
Aug 18, 2026
|
|
||
| In practice, clicking **View dashboard** or **View active enrollment** from a search result doesn't always show the enrollment's content. For a Closed program you'll see an access-denied message if you don't have data capture access to the owning organisation unit. For a Protected program you'll see the breaking the glass prompt if you only have search access, or the same access-denied message if you have neither. | ||
|
|
||
| Even once you can open an enrollment, whether you can also edit it depends separately on the program's sharing settings; you may still see a **View only** label if you don't have write access. |
Contributor
There was a problem hiding this comment.
"Even once you can open an enrollment" does not sound right..
A rephrase is needed I think.
ameenhere
reviewed
Aug 18, 2026
|
|
||
|  | ||
|
|
||
| Once submitted, you get access to the enrollment for about 3 hours. This access is tied to your current browser session rather than the record itself: if you refresh the page or come back later, you may be asked to provide a reason again even if the 3 hours haven't elapsed. Every request is logged for audit purposes. |
Contributor
There was a problem hiding this comment.
I am not sure the current browser session stands.... I thought the access is 3 hours persisted in database 🤔 So the user will still have access after logout/login. (I'll confirm again).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AI Assisted.
Test plan