"""
camcops_server/tasks/zbi.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, cast, List, Optional, Type
from cardinal_pythonlib.stringfunc import strseq
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_string import AS
from camcops_server.cc_modules.cc_summaryelement import SummaryElement
from camcops_server.cc_modules.cc_task import (
get_from_dict,
Task,
TaskHasPatientMixin,
TaskHasRespondentMixin,
)
# =============================================================================
# ZBI
# =============================================================================
[docs]class Zbi12( # type: ignore[misc]
TaskHasRespondentMixin,
TaskHasPatientMixin,
Task,
):
"""
Server implementation of the ZBI-12 task.
"""
__tablename__ = "zbi12"
shortname = "ZBI-12"
info_filename_stem = "zbi"
MIN_PER_Q = 0
MAX_PER_Q = 4
NQUESTIONS = 12
@classmethod
def extend_columns(cls: Type["Zbi12"], **kwargs: Any) -> None:
add_multiple_columns(
cls,
"q",
1,
cls.NQUESTIONS,
minimum=cls.MIN_PER_Q,
maximum=cls.MAX_PER_Q,
comment_fmt="Q{n}, {s} (0-4, higher worse)",
comment_strings=[
"insufficient time for self", # 1
"stressed with other responsibilities",
"angry",
"other relationships affected",
"strained", # 5
"health suffered",
"insufficient privacy",
"social life suffered",
"lost control",
"uncertain", # 10
"should do more",
"could care better",
],
)
TASK_FIELDS = strseq("q", 1, NQUESTIONS)
MAX_TOTAL = MAX_PER_Q * NQUESTIONS
[docs] @staticmethod
def longname(req: "CamcopsRequest") -> str:
_ = req.gettext
return _("Zarit Burden Interview-12")
[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=f"Total score (/ {self.MAX_TOTAL})",
)
]
[docs] def get_clinical_text(self, req: CamcopsRequest) -> List[CtvInfo]:
if not self.is_complete():
return CTV_INCOMPLETE
return [
CtvInfo(
content=f"ZBI-12 total score "
f"{self.total_score()}/{self.MAX_TOTAL}"
)
]
def total_score(self) -> int:
return cast(int, self.sum_fields(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:
option_dict: dict[Optional[int], Optional[str]] = {None: None}
for a in range(self.MIN_PER_Q, self.MAX_PER_Q + 1):
option_dict[a] = req.wappstring(AS.ZBI_A_PREFIX + str(a))
h = f"""
<div class="{CssClass.SUMMARY}">
<table class="{CssClass.SUMMARY}">
{self.get_is_complete_tr(req)}
<tr>
<td>Total score (/ {self.MAX_TOTAL})</td>
<td>{answer(self.total_score())}</td>
</td>
</table>
</div>
<table class="{CssClass.TASKDETAIL}">
<tr>
<th width="75%">Question</th>
<th width="25%">Answer ({self.MIN_PER_Q}–{self.MAX_PER_Q})
</th>
</tr>
"""
for q in range(1, self.NQUESTIONS + 1):
a = getattr(self, "q" + str(q))
fa = (
f"{a}: {get_from_dict(option_dict, a)}"
if a is not None
else None
)
h += tr(self.wxstring(req, "q" + str(q)), answer(fa))
h += (
"""
</table>
"""
+ DATA_COLLECTION_UNLESS_UPGRADED_DIV
)
return h