ABCClinicalDemandForecast
1.0.0Schema URL
Schema defining the structure of ABCClinicalDemandForecast used for clinical trial demand forecasting in ABC-Plan.
Properties
Optional notes about the clinical demand forecast plan.
3 nested properties
All algorithm inputs that affect forecast calculation. Any change to this object should invalidate the calculated forecast.
8 nested properties
Basic study information from wizard step 1.
4 nested properties
Name of the clinical trial study.
Phase of the clinical trial.
Summary of the trial protocol. Optional field with recommended default: empty string.
Disease category being treated (e.g., Oncology, CNS, Rare Disease). Will be normalized by LLM for benchmarking. Required field with recommended default: empty string.
Enrollment configuration from wizard step 2.
3 nested properties
Target number of subjects to complete the trial.
Percentage of subjects who fail screening (0-100).
Percentage of enrolled subjects who drop out of the study entirely and stop receiving all doses (0-100). NOTE: This is different from adverse events in dose escalation regimens. Attrition causes subjects to exit the study early, while adverse events only prevent dose escalation but subjects continue receiving doses at their maximum tolerated level.
Configuration of kits with containers and items, keyed by kit ID.
Available dosing regimens for the study, keyed by ID.
Treatment arms in the clinical trial, keyed by ID.
Site supply and region configuration from wizard step 6.
1 nested properties
Region-specific site configuration, keyed by ID.
Actual enrollment data entered by users to reconcile with forecast.
4 nested properties
Actual enrollment by region and month.
Actual site counts by region and month.
Explanatory notes for enrollment actuals by region and month.
Explanatory notes for site activation actuals by region and month.
Trial design type: parallel (single regimen per arm) or crossOver (sequence of treatments with washout periods).
Atomic monthly forecast data. Contains per-region data only. UI computes global totals and cumulative views.
1 nested properties
Region-specific forecast data keyed by region ID.
Definitions
All algorithm inputs that affect forecast calculation. Any change to this object should invalidate the calculated forecast.
Basic study information from wizard step 1.
4 nested properties
Name of the clinical trial study.
Phase of the clinical trial.
Summary of the trial protocol. Optional field with recommended default: empty string.
Disease category being treated (e.g., Oncology, CNS, Rare Disease). Will be normalized by LLM for benchmarking. Required field with recommended default: empty string.
Enrollment configuration from wizard step 2.
3 nested properties
Target number of subjects to complete the trial.
Percentage of subjects who fail screening (0-100).
Percentage of enrolled subjects who drop out of the study entirely and stop receiving all doses (0-100). NOTE: This is different from adverse events in dose escalation regimens. Attrition causes subjects to exit the study early, while adverse events only prevent dose escalation but subjects continue receiving doses at their maximum tolerated level.
Configuration of kits with containers and items, keyed by kit ID.
Available dosing regimens for the study, keyed by ID.
Treatment arms in the clinical trial, keyed by ID.
Site supply and region configuration from wizard step 6.
1 nested properties
Region-specific site configuration, keyed by ID.
Actual enrollment data entered by users to reconcile with forecast.
4 nested properties
Actual enrollment by region and month.
Actual site counts by region and month.
Explanatory notes for enrollment actuals by region and month.
Explanatory notes for site activation actuals by region and month.
Trial design type: parallel (single regimen per arm) or crossOver (sequence of treatments with washout periods).
Basic study information from wizard step 1.
Name of the clinical trial study.
Phase of the clinical trial.
Summary of the trial protocol. Optional field with recommended default: empty string.
Disease category being treated (e.g., Oncology, CNS, Rare Disease). Will be normalized by LLM for benchmarking. Required field with recommended default: empty string.
Enrollment configuration from wizard step 2.
Target number of subjects to complete the trial.
Percentage of subjects who fail screening (0-100).
Percentage of enrolled subjects who drop out of the study entirely and stop receiving all doses (0-100). NOTE: This is different from adverse events in dose escalation regimens. Attrition causes subjects to exit the study early, while adverse events only prevent dose escalation but subjects continue receiving doses at their maximum tolerated level.
A kit containing items and containers. The kit ID is the key in the kitConfiguration map.
Display name of the kit.
Items and containers within this kit, keyed by node ID.
A structural container (bottle, blister pack) that holds other nodes. The container ID is the key in the parent items/children map.
Discriminator identifying this as a container node.
Name of the container.
Type of container.
Items contained within this container, keyed by node ID.
Display order of this node within its parent. Lower numbers appear first.
An actual pharmaceutical item (tablet, capsule, vial) with dosage. The item ID is the key in the parent items/children map.
Discriminator identifying this as an item node.
Name of the item.
Type of pharmaceutical item.
Number of units contained in this item within one kit. For example, if this is a bottle containing tablets, quantity=10 means the bottle contains 10 tablets. This is NOT the same as dosingRegimen.kitItemQuantities, which specifies consumption per dose. This quantity field defines the container/packaging size.
Dosage amount.
Units of dosage (e.g., mg, ml).
Display order of this node within its parent. Lower numbers appear first.
Dosing regimen configuration with nested dosingRegimenDefinition discriminated union.
Name of the dosing regimen.
Description of the dosing regimen.
Discriminated union: either an active regimen definition (isPlacebo: false) or a placebo definition (isPlacebo: true).
Definition for an active (non-placebo) dosing regimen.
Discriminator: false for active regimens.
Total duration of treatment for all subjects.
Unit of treatment duration.
Frequency of dose administration.
Configuration for fixed dose regimens. Null if using another regimen type.
Configuration for dose escalation regimens. Null if using another regimen type.
Configuration for weight-based dosing regimens. Null if using another regimen type.
Configuration for age-based dosing regimens. Null if using another regimen type.
Definition for a placebo regimen that references an active regimen.
Discriminator: true for placebo regimens.
ID of the active dosing regimen this placebo references. Placebo inherits all dosing configuration from the active regimen.
Configuration for fixed dose regimens.
Mapping of kit item IDs to quantities consumed per dose.
Configuration for dose escalation levels.
Map of level IDs to dose escalation levels. Use ordering property to maintain display order.
Individual dose escalation level configuration. This is a discriminated union with three variants: First level (isFirstLevel=true), Intermediate level (isFinalLevel=false, has adverseEventRate), and Final level (isFinalLevel=true, no duration).
Base properties shared by all dose escalation level variants.
Mapping of kit item IDs to quantities consumed per dose at this escalation level.
Display order of this level within the escalation sequence. Lower numbers appear first.
First escalation level. Has isFirstLevel=true, isFinalLevel=false, duration and durationUnit. Does NOT have adverseEventRate because adverse events occur when trialing a level, and there is no previous level to trial from.
Intermediate escalation level (not first, not final). Has isFinalLevel=false, duration, durationUnit, and adverseEventRate. Does NOT have isFirstLevel property.
Final escalation level. Has isFinalLevel=true and adverseEventRate. Does NOT have duration or durationUnit (subjects continue at final level until treatment ends).
Configuration for weight-based dosing.
Unit of weight measurement.
Map of range IDs to weight ranges for kit assignment. Use ordering property to maintain display order.
Weight range configuration for dosing.
Mapping of kit item IDs to quantities consumed per dose for subjects in THIS weight range. Each value represents the number of units (e.g., tablets) of that item required for a single dose. Different weight ranges can specify different quantities for the same item.
Minimum weight for this range (null for no lower bound).
Maximum weight for this range (null for no upper bound).
Expected percentage of subjects in this weight range.
Display order of this range. Lower numbers appear first.
Configuration for age-based dosing.
Unit of age measurement.
Map of range IDs to age ranges for kit assignment. Use ordering property to maintain display order.
Age range configuration for dosing.
Mapping of kit item IDs to quantities consumed per dose for subjects in THIS age range. Each value represents the number of units (e.g., tablets) of that item required for a single dose. Different age ranges can specify different quantities for the same item.
Minimum age for this range (null for no lower bound).
Maximum age for this range (null for no upper bound).
Expected percentage of subjects in this age range.
Display order of this range. Lower numbers appear first.
Treatment period in a dosing regimen sequence.
Discriminator identifying this as a treatment period.
ID of the dosing regimen used during this treatment period.
Order position of this period in the sequence.
Washout period (no dosing) in a dosing regimen sequence.
Discriminator identifying this as a washout period.
Duration of the washout period.
Unit of washout duration.
Order position of this period in the sequence.
Ordered sequence of treatment and washout periods, keyed by unique period ID.
Treatment arm configuration from wizard step 5.
Name of the treatment arm.
Percentage of subjects allocated to this arm.
Ordered sequence of treatment and washout periods, keyed by unique period ID.
Site supply and region configuration from wizard step 6.
Region-specific site configuration, keyed by ID.
Container node for grouping regions. Has subregions but no sites.
Discriminator identifying this as a container node.
Name of the region container.
Child regions within this container.
Default activation start date for child regions. Null means no default.
Default screen rate for child regions. Null means no default.
Default site activation rate for child regions. Null means no default.
Default max enrollment per site for child regions. Null means no default.
Default site seeding quantity per kit for child regions. Map of kitId to quantity, or null to inherit.
Leaf node representing an operational region with sites.
Discriminator identifying this as a leaf region node.
Name of the region.
Total number of sites in this region.
Date when site activation begins. Null inherits from parent container.
Number of subjects screened per site per month. Null inherits from parent container.
Number of sites activated per month. Null inherits from parent container.
Maximum number of patients that can be enrolled per site. Null for unlimited or inherited.
Site seeding quantity per kit. Map of kitId to quantity, or null to inherit from parent.
Atomic monthly forecast data for a single region. All values are monthly (not cumulative). UI computes cumulative views.
Mapping of dates to positive numerical values.
Mapping of dates to positive numerical values.
Mapping of dates to positive numerical values.
Mapping of treatment arm IDs to date-value maps. Each arm ID maps to a PositiveDateMap.
Mapping of treatment arm IDs to date-value maps. Each arm ID maps to a PositiveDateMap.
Mapping of treatment arm IDs to date-value maps. Each arm ID maps to a PositiveDateMap.
Mapping of treatment arm IDs to date-value maps. Each arm ID maps to a PositiveDateMap.
Mapping of treatment arm IDs to sequence periods to kit demand. Structure: arm → sequenceId → kit → KitDemandEntry. The sequence ID matches keys in dosingRegimenSequence.
Mapping of treatment arm IDs to sequence periods to kit item consumption. Structure: arm → sequenceId → item → KitItemDemandEntry. The sequence ID matches keys in dosingRegimenSequence. Displayed as 'Dosing' in the UI.
Mapping of kit IDs to date-value maps for site-level kit demand (not per-arm).
Atomic monthly forecast data. Contains per-region data only. UI computes global totals and cumulative views.
Region-specific forecast data keyed by region ID.
Mapping of dates to positive numerical values.
Mapping of treatment arm IDs to date-value maps. Each arm ID maps to a PositiveDateMap.
Kit demand with placeboOf tagging for active/placebo separation.
Mapping of dates to positive numerical values.
Regimen ID this is placebo of, or null if active.
Kit item consumption entry with placeboOf tagging for active/placebo separation. Represents what patients actually receive, not supply demand.
Mapping of dates to positive numerical values.
Regimen ID this is placebo of, or null if active.
Mapping of treatment arm IDs to sequence periods to kit demand. Structure: arm → sequenceId → kit → KitDemandEntry. The sequence ID matches keys in dosingRegimenSequence.
Mapping of treatment arm IDs to sequence periods to kit item consumption. Structure: arm → sequenceId → item → KitItemDemandEntry. The sequence ID matches keys in dosingRegimenSequence. Displayed as 'Dosing' in the UI.
Mapping of kit IDs to date-value maps for site-level kit demand (not per-arm).
Actual enrollment data entered by users to reconcile with forecast.
Actual enrollment by region and month.
Actual site counts by region and month.
Explanatory notes for enrollment actuals by region and month.
Explanatory notes for site activation actuals by region and month.