#!/usr/bin/env python
"""
camcops_server/tasks/badls.py
===============================================================================
Copyright (C) 2012, University of Cambridge, Department of Psychiatry.
Created by Rudolf Cardinal (rnc1001@cam.ac.uk).
This file is part of CamCOPS.
CamCOPS is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
CamCOPS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with CamCOPS. If not, see <https://www.gnu.org/licenses/>.
===============================================================================
"""
from typing import Any, Dict, List, Tuple, Type
from cardinal_pythonlib.stringfunc import strseq
from sqlalchemy.ext.declarative import DeclarativeMeta
from sqlalchemy.sql.sqltypes import Integer
from camcops_server.cc_modules.cc_constants import (
CssClass,
DATA_COLLECTION_UNLESS_UPGRADED_DIV,
)
from camcops_server.cc_modules.cc_ctvinfo import CTV_INCOMPLETE, CtvInfo
from camcops_server.cc_modules.cc_db import add_multiple_columns
from camcops_server.cc_modules.cc_html import answer, tr
from camcops_server.cc_modules.cc_request import CamcopsRequest
from camcops_server.cc_modules.cc_snomed import SnomedExpression, SnomedLookup
from camcops_server.cc_modules.cc_sqla_coltypes import CharColType
from camcops_server.cc_modules.cc_summaryelement import SummaryElement
from camcops_server.cc_modules.cc_task import (
Task,
TaskHasPatientMixin,
TaskHasRespondentMixin,
)
# =============================================================================
# BADLS
# =============================================================================
class BadlsMetaclass(DeclarativeMeta):
# noinspection PyInitNewSignature
def __init__(
cls: Type["Badls"],
name: str,
bases: Tuple[Type, ...],
classdict: Dict[str, Any],
) -> None:
add_multiple_columns(
cls,
"q",
1,
cls.NQUESTIONS,
CharColType,
comment_fmt="Q{n}, {s} ('a' best [0] to 'd' worst [3]; "
"'e'=N/A [scored 0])",
pv=list(cls.SCORING.keys()),
comment_strings=cls.QUESTION_SNIPPETS,
)
super().__init__(name, bases, classdict)
[docs]class Badls(
TaskHasPatientMixin, TaskHasRespondentMixin, Task, metaclass=BadlsMetaclass
):
"""
Server implementation of the BADLS task.
"""
__tablename__ = "badls"
shortname = "BADLS"
provides_trackers = True
SCORING = {"a": 0, "b": 1, "c": 2, "d": 3, "e": 0}
NQUESTIONS = 20
QUESTION_SNIPPETS = [
"food", # 1
"eating",
"drink",
"drinking",
"dressing", # 5
"hygiene",
"teeth",
"bath/shower",
"toilet/commode",
"transfers", # 10
"mobility",
"orientation: time",
"orientation: space",
"communication",
"telephone", # 15
"hosuework/gardening",
"shopping",
"finances",
"games/hobbies",
"transport", # 20
]
TASK_FIELDS = strseq("q", 1, NQUESTIONS)
[docs] @staticmethod
def longname(req: "CamcopsRequest") -> str:
_ = req.gettext
return _("Bristol Activities of Daily Living Scale")
[docs] def get_summaries(self, req: CamcopsRequest) -> List[SummaryElement]:
return self.standard_task_summary_fields() + [
SummaryElement(
name="total_score",
coltype=Integer(),
value=self.total_score(),
comment="Total score (/ 48)",
)
]
[docs] def get_clinical_text(self, req: CamcopsRequest) -> List[CtvInfo]:
if not self.is_complete():
return CTV_INCOMPLETE
return [
CtvInfo(
content="BADLS total score {}/60 (lower is better)".format(
self.total_score()
)
)
]
def score(self, q: str) -> int:
text_value = getattr(self, q)
return self.SCORING.get(text_value, 0)
def total_score(self) -> int:
return sum(self.score(q) for q in self.TASK_FIELDS)
[docs] def is_complete(self) -> bool:
return (
self.field_contents_valid()
and self.is_respondent_complete()
and self.all_fields_not_none(self.TASK_FIELDS)
)
[docs] def get_task_html(self, req: CamcopsRequest) -> str:
q_a = ""
for q in range(1, self.NQUESTIONS + 1):
fieldname = "q" + str(q)
qtext = self.wxstring(req, fieldname) # happens to be the same
avalue = getattr(self, "q" + str(q))
atext = (
self.wxstring(req, "q{}_{}".format(q, avalue))
if q is not None
else None
)
score = self.score(fieldname)
q_a += tr(qtext, answer(atext), score)
return f"""
<div class="{CssClass.SUMMARY}">
<table class="{CssClass.SUMMARY}">
{self.get_is_complete_tr(req)}
<tr>
<td>Total score (0–60, higher worse)</td>
<td>{answer(self.total_score())}</td>
</td>
</table>
</div>
<table class="{CssClass.TASKDETAIL}">
<tr>
<th width="30%">Question</th>
<th width="50%">Answer <sup>[1]</sup></th>
<th width="20%">Score</th>
</tr>
{q_a}
</table>
<div class="{CssClass.FOOTNOTES}">
[1] Scored a = 0, b = 1, c = 2, d = 3, e = 0.
</div>
{DATA_COLLECTION_UNLESS_UPGRADED_DIV}
"""
[docs] def get_snomed_codes(self, req: CamcopsRequest) -> List[SnomedExpression]:
# The BADLS is ALWAYS carer-rated, so it's appropriate to put the
# SNOMED-CT codes in.
codes = [
SnomedExpression(
req.snomed(SnomedLookup.BADLS_PROCEDURE_ASSESSMENT)
)
]
if self.is_complete():
codes.append(
SnomedExpression(
req.snomed(SnomedLookup.BADLS_SCALE),
{req.snomed(SnomedLookup.BADLS_SCORE): self.total_score()},
)
)
return codes