#!/usr/bin/env python
"""
camcops_server/tasks/iesr.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.schema import Column
from sqlalchemy.sql.sqltypes import Integer, UnicodeText
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, tr_qa
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_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,
)
from camcops_server.cc_modules.cc_text import SS
from camcops_server.cc_modules.cc_trackerhelpers import TrackerInfo
# =============================================================================
# IES-R
# =============================================================================
class IesrMetaclass(DeclarativeMeta):
# noinspection PyInitNewSignature
def __init__(
cls: Type["Iesr"],
name: str,
bases: Tuple[Type, ...],
classdict: Dict[str, Any],
) -> None:
add_multiple_columns(
cls,
"q",
1,
cls.NQUESTIONS,
minimum=cls.MIN_SCORE,
maximum=cls.MAX_SCORE,
comment_fmt="Q{n}, {s} (0-4, higher worse)",
comment_strings=[
"reminder feelings", # 1
"sleep maintenance",
"reminder thinking",
"irritable",
"avoided getting upset", # 5
"thought unwanted",
"unreal",
"avoided reminder",
"mental pictures",
"jumpy", # 10
"avoided thinking",
"feelings undealt",
"numb",
"as if then",
"sleep initiation", # 15
"waves of emotion",
"tried forgetting",
"concentration",
"reminder physical",
"dreams", # 20
"vigilant",
"avoided talking",
],
)
super().__init__(name, bases, classdict)
[docs]class Iesr(TaskHasPatientMixin, Task, metaclass=IesrMetaclass):
"""
Server implementation of the IES-R task.
"""
__tablename__ = "iesr"
shortname = "IES-R"
provides_trackers = True
event = Column("event", UnicodeText, comment="Relevant event")
NQUESTIONS = 22
MIN_SCORE = 0 # per question
MAX_SCORE = 4 # per question
MAX_TOTAL = 88
MAX_AVOIDANCE = 32
MAX_INTRUSION = 28
MAX_HYPERAROUSAL = 28
QUESTION_FIELDS = strseq("q", 1, NQUESTIONS)
AVOIDANCE_QUESTIONS = [5, 7, 8, 11, 12, 13, 17, 22]
AVOIDANCE_FIELDS = Task.fieldnames_from_list("q", AVOIDANCE_QUESTIONS)
INTRUSION_QUESTIONS = [1, 2, 3, 6, 9, 16, 20]
INTRUSION_FIELDS = Task.fieldnames_from_list("q", INTRUSION_QUESTIONS)
HYPERAROUSAL_QUESTIONS = [4, 10, 14, 15, 18, 19, 21]
HYPERAROUSAL_FIELDS = Task.fieldnames_from_list(
"q", HYPERAROUSAL_QUESTIONS
)
[docs] @staticmethod
def longname(req: "CamcopsRequest") -> str:
_ = req.gettext
return _("Impact of Events Scale – Revised")
[docs] def get_trackers(self, req: CamcopsRequest) -> List[TrackerInfo]:
return [
TrackerInfo(
value=self.total_score(),
plot_label="IES-R total score (lower is better)",
axis_label=f"Total score (out of {self.MAX_TOTAL})",
axis_min=-0.5,
axis_max=self.MAX_TOTAL + 0.5,
),
TrackerInfo(
value=self.avoidance_score(),
plot_label="IES-R avoidance score",
axis_label=f"Avoidance score (out of {self.MAX_AVOIDANCE})",
axis_min=-0.5,
axis_max=self.MAX_AVOIDANCE + 0.5,
),
TrackerInfo(
value=self.intrusion_score(),
plot_label="IES-R intrusion score",
axis_label=f"Intrusion score (out of {self.MAX_INTRUSION})",
axis_min=-0.5,
axis_max=self.MAX_INTRUSION + 0.5,
),
TrackerInfo(
value=self.hyperarousal_score(),
plot_label="IES-R hyperarousal score",
axis_label=f"Hyperarousal score (out of {self.MAX_HYPERAROUSAL})", # noqa
axis_min=-0.5,
axis_max=self.MAX_HYPERAROUSAL + 0.5,
),
]
[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})",
),
SummaryElement(
name="avoidance_score",
coltype=Integer(),
value=self.avoidance_score(),
comment=f"Avoidance score (/ {self.MAX_AVOIDANCE})",
),
SummaryElement(
name="intrusion_score",
coltype=Integer(),
value=self.intrusion_score(),
comment=f"Intrusion score (/ {self.MAX_INTRUSION})",
),
SummaryElement(
name="hyperarousal_score",
coltype=Integer(),
value=self.hyperarousal_score(),
comment=f"Hyperarousal score (/ {self.MAX_HYPERAROUSAL})",
),
]
[docs] def get_clinical_text(self, req: CamcopsRequest) -> List[CtvInfo]:
if not self.is_complete():
return CTV_INCOMPLETE
t = self.total_score()
a = self.avoidance_score()
i = self.intrusion_score()
h = self.hyperarousal_score()
return [
CtvInfo(
content=(
f"IES-R total score {t}/{self.MAX_TOTAL} "
f"(avoidance {a}/{self.MAX_AVOIDANCE} "
f"intrusion {i}/{self.MAX_INTRUSION}, "
f"hyperarousal {h}/{self.MAX_HYPERAROUSAL})"
)
)
]
def total_score(self) -> int:
return self.sum_fields(self.QUESTION_FIELDS)
def avoidance_score(self) -> int:
return self.sum_fields(self.AVOIDANCE_FIELDS)
def intrusion_score(self) -> int:
return self.sum_fields(self.INTRUSION_FIELDS)
def hyperarousal_score(self) -> int:
return self.sum_fields(self.HYPERAROUSAL_FIELDS)
[docs] def is_complete(self) -> bool:
return bool(
self.field_contents_valid()
and self.event
and self.all_fields_not_none(self.QUESTION_FIELDS)
)
[docs] def get_task_html(self, req: CamcopsRequest) -> str:
option_dict = {None: None}
for a in range(self.MIN_SCORE, self.MAX_SCORE + 1):
option_dict[a] = req.wappstring(AS.IESR_A_PREFIX + str(a))
h = f"""
<div class="{CssClass.SUMMARY}">
<table class="{CssClass.SUMMARY}">
{self.get_is_complete_tr(req)}
<tr>
<td>Total score</td>
<td>{answer(self.total_score())} / {self.MAX_TOTAL}</td>
</td>
<tr>
<td>Avoidance score</td>
<td>{answer(self.avoidance_score())} / {self.MAX_AVOIDANCE}</td>
</td>
<tr>
<td>Intrusion score</td>
<td>{answer(self.intrusion_score())} / {self.MAX_INTRUSION}</td>
</td>
<tr>
<td>Hyperarousal score</td>
<td>{answer(self.hyperarousal_score())} / {self.MAX_HYPERAROUSAL}</td>
</td>
</table>
</div>
<table class="{CssClass.TASKDETAIL}">
{tr_qa(req.sstring(SS.EVENT), self.event)}
</table>
<table class="{CssClass.TASKDETAIL}">
<tr>
<th width="75%">Question</th>
<th width="25%">Answer (0–4)</th>
</tr>
""" # noqa
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
[docs] def get_snomed_codes(self, req: CamcopsRequest) -> List[SnomedExpression]:
codes = [
SnomedExpression(
req.snomed(SnomedLookup.IESR_PROCEDURE_ASSESSMENT)
)
]
if self.is_complete():
codes.append(
SnomedExpression(
req.snomed(SnomedLookup.IESR_SCALE),
{req.snomed(SnomedLookup.IESR_SCORE): self.total_score()},
)
)
return codes