@neobiotechlabs/neobiotech-dev-agent 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude-plugin/marketplace.json +22 -0
- package/.claude-plugin/plugin.json +58 -0
- package/.mcp.json +14 -0
- package/README.md +442 -0
- package/dist/__tests__/adf.test.d.ts +1 -0
- package/dist/__tests__/adf.test.js +68 -0
- package/dist/__tests__/adf.test.js.map +1 -0
- package/dist/__tests__/annex-ii-template.test.d.ts +1 -0
- package/dist/__tests__/annex-ii-template.test.js +39 -0
- package/dist/__tests__/annex-ii-template.test.js.map +1 -0
- package/dist/__tests__/doc-render.test.d.ts +1 -0
- package/dist/__tests__/doc-render.test.js +93 -0
- package/dist/__tests__/doc-render.test.js.map +1 -0
- package/dist/__tests__/help.test.d.ts +1 -0
- package/dist/__tests__/help.test.js +31 -0
- package/dist/__tests__/help.test.js.map +1 -0
- package/dist/__tests__/jira-fields.test.d.ts +1 -0
- package/dist/__tests__/jira-fields.test.js +81 -0
- package/dist/__tests__/jira-fields.test.js.map +1 -0
- package/dist/__tests__/plugin-manifest.test.d.ts +1 -0
- package/dist/__tests__/plugin-manifest.test.js +91 -0
- package/dist/__tests__/plugin-manifest.test.js.map +1 -0
- package/dist/__tests__/setup.test.d.ts +1 -0
- package/dist/__tests__/setup.test.js +7 -0
- package/dist/__tests__/setup.test.js.map +1 -0
- package/dist/__tests__/sync-version.test.d.ts +1 -0
- package/dist/__tests__/sync-version.test.js +37 -0
- package/dist/__tests__/sync-version.test.js.map +1 -0
- package/dist/clients/risk-client.d.ts +17 -0
- package/dist/clients/risk-client.js +54 -0
- package/dist/clients/risk-client.js.map +1 -0
- package/dist/clients/xray-client.d.ts +34 -0
- package/dist/clients/xray-client.js +127 -0
- package/dist/clients/xray-client.js.map +1 -0
- package/dist/config/project-config.d.ts +14 -0
- package/dist/config/project-config.js +45 -0
- package/dist/config/project-config.js.map +1 -0
- package/dist/confluence-client.d.ts +16 -0
- package/dist/confluence-client.js +97 -0
- package/dist/confluence-client.js.map +1 -0
- package/dist/index.d.ts +2 -0
- package/dist/index.js +60 -0
- package/dist/index.js.map +1 -0
- package/dist/jira-client.d.ts +35 -0
- package/dist/jira-client.js +119 -0
- package/dist/jira-client.js.map +1 -0
- package/dist/tools/annex-ii-template.d.ts +30 -0
- package/dist/tools/annex-ii-template.js +129 -0
- package/dist/tools/annex-ii-template.js.map +1 -0
- package/dist/tools/confluence.d.ts +2 -0
- package/dist/tools/confluence.js +54 -0
- package/dist/tools/confluence.js.map +1 -0
- package/dist/tools/cvss.d.ts +2 -0
- package/dist/tools/cvss.js +59 -0
- package/dist/tools/cvss.js.map +1 -0
- package/dist/tools/doc-render.d.ts +2 -0
- package/dist/tools/doc-render.js +96 -0
- package/dist/tools/doc-render.js.map +1 -0
- package/dist/tools/doc-validation.d.ts +2 -0
- package/dist/tools/doc-validation.js +221 -0
- package/dist/tools/doc-validation.js.map +1 -0
- package/dist/tools/help-data.d.ts +7 -0
- package/dist/tools/help-data.js +144 -0
- package/dist/tools/help-data.js.map +1 -0
- package/dist/tools/help.d.ts +2 -0
- package/dist/tools/help.js +39 -0
- package/dist/tools/help.js.map +1 -0
- package/dist/tools/iec.d.ts +2 -0
- package/dist/tools/iec.js +203 -0
- package/dist/tools/iec.js.map +1 -0
- package/dist/tools/init.d.ts +2 -0
- package/dist/tools/init.js +38 -0
- package/dist/tools/init.js.map +1 -0
- package/dist/tools/jira-crud.d.ts +2 -0
- package/dist/tools/jira-crud.js +142 -0
- package/dist/tools/jira-crud.js.map +1 -0
- package/dist/tools/risk.d.ts +2 -0
- package/dist/tools/risk.js +172 -0
- package/dist/tools/risk.js.map +1 -0
- package/dist/tools/traceability.d.ts +2 -0
- package/dist/tools/traceability.js +85 -0
- package/dist/tools/traceability.js.map +1 -0
- package/dist/tools/types.d.ts +13 -0
- package/dist/tools/types.js +2 -0
- package/dist/tools/types.js.map +1 -0
- package/dist/tools/usability.d.ts +2 -0
- package/dist/tools/usability.js +149 -0
- package/dist/tools/usability.js.map +1 -0
- package/dist/tools/xray.d.ts +2 -0
- package/dist/tools/xray.js +35 -0
- package/dist/tools/xray.js.map +1 -0
- package/dist/utils/adf.d.ts +27 -0
- package/dist/utils/adf.js +104 -0
- package/dist/utils/adf.js.map +1 -0
- package/dist/utils/cvss.d.ts +15 -0
- package/dist/utils/cvss.js +86 -0
- package/dist/utils/cvss.js.map +1 -0
- package/dist/utils/doc-render.d.ts +28 -0
- package/dist/utils/doc-render.js +50 -0
- package/dist/utils/doc-render.js.map +1 -0
- package/dist/utils/jira-fields.d.ts +38 -0
- package/dist/utils/jira-fields.js +53 -0
- package/dist/utils/jira-fields.js.map +1 -0
- package/dist/utils/sync-version.d.ts +2 -0
- package/dist/utils/sync-version.js +20 -0
- package/dist/utils/sync-version.js.map +1 -0
- package/package.json +49 -0
- package/skills/doc-render/SKILL.md +79 -0
- package/vendor/dev-docs-templates/templates/dev_docs/plan_template.md +104 -0
- package/vendor/dev-docs-templates/templates/dev_docs/prd_template.md +110 -0
- package/vendor/dev-docs-templates/templates/dev_docs/spec_template.md +81 -0
- package/vendor/dev-docs-templates/templates/dev_docs/tasks_template.md +122 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/checklist-clinical-evaluation.md +81 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/checklist-gspr-mdr.md +403 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/clinical-evaluation-report.md +492 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/instructions-for-use.md +132 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/literature-evaluation-table.md +15 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/mdr-declaration-of-conformity.md +75 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/post-market-clinical-follow-up-plan.md +162 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/post-market-surveillance-plan.md +175 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/risk-management-cybersecurity-checklist.md +67 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/risk-management-report.md +111 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/CA/usability-evaluation-report.md +70 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/clinical-evaluation-plan.md +154 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/list-of-hazard-related-use-scenarios.md +34 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/risk-table-fmea.md +155 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/software-architecture-description.md +307 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/software-requirements-list.md +156 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/soup-list.md +82 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/EA/usability-evaluation-plan.md +103 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/global/bug-fixes-documentation-list.md +35 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/global/change-evaluation-list.md +100 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/global/list-of-known-anomalies.md +29 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/algorithm-validation-report.md +170 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/checklist-software-release.md +52 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/checklist-software-requirements-review.md +50 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/software-architecture-checklist.md +41 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/software-detailed-design.md +321 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/software-system-test-plan.md +155 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/usability-evaluation-protocol.md +63 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/PA/intended-use.md +116 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/PA/mdr-classification-document.md +114 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/PA/risk-management-plan.md +198 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/PA/software-development-maintenance-plan.md +225 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/PA/system-requirements-spec.md +182 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/information_security/information-security-controls.md +966 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/information_security/information-security-policy-and-scope.md +99 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/quality-manual-policy-objectives.md +187 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-capa.md +112 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-change-management.md +128 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-clinical-evaluation.md +102 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-feedback-management.md +140 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-integrated-software-development.md +361 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-post-market-surveillance.md +159 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/global/qms/sop-software-problem-resolution.md +99 -0
package/vendor/dev-docs-templates/templates/mdr_docs/ER/global/bug-fixes-documentation-list.md
ADDED
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# Bug Fixes Documentation List
|
|
2
|
+
|
|
3
|
+
| Regulations | Document Section |
|
|
4
|
+
|----------------------|------------------|
|
|
5
|
+
| IEC 62304, Chapter 9 | All |
|
|
6
|
+
|
|
7
|
+
## Summary
|
|
8
|
+
|
|
9
|
+
This list is used to document the evaluation and implementation of all bug fixes according to the company's
|
|
10
|
+
change management process.
|
|
11
|
+
|
|
12
|
+
## Documentation of Bug Fixes
|
|
13
|
+
|
|
14
|
+
| Evaluation Categories | | | |
|
|
15
|
+
|-------------------------------------------------------------------------------|----------------------------------------------------------|------------------------------------------------------|-------|
|
|
16
|
+
| Bug ID | #B01 | #B02 | (...) |
|
|
17
|
+
| Bug Description | Hovering over button should display info box but doesn't | Users do not understand how to use text field | |
|
|
18
|
+
| Occurrence Date and Time | 01-04-2021 | 16-03-2021 | |
|
|
19
|
+
| Corrective Action | Display of information when hovering | Renaming text field | |
|
|
20
|
+
| Preventive Action | Added test scenario #T123 *(link file)* | Added usability test scenario #U123 *(link file)* | |
|
|
21
|
+
| Affected Software Requirement | #REQ192 "Display user information (...)" | #REQ193 "Provide field to document information (..." | |
|
|
22
|
+
| Corresponding Implementation Ticket<br>*(optional, e.g. Github Pull Request)* | (...) | (...) | |
|
|
23
|
+
| Corresponding Test Documentation<br>*(e.g. System Test ID #121)* | #T123 | #T132 | |
|
|
24
|
+
| Test Completed (When / By Whom) | 2021-04-15 by John Doe | 2021-04-15 by John Doe | |
|
|
25
|
+
| Affected Risk Documentation | - | Risk ID #369 "User does not understand XYZ" | |
|
|
26
|
+
| Preliminary Incident Assessment by MDSO | No incident | No incident | |
|
|
27
|
+
| Preliminary Significance Assessment by QMO | Not significant | Not significant | |
|
|
28
|
+
| Release Date of Updated Software Version | 2021-04-16 | 2021-04-16 | |
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
33
|
+
license](https://openregulatory.com/template-license).
|
|
34
|
+
|
|
35
|
+
Please don't remove this notice even if you've modified contents of this template.
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
# Change Evaluation List
|
|
2
|
+
|
|
3
|
+
| Regulation / Guidance | Document Section |
|
|
4
|
+
|-------------------------------------------------------------------|------------------|
|
|
5
|
+
| Medical Device Regulation, Annex IX<br>Chapter II Section 4.10 | All |
|
|
6
|
+
| MDCG Guidance Document 2020-03 | All |
|
|
7
|
+
|
|
8
|
+
## Summary:
|
|
9
|
+
|
|
10
|
+
This list is used to document the evaluation of all regular change requests according to the company's change
|
|
11
|
+
management process.
|
|
12
|
+
|
|
13
|
+
## Evaluation of Product Changes
|
|
14
|
+
|
|
15
|
+
> Disclaimer for Use #1: You may want to separate your lists for product and organizational changes, as you
|
|
16
|
+
> should release a new list for every product version. This is to separately identify all changes related to
|
|
17
|
+
> that specific version. Each product version list should ideally be attached to the respective technical
|
|
18
|
+
> documentation file.
|
|
19
|
+
|
|
20
|
+
> Disclaimer for Use #2: If any of the below mentioned categories are answered with YES, this indicates that
|
|
21
|
+
> your change must be classified as significant.
|
|
22
|
+
|
|
23
|
+
> Disclaimer for Use #3: In the example content filled into the table below, "PCR" stands for "Product Change
|
|
24
|
+
> Request" and "OCR" stands for "Organization Change Request".
|
|
25
|
+
|
|
26
|
+
**Please note:**
|
|
27
|
+
|
|
28
|
+
* YES in the first two categories (intended use / essential requirements / GSPR) always leads to a significant
|
|
29
|
+
change.
|
|
30
|
+
* If the device is modified (a) to correct an error, for which there is a safety risk to the patient if the
|
|
31
|
+
error is not corrected or (b) as part of field safety corrective actions for an incident, the change is
|
|
32
|
+
discussed with the Notified Body to determine the significance of the change. If no Notified Body was
|
|
33
|
+
involved in the conformity assessment process of the device, the change is treated as a significant change.
|
|
34
|
+
|
|
35
|
+
| Evaluation Categories | | | |
|
|
36
|
+
|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------|----------------------------------------------------------------|-------|
|
|
37
|
+
| **Change Request ID** | #PCR01 | #PCR02 | (...) |
|
|
38
|
+
| **Change Request Description** | Performance update of machine learning algorithm model | Additional integrability of device with new clinical IT-system | |
|
|
39
|
+
| **Overall Evaluation Outcome** | **Not significant** | **Significant** | |
|
|
40
|
+
| Does the change alter specifications provided in the Intended Use? (Chart A of MDCG 2020-03, e.g. new user or patient population) | No | No | |
|
|
41
|
+
| Does the change affect conformity with the General Safety and Performance Requirements? | No | No | |
|
|
42
|
+
| Does change implementation require further clinical or usability data to support safety and performance? (Chart B of MDCG 2020-03) | No, but internal validation showed that performance on same metrics improved | Yes | |
|
|
43
|
+
| Do new risks require risk control measures or are existing risks negatively affected? (Chart B of MDCG 2020-03) | No | Yes | |
|
|
44
|
+
| Does the change alter built-in control mechanisms or alarms? (Chart B of MDCG 2020-03) | No | No | |
|
|
45
|
+
| Does the change modify an operating principle or sources of energy? (Chart B of MDCG 2020-03) | No | No | |
|
|
46
|
+
| Does the change introduce a new or major change of the operating system or of any component? (Chart C of MDCG 2020-03, e.g. major SOUP update) | No | No | |
|
|
47
|
+
| Does the change introduce a new or modified architecture or database structure, change of an algorithm? (Chart C of MDCG 2020-03, e.g. changes to prediction principle of an algorithm model) | No, same prediction model | No | |
|
|
48
|
+
| Does the change replace previously required user input by a closed-loop algorithm? (Chart C of MDCG 2020-03) | No | No | |
|
|
49
|
+
| Does the change introduce a new diagnostic or therapeutic feature, or new channel of interoperability?<br>(Chart C of MDCG 2020-03) | No | Yes, new channel of interoperability | |
|
|
50
|
+
| Does the change introduce a new user interface or presentation of data? (Chart C of MDCG 2020-03) | No | No | |
|
|
51
|
+
| Does change implementation involve changes in critical suppliers? (Chart D of MDCG 2020-03) | No | No | |
|
|
52
|
+
| Does the change impact the way medical data is read or interpreted by the user, such that the treatment or diagnosis of the patient may be altered when compared to the previous version of the software? | Yes, but only improved accuracy in supported diagnosis | No | |
|
|
53
|
+
|
|
54
|
+
## Evaluation of Organizational Changes
|
|
55
|
+
|
|
56
|
+
Please note: YES in the first two categories (Intended Use / GSPR) always leads to a significant
|
|
57
|
+
change.
|
|
58
|
+
|
|
59
|
+
| Evaluation Categories | | | |
|
|
60
|
+
|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------|------------------------------------------------------------------------|-------|
|
|
61
|
+
| **Change Request ID** | #OCR1 | #OCR2 | (...) |
|
|
62
|
+
| **Change Request Description** | Change of Company Business Address | Adding a new compliance process to comply with anti-bribery provisions | |
|
|
63
|
+
| **Overall Evaluation Outcome** | **Significant** | **Not significant** | |
|
|
64
|
+
| Does the change affect QMS conformity with the General Safety and Performance Requirements (MDR)? | No | No | |
|
|
65
|
+
| Does the change affect product conformity with the General Safety and Performance Requirements (MDR) or the approved type / design?<br> | No | No | |
|
|
66
|
+
| Does the change relate to manufacturing processes, technologies, facility or equipment in a way that could impact product safety and performance? | No | No | |
|
|
67
|
+
| Does the change affect the location of the company's activities?<br> | Yes | No | |
|
|
68
|
+
| Does change implementation involve changes in critical suppliers?<br>(Chart D of MDCG 2020-03) | No | No | |
|
|
69
|
+
| Does the change affect the arrangements implemented to achieve continued compliance of the QMS with the relevant harmonized standards and/or MDR requirements (e.g. design verification, design validation, organizational structure, process interaction, quality control procedures)?<br> | No | No | |
|
|
70
|
+
|
|
71
|
+
> Based on the linked guidance documents, examples for non-significant changes are:
|
|
72
|
+
>
|
|
73
|
+
> * a software change that only introduces non-therapeutic and/or non-diagnostic features such as printing,
|
|
74
|
+
> faxing, improved image clarity, reporting format or additional language support
|
|
75
|
+
> * a software change that only modifies the appearance of the user interface with negligible risk of
|
|
76
|
+
> impacting the diagnosis or therapy delivered to the patient
|
|
77
|
+
> * a software change only intended to correct an inadvertent logic error that does not pose a safety risk and
|
|
78
|
+
> brings the system back into specification
|
|
79
|
+
> * a software change that consists only of tightening of design specifications within specified tolerances
|
|
80
|
+
> and where there is no creation of new features
|
|
81
|
+
> * changes to labelling to include additional languages required in other regulatory jurisdictions
|
|
82
|
+
> * minor changes to clarify the existing wording of warnings and precautions. However, in the case where
|
|
83
|
+
> these changes add or remove a contraindication, or remove a warning or precaution, the Notified Body shall
|
|
84
|
+
> be involved.
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
> Based on the linked guidance documents, examples for significant changes are:
|
|
88
|
+
>
|
|
89
|
+
> * an alteration in software that modifies an algorithm impacting the diagnosis or the therapy delivered
|
|
90
|
+
> * introduction or removal of a new alarm function from the software such that a response to the new
|
|
91
|
+
> configuration may change the treatment of the patient in comparison to the previous version of the
|
|
92
|
+
> software
|
|
93
|
+
> * medical data is presented in a new format, new dimension or new measuring unit.
|
|
94
|
+
|
|
95
|
+
---
|
|
96
|
+
|
|
97
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
98
|
+
license](https://openregulatory.com/template-license).
|
|
99
|
+
|
|
100
|
+
Please don't remove this notice even if you've modified contents of this template.
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
# List of Known Anomalies
|
|
2
|
+
|
|
3
|
+
> This template is supposed to give you an idea of the structure. Don't use Microsoft Word - this is thought
|
|
4
|
+
> as an excel / sheets file.
|
|
5
|
+
|
|
6
|
+
This list shows technical errors ("bugs") of the current device which were decided not to be corrected before the
|
|
7
|
+
release of the latest version.
|
|
8
|
+
|
|
9
|
+
It, therefore, serves as an overview and as a documentation of reasoning for non-correction.
|
|
10
|
+
|
|
11
|
+
**Regulatory references:**
|
|
12
|
+
|
|
13
|
+
| | |
|
|
14
|
+
|----------------|----------------------------|
|
|
15
|
+
| IEC 62304:2006 | Para. 5.7.5, 5.8.2 / 5.8.3 |
|
|
16
|
+
|
|
17
|
+
## Anomalies
|
|
18
|
+
|
|
19
|
+
| Title | Description | Impact / Hazard | Discovery (Date, How, By Whom) | Proposed Correction | Justification for Delay | Timeline |
|
|
20
|
+
|------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------------|------------------------------------|-----------------------------------------------------------------------------------------------------------------|----------------------|
|
|
21
|
+
| Default language | If the app is installed on a smartphone with unsupported language, the default language is German. Users then have to navigate to the language settings for changes. | Users in countries with unsupported language are likely not German-speaking and may not be able to use the app without changing language settings. | 2022-04-01 during usability testing by Product Manager | Change default language to English | Per appstore setting, the app is currently only available in countries whose predominant language is supported. | Next version release |
|
|
22
|
+
| (...) | (...) | (...) | (...) | (...) | (...) | (...) |
|
|
23
|
+
|
|
24
|
+
---
|
|
25
|
+
|
|
26
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
27
|
+
license](https://openregulatory.com/template-license).
|
|
28
|
+
|
|
29
|
+
Please don't remove this notice even if you've modified contents of this template.
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
> DISCLAIMER:
|
|
2
|
+
>
|
|
3
|
+
> You may not need this template. It's aimed companies that develop devices including ML algorithms. Why do
|
|
4
|
+
> they need this template?
|
|
5
|
+
>
|
|
6
|
+
> Due to the "blackbox" nature of many of those algorithms, their functionalities typically can't be verified
|
|
7
|
+
> in the same sense as code reviews can verify correct coding in the world of old-school software
|
|
8
|
+
> development. That's why they can only be validated by subjecting the model to rigorous testing on separate
|
|
9
|
+
> test datasets. This report is the place to document all the results (e.g. sensitivity, specificity,
|
|
10
|
+
> accuracy, ROC curve values, discussion of outlayers, edge cases, etc.). Side note: there's a disconnect
|
|
11
|
+
> between what data science and regulatory affairs understands as validation and verification. Don't get
|
|
12
|
+
> confused!
|
|
13
|
+
|
|
14
|
+
# 1. General Information
|
|
15
|
+
|
|
16
|
+
This document describes the specification of our machine learning (algorithm) model and its testing strategy.
|
|
17
|
+
|
|
18
|
+
> Keep in mind that the results of the algorithm validation should also serve as input to and be referenced in
|
|
19
|
+
> your clinical evaluation / performance evaluation report.
|
|
20
|
+
|
|
21
|
+
**Regulatory references:**
|
|
22
|
+
|
|
23
|
+
| ISO 13485:2016 Section | Document Section |
|
|
24
|
+
|--------------------------|------------------|
|
|
25
|
+
| 6.2; 7.3.2 | 2.1 |
|
|
26
|
+
| 7.3.7 | 2.3; 3.1; 3.2 |
|
|
27
|
+
| 4.2.3; 5.2; 7.2.1; 7.3.3 | 2.4 |
|
|
28
|
+
| 4.1; 7.3.6 | 3 |
|
|
29
|
+
| 7.3.2; 7.3.6; 7.3.7 | 5 |
|
|
30
|
+
|
|
31
|
+
| ISO 14971:2019 Section | Document Section |
|
|
32
|
+
|------------------------|------------------|
|
|
33
|
+
| 4.3 | 2.1 |
|
|
34
|
+
| 5.2 | 2.4 |
|
|
35
|
+
|
|
36
|
+
| ISO 82304:2016 Section | Document Section |
|
|
37
|
+
|------------------------|------------------|
|
|
38
|
+
| 6.1 | 2.1 |
|
|
39
|
+
|
|
40
|
+
| ISO 62366-1:2015 Section | Document Section |
|
|
41
|
+
|--------------------------|------------------|
|
|
42
|
+
| 5.1; 5.2 | 2.4 |
|
|
43
|
+
|
|
44
|
+
| ISO 62304:2006 Section | Document Section |
|
|
45
|
+
|------------------------|------------------|
|
|
46
|
+
| 5.3; 8.1.2 | 2.2 |
|
|
47
|
+
| 5.2 | 2.4 |
|
|
48
|
+
|
|
49
|
+
| ISO/IEC 24028:2020 Section | Document Section |
|
|
50
|
+
|----------------------------|------------------|
|
|
51
|
+
| 9.8.1; 10.5 | 3.1; 3.2 |
|
|
52
|
+
| 9.8.2.1 | 3.2 |
|
|
53
|
+
| 9.8.2.2 | 4 |
|
|
54
|
+
|
|
55
|
+
**Relevant other documentation:**
|
|
56
|
+
|
|
57
|
+
* SOP Software Development
|
|
58
|
+
* Software Development and Maintenance Plan
|
|
59
|
+
* SOUP List
|
|
60
|
+
|
|
61
|
+
# 2. Development Resources
|
|
62
|
+
|
|
63
|
+
For more context information, refer to the device’s software development and maintenance plan.
|
|
64
|
+
|
|
65
|
+
## 2.1. Developer Team
|
|
66
|
+
|
|
67
|
+
| Name | Role | Qualification |
|
|
68
|
+
|-------|-------|---------------|
|
|
69
|
+
| (...) | (...) | (...) |
|
|
70
|
+
|
|
71
|
+
## 2.2. SOUP / Frameworks
|
|
72
|
+
|
|
73
|
+
| Name | Version |
|
|
74
|
+
|---------|---------|
|
|
75
|
+
| PyTorch | (...) |
|
|
76
|
+
|
|
77
|
+
## 2.3. Data
|
|
78
|
+
|
|
79
|
+
| Count | Description |
|
|
80
|
+
|-------|-------------------------------------------------------|
|
|
81
|
+
| | \<e.g. annotated heart rate dataset from a wearable\> |
|
|
82
|
+
|
|
83
|
+
## 2.4. Development Planning
|
|
84
|
+
|
|
85
|
+
Optional: remove or add to the following sub-paragraphs as appropriate.
|
|
86
|
+
|
|
87
|
+
**Intended Purpose**
|
|
88
|
+
|
|
89
|
+
> Reference intended use; describe intended task the model should solve.
|
|
90
|
+
|
|
91
|
+
(...)
|
|
92
|
+
|
|
93
|
+
**Clinical Environment**
|
|
94
|
+
|
|
95
|
+
> Reference clinical evaluation plan; describe clinical context in which the model will be used.
|
|
96
|
+
|
|
97
|
+
(...)
|
|
98
|
+
|
|
99
|
+
**Software Architecture**
|
|
100
|
+
|
|
101
|
+
> Reference software architecture (diagram); describe how the model will be embedded in the overall system and
|
|
102
|
+
> how it will interact with other software components.
|
|
103
|
+
|
|
104
|
+
(...)
|
|
105
|
+
|
|
106
|
+
**Quality Requirements**
|
|
107
|
+
|
|
108
|
+
> Reference clinical evaluation plan; describe quality criteria that shall apply to the model, for example,
|
|
109
|
+
> quantify values for sensitivity / specificity, AUC, positive/negative predictive value, accuracy,
|
|
110
|
+
> repeatability. Also, provide justification for why certain parameters may not apply and compare your
|
|
111
|
+
> approach to the current state of the art / technology.
|
|
112
|
+
|
|
113
|
+
(...)
|
|
114
|
+
|
|
115
|
+
# 3. Data Management
|
|
116
|
+
|
|
117
|
+
## 3.1. Data Acquisition
|
|
118
|
+
|
|
119
|
+
> Describe how you acquired your data (sources, inclusion / exclusion criteria, possible biases, data
|
|
120
|
+
> protection measures, etc). Give a rough estimate of what size of datasets are required.
|
|
121
|
+
>
|
|
122
|
+
> If applicable, reference relevant QMS processes.
|
|
123
|
+
|
|
124
|
+
(...)
|
|
125
|
+
|
|
126
|
+
## 3.2. Data Annotation
|
|
127
|
+
|
|
128
|
+
> Describe how data is labeled and how you determined the ground truth. Further, you can describe: labeling
|
|
129
|
+
> requirements (quality criteria), qualification / training of staff involved, quality assurance for correct
|
|
130
|
+
> labeling. If applicable, reference relevant QMS processes.
|
|
131
|
+
|
|
132
|
+
(...)
|
|
133
|
+
|
|
134
|
+
## 3.3. Data Pre-Processing
|
|
135
|
+
|
|
136
|
+
> Describe how you pre-processed data. Possible steps may include: anonymization / pseudonymization, removing
|
|
137
|
+
> data elements, converting data formats or units, handling missing values or data outliers. How did you
|
|
138
|
+
> divide data into training, validation and test data. If applicable, reference relevant QMS processes.
|
|
139
|
+
|
|
140
|
+
(...)
|
|
141
|
+
|
|
142
|
+
# 4. Algorithm Model Training and Description
|
|
143
|
+
|
|
144
|
+
> Describe your algorithm model. For example: which type of model (e.g. CNN) is used? Optionally, add a graph
|
|
145
|
+
> or diagram to explain the model architecture. Describe model training; e.g. selection of features, (most
|
|
146
|
+
> important) hyperparameters, etc.
|
|
147
|
+
|
|
148
|
+
(...)
|
|
149
|
+
|
|
150
|
+
# 5. Algorithm Model Evaluation
|
|
151
|
+
|
|
152
|
+
> Describe how testing is done: describe your test data set, which metrics are used for evaluation and which
|
|
153
|
+
> values are deemed acceptable.
|
|
154
|
+
|
|
155
|
+
(...)
|
|
156
|
+
|
|
157
|
+
# 6. Conclusion
|
|
158
|
+
|
|
159
|
+
> Discuss your evaluation results: why do they meet predefined quality criteria, why is the model fit for
|
|
160
|
+
> purpose in accordance with the medical device’s intended use? Take into account possible risks, biases and
|
|
161
|
+
> limitations.
|
|
162
|
+
|
|
163
|
+
(...)
|
|
164
|
+
|
|
165
|
+
---
|
|
166
|
+
|
|
167
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
168
|
+
license](https://openregulatory.com/template-license).
|
|
169
|
+
|
|
170
|
+
Please don't remove this notice even if you've modified contents of this template.
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Checklist: Software Release
|
|
2
|
+
|
|
3
|
+
| Classes | IEC 62304:2006 Section | Document Section |
|
|
4
|
+
| ------- | ---------------------- | ---------------- |
|
|
5
|
+
| A, B, C | 5.8.1 | (All) |
|
|
6
|
+
| A, B, C | 5.8.2 | (All) |
|
|
7
|
+
| A, B, C | 5.8.3 | (All) |
|
|
8
|
+
| A, B, C | 5.8.4 | (All) |
|
|
9
|
+
| B, C | 5.8.5 | (All) |
|
|
10
|
+
| B, C | 5.8.6 | (All) |
|
|
11
|
+
| A, B, C | 5.8.7 | (All) |
|
|
12
|
+
|
|
13
|
+
## Summary
|
|
14
|
+
|
|
15
|
+
This checklist is used to verify that documentation and activities are complete before releasing a new version of the product.
|
|
16
|
+
|
|
17
|
+
> As with all regulatory documents, it's more about the content than about the tool. You don't have to fill this checklist out every time in Word / GDocs / etc., but could embed it in your Jira / GitHub workflow. The main point is that, at minimum, the items below should be checked (and documented) before you release a new version of your software.
|
|
18
|
+
|
|
19
|
+
> Feel free to add further rows in the checklist if they make sense for your company. This template is pretty much the bare minimum to be 62304-compliant.
|
|
20
|
+
|
|
21
|
+
## Checklist
|
|
22
|
+
|
|
23
|
+
The following documents are up to date:
|
|
24
|
+
|
|
25
|
+
> The table below shows examples only. Add - or reference - a list of all your required TechDoc records.
|
|
26
|
+
|
|
27
|
+
| Item | Yes | No | Comment |
|
|
28
|
+
| ---- | --- | --- | ------- |
|
|
29
|
+
| Device Description | | | |
|
|
30
|
+
| Clinical Evaluation | | | |
|
|
31
|
+
| Declaration of Conformity | | | |
|
|
32
|
+
| (...) | | | |
|
|
33
|
+
|
|
34
|
+
The following activities have been performed:
|
|
35
|
+
|
|
36
|
+
| Item | Yes | No | Comment |
|
|
37
|
+
| ---- | --- | --- | ------- |
|
|
38
|
+
| All relevant functionalities of the software have been specified; the Software Requirement List is complete and has been reviewed. | | | |
|
|
39
|
+
| All relevant risks (including risks of known anomalies) have been evaluated; the Risk Management Report is complete. | | | |
|
|
40
|
+
| Verification (as software system testing) has been completed. | | | |
|
|
41
|
+
| Design control traceability is ensured:<br>Stakeholder requirements can be traced to software requirements.<br>Software requirements can be traced to system tests.<br>Software requirements can be traced to software code implementation / software code reviews.<br>Software requirements can be traced to risks and risk control measures.<br>Stakeholder requirements can be traced to usability tests.<br>Hazard-related use scenarios can be traced to usability tests.<br>Hazard-related use scenarios can be traced to risks and risk control measures. | | | |
|
|
42
|
+
| A version number as defined in the Software Development Plan has been assigned and added as a tag to git. | | | |
|
|
43
|
+
| Software is registered with a Notified Body. | | | |
|
|
44
|
+
| If release includes substantial change: Notified Body has been informed. | | | |
|
|
45
|
+
| Label is applied correctly including CE marking. | | | |
|
|
46
|
+
|
|
47
|
+
---
|
|
48
|
+
|
|
49
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
50
|
+
license](https://openregulatory.com/template-license).
|
|
51
|
+
|
|
52
|
+
Please don't remove this notice even if you've modified contents of this template.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Checklist: Software Requirements Review
|
|
2
|
+
|
|
3
|
+
| Classes | IEC 62304:2006 Section | Document Section |
|
|
4
|
+
|---------|------------------------|------------------|
|
|
5
|
+
| A, B, C | 5.2.6 | (All) |
|
|
6
|
+
|
|
7
|
+
| ISO 13485:2016 Section | Document Section |
|
|
8
|
+
|------------------------|------------------|
|
|
9
|
+
| 7.3.3 | (All) |
|
|
10
|
+
| 7.3.5 | (All) |
|
|
11
|
+
|
|
12
|
+
## 1. Summary
|
|
13
|
+
|
|
14
|
+
This checklist is used to review (verify) software requirements prior to implementation.
|
|
15
|
+
|
|
16
|
+
> As with all regulatory documents, it's more about the content than about the tool. You don't have to fill
|
|
17
|
+
> this checklist out every time in Word / GDocs / etc., but could embed it in your Jira / GitHub workflow. The
|
|
18
|
+
> main point is that, at minimum, the items below should be filled out before you start implementing software
|
|
19
|
+
> requirements.
|
|
20
|
+
|
|
21
|
+
> Feel free to add further rows in the checklist if they make sense for your company. This template is pretty
|
|
22
|
+
> much the bare minimum to be 62304-compliant.
|
|
23
|
+
|
|
24
|
+
## 2. Checklist
|
|
25
|
+
|
|
26
|
+
| Software Requirements... | Yes | No | Comment |
|
|
27
|
+
|-------------------------------------------------------------------------------|-----|----|---------|
|
|
28
|
+
| are traceable to design input or risk control measures. | | | |
|
|
29
|
+
| are complete. | | | |
|
|
30
|
+
| are understandable, uniquely identifiable and do not contradict each other. | | | |
|
|
31
|
+
| include user interface requirements (mockups, wireframes, etc.), if relevant. | | | |
|
|
32
|
+
| include IT security requirements, if relevant. | | | |
|
|
33
|
+
| are testable and include acceptance criteria. | | | |
|
|
34
|
+
|
|
35
|
+
# 3. Comments
|
|
36
|
+
|
|
37
|
+
\<Insert comments if applicable\>
|
|
38
|
+
|
|
39
|
+
# 4. Result
|
|
40
|
+
|
|
41
|
+
[ ] Software Requirements passed\
|
|
42
|
+
[ ] Software Requirements not passed\
|
|
43
|
+
[ ] Software Requirements passed with the following obligations: \<Insert if applicable\>\
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
48
|
+
license](https://openregulatory.com/template-license).
|
|
49
|
+
|
|
50
|
+
Please don't remove this notice even if you've modified contents of this template.
|
package/vendor/dev-docs-templates/templates/mdr_docs/ER/sprint/software-architecture-checklist.md
ADDED
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Software Architecture Checklist
|
|
2
|
+
|
|
3
|
+
**Regulatory references:**
|
|
4
|
+
|
|
5
|
+
IEC 62304, para. 5.3.6 [class B, C]
|
|
6
|
+
|
|
7
|
+
**Relevant other documentation:**
|
|
8
|
+
|
|
9
|
+
* SOP Software Development
|
|
10
|
+
* User needs / stakeholder requirements
|
|
11
|
+
* Design input / software requirements
|
|
12
|
+
* Software architecture description
|
|
13
|
+
* (...)
|
|
14
|
+
|
|
15
|
+
# 1. Checklist
|
|
16
|
+
|
|
17
|
+
| Criteria | Pass / Fail |
|
|
18
|
+
|----------------------------------------------------------------------------------------------------------|-------------------------|
|
|
19
|
+
| The software architecture is in agreement with the software requirements. | ( ) Yes<br>( ) Improve: |
|
|
20
|
+
| All software systems are listed and their respective safety class is stated. | ( ) Yes<br>( ) Improve: |
|
|
21
|
+
| All software components are listed and described, including interfaces. | ( ) Yes<br>( ) Improve: |
|
|
22
|
+
| All software units are listed and described. | ( ) Yes<br>( ) Improve: |
|
|
23
|
+
| (Optional) Further architecture is described, e.g. databases, security and data protection requirements. | ( ) Yes<br>( ) Improve: |
|
|
24
|
+
| The software architecture can be implemented with our given resources. | ( ) Yes<br>( ) Improve: |
|
|
25
|
+
|
|
26
|
+
# 2. Comments
|
|
27
|
+
|
|
28
|
+
\<Insert comments if applicable\>
|
|
29
|
+
|
|
30
|
+
# 3. Results
|
|
31
|
+
|
|
32
|
+
( ) Software Architecture passed\
|
|
33
|
+
( ) Software Architecture not passed\
|
|
34
|
+
( ) Software Architecture passed with the following obligations: \<Insert if applicable\>\
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
39
|
+
license](https://openregulatory.com/template-license).
|
|
40
|
+
|
|
41
|
+
Please don't remove this notice even if you've modified contents of this template.
|