Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions design_decisions/patterns/atoms_components/avatar.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"$id": "atoms_components/avatar.schema",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Avatar",
"type": "object",
"properties": {
"src": {
"type": "string"
},
"alt": {
"type": "string"
},
"width": {
"type": "integer"
},
"height": {
"type": "integer"
}
},
"required": ["src", "alt", "width", "height"]
}
15 changes: 15 additions & 0 deletions design_decisions/patterns/atoms_components/link.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"$id": "atoms_components/link.schema",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Link",
"type": "object",
"properties": {
"children": {
"type": "object"
},
"url": {
"type": "string"
}
},
"required": ["children", "url"]
}
15 changes: 15 additions & 0 deletions design_decisions/patterns/atoms_components/navigation.schema.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"$id": "atoms_components/navigation.schema",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Navigation",
"type": "object",
"properties": {
"render_links": {
"type": "object"
},
"render_title": {
"type": "object"
}
},
"required": ["renderLinks"]
}
30 changes: 30 additions & 0 deletions design_decisions/patterns/common_elements/footer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Footer

## Overview

The PCGL Footer identity, documentation, definition, and properties are based on the [Canada design system](https://design-system.canada.ca/en/components/footer/) and the [Canadian Institutes of Health Research visual identity](https://cihr-irsc.gc.ca/e/50426.html).

## Properties

| Property | Attribute | Description| Type| Default |
| ------------------- | -------------------- | ---------- | --- | ----------- |
| [meta](/patterns/molecules_regions/footer-meta-item.schema.json) | `meta` | Object containing items for the sub-footer. | `object` | `{terms_conditions, logo}` |
| [navigation_sections](/patterns/atoms_components/navigation.schema.json) | `navigation` | Slot for displaying a band with lists of link items. Format: `{ render_title, render_links }` | `object` | `undefined` |


## Slots

[**navigation_sections**](/patterns/atoms_components/navigation.schema.json): Accepts a function to display contextual and external navigation items.

### Diagram
```mermaid
block
columns 1
block
navigation["navigation"]
meta["meta"]
style navigation stroke-dasharray:8px
end
```

> Check out the [template](/patterns/templates/figma.md).
46 changes: 46 additions & 0 deletions design_decisions/patterns/common_elements/header.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Header

## Overview

The PCGL Header identity, documentation, definition, and properties are based on the [Canada design system](https://design-system.canada.ca/en/components/header/code/#section-essential) and the [DACO portal visual identity](https://www.figma.com/design/DMs06XLL2oAlCQlRktXYqA/PCGL-Design-Mockups---REBRAND--Copy-?node-id=2025-565&t=lLoqA9iHKkFA7Qb2-0).

## Properties

| Property | Attribute | Description| Type| Default |
| ------------------- | -------------------- | ---------- | --- | ----------- |
| [accessibility_links](/patterns/atoms_components/link.schema.json) | `a11y-links` | Object containing hidden skip links for navigation accessibility. | `object` | `{ url, children }` |
| [menu_options](/patterns/atoms_components/navigation.schema.json) | `render-menu` | Slot containing the items for navigation. | `object` | `undefined` |
| [logo](/patterns/atoms_components/avatar.schema.json) | `logo` | Object containing the wordmark as an image wrapped inside an anchor or link. | `object`| `{ src, alt, width, height }` |
| [lang](/patterns/atoms_components/link.schema.json) | `render_lang` | Slot for switching between available language versions. | `object` | `undefined` |
| **search_bar** | `render_search` | Slot for displaying a search bar. | `object` | `undefined` |
| [auth](/patterns/atoms_components/link.schema.json) | `render_auth` | Slot for displaying the authentication component. | `object` | `undefined` |


## Slots

[**render-menu**](/patterns/atoms_components/navigation.schema.json): Accepts a function to display contextual and external navigation items, such a hamburger menu for example.

**`render_lang`**: Accepts a function to display the language toggle component.

**`render_search`**: Accepts a function to display the search component.

**`render_auth`**: Accepts a function to display the authentication component.

### Diagram
```mermaid
block
columns 1
accessibility_links
block:group1
columns 12
navigation logo children lang search_bar auth
end
classDef optional stroke-dasharray:8px
class navigation optional
class lang optional
class search_bar optional
class children optional

```

> Check out the [template](/patterns/templates/figma.md).
121 changes: 121 additions & 0 deletions design_decisions/patterns/docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
# Contributing

## Check With Our Team

When contributing to this repository, please first discuss the changes you wish to make via an issue, email, or any other method with the repository owners before starting work.

## Review Our Guidelines

These guidelines combine concepts from [Atomic Design][atomic-design-brad-frost] and the [MDN HTML elements reference][element] to provide a structured, hierarchical approach to representing components across portals.


Pages
: Specific instances where templates are populated with real data, representing the final user interface.

Templates
: Page-level layouts that arrange components and regions without specific content or data.

Landmarks (Organisms)
: Complex UI sections representing major areas of a page (e.g., header, footer) that users can navigate to directly.

Regions (Molecules)
: A group of components combined to serve a single responsibility.

Components (Atoms)
: An indivisible UI element (e.g., button, link, avatar) that serves as a fundamental building block.

Our decisions draw inspiration from established design systems, accessibility standards, and industry best practices, including but not limited to:
- [The Government of Canada][canada]
- [The UK Government][uk]
- [Atomic Design by Brad Frost][atomic-design-brad-frost]
- [MDN][MDN]
- [Splunk][splunk]

## Pull Request Process

You may merge a pull request once you have the sign-off of two other developers. If you do not have permission to merge, you may request the second reviewer to merge it on your behalf.

## Code of Conduct

### Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

### Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

### Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

### Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

### Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

### Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage].

[homepage]: https://contributor-covenant.org

[canada]: https://design-system.canada.ca

[uk]: https://design-system.service.gov.uk

[atomic-design-brad-frost]: https://atomicdesign.bradfrost.com

[MDN]: https://developer.mozilla.org/en-US/docs/Learn_web_development/Howto/Design_and_accessibility

[splunk]: https://splunkui.splunk.com/DesignSystem/DesignPrinciples#splunk-ui-design-system-principles

[element]: https://developer.mozilla.org/en-US/docs/Web/API/Element
98 changes: 98 additions & 0 deletions design_decisions/patterns/docs/users_personas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
# PCGL User Personas and Context

This document outlines the user personas, their actions (verbs), and their relationships with the system elements within the Pan-Canadian Genome Library (PCGL) platform.

## System Context Diagram

```mermaid
C4Context
title PCGL Platform - User Personas and Context Diagram

Enterprise_Boundary(pcgl, "Pan-Canadian Genome Library (PCGL)") {
System(admin_tools, "Administration & Identity", "COManage, OIDC, System Config")
System(submission_sys, "Data Submission System", "Score CLI, Song manifests, Schema validation")
System(daco_portal, "DACO Portal", "Data Access Committee operations and applications")
System(research_portal, "Research Portal", "Data discovery and access")
System(tre, "TRE (Trusted Research Environment)", "Secure data analysis environment")
System(participant_portal, "Participant Portal", "PHI isolated, consent management")
System(reporting_module, "Reporting Module", "Compliance, QC, milestones")
System(infrastructure, "SD4H Infrastructure", "K8s, Globus, S3, Pipelines")
}

%% Personas - Administrative & Support
Person(super_admin, "Super-Admin", "Highest privilege group.")
Person(data_admin, "Data Admin", "Manages data-related administrative operations.")
Person(op_support, "Operational Support", "Assists data submitters with onboarding and setup.")
Person(devops, "DevOps & Infrastructure", "Manages SD4H Kubernetes clusters, monitoring, backups.")

%% Personas - Data Submission & Research
Person(submitter, "Data Submitter", "Submits clinical and/or genomic data to a specific study.")
Person(researcher, "Researcher", "Discovers data and requests access.")
Person(daco_collaborator, "DACO Collaborator", "Project members wanting controlled data access.")
Person(signing_official, "Signing Official", "Legally commits entity to data access agreements.")

%% Personas - Governance
Person(dac_chair, "DAC Chair", "Issues final approval or rejection of data access requests.")
Person(dac_member, "DAC Member", "Views and reviews submitted data access applications.")
Person(daco_admin, "DACO Admin", "Admin of the PCGL DACO Portal.")

%% Personas - Other
Person(participant, "Study Participant", "Interacts with the Participant Portal.")
Person(funder, "Funding Body Rep", "Views compliance reports and project milestones.")

System_Ext(external_platforms, "External Platforms", "gnomAD, Cloud Analysis (GA4GH APIs)")

%% Relationships - Administrative
Rel(super_admin, admin_tools, "Manages groups, OIDC, config, roles")
Rel(data_admin, admin_tools, "Registers studies, schemas, assigns submitters")
Rel(data_admin, submission_sys, "Flags submissions as validated, configures settings")
Rel(op_support, submission_sys, "Creates studies, registers participants, wrangles data, submits on behalf")
Rel(devops, infrastructure, "Manages clusters, backups, storage, deploys, monitors health")
Rel(devops, tre, "Provisions TRE instances")

%% Relationships - Submission
Rel(submitter, submission_sys, "Uploads clinical TSV, deposits files via Score CLI, registers Song manifests")

%% Relationships - Research & Access
Rel(researcher, research_portal, "Discovers data")
Rel(researcher, daco_portal, "Requests access")
Rel(researcher, tre, "Accesses individual-level data for approved studies, exports data")
Rel(signing_official, daco_portal, "Signs Data Access Applications")
Rel(daco_collaborator, daco_portal, "Requests access to controlled data")

%% Relationships - Governance
Rel(dac_chair, daco_portal, "Approves, rejects, or revokes data access requests")
Rel(dac_member, daco_portal, "Reviews applications, requests clarifications")
Rel(daco_admin, daco_portal, "Imports, activates, and deactivates studies")

%% Relationships - Other
Rel(participant, participant_portal, "Provides e-consent, views data usage, withdraws consent, updates contact")
Rel(funder, reporting_module, "Views reports, QC metrics, data ingestion status (Read-only)")
Rel(external_platforms, research_portal, "Accesses PCGL data programmatically via GA4GH APIs")

UpdateLayoutConfig($c4ShapeInRow="3", $c4BoundaryInRow="2")
```

## Persona Definitions

### Administrative & Infrastructure Support
* **Super-Admin:** Full super-admin access to the PCGL platform. Can manage all COManage groups, OIDC clients, enrollment flows, and system-wide configuration. Can create new roles and designate other admins. This is the highest-privilege group.
* **Data Admin:** Manages data-related administrative operations across the platform. Can register new studies, register custom schemas, assign data submitters to studies, flag submissions as validated, and configure data-related settings. Does not have system-level infrastructure access.
* **Operational Support:** Operational support staff who assist data submitters with onboarding, study setup, and submission issues. Can create studies, register participants, perform data wrangling, and manage day-to-day submission operations (including submitting clinical and genomics data on behalf of a data submitter). Does not have system admin access, only create/edit data permissions.
* **DevOps & Infrastructure:** DevOps and infrastructure staff responsible for managing the SD4H Kubernetes clusters, monitoring, backups, disaster recovery, storage management, and service deployments. Can trigger pipeline runs, manage Globus endpoints, manage S3 buckets and keys, provision TRE instances, and monitor all system health. Does not make data governance or access decisions.

### Data Submission & Research
* **Data Submitter:** Submits clinical and/or genomic data to a specific study. Can upload clinical TSV/metadata, deposit genomic files via Score CLI, register file metadata with Song manifests, register participants, validate data against schemas, and view submission status. Scoped strictly to the studies they are assigned to.
* **Researcher:** Any authenticated user who discovers data through the Research Portal and/or requests access through the DACO portal. Before access approval, can log into the research portal and DACO portal. After DAC approval, can view individual-level data for approved studies, export/download approved data, and access the TRE. A researcher may also be a data_submitter for a different study.
* **Signing Official:** Signing official of any Data Access Application. They must be a qualified representative of a legal entity who has the administrative power to legally commit that entity to the terms and conditions of the data access agreement. Examples of institutional representatives include, but are not limited to: a Vice-President Research, a Research Director, or a Contracts Officer for the entity.
* **DACO Collaborator:** Researchers or post-docs or students who are part of a project as the applicant, and want to access controlled data for research purposes.

### Data Governance (DACO)
* **DAC Chair:** Chair of a Data Access Committee. The only role that can issue final approval or rejection of data access requests in the DACO portal. Can also revoke previously granted access. Currently there is only one DAC for PCGL. A Local DAC is a DAC independent of the PCGL DAC and controls data access for studies under its governance. Only one Chair is allowed for Local DAC users.
* **DAC Member:** Member of a Data Access Committee who can view and review submitted data access applications, add review comments, and request clarifications from applicants. Cannot approve or reject applications, as only the DAC Chair can make final decisions.
* **DACO Admin:** Admin of the PCGL DACO Portal. The admin has two responsibilities: 1. Import studies. 2. Activate/Deactivate studies.

### Other Participants & External Entities
* **Study Participant:** A study participant who interacts with the Participant Portal. Can provide electronic consent, view how their data is used, see study results/summaries, withdraw consent, discover new research opportunities, and update their contact information. The Participant Portal contains PHI and is isolated from other PCGL components. Participants authenticate separately from other PCGL users.
* **Funding Body Rep:** Representatives of funding bodies (e.g., Genome Canada) who need to view compliance reports, QC metrics, data ingestion status, and project milestones for the projects they fund. Access is read-only and limited to the Reporting Module. Do not interact with data directly.
* **External Platforms:** External platforms and applications (e.g., gnomAD, commercial cloud analysis solutions) that access PCGL data programmatically via GA4GH APIs (DRS, htsget, refget). Authenticated via registered OIDC clients or API keys rather than individual user credentials. Access is scoped to authorized datasets.
Loading