15.2.372. camcops_server.tasks.cpft_lps

camcops_server/tasks/cpft_lps.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/>.

---

class camcops_server.tasks.cpft_lps.CPFTLPSDischarge(**kwargs)

Server implementation of the CPFT_LPS_Discharge task.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

clinician_contact_details: Mapped[Optional[str]]

clinician_name: Mapped[Optional[str]]

clinician_post: Mapped[Optional[str]]

clinician_professional_registration: Mapped[Optional[str]]

clinician_service: Mapped[Optional[str]]

clinician_specialty: Mapped[Optional[str]]

editing_time_: Mapped[Optional[float]]

firstexit_is_abort: Mapped[Optional[bool]]

How long has the user spent editing the task? (Calculated by the CamCOPS client.)

firstexit_is_finish: Mapped[Optional[bool]]

Was the first exit from the task’s editor an “abort”?

get_clinical_text(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → List[camcops_server.cc_modules.cc_ctvinfo.CtvInfo]

Tasks that provide clinical text information should override this to provide a list of camcops_server.cc_modules.cc_ctvinfo.CtvInfo objects.

Return None (default) for a task that doesn’t provide clinical text, or [] for one that does in general but has no information for this particular instance, or a list of camcops_server.cc_modules.cc_ctvinfo.CtvInfo objects.

get_task_html(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → str

HTML for the main task content.

Must be overridden by derived classes.

id: Mapped[int]

is_complete() → bool

Is the task instance complete?

Must be overridden.

static longname(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → str

Long name (in the relevant language).

patient

“the patient for this task”.

Note that this refers to the CURRENT version of the patient. If there is an editing chain, older patient versions are not retrieved.

Compare camcops_server.cc_modules.cc_blob.blob_relationship(), which uses the same strategy, as do several other similar functions.

Type

SQLAlchemy relationship

patient_id: Mapped[int]

special_notes

List-style SQLAlchemy relationship to any SpecialNote objects attached to this class. Skips hidden (quasi-deleted) notes.

when_created: Mapped[Pendulum]

Column representing when the user first exited the task’s editor (i.e. first “finish” or first “abort”).

when_firstexit: Mapped[Optional[Pendulum]]

Was the first exit from the task’s editor a successful “finish”?

when_last_modified: Mapped[Optional[Pendulum]]

class camcops_server.tasks.cpft_lps.CPFTLPSReferral(**kwargs)

Server implementation of the CPFT_LPS_Referral task.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

editing_time_: Mapped[Optional[float]]

firstexit_is_abort: Mapped[Optional[bool]]

How long has the user spent editing the task? (Calculated by the CamCOPS client.)

firstexit_is_finish: Mapped[Optional[bool]]

Was the first exit from the task’s editor an “abort”?

get_clinical_text(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → List[camcops_server.cc_modules.cc_ctvinfo.CtvInfo]

Tasks that provide clinical text information should override this to provide a list of camcops_server.cc_modules.cc_ctvinfo.CtvInfo objects.

Return None (default) for a task that doesn’t provide clinical text, or [] for one that does in general but has no information for this particular instance, or a list of camcops_server.cc_modules.cc_ctvinfo.CtvInfo objects.

get_task_html(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → str

HTML for the main task content.

Must be overridden by derived classes.

id: Mapped[int]

is_complete() → bool

Is the task instance complete?

Must be overridden.

static longname(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → str

Long name (in the relevant language).

patient

“the patient for this task”.

Note that this refers to the CURRENT version of the patient. If there is an editing chain, older patient versions are not retrieved.

Compare camcops_server.cc_modules.cc_blob.blob_relationship(), which uses the same strategy, as do several other similar functions.

Type

SQLAlchemy relationship

patient_id: Mapped[int]

special_notes

List-style SQLAlchemy relationship to any SpecialNote objects attached to this class. Skips hidden (quasi-deleted) notes.

when_created: Mapped[Pendulum]

Column representing when the user first exited the task’s editor (i.e. first “finish” or first “abort”).

when_firstexit: Mapped[Optional[Pendulum]]

Was the first exit from the task’s editor a successful “finish”?

when_last_modified: Mapped[Optional[Pendulum]]

class camcops_server.tasks.cpft_lps.CPFTLPSResetResponseClock(**kwargs)

Server implementation of the CPFT_LPS_ResetResponseClock task.

__init__(**kwargs)

A simple constructor that allows initialization from kwargs.

Sets attributes on the constructed instance using the names and values in kwargs.

Only keys that are present as attributes of the instance’s class are allowed. These could be, for example, any mapped columns or relationships.

clinician_contact_details: Mapped[Optional[str]]

clinician_name: Mapped[Optional[str]]

clinician_post: Mapped[Optional[str]]

clinician_professional_registration: Mapped[Optional[str]]

clinician_service: Mapped[Optional[str]]

clinician_specialty: Mapped[Optional[str]]

editing_time_: Mapped[Optional[float]]

firstexit_is_abort: Mapped[Optional[bool]]

How long has the user spent editing the task? (Calculated by the CamCOPS client.)

firstexit_is_finish: Mapped[Optional[bool]]

Was the first exit from the task’s editor an “abort”?

get_clinical_text(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → List[camcops_server.cc_modules.cc_ctvinfo.CtvInfo]

Tasks that provide clinical text information should override this to provide a list of camcops_server.cc_modules.cc_ctvinfo.CtvInfo objects.

Return None (default) for a task that doesn’t provide clinical text, or [] for one that does in general but has no information for this particular instance, or a list of camcops_server.cc_modules.cc_ctvinfo.CtvInfo objects.

get_task_html(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → str

HTML for the main task content.

Must be overridden by derived classes.

id: Mapped[int]

is_complete() → bool

Is the task instance complete?

Must be overridden.

static longname(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → str

Long name (in the relevant language).

patient

“the patient for this task”.

Note that this refers to the CURRENT version of the patient. If there is an editing chain, older patient versions are not retrieved.

Compare camcops_server.cc_modules.cc_blob.blob_relationship(), which uses the same strategy, as do several other similar functions.

Type

SQLAlchemy relationship

patient_id: Mapped[int]

special_notes

List-style SQLAlchemy relationship to any SpecialNote objects attached to this class. Skips hidden (quasi-deleted) notes.

when_created: Mapped[Pendulum]

Column representing when the user first exited the task’s editor (i.e. first “finish” or first “abort”).

when_firstexit: Mapped[Optional[Pendulum]]

Was the first exit from the task’s editor a successful “finish”?

when_last_modified: Mapped[Optional[Pendulum]]

class camcops_server.tasks.cpft_lps.LPSReportReferredNotClerkedOrDischarged

static get_paramform_schema_class() → Type[camcops_server.cc_modules.cc_forms.ReportParamSchema]

Returns the class used as the Colander schema for the form that configures the report. By default, this is a simple form that just offers a choice of output format, but you can provide a more extensive one (an example being in camcops_server.tasks.diagnosis.DiagnosisFinderReportBase.

get_query(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → sqlalchemy.sql.selectable.SelectBase

Overriding this function is one way of providing a report. (The other is get_rows_colnames().)

To override this function, return the SQLAlchemy Base Select statement to execute the report.

(Do not return a Query; that can no longer be executed via session.execute() in SQLAlchemy 2.)

Parameters are passed in via the request.

class camcops_server.tasks.cpft_lps.LPSReportReferredNotDischarged

static get_paramform_schema_class() → Type[camcops_server.cc_modules.cc_forms.ReportParamSchema]

Returns the class used as the Colander schema for the form that configures the report. By default, this is a simple form that just offers a choice of output format, but you can provide a more extensive one (an example being in camcops_server.tasks.diagnosis.DiagnosisFinderReportBase.

get_query(req: camcops_server.cc_modules.cc_request.CamcopsRequest) → sqlalchemy.sql.selectable.SelectBase

Overriding this function is one way of providing a report. (The other is get_rows_colnames().)

To override this function, return the SQLAlchemy Base Select statement to execute the report.

(Do not return a Query; that can no longer be executed via session.execute() in SQLAlchemy 2.)

Parameters are passed in via the request.

class camcops_server.tasks.cpft_lps.LPSReportSchema(*args, **kw)