--
This commit is contained in:
+82
-11
@@ -1,4 +1,12 @@
|
||||
"""The Daily Call Report and its call rows — the core artefact of the MVP."""
|
||||
"""The Daily Call Report and its call rows — the core artefact of the MVP.
|
||||
|
||||
Each working day an MR files two reports (see ``ReportType``): a morning PLAN of the
|
||||
doctors and chemists they intend to visit, and an end-of-day ACTUAL report of the visits
|
||||
that happened. Both share this table and its call rows; the ACTUAL report points at its
|
||||
plan, and records why any planned visit was missed in ``missed_visit``.
|
||||
|
||||
An Area Manager files a SELF report of their own visits in the same table; ``mr_user_id``
|
||||
is then the Area Manager (the report's owner), and submitting it makes it final."""
|
||||
|
||||
import uuid
|
||||
from datetime import date, datetime, time
|
||||
@@ -14,19 +22,24 @@ from sqlalchemy import (
|
||||
Time,
|
||||
UniqueConstraint,
|
||||
)
|
||||
from sqlalchemy.dialects.postgresql import ARRAY
|
||||
from sqlalchemy.dialects.postgresql import UUID as PGUUID
|
||||
from sqlalchemy.orm import Mapped, mapped_column, relationship
|
||||
|
||||
from app.common.enums import CallOutcome, ConversionStatus, DCRStatus, Role
|
||||
from app.common.enums import CallOutcome, ConversionStatus, DCRStatus, ReportType, Role
|
||||
from app.database.base import Base, TimestampMixin, UUIDMixin
|
||||
|
||||
|
||||
class DailyCallReport(Base, UUIDMixin, TimestampMixin):
|
||||
__tablename__ = "daily_call_report"
|
||||
__table_args__ = (
|
||||
# V1 / A9 — ONE report per MR per calendar date. Enforced in the database and
|
||||
# not only in the service, so a double-submit race cannot create two reports.
|
||||
UniqueConstraint("mr_user_id", "report_date", name="uq_dcr_mr_date"),
|
||||
# V1 / A9 — ONE report of each type per MR per calendar date. Enforced in the
|
||||
# database and not only in the service, so a double-submit race cannot create two.
|
||||
UniqueConstraint("mr_user_id", "report_date", "report_type", name="uq_dcr_mr_date_type"),
|
||||
# A plan is followed by at most one end-of-day report.
|
||||
UniqueConstraint("plan_id", name="uq_dcr_plan_id"),
|
||||
# Only an end-of-day report points at a plan.
|
||||
CheckConstraint("report_type = 'ACTUAL' OR plan_id IS NULL", name="ck_dcr_plan_link"),
|
||||
# An approved report must carry its approval timestamp, and nothing else may.
|
||||
CheckConstraint(
|
||||
"(status = 'APPROVED' AND approved_at IS NOT NULL) "
|
||||
@@ -44,6 +57,16 @@ class DailyCallReport(Base, UUIDMixin, TimestampMixin):
|
||||
PGUUID(as_uuid=True), ForeignKey("headquarters.id", ondelete="RESTRICT"), nullable=False
|
||||
)
|
||||
report_date: Mapped[date] = mapped_column(Date, nullable=False)
|
||||
report_type: Mapped[ReportType] = mapped_column(
|
||||
Enum(ReportType, name="report_type_enum", native_enum=False, length=10),
|
||||
default=ReportType.ACTUAL,
|
||||
nullable=False,
|
||||
)
|
||||
#: The approved morning plan an end-of-day report is filed against. NULL for plans,
|
||||
#: and for end-of-day reports filed before plans existed.
|
||||
plan_id: Mapped[uuid.UUID | None] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("daily_call_report.id", ondelete="RESTRICT")
|
||||
)
|
||||
status: Mapped[DCRStatus] = mapped_column(
|
||||
Enum(DCRStatus, name="dcr_status_enum", native_enum=False, length=20),
|
||||
default=DCRStatus.DRAFT,
|
||||
@@ -81,6 +104,16 @@ class DailyCallReport(Base, UUIDMixin, TimestampMixin):
|
||||
chemist_calls: Mapped[list["ChemistCall"]] = relationship(
|
||||
back_populates="dcr", cascade="all, delete-orphan", lazy="selectin"
|
||||
)
|
||||
missed_visits: Mapped[list["MissedVisit"]] = relationship(
|
||||
back_populates="dcr", cascade="all, delete-orphan", lazy="selectin"
|
||||
)
|
||||
#: Loaded explicitly by the repository (self-referential, so never eagerly by default).
|
||||
plan: Mapped["DailyCallReport | None"] = relationship(
|
||||
remote_side="DailyCallReport.id", foreign_keys=[plan_id], back_populates="actual"
|
||||
)
|
||||
actual: Mapped["DailyCallReport | None"] = relationship(
|
||||
foreign_keys=[plan_id], back_populates="plan", uselist=False
|
||||
)
|
||||
|
||||
@property
|
||||
def is_locked(self) -> bool:
|
||||
@@ -103,18 +136,25 @@ class DoctorCall(Base, UUIDMixin, TimestampMixin):
|
||||
doctor_id: Mapped[uuid.UUID] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("doctor.id", ondelete="RESTRICT"), nullable=False
|
||||
)
|
||||
#: On a plan this is the planned time; on an end-of-day report, when the visit happened.
|
||||
visit_time: Mapped[time] = mapped_column(Time, nullable=False)
|
||||
call_outcome: Mapped[CallOutcome] = mapped_column(
|
||||
Enum(CallOutcome, name="call_outcome_enum", native_enum=False, length=20),
|
||||
nullable=False,
|
||||
#: Required on an end-of-day report; a planned visit has no outcome yet (NULL).
|
||||
call_outcome: Mapped[CallOutcome | None] = mapped_column(
|
||||
Enum(CallOutcome, name="call_outcome_enum", native_enum=False, length=20)
|
||||
)
|
||||
#: V7 — only permitted when the doctor is a core doctor.
|
||||
conversion_status: Mapped[ConversionStatus | None] = mapped_column(
|
||||
Enum(ConversionStatus, name="conversion_status_enum", native_enum=False, length=20)
|
||||
)
|
||||
#: The printed form's "PRODUCT PROMOTE" and "PRODUCT SAMPLE" columns.
|
||||
product_promote: Mapped[str | None] = mapped_column(String(200))
|
||||
product_sample: Mapped[str | None] = mapped_column(String(200))
|
||||
#: The printed form's "PRODUCT PROMOTE" and "PRODUCT SAMPLE" columns; several per visit.
|
||||
product_promote: Mapped[list[str]] = mapped_column(
|
||||
ARRAY(String(200)), default=list, server_default="{}", nullable=False
|
||||
)
|
||||
product_sample: Mapped[list[str]] = mapped_column(
|
||||
ARRAY(String(200)), default=list, server_default="{}", nullable=False
|
||||
)
|
||||
#: A gift given to the doctor on this visit, typed in by the MR.
|
||||
gift: Mapped[str | None] = mapped_column(String(200))
|
||||
remarks: Mapped[str | None] = mapped_column(Text)
|
||||
|
||||
dcr: Mapped["DailyCallReport"] = relationship(back_populates="doctor_calls")
|
||||
@@ -142,3 +182,34 @@ class ChemistCall(Base, UUIDMixin, TimestampMixin):
|
||||
|
||||
dcr: Mapped["DailyCallReport"] = relationship(back_populates="chemist_calls")
|
||||
chemist: Mapped["Chemist"] = relationship(lazy="selectin") # noqa: F821
|
||||
|
||||
|
||||
class MissedVisit(Base, UUIDMixin, TimestampMixin):
|
||||
"""Why a doctor or chemist on the approved plan was not visited that day.
|
||||
|
||||
Belongs to the end-of-day report; exactly one of doctor/chemist is set.
|
||||
"""
|
||||
|
||||
__tablename__ = "missed_visit"
|
||||
__table_args__ = (
|
||||
UniqueConstraint("dcr_id", "doctor_id", name="uq_missed_dcr_doctor"),
|
||||
UniqueConstraint("dcr_id", "chemist_id", name="uq_missed_dcr_chemist"),
|
||||
CheckConstraint(
|
||||
"(doctor_id IS NULL) <> (chemist_id IS NULL)", name="ck_missed_one_target"
|
||||
),
|
||||
)
|
||||
|
||||
dcr_id: Mapped[uuid.UUID] = mapped_column(
|
||||
PGUUID(as_uuid=True),
|
||||
ForeignKey("daily_call_report.id", ondelete="CASCADE"),
|
||||
nullable=False,
|
||||
)
|
||||
doctor_id: Mapped[uuid.UUID | None] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("doctor.id", ondelete="RESTRICT")
|
||||
)
|
||||
chemist_id: Mapped[uuid.UUID | None] = mapped_column(
|
||||
PGUUID(as_uuid=True), ForeignKey("chemist.id", ondelete="RESTRICT")
|
||||
)
|
||||
reason: Mapped[str] = mapped_column(Text, nullable=False)
|
||||
|
||||
dcr: Mapped["DailyCallReport"] = relationship(back_populates="missed_visits")
|
||||
|
||||
Reference in New Issue
Block a user