edc-retinopathy
Add a diabetic retinopathy screening form and REST API for integrating with a fundus camera in a clinicedc project.
A clinician creates an EyeExamRegister instance in the EDC before the exam. The camera software (fundus-camera-watchdog) resolves the subject, uploads eye images, DICOM files and reports, then checks status.
Requires django>=5.2,<6.1 and djangorestframework>=3.16.0
REST API
All endpoints use TokenAuthentication.
- GET /api/retinopathy/ping/
Health check. Returns {"status": "ok"}.
- POST /api/retinopathy/resolve/
Confirm a EyeExamRegister exists for a subject. Payload:
{"subject_identifier": "105-10-0001-2"}Returns 200 with eye_exam_register_id and uploaded list, or 404 if no session exists.
- POST /api/retinopathy/<subject_identifier>/<file_type>/
Upload a file. Multipart form with file, capture_datetime, and optional checksum (SHA-256). Valid file types:
left, right – eye images (JPEG/PNG)
left_dicom, right_dicom – DICOM files
left_report, right_report, report – reports (PDF/HTML)
Multiple files per type are accepted. Files are stored with their original filenames under <storage_dir>/images/<session_pk>/.
- GET /api/retinopathy/<subject_identifier>/status/
Session status: uploaded types, missing types, and whether the session is complete.
Models
- EyeExamRegister
Created by the clinician in the EDC. Links to RegisteredSubject and stores contra-indication screening fields, report type (combined / per-eye), and device ID.
- SessionFile
One record per uploaded file. Tracks file type, original filename, stored path, content type, size, SHA-256 checksum, and capture timestamp.
Settings
- EDC_RETINOPATHY_STORAGE_DIR
Base path for file storage. Must contain an images/ subdirectory.
- EDC_RETINOPATHY_MAX_FILE_SIZE_MB
Maximum upload size in MB (default: 10).
- EDC_RETINOPATHY_VISIT_DATETIME_FILTER
Datetime filter for Call List. If set, filters the list of subjects to those who attended AFTER the given datetime.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file edc_retinopathy-1.0.0.tar.gz.
File metadata
- Download URL: edc_retinopathy-1.0.0.tar.gz
- Upload date:
- Size: 41.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4d11d095616d47617be9623a71a62dbae2b25e4a22b6fa96ee78863f326eb664
|
|
| MD5 |
e4c82c2284c6092357992803b623c27d
|
|
| BLAKE2b-256 |
f49f1f7c40e58547a4a40751aa154d27af999d7e3e3604c407632c1e644baf86
|
File details
Details for the file edc_retinopathy-1.0.0-py3-none-any.whl.
File metadata
- Download URL: edc_retinopathy-1.0.0-py3-none-any.whl
- Upload date:
- Size: 77.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.6 {"installer":{"name":"uv","version":"0.12.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cb677cb362be9bc9691a1a9bdac07858a1d538c18da4fea5f2789493a23db5d8
|
|
| MD5 |
f4a397fd6627a810450ab1a3866b3703
|
|
| BLAKE2b-256 |
17b748f95af9a28e8852c8a7fa1b206a075f55271b878c951d28041d764a9569
|
