Add the return key attributes as specified in the conformance doc

The documentation says non-requested keys will be ignored, so we are safe to always return the full set for each item.

Author: steventux

src/services/mwl/c_find.py

@@ -88,26 +88,47 @@ def _build_worklist_response(self, item: WorklistItem) -> Dataset:
         ds.PatientID = item.patient_id
         ds.PatientName = item.patient_name
         ds.PatientBirthDate = item.patient_birth_date
-        if item.patient_sex:
-            ds.PatientSex = item.patient_sex
+        ds.PatientSex = item.patient_sex
+        ds.PatientAge = item.patient_age
+        ds.PatientWeight = item.patient_weight
+        ds.PatientAddress = item.patient_address
+        ds.PatientComments = item.patient_comments
 
         # Study information
         ds.AccessionNumber = item.accession_number
-        if item.study_instance_uid:
-            ds.StudyInstanceUID = item.study_instance_uid
+        ds.StudyInstanceUID = item.study_instance_uid
 
-        if item.study_description:
-            ds.StudyDescription = item.study_description
-            sps_item.ScheduledProcedureStepDescription = ds.StudyDescription
+        ds.StudyDescription = item.study_description
+        sps_item.ScheduledProcedureStepDescription = ds.StudyDescription
 
-        if item.procedure_code:
-            ds.RequestedProcedureID = item.procedure_code
-            sps_item.ScheduledProcedureStepID = ds.RequestedProcedureID
+        ds.RequestedProcedureID = item.procedure_code
+
+        ds.RequestedProcedureCodeSequence = [Dataset()]
+        ds.RequestedProcedureCodeSequence[0].CodeValue = item.procedure_code
+        ds.RequestedProcedureCodeSequence[0].CodingSchemeDesignator = item.procedure_coding_scheme_designator
+        ds.RequestedProcedureCodeSequence[0].CodeMeaning = item.procedure_code_meaning
+
+        ds.ReasonForRequestedProcedureCodeSequence = [Dataset()]
+        ds.ReasonForRequestedProcedureCodeSequence[0].CodeValue = item.reason_code_value
+        ds.ReasonForRequestedProcedureCodeSequence[0].CodingSchemeDesignator = item.reason_coding_scheme_designator
+        ds.ReasonForRequestedProcedureCodeSequence[0].CodeMeaning = item.reason_code_meaning
+
+        sps_item.ScheduledProcedureStepID = ds.RequestedProcedureID
 
         # Scheduled Procedure Step Sequence
         sps_item.ScheduledProcedureStepStartDate = item.scheduled_date
         sps_item.ScheduledProcedureStepStartTime = item.scheduled_time
         sps_item.Modality = item.modality
+        sps_item.ScheduledStationAETitle = item.scheduled_station_aet
+        sps_item.ScheduledPerformingPhysicianName = item.scheduled_performing_physician_name
+        sps_item.ScheduledStationName = item.scheduled_station_name
+        sps_item.ScheduledProcedureStepLocation = item.scheduled_procedure_step_location
+        sps_item.ScheduledProtocolCodeSequence = [Dataset()]
+        sps_item.ScheduledProtocolCodeSequence[0].CodeValue = item.scheduled_protocol_code_value
+        sps_item.ScheduledProtocolCodeSequence[
+            0
+        ].CodingSchemeDesignator = item.scheduled_protocol_coding_scheme_designator
+        sps_item.ScheduledProtocolCodeSequence[0].CodeMeaning = item.scheduled_protocol_code_meaning
 
         ds.ScheduledProcedureStepSequence = [sps_item]
 

src/services/storage.py

@@ -291,6 +291,7 @@ class WorklistItem:
     scheduled_date: str = field(doc="Date the procedure is scheduled for.")
     scheduled_time: str = field(doc="Time the procedure is scheduled for.")
     status: str = field(doc="Status of the worklist item", default=MWLStatus.SCHEDULED.value)
+
     source_message_id: Optional[str] = field(
         default=None, doc="Message ID from system which created this worklist item", hash=True
     )
@@ -302,6 +303,36 @@ class WorklistItem:
         default=None, doc="Modality Performed Procedure Step (MPPS) instance UID if available."
     )
 
