schema
YAML schema template defining the structure for drug entries in the database.
1 File
YAML Format
drug-schema.yaml YAML
# ADHD Drug Schema Template
# Copy this template when adding a new drug
# All fields are optional unless marked [required]
#
# LOCALIZATION:
# Fields that support multiple languages use this format:
# fieldName:
# en: "English text"
# zh: "中文文本"
# ja: "日本語テキスト"
# Or for simple cases, just use the base field (defaults to English)
# ============================================
# BASIC INFORMATION
# ============================================
id: "" # [required] unique identifier, e.g., "methylphenidate"
brandNames: # brand names by region
US: [] # e.g., ["Concerta", "Ritalin LA"]
CN: [] # e.g., ["专注达"]
EU: []
JP: []
UK: []
AU: []
CA: []
genericName: # [required] localized generic name
en: "" # e.g., "methylphenidate hydrochloride"
zh: "" # e.g., "盐酸哌甲酯"
ja: "" # e.g., "塩酸メチルフェニデート"
manufacturers: # list of manufacturers
- name: ""
region: "" # US, CN, EU, etc.
# ============================================
# CLASSIFICATION
# ============================================
drugClass: "" # stimulant | non-stimulant
drugClassLabel: # localized label for drug class
en: "" # e.g., "stimulant"
zh: "" # e.g., "兴奋剂"
ja: "" # e.g., "中枢刺激薬"
category: "" # e.g., "methylphenidate", "amphetamine", "SNRI"
categoryLabel: # localized category label
en: ""
zh: ""
ja: ""
controlledSubstance: false # true | false
schedule: # controlled substance schedule by region
US: "" # e.g., "Schedule II"
CN: "" # e.g., "第一类精神药品"
EU: ""
JP: ""
# ============================================
# MECHANISM OF ACTION
# ============================================
activeIngredient: # localized active ingredient name
en: ""
zh: ""
ja: ""
mechanismOfAction: # localized description of how it works
en: ""
zh: ""
ja: ""
neurotransmittersAffected: # list of affected neurotransmitters
- dopamine
- norepinephrine
# ============================================
# DOSAGE & FORMS
# ============================================
forms: # available dosage forms
- type: "" # tablet | capsule | liquid | patch | chewable | ODT
typeLabel: # localized type label
en: ""
zh: ""
ja: ""
releaseType: "" # immediate | extended | mixed
releaseTypeLabel:
en: ""
zh: ""
ja: ""
brandName: ""
strengths: []
durationHours: 0
notes: # localized notes
en: ""
zh: ""
ja: ""
# ============================================
# EFFICACY & TIMING
# ============================================
onsetMinutes: 0
peakEffectHours: 0
durationHours: 0
# ============================================
# SIDE EFFECTS
# ============================================
sideEffects:
common: # >10% occurrence
- name:
en: ""
zh: ""
ja: ""
frequency: ""
uncommon: # 1-10% occurrence
- name:
en: ""
zh: ""
ja: ""
frequency: ""
serious: # rare but clinically important
- name:
en: ""
zh: ""
ja: ""
notes:
en: ""
zh: ""
ja: ""
# ============================================
# SAFETY & CONTRAINDICATIONS
# ============================================
contraindications: # localized list
en: []
zh: []
ja: []
drugInteractions:
- drug:
en: ""
zh: ""
ja: ""
severity: "" # major | moderate | minor
effect:
en: ""
zh: ""
ja: ""
blackBoxWarnings:
en: []
zh: []
ja: []
pregnancyCategory: ""
foodInteractions:
en: ""
zh: ""
ja: ""
# ============================================
# EXTENDED INTERACTIONS DATA
# Comprehensive drug-drug and drug-nutrient interactions
# ============================================
interactionsData:
# Detailed drug-drug interactions from DrugBank/FDA
drugInteractions:
- interactingSubstance:
en: "" # e.g., "MAO Inhibitors"
zh: "" # e.g., "单胺氧化酶抑制剂"
ja: "" # e.g., "MAO阻害薬"
zh-TW: "" # e.g., "單胺氧化酶抑制劑"
substanceType: "" # drug | drug_class | food | nutrient
rxcui: "" # RxNorm identifier if available
drugBankId: "" # DrugBank identifier
severity: "" # major | moderate | minor | unknown
mechanism:
en: "" # How the interaction works
zh: ""
ja: ""
effect:
en: "" # Clinical effect of interaction
zh: ""
ja: ""
clinicalSignificance:
en: "" # Clinical importance
zh: ""
ja: ""
recommendation:
en: "" # Management recommendation
zh: ""
ja: ""
evidenceLevel: "" # established | probable | possible | theoretical
sources:
- url: ""
name: ""
# Drug-nutrient/food interactions
nutrientInteractions:
- nutrient:
en: "" # e.g., "Vitamin C (Ascorbic Acid)"
zh: ""
ja: ""
zh-TW: ""
nutrientType: "" # vitamin | mineral | food | supplement | beverage
effect:
en: ""
zh: ""
ja: ""
severity: "" # major | moderate | minor
mechanism:
en: ""
zh: ""
ja: ""
timing: "" # avoid_together | separate_2hr | separate_4hr | monitor | caution
recommendation:
en: ""
zh: ""
ja: ""
# Common co-prescribed drug classes with quick notes
commonCoprescribed:
- drugClass: "" # e.g., "SSRI"
drugClassLabel:
en: "" # e.g., "SSRIs (Selective Serotonin Reuptake Inhibitors)"
zh: ""
ja: ""
zh-TW: ""
examples: [] # e.g., ["sertraline", "fluoxetine", "escitalopram"]
interactionSeverity: "" # major | moderate | minor
quickNote:
en: "" # Brief interaction summary
zh: ""
ja: ""
zh-TW: ""
# Data metadata
lastUpdated: "" # Date when interaction data was last updated
sources: [] # e.g., ["DrugBank Open Data", "FDA DailyMed"]
# ============================================
# CLINICAL TRIALS DATA
# From ClinicalTrials.gov API
# ============================================
clinicalTrialsData:
# Summary statistics
summary:
total: 0 # Total number of trials
recruiting: 0 # Currently recruiting
active: 0 # Active but not recruiting
completed: 0 # Completed trials
# Notable/highlighted trials
notableTrials:
- nctId: "" # e.g., "NCT12345678"
title: "" # Brief title
status: "" # RECRUITING | ACTIVE_NOT_RECRUITING | COMPLETED
phase: "" # PHASE1 | PHASE2 | PHASE3 | PHASE4
sponsor: "" # Lead sponsor
enrollment: 0 # Enrollment count
completionDate: "" # Expected/actual completion
# Link to search more trials
searchUrl: "" # ClinicalTrials.gov search URL
# Data freshness
lastUpdated: ""
# ============================================
# PRACTICAL INFORMATION
# ============================================
typicalDosing:
children:
startingDose: ""
maxDose: ""
notes:
en: ""
zh: ""
ja: ""
adults:
startingDose: ""
maxDose: ""
notes:
en: ""
zh: ""
ja: ""
costEstimate:
US:
brand: ""
generic: ""
CN:
brand: ""
generic: ""
storageRequirements:
en: ""
zh: ""
ja: ""
# ============================================
# APPROVAL & AVAILABILITY
# ============================================
approvals:
- region: "US"
agency: "FDA"
year: null
approvedAges:
en: ""
zh: ""
ja: ""
indications:
en: []
zh: []
ja: []
available: true
notes:
en: ""
zh: ""
ja: ""
# ============================================
# SPECIAL CONSIDERATIONS
# ============================================
specialConsiderations:
cardiacRisk:
en: ""
zh: ""
ja: ""
abuseRisk:
en: ""
zh: ""
ja: ""
withdrawalNotes:
en: ""
zh: ""
ja: ""
monitoringRequired:
en: ""
zh: ""
ja: ""
# ============================================
# OPENFDA DATA (from FDA Structured Product Labeling)
# ============================================
# FDA identifiers and references
fdaData:
# Application numbers (NDA = New Drug Application, ANDA = Abbreviated NDA)
applicationNumbers: [] # e.g., ["NDA021121", "NDA010187"]
# SPL (Structured Product Label) identifiers
splSetId: "" # SPL Set ID for tracking versions
splId: "" # Individual SPL ID
# RxNorm Concept Unique Identifier(s)
rxcui: [] # e.g., ["4158", "83366"]
# Pharmacological classification from FDA
pharmacologicClass:
mechanismOfAction: [] # pharm_class_moa, e.g., ["Central Nervous System Stimulant [MoA]"]
establishedClass: [] # pharm_class_epc, e.g., ["Central Nervous System Stimulant"]
physiologicEffect: [] # pharm_class_pe, e.g., ["Increased Central Nervous System Activity"]
# Black box warning - critical safety information (localized)
boxedWarning:
en: "" # Raw FDA black box warning text
zh: ""
ja: ""
# FDA-approved indications (more specific than general indications)
fdaIndications:
en: ""
zh: ""
ja: ""
# Abuse and dependence information (important for controlled substances)
abuseAndDependence:
controlledSubstanceClass: "" # e.g., "CII" for Schedule II
abuse:
en: ""
zh: ""
ja: ""
dependence:
en: ""
zh: ""
ja: ""
# FDA label last update date
labelEffectiveDate: "" # Format: YYYYMMDD
# Link to full FDA label
fdaLabelUrl: "" # e.g., "https://dailymed.nlm.nih.gov/dailymed/..."
# FAERS (FDA Adverse Event Reporting System) data
faersData:
# Total number of adverse event reports
totalReports: 0
# Number of serious adverse event reports
seriousReports: 0
# Top reported adverse reactions with frequency
topReactions:
- reaction:
en: ""
zh: ""
ja: ""
reportCount: 0
percentage: 0 # Percentage of total reports
# Demographics of reports
demographics:
byAge: # Age group breakdown
- ageGroup: "" # e.g., "6-11", "12-17", "18-24"
count: 0
bySex: # Sex breakdown
- sex: "" # Male, Female, Unknown
count: 0
# Outcome breakdown
outcomes:
recovered: 0
recovering: 0
notRecovered: 0
fatal: 0
unknown: 0
# Data range and freshness
dataRange:
from: "" # e.g., "2004-01-01"
to: "" # e.g., "2025-12-01"
# Last time this data was fetched from OpenFDA
lastUpdated: ""
# ============================================
# RXNORM DATA (from NLM RxNorm/RxNav API)
# Drug name normalization and relationship mapping
# @see https://www.nlm.nih.gov/research/umls/rxnorm/overview.html
# ============================================
rxnormData:
# Primary ingredient-level RxCUI (base substance)
ingredientRxcui: "" # e.g., "6887" for methylphenidate
# Human-readable ingredient name from RxNorm
ingredientName: "" # e.g., "methylphenidate"
# RxCUI mappings at different term type levels
# TTY (Term Type) Reference:
# IN = Ingredient (base substance)
# PIN = Precise Ingredient (includes salt form)
# SCD = Semantic Clinical Drug (ingredient + strength + form)
# SBD = Semantic Branded Drug (brand + strength + form)
# SCDF = Semantic Clinical Drug Form (ingredient + form)
# SBDF = Semantic Branded Drug Form (brand + form)
# BN = Brand Name
rxcuiMappings:
- rxcui: "" # RxNorm Concept Unique Identifier
name: "" # Drug name at this level
tty: "" # Term Type (IN, PIN, SCD, SBD, BN, etc.)
description: "" # Human-readable description
# Brand name to RxCUI mappings
# Links brand names to their specific RxCUI for precise identification
brandMappings:
- brandName: "" # e.g., "Concerta"
rxcui: "" # RxCUI for this brand
manufacturer: "" # Optional: manufacturer name
region: "" # Optional: region (US, EU, etc.)
# Drug synonyms and alternative names
# Used for search normalization - any of these names should find this drug
synonyms:
- name: "" # Alternative name
type: "" # generic | brand | abbreviation | chemical | common
source: "" # Optional: source of this synonym
# Related drugs (same ingredient, different forms/brands)
# Shows the drug relationship graph
relatedDrugs:
- rxcui: "" # RxCUI of related drug
name: "" # Drug name
tty: "" # Term type
relationship: "" # Relationship type (clinical_drug, branded_drug, drug_form)
# Data freshness
lastUpdated: "" # Date when RxNorm data was last fetched
# ============================================
# PACKAGE INSERT / INSTRUCTIONS (说明书)
# Official prescribing information
# ============================================
instructions:
indicationsAndUsage: # What the drug is used for
en: ""
zh: ""
ja: ""
dosageAndAdministration: # How to take the medication
en: ""
zh: ""
ja: ""
dosageForms: # Available forms and strengths
en: ""
zh: ""
ja: ""
contraindications: # When NOT to use
en: ""
zh: ""
ja: ""
warningsAndPrecautions: # Important safety information
en: ""
zh: ""
ja: ""
adverseReactions: # Side effects
en: ""
zh: ""
ja: ""
drugInteractions: # Interactions with other drugs
en: ""
zh: ""
ja: ""
useInSpecificPopulations: # Pregnancy, nursing, pediatric, geriatric
en: ""
zh: ""
ja: ""
overdosage: # What to do in case of overdose
en: ""
zh: ""
ja: ""
clinicalPharmacology: # How the drug works
en: ""
zh: ""
ja: ""
howSupplied: # Packaging and storage
en: ""
zh: ""
ja: ""
patientCounselingInfo: # Information for patients
en: ""
zh: ""
ja: ""
# ============================================
# METADATA
# ============================================
lastUpdated: null
sources:
- ""
notes:
en: ""
zh: ""
ja: ""