diff --git a/docs/includes/generated_docs/schemas/tpp.md b/docs/includes/generated_docs/schemas/tpp.md index a123755fb..080985d3e 100644 --- a/docs/includes/generated_docs/schemas/tpp.md +++ b/docs/includes/generated_docs/schemas/tpp.md @@ -15,6 +15,7 @@ from ehrql.tables.tpp import ( clinical_events, clinical_events_ranges, covid_therapeutics, + decision_support_values, ec, ec_cost, emergency_care_attendances, @@ -1185,6 +1186,105 @@ date or a past date at the time of form submission. +

many rows per patient

+## decision_support_values + +Returns values computed by decision support algorithms, for example the +[Electronic Frailty Index (EFI)][efi_ref] + +[efi_ref]: https://www.england.nhs.uk/ourwork/clinical-policy/older-people/frailty/efi/ +
+
Columns
+
+
+
+ algorithm_type + 🔗 + integer +
+
+A unique id for the decision support algorithm. Currently, the only option is '1' for the electronic frailty index. + +
+
+ +
+
+ calculation_date + 🔗 + date +
+
+Date of calculation for the decision support algorithm. + +
+
+ +
+
+ numeric_value + 🔗 + float +
+
+The value computed by the decision support algorithm + +
+
+ +
+
+ algorithm_description + 🔗 + string +
+
+The description of the decision support algorithm. + +
+
+ +
+
+ algorithm_version + 🔗 + string +
+
+The version of the decision support algorithm. + +
+
+ +
+
+
+
Methods
+
+
+
+ electronic_frailty_index() + 🔗 + +
+
+Returns every calculated electronic frailty index v1 (EFI) for each patient. +
+ View method definition +```py +return decision_support_values.where( + decision_support_values.algorithm_description == "UK Electronic Frailty Index (eFI)" +).where(decision_support_values.algorithm_version == "1.0") + +``` +
+
+
+ +
+
+ +

many rows per patient

## ec