+    patient_age: Optional[str] = field(default=None, doc="Age of the patient at the time of scheduling.")
+    patient_weight: Optional[str] = field(default=None, doc="Weight of the patient at the time of scheduling.")
+    patient_address: Optional[str] = field(default=None, doc="Address of the patient.")
+    patient_comments: Optional[str] = field(default=None, doc="Additional comments about the patient.")
+
+    procedure_coding_scheme_designator: Optional[str] = field(
+        default=None, doc="Coding scheme designator for the procedure code."
+    )
+    procedure_code_meaning: Optional[str] = field(default=None, doc="Code meaning for the procedure code.")
+
+    reason_code_value: Optional[str] = field(default=None, doc="Code value for the reason for requested procedure.")
+    reason_coding_scheme_designator: Optional[str] = field(
+        default=None, doc="Coding scheme designator for the reason for requested procedure."
+    )
+    reason_code_meaning: Optional[str] = field(default=None, doc="Code meaning for the reason for requested procedure.")
+
+    scheduled_performing_physician_name: Optional[str] = field(
+        default=None, doc="Name of the scheduled performing physician."
+    )
+    scheduled_procedure_step_location: Optional[str] = field(
+        default=None, doc="Location of the scheduled procedure step."
+    )
+    scheduled_station_aet: Optional[str] = field(default=None, doc="AE Title of the scheduled station.")
+    scheduled_station_name: Optional[str] = field(default=None, doc="Name of the scheduled station.")
+    scheduled_protocol_code_value: Optional[str] = field(default=None, doc="Code value for the scheduled protocol.")
+    scheduled_protocol_coding_scheme_designator: Optional[str] = field(
+        default=None, doc="Coding scheme designator for the scheduled protocol."
+    )
+    scheduled_protocol_code_meaning: Optional[str] = field(default=None, doc="Code meaning for the scheduled protocol.")
+
 
 class WorklistItemNotFoundError(Exception):
     """Raised when a worklist item is not found in storage."""

tests/services/mwl/test_c_find.py

@@ -215,23 +215,45 @@ def test_call_handles_storage_exception(self, handler, mock_storage, mock_event)
         assert status == FAILURE
         assert ds is None
 
-    def test_build_worklist_response_missing_optional_fields(self, handler):
-        minimal_item = WorklistItem(
-            accession_number="ACC001",
-            patient_id="9876543210",
-            patient_name="TEST^PATIENT",
-            patient_birth_date="19800101",
-            scheduled_date="20260107",
-            scheduled_time="100000",
-            modality="MG",
-        )
+    def test_call_return_key_attributes_present(self, handler, mock_storage, mock_event, sample_worklist_item):
+        worklist_item = WorklistItem(**sample_worklist_item)
+        mock_storage.find_worklist_items.return_value = [worklist_item]
 
-        ds = handler._build_worklist_response(minimal_item)
+        results = list(handler.call(mock_event))
 
-        # Required fields present
+        assert len(results) == 2
+        status, ds = results[0]
+        assert status == PENDING
         assert ds.PatientID == "9876543210"
         assert ds.AccessionNumber == "ACC001"
-        # Optional fields absent
-        assert not hasattr(ds, "PatientSex")
-        assert not hasattr(ds, "StudyInstanceUID")
-        assert not hasattr(ds, "StudyDescription")
+        assert ds.PatientName == "TEST^PATIENT"
+        assert ds.PatientBirthDate == "19800101"
+
+        assert ds.PatientAddress is None
+        assert ds.PatientComments is None
+        assert ds.PatientWeight is None
+        assert ds.PatientAge is None
+        assert ds.PatientSex == "F"
+
+        assert ds.StudyDescription == "Bilateral Screening Mammogram"
+        assert ds.StudyInstanceUID == "1.2.3.4.5"  # gitleaks:allow
+
+        scheduled_procedure_step = ds.ScheduledProcedureStepSequence[0]
+
+        assert scheduled_procedure_step.Modality == "MG"
+        assert scheduled_procedure_step.ScheduledProcedureStepStartDate == "20260107"
+        assert scheduled_procedure_step.ScheduledProcedureStepStartTime == "100000"
+        assert scheduled_procedure_step.ScheduledProcedureStepID == "PROC001"
+        assert scheduled_procedure_step.ScheduledStationAETitle is None
+        assert scheduled_procedure_step.ScheduledStationName is None
+        assert scheduled_procedure_step.ScheduledProtocolCodeSequence[0].CodeValue is None
+        assert scheduled_procedure_step.ScheduledProtocolCodeSequence[0].CodingSchemeDesignator is None
+        assert scheduled_procedure_step.ScheduledProtocolCodeSequence[0].CodeMeaning is None
+
+        assert ds.ReasonForRequestedProcedureCodeSequence[0].CodeValue is None
+        assert ds.ReasonForRequestedProcedureCodeSequence[0].CodingSchemeDesignator is None
+        assert ds.ReasonForRequestedProcedureCodeSequence[0].CodeMeaning is None
+
+        assert ds.RequestedProcedureCodeSequence[0].CodeValue == "PROC001"
+        assert ds.RequestedProcedureCodeSequence[0].CodingSchemeDesignator is None
+        assert ds.RequestedProcedureCodeSequence[0].CodeMeaning is None