ANALYTICS: Documentation and Packaging

[roywanyaga]

Objective

Document the analytics system for adopters, enabling them to extend ViewDefinitions, add custom indicators, and operate the pipeline independently.

User Story

As an implementer adopting OHS Player,
I want clear documentation on extending the analytics stack,
So that I can add program-specific indicators and views without starting from scratch.

Key Deliverables

• ViewDefinition authoring guide (syntax, FHIRPath expressions, testing, common patterns)
• Indicator extension guide (adding indicators, custom dashboards, best practices)
• Operational runbook (pipeline scheduling, monitoring, troubleshooting, schema management, Superset administration)
• Finalized README

Acceptance Criteria

• ViewDefinition guide enables creating new definitions independently
• Indicator guide enables adding custom metrics
• Runbook covers all operational scenarios including troubleshooting
• Documentation tested by a team member not involved in writing it
• Examples provided for common use cases
• README accurate against the final implemented state

Cross-Repository Tasks

Analytics (ohs-player-reference-analytics)

• ohs-foundation/ohs-player-reference-analytics#6 - Analytics documentation and packaging

Dependencies

Can begin in parallel with Epic 4. Must complete after Epic 4.

References

• OHS Analytics Workflow Design RFC
• FHIR Data Pipes documentation