|
| 1 | +# Data Dictionary: `parameters` JSON |
| 2 | + |
| 3 | +## Top-level key: `simulation_parameters` |
| 4 | + |
| 5 | +Type: `object` |
| 6 | + |
| 7 | +Description: Maps parameter names (str) to a specification describing how to sample from a statistical distribution for this metric in the simulation. |
| 8 | + |
| 9 | +## Structure summary |
| 10 | + |
| 11 | +Each item under `simulation_parameters` is itself an object with: |
| 12 | + |
| 13 | +* `class_name`: The name of the distribution class to use. |
| 14 | +* `params`: An object containing parameters required by that distribution. |
| 15 | + |
| 16 | +## Parameter specification table |
| 17 | + |
| 18 | +| Field | Data type | Description | Example/Allowed values | |
| 19 | +| - | - | - | - | |
| 20 | +| Parameter name | str (object key) | Description name for the parameter: `<unit>_<metric>_<type>` | `asu_arrival_stroke`, `rehab_los_other`, `asu_routing_tia` | |
| 21 | +| `class_name` | str | Statistical distribution for the parameter | `Exponential`, `Lognormal`, `DiscreteEmpricial` | |
| 22 | +| `params ` | Object | Dictionary of parameters required to instantiate the distribution | See subsequent rows per distribution type | |
| 23 | + |
| 24 | +## Distribution-specific `params` field |
| 25 | + |
| 26 | +| `class_name` | Parameter key(s) | Data type | Description | Example values | |
| 27 | +| - | - | - | - | - | |
| 28 | +| `Exponential` | mean | float | Mean of exponential distribution | `1.2`, `9.3` | |
| 29 | +| `Lognormal` | mean, stdev | float | Mean and standard deviation of lognormal distribution | `mean: 7.4`, `stdev: 8.61` | |
| 30 | +| `DiscreteEmpirical` | values, freq | list (str/float) | Possible discrete values; corresponding probabilities or frequencies | `values: ["rehab", "esd", "other"]`, `freq: [0.24, 0.13, 0.63]` | |
| 31 | + |
| 32 | +## Glossary |
| 33 | + |
| 34 | +### Unit |
| 35 | + |
| 36 | +* `asu`: Acute Stroke Unit |
| 37 | +* `rehab`: Rehabilitation Unit |
| 38 | + |
| 39 | +### Metric |
| 40 | + |
| 41 | +* `arrival`: Interarrival time (days between admissions) |
| 42 | +* `los`: Length of stay (days in unit) |
| 43 | +* `routing`: Probabilities of routing/discharge |
| 44 | + |
| 45 | +### Type |
| 46 | + |
| 47 | +For `iat`/`los`: |
| 48 | + |
| 49 | +* `stroke`: Stroke patients |
| 50 | +* `tia`: Transient ischaemic attack patients |
| 51 | +* `neuro`: Complex neurological patients |
| 52 | +* `other`: Other patient types |
| 53 | +* `stroke_noesd`, `stroke_esd`: Stroke patients split by whether they were transferred to early supported discharge (ESD). |
| 54 | + |
| 55 | +For `routing`: |
| 56 | + |
| 57 | +* `[diagnosis]_rehab`: Probability of transferring to rehabilitation unit |
| 58 | +* `[diagnosis]_esd`: Probability of early supported discharge (ESD). |
| 59 | +* `[diagnosis]_other`: Probability of other discharge pathways |
0 commit comments