Skip to content

SOURCE_ACCESS_AND_LICENSES.md

Latest commit

 

History

History
111 lines (91 loc) · 7.41 KB

SOURCE_ACCESS_AND_LICENSES.md

File metadata and controls

111 lines (91 loc) · 7.41 KB
Raw

Source Access & Licensing

Machine-readable companion and deterministic checker: SOURCE_ACCESS_CONTRACT.md and config/source_access_registry.json.

Educational prototype documentation. ParkinSUM is not a clinical product and does not perform production ingestion of any external source. All adapters listed here are fixture-validated (deterministic parsers over synthetic payloads modeled on public schema shapes). An optional, opt-in live smoke harness exists for shape validation only (see below); it is disabled by default, never runs in normal tests, fetches official metadata only (never clinical advice), and never stores raw payloads.

Source-specific legal / license / terms-of-use review remains future work and is required before any production use of any source below.

Implementation status legend

  • fixture_tested — deterministic parser validated against a synthetic fixture; no live ingestion.
  • opt_in_live_smoke — reachable by the opt-in smoke harness for shape checks only.
  • production_parser — real-schema, license-reviewed production ingestion (none today).
  • spec_only — registry metadata only, no concrete parser.

Medication sources

Source Owner Jurisdiction Access method Key/account/license review Status Data type Mechanism evidence alone? Notes
DailyMed U.S. NLM US SPL download / web service No key; public domain (review terms) fixture_tested + opt_in_live_smoke Official SPL label Yes (label text) Live smoke hits a metadata listing endpoint only.
Health Canada DPD Health Canada CA DPD API / monograph Open data terms review fixture_tested Official DB + monograph Partial (monograph) Food-effect text often in monograph PDFs.
EMA / ePI European Medicines Agency EU EPAR / ePI (FHIR) download Reuse-terms review fixture_tested EPAR / SmPC / ePI Yes (SmPC text) Centralized products.
EU national registers National competent authorities (EMA index) EU/EEA member states Web page / register index Per-member-state terms review fixture_tested Register identity + PI link No unless SmPC/ePI text present Identity/register source; distinguish from full SmPC.
NHS dm+d NHSBSA / NHS England GB TRUD XML download / NHS Terminology Server (FHIR API) dm+d licence + SNOMED CT licensing review fixture_tested Drug dictionary (SNOMED CT) No Identity/coding-strong; not a complete food-effect label source.
PMDA PMDA JP Web page (package insert / review report) PMDA terms review fixture_tested Package insert Yes (Japanese authoritative) English index is reference-only.
NMPA National Medical Products Administration CN Web page (approval / label) NMPA terms review fixture_tested (NOT live-verified) Drug approval / label Reference-only Chinese-language authoritative; English mapping reference-only; fixture/prototype only.
RxNorm U.S. NLM US API Review terms spec_only Concept normalization No Identity normalization only.

Food composition sources

Source Owner Jurisdiction Access method Key/account/license review Status Data type Notes
USDA FoodData Central USDA ARS US REST API API key required for live fixture_tested + opt_in_live_smoke (skips without key) Food composition incl. amino acids Amino-acid nutrient numbers extracted when present, using the verified FDC mapping (501 Trp, 502 Thr, 503 Ile, 504 Leu, 506 Met, 508 Phe, 509 Tyr, 510 Val, 512 His).
Ciqual ANSES FR Download Reuse-terms review fixture_tested Food composition French-language codes.
China CDC food platform China CDC CN Web page Terms review fixture_tested Food composition No amino-acid fields captured today.
FAO/INFOODS (standard) FAO Global Download Open-access guidelines spec_only Component identifiers (tagnames) + matching/conversion guidelines Standardizes nutrient basis + missingness; citation candidate, no parser today.
Canadian Nutrient File Health Canada CA Download Open-data terms review spec_only Food composition Citation/fixture candidate; not yet wired.
app seed / synthetic demo ParkinSUM — manual n/a fixture_tested Seed/synthetic Never authoritative.

API / license review checklist (required before any production ingestion)

FAIR-aligned (Wilkinson et al. 2016) governance gate. No source may move from fixture_tested / spec_only to production_parser until every box is checked and recorded here. This is documentation only; it does not enable any live ingestion.

  • License / terms-of-use reviewed and recorded (owner, license, attribution requirements, redistribution limits).
  • Access method confirmed (public domain / public API / API key / account / download) — secrets are never committed.
  • Rate limits + caching policy documented; no bulk scraping.
  • Provenance fields captured (source id, version, effective/publication date, retrieval date) — FAIR Findable/Reusable.
  • Identifiers + schema mapped to internal metadata (FAIR Interoperable); missing fields preserved as missing (never 0).
  • No PHI / patient data / credentials in fixtures or payloads.
  • Mechanism evidence vs identity/coding role recorded (a coding source is not a food-effect source).
  • Opt-in flag + skip-without-network behavior verified (see live smoke).
  • Safety note recorded (educational; non-prescriptive; not calibrated).

See docs/BIOMEDICAL_ENGINEERING_OPPORTUNITY_MAP.md and docs/BIOMEDICAL_ENGINEERING_BACKLOG.md for the surveyed future sources and the issue-ready tasks that would exercise this checklist.

Optional live smoke harness

# Disabled by default — safely skips, no network:
dart run tool/run_live_source_smoke.dart            # or: npm run live:smoke
# Opt-in (NOT run in CI / normal tests):
PARKINSUM_ENABLE_LIVE_SOURCE_SMOKE=1 dart run tool/run_live_source_smoke.dart --source=dailymed
  • Validates fetch shape + parser ability on a small public metadata query. It does not validate production ingestion, real-schema completeness, licensing compliance, or clinical accuracy.
  • --source=fdc requires an API key; without one the smoke reports requires_api_key_not_supplied and exits without embedding any secret.
  • Raw payloads are never written to the repo; only a redacted shape summary is printed.

Reminder

Nothing here is medical advice, a diagnosis, a dosing/timing recommendation, or a claim of clinical validation. The mechanistic model is not clinically calibrated (see docs/CONFLICT_ENGINE_MODEL.md).

Public-demo allowance column

Each registry record now carries allowed_for_public_demo (default false). It must be set to true — after a license/terms review — before a source may be cited in public-demo material (walkthroughs, public docs). The contract checker (npm run source:access) warns on public_demo_not_allowed when a source is cited in public-demo paths without the flag, and blocks on missing_required_fields when a record omits the core matrix fields (source_id, display_name, owner, jurisdiction, access_method, implementation_status). This is governance bookkeeping, not legal advice or license clearance.