@neobiotechlabs/neobiotech-dev-agent-codex 0.1.39
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/.codex-plugin/plugin.json +36 -0
- package/.mcp.json +20 -0
- package/data/cyber_sec.png +0 -0
- package/data/hazard_panel.png +0 -0
- package/data/review-criteria.md +185 -0
- package/data/risk_score.png +0 -0
- package/dist/build/plantuml-1.2026.1.jar +0 -0
- package/dist/data/Courier-Bold.afm +342 -0
- package/dist/data/Courier-BoldOblique.afm +342 -0
- package/dist/data/Courier-Oblique.afm +342 -0
- package/dist/data/Courier.afm +342 -0
- package/dist/data/Helvetica-Bold.afm +2827 -0
- package/dist/data/Helvetica-BoldOblique.afm +2827 -0
- package/dist/data/Helvetica-Oblique.afm +3051 -0
- package/dist/data/Helvetica.afm +3051 -0
- package/dist/data/Symbol.afm +213 -0
- package/dist/data/Times-Bold.afm +2588 -0
- package/dist/data/Times-BoldItalic.afm +2384 -0
- package/dist/data/Times-Italic.afm +2667 -0
- package/dist/data/Times-Roman.afm +2419 -0
- package/dist/data/ZapfDingbats.afm +225 -0
- package/dist/data/sRGB_IEC61966_2_1.icc +0 -0
- package/dist/doctor.js +15106 -0
- package/dist/doctor.js.map +1 -0
- package/dist/fonts/LICENSE.txt +94 -0
- package/dist/fonts/Pretendard-Bold.ttf +0 -0
- package/dist/fonts/Pretendard-Regular.ttf +0 -0
- package/dist/index.js +185999 -0
- package/dist/index.js.map +1 -0
- package/dist/setup-codex.js +164 -0
- package/dist/setup-codex.js.map +1 -0
- package/package.json +34 -0
- package/skills/doc-render/SKILL.md +84 -0
- package/skills/role-document-content-reviewer/SKILL.md +68 -0
- package/skills/role-mdr-cybersecurity-reviewer/SKILL.md +47 -0
- package/skills/role-mdr-regulatory-architect/SKILL.md +48 -0
- package/skills/role-requirement-coverage-tracker/SKILL.md +108 -0
- package/skills/role-sw-architect/SKILL.md +61 -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-detailed-design.md +321 -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-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/configuration-management-plan.md +112 -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/security-management-plan.md +101 -0
- package/vendor/dev-docs-templates/templates/mdr_docs/PA/software-development-maintenance-plan.md +213 -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
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
# Software Requirements List (SRS): {PRODUCT_NAME}
|
|
2
|
+
|
|
3
|
+
<!-- AI AGENT 작성 지침
|
|
4
|
+
이 문서는 IEC 62304 Cl.5.2 기반 SW 요구사항 명세서입니다.
|
|
5
|
+
A/B/C 전체 등급에서 필수 산출물입니다.
|
|
6
|
+
|
|
7
|
+
작성 전 반드시 다음 문서를 참조하세요:
|
|
8
|
+
- 시스템 요구사항 명세서(system-requirements-spec.md): 시스템 요구사항 및 SRS로 분해할 항목 확인
|
|
9
|
+
- 사용 목적 정의서(intended-use.md): 의도된 사용자, 사용 환경 확인
|
|
10
|
+
- FMEA(risk-table-fmea.md): 위험 통제 조치(Risk Control Measure)가 SRS에 반영되었는지 확인
|
|
11
|
+
|
|
12
|
+
작성 지침:
|
|
13
|
+
1. 모든 요구사항에 고유 ID를 부여하세요 (예: SRS-F-001, SRS-S-001)
|
|
14
|
+
2. IEC 62304 카테고리를 정확히 분류하세요:
|
|
15
|
+
- Functional (기능 요구사항)
|
|
16
|
+
- Performance (성능 요구사항)
|
|
17
|
+
- User Interface (사용자 인터페이스)
|
|
18
|
+
- Security (보안 요구사항)
|
|
19
|
+
- Interface (외부 인터페이스)
|
|
20
|
+
- Regulatory (규제 준수 요구사항)
|
|
21
|
+
3. 보안 요구사항(IEC 81001-5-1)은 Security 카테고리로 반드시 포함하세요
|
|
22
|
+
4. 위험 통제 조치(Risk Control Measure)를 요구사항으로 추가할 때는
|
|
23
|
+
Risk Control Measure 열을 Yes로 표시하고 FMEA의 Risk ID를 연결하세요
|
|
24
|
+
5. 각 요구사항은 독립적으로 검증 가능해야 합니다 (Verifiable)
|
|
25
|
+
|
|
26
|
+
예시 요구사항 ID 체계:
|
|
27
|
+
SRS-F-001: 기능 요구사항 #001
|
|
28
|
+
SRS-P-001: 성능 요구사항 #001
|
|
29
|
+
SRS-UI-001: 사용자 인터페이스 요구사항 #001
|
|
30
|
+
SRS-S-001: 보안 요구사항 #001
|
|
31
|
+
SRS-I-001: 인터페이스 요구사항 #001
|
|
32
|
+
SRS-R-001: 규제 요구사항 #001
|
|
33
|
+
-->
|
|
34
|
+
|
|
35
|
+
**문서 번호**: {DOC_ID}
|
|
36
|
+
**버전**: {VERSION} | **상태**: Draft
|
|
37
|
+
**작성일**: {DATE} | **작성자**: {AUTHOR}
|
|
38
|
+
**검토자**: {REVIEWER} | **승인자**: {APPROVER}
|
|
39
|
+
|
|
40
|
+
---
|
|
41
|
+
|
|
42
|
+
## 표준 요건 매핑 (Standard Requirements Mapping)
|
|
43
|
+
|
|
44
|
+
| 표준 조항 | 제목 | 해당 섹션 | Class |
|
|
45
|
+
| -------------------- | --------------------------- | ---------------- | ------- |
|
|
46
|
+
| IEC 62304 Cl.5.2.1 | SW 요구사항 정의 | 1~3 | A, B, C |
|
|
47
|
+
| IEC 62304 Cl.5.2.2 | SW 요구사항 내용 | 1~3 | A, B, C |
|
|
48
|
+
| IEC 62304 Cl.5.2.3 | SW 요구사항 검토 | 전체 | A, B, C |
|
|
49
|
+
| IEC 62366-1 Cl.5.2 | 사용 오류 관련 UI 특성 식별 | 2. UI 요구사항 | - |
|
|
50
|
+
| IEC 62366-1 Cl.5.6 | 사용자 인터페이스 사양 | 2. UI 요구사항 | - |
|
|
51
|
+
| IEC 81001-5-1 Cl.5.2 | 보안 요구사항 | 3. 보안 요구사항 | - |
|
|
52
|
+
| MDR Annex I 17.2 | IT 보안 고려 | 3. 보안 요구사항 | - |
|
|
53
|
+
| ISO 13485 Cl.7.2.1 | 고객 관련 프로세스 | 전체 | - |
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## 1. 기능 및 성능 요구사항 (Functional & Performance Requirements)
|
|
58
|
+
|
|
59
|
+
<!-- AI AGENT: 시스템 요구사항 명세서의 SYS-F-xxx 항목을 SW 수준으로 분해하여 작성하세요
|
|
60
|
+
각 요구사항은 "SW는 [조건]에서 [동작]을 [기준]으로 수행해야 한다" 형식으로 작성하면 좋습니다
|
|
61
|
+
|
|
62
|
+
예시:
|
|
63
|
+
- SRS-F-001: 사용자가 로그인 후 대시보드를 요청할 경우, 시스템은 3초 이내에 결과를 반환해야 한다.
|
|
64
|
+
- SRS-P-001: 시스템은 동시 사용자 100명 이상을 처리할 수 있어야 한다. -->
|
|
65
|
+
|
|
66
|
+
| ID | SW 시스템 | 카테고리 | 요구사항 설명 | 위험 통제 조치? | 관련 Risk ID | 검증 방법 |
|
|
67
|
+
| --------- | ----------- | ----------- | --------------------------------- | --------------- | ------------ | ---------------- |
|
|
68
|
+
| SRS-F-001 | {SW_SYSTEM} | Functional | {REQ_DESC} | Yes / No | {RISK_ID} | System Test |
|
|
69
|
+
| SRS-P-001 | {SW_SYSTEM} | Performance | 시스템은 {N}초 이내 응답해야 한다 | No | - | Performance Test |
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 2. 사용자 인터페이스 요구사항 (User Interface Requirements)
|
|
74
|
+
|
|
75
|
+
<!-- AI AGENT: IEC 62366-1 관점에서 사용 오류(Use Error)를 방지하는 UI 요구사항을 작성하세요
|
|
76
|
+
다음 항목을 고려하세요:
|
|
77
|
+
- 위험 관련 정보의 가시성 (색상, 크기, 위치)
|
|
78
|
+
- 사용자 확인(Confirmation) 절차가 필요한 위험 동작
|
|
79
|
+
- 오류 메시지의 명확성
|
|
80
|
+
|
|
81
|
+
예시:
|
|
82
|
+
- SRS-UI-001: 위험 등급 HIGH 결과는 빨간색 배경과 경고 아이콘으로 표시해야 한다.
|
|
83
|
+
- SRS-UI-002: 데이터 삭제 동작 전 사용자 확인(Confirmation Dialog)을 표시해야 한다. -->
|
|
84
|
+
|
|
85
|
+
| ID | SW 시스템 | 카테고리 | 요구사항 설명 | 위험 통제 조치? | 관련 Risk ID | 검증 방법 |
|
|
86
|
+
| ---------- | ----------- | -------------- | ------------- | --------------- | ------------ | -------------- |
|
|
87
|
+
| SRS-UI-001 | {SW_SYSTEM} | User Interface | {UI_REQ_DESC} | Yes / No | {RISK_ID} | Usability Test |
|
|
88
|
+
|
|
89
|
+
---
|
|
90
|
+
|
|
91
|
+
## 3. 보안 요구사항 (Security Requirements)
|
|
92
|
+
|
|
93
|
+
<!-- AI AGENT: MDR Annex I 17.2 및 IEC 81001-5-1 기준으로 사이버보안 요구사항을 작성하세요
|
|
94
|
+
다음 항목을 필수로 포함하세요:
|
|
95
|
+
- 인증 및 접근 제어
|
|
96
|
+
- 데이터 암호화 (전송/저장)
|
|
97
|
+
- 감사 로그
|
|
98
|
+
- 취약점 패치 정책
|
|
99
|
+
|
|
100
|
+
예시:
|
|
101
|
+
- SRS-S-001: 시스템은 모든 사용자 세션에 JWT 기반 인증을 적용해야 한다 (exp: 1시간).
|
|
102
|
+
- SRS-S-002: 모든 API 통신은 TLS 1.2 이상을 사용해야 한다.
|
|
103
|
+
- SRS-S-003: 로그인 실패 5회 이상 시 계정을 30분간 잠금 처리해야 한다. -->
|
|
104
|
+
|
|
105
|
+
| ID | SW 시스템 | 카테고리 | 요구사항 설명 | 위험 통제 조치? | 관련 Risk ID | 검증 방법 |
|
|
106
|
+
| --------- | ----------- | -------- | -------------------------------------------------- | --------------- | ------------ | ------------- |
|
|
107
|
+
| SRS-S-001 | All | Security | 모든 사용자 인증은 {AUTH_METHOD}을 사용해야 한다 | Yes | {RISK_ID} | Security Test |
|
|
108
|
+
| SRS-S-002 | All | Security | 모든 API 통신은 TLS 1.2 이상을 사용해야 한다 | Yes | {RISK_ID} | Security Test |
|
|
109
|
+
| SRS-S-003 | {SW_SYSTEM} | Security | 환자 데이터는 AES-256으로 암호화하여 저장해야 한다 | Yes | {RISK_ID} | Security Test |
|
|
110
|
+
|
|
111
|
+
---
|
|
112
|
+
|
|
113
|
+
## 4. 인터페이스 요구사항 (Interface Requirements)
|
|
114
|
+
|
|
115
|
+
<!-- AI AGENT: 시스템 요구사항 명세서의 SYS-I-xxx 항목을 SW 수준으로 구체화하세요
|
|
116
|
+
외부 시스템(EHR, PACS, DICOM 서버 등)과의 연동 사양을 포함하세요 -->
|
|
117
|
+
|
|
118
|
+
| ID | SW 시스템 | 카테고리 | 요구사항 설명 | 위험 통제 조치? | 관련 Risk ID | 검증 방법 |
|
|
119
|
+
| --------- | --------- | --------- | ------------------------------------------------------- | --------------- | ------------ | ---------------- |
|
|
120
|
+
| SRS-I-001 | Backend | Interface | 시스템은 {EXTERNAL_SYSTEM}과 {PROTOCOL}로 연동해야 한다 | No | - | Integration Test |
|
|
121
|
+
|
|
122
|
+
---
|
|
123
|
+
|
|
124
|
+
## 5. 규제 준수 요구사항 (Regulatory Compliance Requirements)
|
|
125
|
+
|
|
126
|
+
<!-- AI AGENT: MDR 및 적용 표준에서 요구하는 SW 준수 사항을 명시하세요 -->
|
|
127
|
+
|
|
128
|
+
| ID | SW 시스템 | 카테고리 | 요구사항 설명 | 근거 표준 | 검증 방법 |
|
|
129
|
+
| --------- | --------- | ---------- | -------------------------------------------------------- | --------- | --------------- |
|
|
130
|
+
| SRS-R-001 | All | Regulatory | SW는 IEC 62304:2006/AMD1:2015를 준수하여 개발되어야 한다 | IEC 62304 | Document Review |
|
|
131
|
+
| SRS-R-002 | All | Regulatory | SW는 ISO 14971:2019에 따른 위험 관리를 수행해야 한다 | ISO 14971 | Document Review |
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## 6. 추적성 (Traceability)
|
|
136
|
+
|
|
137
|
+
이 문서의 요구사항은 다음 문서와 연결된다:
|
|
138
|
+
|
|
139
|
+
| 연결 방향 | 연결 문서 |
|
|
140
|
+
| ----------------- | --------------------------------------------------------- |
|
|
141
|
+
| 입력 (Input from) | 시스템 요구사항 명세서 (system-requirements-spec.md) |
|
|
142
|
+
| 입력 (Input from) | FMEA 위험 통제 조치 (risk-table-fmea.md) |
|
|
143
|
+
| 출력 (Input for) | SW 아키텍처 설계서 (software-architecture-description.md) |
|
|
144
|
+
| 출력 (Input for) | 시스템 테스트 계획서 (software-system-test-plan.md) |
|
|
145
|
+
|
|
146
|
+
---
|
|
147
|
+
|
|
148
|
+
## 7. 변경 이력 (Revision History)
|
|
149
|
+
|
|
150
|
+
| 버전 | 날짜 | 작성자 | 변경 내용 |
|
|
151
|
+
| ---- | ------ | -------- | --------- |
|
|
152
|
+
| 0.1 | {DATE} | {AUTHOR} | 초안 작성 |
|
|
153
|
+
|
|
154
|
+
---
|
|
155
|
+
|
|
156
|
+
> Template based on IEC 62304:2006/AMD1:2015 Clausee 5.2, IEC 81001-5-1, MDR 2017/745 Annex I
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
# SOUP List (Software of Unknown Provenance)
|
|
2
|
+
|
|
3
|
+
<!-- AI AGENT 작성 지침
|
|
4
|
+
이 문서는 IEC 62304 Cl.8.1.2 기반 SOUP 목록입니다. EA 단계에서 초안 작성 후 매 Sprint 업데이트합니다.
|
|
5
|
+
|
|
6
|
+
작성 전 반드시 다음 문서를 참조하세요:
|
|
7
|
+
- SW 아키텍처 설계서(software-architecture-description.md): SOUP 격리 전략 확인
|
|
8
|
+
- 프로젝트 requirements.txt / package.json: 실제 사용 라이브러리 목록 확인
|
|
9
|
+
|
|
10
|
+
작성 지침:
|
|
11
|
+
1. SOUP ID 체계: SOUP-{N:3d} (예: SOUP-001)
|
|
12
|
+
2. 프로젝트에서 실제 사용하는 모든 서드파티 라이브러리/프레임워크를 포함하세요
|
|
13
|
+
(직접 의존성 + 주요 간접 의존성)
|
|
14
|
+
3. 위험 등급 판단 기준:
|
|
15
|
+
- Low: 고장 시 환자 위해 없음 (로깅, UI 유틸리티 등)
|
|
16
|
+
- Medium: 고장 시 가역적 위해 가능 (데이터 처리 라이브러리 등)
|
|
17
|
+
- High: 고장 시 비가역적 위해 가능 (인증, 암호화, 진단 알고리즘 라이브러리 등)
|
|
18
|
+
4. CVE 취약점은 최소 6개월마다 검토하고 "Last verified at" 날짜를 업데이트하세요
|
|
19
|
+
(SOP Integrated Software Development 참조)
|
|
20
|
+
5. IEC 81001-5-1 관점: 보안 관련 SOUP(인증, 암호화 등)는 Known Anomalies를 반드시 확인하세요
|
|
21
|
+
|
|
22
|
+
SOUP 추가 체크리스트 (신규 추가 시):
|
|
23
|
+
[ ] 버전 고정 (pinned version) 여부 확인
|
|
24
|
+
[ ] CVE 데이터베이스 조회 (https://nvd.nist.gov)
|
|
25
|
+
[ ] 라이선스 호환성 확인
|
|
26
|
+
[ ] SBOM(Software Bill of Materials) 업데이트
|
|
27
|
+
[ ] SAD의 SOUP 격리 전략 섹션에 반영
|
|
28
|
+
-->
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
> The 62304 requires you to document your SOUP, which is short for Software of Unknown Provenance. In human
|
|
32
|
+
> language, those are the third-party libraries you're using in your code, typically in your
|
|
33
|
+
> `requirements.txt` or `Gemfile`.
|
|
34
|
+
|
|
35
|
+
| Classes | IEC 62304:2006 Section | Document Section |
|
|
36
|
+
| ------- | ----------------------------------------------- | ---------------- |
|
|
37
|
+
| B, C | 5.3.3 (Functional and Performance Requirements) | 2 |
|
|
38
|
+
| B, C | 5.3.4 (Hardware and Software Requirements) | 2 |
|
|
39
|
+
| B, C | 7.1.2 (Hazardous Situations) | 2 |
|
|
40
|
+
| B, C | 7.1.3 (SOUP Anomaly Lists) | 2 |
|
|
41
|
+
| A, B, C | 8.1.2 (Identify SOUP) | 2 |
|
|
42
|
+
|
|
43
|
+
## 1 Risk Level Definitions
|
|
44
|
+
|
|
45
|
+
> The 62304 requires you to assess risks associated with SOUP. The simplest way to do this is to classify each
|
|
46
|
+
> SOUP as a certain risk level. Unless you're developing software which shoots radiation at patients, it's
|
|
47
|
+
> likely that your SOUP risk levels remain "low" or "medium".
|
|
48
|
+
|
|
49
|
+
| Risk Level | Definition |
|
|
50
|
+
| ---------- | ---------------------------------------------------------- |
|
|
51
|
+
| Low | Malfunction in SOUP can't lead to patient harm. |
|
|
52
|
+
| Medium | Malfunction in SOUP can lead to reversible patient harm. |
|
|
53
|
+
| High | Malfunction in SOUP can lead to irreversible patient harm. |
|
|
54
|
+
|
|
55
|
+
## 2 SOUP List
|
|
56
|
+
|
|
57
|
+
> This is the actual SOUP list. For each third-party library you use, add an entry in the table below. The
|
|
58
|
+
> idea is to only have one "global" SOUP list for your medical device even though the code may actually live
|
|
59
|
+
> in multiple repositories. That's what the "software system" column is for; you could also mention your (git)
|
|
60
|
+
> repository there.
|
|
61
|
+
|
|
62
|
+
> When specifying requirements, the 62304 requires you to mention functional, performance, hard- and software
|
|
63
|
+
> requirements. However, you may not have to re-state certain requirements if they apply to all SOUP,
|
|
64
|
+
> e.g., "runs on Linux". So prefer to keep the requirements simple, in a way in which you would communicate them
|
|
65
|
+
> to colleagues on your development team when answering the question "why did we import this library?".
|
|
66
|
+
|
|
67
|
+
> As with all templates: It's more about the content (i.e., the columns you see below) than the tool (filling
|
|
68
|
+
> this out in Google sheets / markdown / wherever). Nobody says that you have to maintain this as a Google
|
|
69
|
+
> sheet. If you can find a way to integrate this in your workflow in a better way, e.g., in a markdown file in
|
|
70
|
+
> your git repository, go for it! Just keep in mind that you need to be able to export it to send it to
|
|
71
|
+
> auditors.
|
|
72
|
+
|
|
73
|
+
| ID | Software System | Package Name | Programming Language | Version | Website | Last verified at | Risk Level | Requirements | Verification Reasoning |
|
|
74
|
+
| --- | --------------- | ------------ | -------------------- | ------- | ------------------------------------------------ | ---------------- | ---------- | -------------------------- | --------------------------------------------------------------------------- |
|
|
75
|
+
| 1 | Mobile App | react-native | JavaScript | 0.61 | [Link](https://facebook.github.io/react-native/) | 23.10.2020 | Low | * Runs JS on Android / iOS | Commonly used, maintained by a large organisation, sufficient test coverage |
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
80
|
+
license](https://openregulatory.com/template-license).
|
|
81
|
+
|
|
82
|
+
Please don't remove this notice even if you've modified contents of this template.
|
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
# Usability Evaluation Plan
|
|
2
|
+
|
|
3
|
+
The Usability Evaluation Plan describes the Usability Evaluation activities and their required resources which
|
|
4
|
+
will be performed for the device.
|
|
5
|
+
|
|
6
|
+
## Mapping of Standard Requirements to Document Sections
|
|
7
|
+
|
|
8
|
+
| IEC 62366-1:2015 Section | Title | Document Section |
|
|
9
|
+
|--------------------------|-----------------------------------------------|------------------|
|
|
10
|
+
| 4.2 | Usability Engineering File | (all) |
|
|
11
|
+
| 4.3 | Tailoring of the Usability Engineering effort | (all) |
|
|
12
|
+
|
|
13
|
+
## 1. Relevant Processes
|
|
14
|
+
|
|
15
|
+
Usability Engineering and Evaluation activities are defined in the **SOP Integrated Software Development**.
|
|
16
|
+
|
|
17
|
+
## 2. Related Documents
|
|
18
|
+
|
|
19
|
+
* List of Hazard-Related Use Scenarios
|
|
20
|
+
* Usability Evaluation Report
|
|
21
|
+
|
|
22
|
+
## 3. Roles
|
|
23
|
+
|
|
24
|
+
| Title | Name(s) |
|
|
25
|
+
|-------------------------------------------------|---------|
|
|
26
|
+
| Head of Usability | |
|
|
27
|
+
| Context / Subject Matter Expert, e.g., physician | |
|
|
28
|
+
|
|
29
|
+
## 4. Formative Usability Evaluation
|
|
30
|
+
|
|
31
|
+
### 4.1 Methods
|
|
32
|
+
|
|
33
|
+
Formative Usability Evaluation is performed with the following methods:
|
|
34
|
+
|
|
35
|
+
* **Presentation of mockups or prototypes to subject matter experts:** E.g., by demonstrating the
|
|
36
|
+
functionality in an in-person or remote screen sharing session.
|
|
37
|
+
* **Feedback sessions with UX/UI experts:** Showing concepts, designs, mockups or prototypes to internal or
|
|
38
|
+
external UX/UI experts with the goal of gathering feedback on potential usability problems and
|
|
39
|
+
improvements.
|
|
40
|
+
* **User Tests:** Letting users of the intended target user group use the device based on a Usability
|
|
41
|
+
Evaluation protocol, observing them and documenting potential Usability problems. This is essentially the
|
|
42
|
+
same methods as the Summative Usability Evaluation, with the only difference being that it's being done on
|
|
43
|
+
a development (non-final, non-release) version of the device with the goal of gathering knowledge for
|
|
44
|
+
improving the final device.
|
|
45
|
+
|
|
46
|
+
### 4.2 Planning (Overview)
|
|
47
|
+
|
|
48
|
+
| Date | Description |
|
|
49
|
+
|------------|-------------------------------------------------------------------------------------------|
|
|
50
|
+
| 01.01.2021 | *Formative Evaluation 1*<br>(Description of methods incl. environment, participants etc.) |
|
|
51
|
+
|
|
52
|
+
## 5 Summative Usability Evaluation
|
|
53
|
+
|
|
54
|
+
### 5.1 Method
|
|
55
|
+
|
|
56
|
+
Summative Usability Evaluation is conducted by performing User Tests.
|
|
57
|
+
|
|
58
|
+
User Tests must comply with the following requirements:
|
|
59
|
+
|
|
60
|
+
* The user profile is the one specified in the Device Description.
|
|
61
|
+
* All Hazard-Related Use Scenarios must be covered by test cases (see IEC 62366, para. 5.7.3 / 5.9).
|
|
62
|
+
* Sufficient stakeholder requirements / user needs must be covered by test cases to ensure that the product
|
|
63
|
+
meets its intended use (see ISO 13485, para. 7.3.7)
|
|
64
|
+
* At least five test participants.
|
|
65
|
+
* The Usability Test Protocol must be filled out which descriptions of each use scenario and
|
|
66
|
+
instructions. It is also used to document the observations and discovered hazards.
|
|
67
|
+
|
|
68
|
+
The following requirements are optional:
|
|
69
|
+
|
|
70
|
+
* Usability Tests are recorded, e.g., video/audio (either in-person or remotely) and screen recording (of
|
|
71
|
+
phone / desktop computer)
|
|
72
|
+
|
|
73
|
+
Results of Summative Usability Evaluation are summarized in the Usability Evaluation Report, most importantly:
|
|
74
|
+
|
|
75
|
+
* Could all tasks in the Usability Test Protocol be achieved?
|
|
76
|
+
* If not, why?
|
|
77
|
+
* Which Use Errors occurred and could they lead to Hazardous Situations? --> Risk analysis of use errors
|
|
78
|
+
|
|
79
|
+
## 5.2 Planning (Setting)
|
|
80
|
+
|
|
81
|
+
#### Participants
|
|
82
|
+
|
|
83
|
+
#### Setting
|
|
84
|
+
|
|
85
|
+
#### Methods and Analysis
|
|
86
|
+
|
|
87
|
+
> Describe whether it's done in person or remotely and how you will document the results (have a protocol at
|
|
88
|
+
> the minimum), optionally also record the sessions.
|
|
89
|
+
>
|
|
90
|
+
> Also, describe how you plan to analyse the data.
|
|
91
|
+
|
|
92
|
+
## 5.3 Planning (Overview)
|
|
93
|
+
|
|
94
|
+
| Date | Description |
|
|
95
|
+
|------------|-------------------------------------------------------------------------------------------|
|
|
96
|
+
| 02.01.2021 | *Summative Evaluation 1*<br>(Description of methods incl. environment, participants etc.) |
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
Template Copyright [openregulatory.com](https://openregulatory.com). See [template
|
|
101
|
+
license](https://openregulatory.com/template-license).
|
|
102
|
+
|
|
103
|
+
Please don't remove this notice even if you've modified contents of this template.
|
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.
|