Skip to content

onconova.oncology.controllers.tumor_board

AnyPayloadSchemas module-attribute

AnyResponseSchemas module-attribute

PAYLOAD_SCHEMAS module-attribute

RESPONSE_SCHEMAS module-attribute

MolecularTherapeuticRecommendationController

Bases: ControllerBase

create_molecular_tumor_board_therapeutic_recommendation(tumorBoardId, payload)

Source code in onconova/oncology/controllers/tumor_board.py 
203
204
205
206
207
208
209
210
211
212
213
214
215
@route.post(
    path="/{tumorBoardId}/therapeutic-recommendations",
    response={201: ModifiedResourceSchema, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="createMolecularTherapeuticRecommendation",
)
def create_molecular_tumor_board_therapeutic_recommendation(self, tumorBoardId: str, payload: scm.MolecularTherapeuticRecommendationCreate):  # type: ignore
    instance = orm.MolecularTherapeuticRecommendation(
        molecular_tumor_board=get_object_or_404(
            orm.MolecularTumorBoard, id=tumorBoardId
        )
    )
    return 201, payload.model_dump_django(instance=instance, create=True)

delete_molecular_tumor_board_therapeutic_recommendation(tumorBoardId, recommendationId)

Source code in onconova/oncology/controllers/tumor_board.py 
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
@route.delete(
    path="/{tumorBoardId}/therapeutic-recommendations/{recommendationId}",
    response={204: None, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="deleteMolecularTherapeuticRecommendation",
)
def delete_molecular_tumor_board_therapeutic_recommendation(
    self, tumorBoardId: str, recommendationId: str
):
    instance = get_object_or_404(
        orm.MolecularTherapeuticRecommendation,
        id=recommendationId,
        molecular_tumor_board__id=tumorBoardId,
    )
    instance.delete()
    return 204, None

get_all_molecular_tumor_board_therapeutic_history_events(tumorBoardId, recommendationId)

Source code in onconova/oncology/controllers/tumor_board.py 
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
@route.get(
    path="/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events",
    response={200: Paginated[HistoryEvent], 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getAllMolecularTherapeuticRecommendationHistoryEvents",
)
@paginate()
@ordering()
def get_all_molecular_tumor_board_therapeutic_history_events(
    self, tumorBoardId: str, recommendationId: str
):
    instance = get_object_or_404(
        orm.MolecularTherapeuticRecommendation,
        id=recommendationId,
        molecular_tumor_board__id=tumorBoardId,
    )
    return pghistory.models.Events.objects.tracks(instance).all()  # type: ignore

get_molecular_tumor_board_therapeutic_history_event_by_id(tumorBoardId, recommendationId, eventId)

Source code in onconova/oncology/controllers/tumor_board.py 
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
@route.get(
    path="/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}",
    response={200: HistoryEvent, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getMolecularTherapeuticRecommendationHistoryEventById",
)
def get_molecular_tumor_board_therapeutic_history_event_by_id(
    self, tumorBoardId: str, recommendationId: str, eventId: str
):
    instance = get_object_or_404(
        orm.MolecularTherapeuticRecommendation,
        id=recommendationId,
        molecular_tumor_board__id=tumorBoardId,
    )
    return get_object_or_404(
        pghistory.models.Events.objects.tracks(instance), pgh_id=eventId  # type: ignore
    )

get_molecular_tumor_board_therapeutic_recommendation_by_id(tumorBoardId, recommendationId)

Source code in onconova/oncology/controllers/tumor_board.py 
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
@route.get(
    path="/{tumorBoardId}/therapeutic-recommendations/{recommendationId}",
    response={200: scm.MolecularTherapeuticRecommendation, 404: None},
    exclude_none=True,
    permissions=[perms.CanViewCases],
    operation_id="getMOlecularTherapeuticRecommendationById",
)
def get_molecular_tumor_board_therapeutic_recommendation_by_id(
    self, tumorBoardId: str, recommendationId: str
):
    return get_object_or_404(
        orm.MolecularTherapeuticRecommendation,
        id=recommendationId,
        molecular_tumor_board__id=tumorBoardId,
    )

get_molecular_tumor_board_therapeutic_recommendations_matching_the_query(tumorBoardId)

Source code in onconova/oncology/controllers/tumor_board.py 
172
173
174
175
176
177
178
179
180
181
182
183
184
185
@route.get(
    path="/{tumorBoardId}/therapeutic-recommendations",
    response={
        200: List[scm.MolecularTherapeuticRecommendation],
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getMolecularTherapeuticRecommendations",
)
def get_molecular_tumor_board_therapeutic_recommendations_matching_the_query(self, tumorBoardId: str):  # type: ignore
    return get_object_or_404(
        orm.MolecularTumorBoard, id=tumorBoardId
    ).therapeutic_recommendations.all()  # type: ignore

revert_molecular_tumor_board_therapeutic_to_history_event(tumorBoardId, recommendationId, eventId)

Source code in onconova/oncology/controllers/tumor_board.py 
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
@route.put(
    path="/{tumorBoardId}/therapeutic-recommendations/{recommendationId}/history/events/{eventId}/reversion",
    response={201: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="revertMolecularTherapeuticRecommendationToHistoryEvent",
)
def revert_molecular_tumor_board_therapeutic_to_history_event(
    self, tumorBoardId: str, recommendationId: str, eventId: str
):
    instance = get_object_or_404(
        orm.MolecularTherapeuticRecommendation,
        id=recommendationId,
        molecular_tumor_board__id=tumorBoardId,
    )
    return 201, get_object_or_404(instance.events, pgh_id=eventId).revert()

update_molecular_tumor_board_therapeutic_recommendation(tumorBoardId, recommendationId, payload)

Source code in onconova/oncology/controllers/tumor_board.py 
217
218
219
220
221
222
223
224
225
226
227
228
229
@route.put(
    path="/{tumorBoardId}/therapeutic-recommendations/{recommendationId}",
    response={200: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="updateMolecularTherapeuticRecommendation",
)
def update_molecular_tumor_board_therapeutic_recommendation(self, tumorBoardId: str, recommendationId: str, payload: scm.MolecularTherapeuticRecommendationCreate):  # type: ignore
    instance = get_object_or_404(
        orm.MolecularTherapeuticRecommendation,
        id=recommendationId,
        molecular_tumor_board__id=tumorBoardId,
    )
    return payload.model_dump_django(instance=instance)

TumorBoardController

Bases: ControllerBase

create_tumor_board(payload)

Source code in onconova/oncology/controllers/tumor_board.py 
77
78
79
80
81
82
83
84
@route.post(
    path="",
    response={201: ModifiedResourceSchema, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="createTumorBoard",
)
def create_tumor_board(self, payload: AnyPayloadSchemas):  # type: ignore
    return 201, payload.model_dump_django()

delete_tumor_board(tumorBoardId)

Source code in onconova/oncology/controllers/tumor_board.py 
110
111
112
113
114
115
116
117
118
119
@route.delete(
    path="/{tumorBoardId}",
    response={204: None, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="deleteTumorBoardById",
)
def delete_tumor_board(self, tumorBoardId: str):
    instance = get_object_or_404(orm.TumorBoard, id=tumorBoardId)
    instance.delete()
    return 204, None

get_all_tumor_board_history_events(tumorBoardId)

Source code in onconova/oncology/controllers/tumor_board.py 
121
122
123
124
125
126
127
128
129
130
131
@route.get(
    path="/{tumorBoardId}/history/events",
    response={200: Paginated[HistoryEvent], 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getAllTumorBoardHistoryEvents",
)
@paginate()
@ordering()
def get_all_tumor_board_history_events(self, tumorBoardId: str):
    instance = get_object_or_404(orm.TumorBoard, id=tumorBoardId)
    return pghistory.models.Events.objects.tracks(instance).all()  # type: ignore

get_all_tumor_boards_matching_the_query(query)

Source code in onconova/oncology/controllers/tumor_board.py 
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
@route.get(
    path="",
    response={
        200: Paginated[AnyResponseSchemas],
        **COMMON_HTTP_ERRORS,
    },
    exclude_none=True,
    permissions=[perms.CanViewCases],
    operation_id="getTumorBoards",
)
@paginate()
@ordering()
@anonymize()
def get_all_tumor_boards_matching_the_query(self, query: Query[scm.TumorBoardFilters]):  # type: ignore
    queryset = orm.TumorBoard.objects.all().order_by("-date")
    return [
        cast_to_model_schema(tumorboard.specialized_tumor_board, RESPONSE_SCHEMAS)
        for tumorboard in query.filter(queryset)
    ]

get_tumor_board_by_id(tumorBoardId)

Source code in onconova/oncology/controllers/tumor_board.py 
86
87
88
89
90
91
92
93
94
95
96
@route.get(
    path="/{tumorBoardId}",
    response={200: AnyResponseSchemas, 404: None},
    exclude_none=True,
    permissions=[perms.CanViewCases],
    operation_id="getTumorBoardById",
)
@anonymize()
def get_tumor_board_by_id(self, tumorBoardId: str):
    instance = get_object_or_404(orm.TumorBoard, id=tumorBoardId)
    return cast_to_model_schema(instance.specialized_tumor_board, RESPONSE_SCHEMAS)

get_tumor_board_history_event_by_id(tumorBoardId, eventId)

Source code in onconova/oncology/controllers/tumor_board.py 
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
@route.get(
    path="/{tumorBoardId}/history/events/{eventId}",
    response={200: HistoryEvent, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getTumorBoardHistoryEventById",
)
def get_tumor_board_history_event_by_id(self, tumorBoardId: str, eventId: str):
    instance = get_object_or_404(orm.TumorBoard, id=tumorBoardId)
    event = instance.parent_events.filter(pgh_id=eventId).first()  # type: ignore
    if not event and hasattr(instance, "events"):
        event = instance.events.filter(pgh_id=eventId).first()
    if not event:
        return 404, None
    return get_object_or_404(
        pghistory.models.Events.objects.tracks(instance), pgh_id=eventId  # type: ignore
    )

revert_tumor_board_to_history_event(tumorBoardId, eventId)

Source code in onconova/oncology/controllers/tumor_board.py 
150
151
152
153
154
155
156
157
158
159
160
161
162
@route.put(
    path="/{tumorBoardId}/history/events/{eventId}/reversion",
    response={201: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="revertTumorBoardToHistoryEvent",
)
def revert_tumor_board_to_history_event(self, tumorBoardId: str, eventId: str):
    instance = get_object_or_404(orm.TumorBoard, id=tumorBoardId)
    instance = instance.specialized_tumor_board
    try:
        return 201, revert_multitable_model(instance, eventId)
    except ObjectDoesNotExist:
        return 404, None

update_tumor_board(tumorBoardId, payload)

Source code in onconova/oncology/controllers/tumor_board.py 
 98
 99
100
101
102
103
104
105
106
107
108
@route.put(
    path="/{tumorBoardId}",
    response={200: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="updateTumorBoardById",
)
def update_tumor_board(self, tumorBoardId: str, payload: AnyPayloadSchemas):  # type: ignore
    instance = get_object_or_404(
        orm.TumorBoard, id=tumorBoardId
    ).specialized_tumor_board
    return payload.model_dump_django(instance=instance)

cast_to_model_schema(model_instance, schemas, payload=None)

Source code in onconova/oncology/controllers/tumor_board.py 
39
40
41
42
43
44
45
46
47
def cast_to_model_schema(model_instance, schemas, payload=None):
    return next(
        (
            schema.model_validate(payload or model_instance)
            for schema in schemas
            if (payload or model_instance).tumor_board_specialty
            == schema.model_fields["category"].default
        )
    )
runner