Skip to content

onconova.oncology.controllers.radiotherapy

RadiotherapyController

Bases: ControllerBase

create_radiotherapy(payload)

Source code in onconova/oncology/controllers/radiotherapy.py 
46
47
48
49
50
51
52
53
@route.post(
    path="",
    response={201: ModifiedResourceSchema, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="createRadiotherapy",
)
def create_radiotherapy(self, payload: scm.RadiotherapyCreate): 
    return 201, payload.model_dump_django().assign_therapy_line()

create_radiotherapy_dosage(radiotherapyId, payload)

Source code in onconova/oncology/controllers/radiotherapy.py 
150
151
152
153
154
155
156
157
158
159
160
@route.post(
    path="/{radiotherapyId}/dosages",
    response={201: ModifiedResourceSchema, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="createRadiotherapyDosage",
)
def create_radiotherapy_dosage(self, radiotherapyId: str, payload: scm.RadiotherapyDosageCreate):  
    instance = orm.RadiotherapyDosage(
        radiotherapy=get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    )
    return 201, payload.model_dump_django(instance=instance, create=True)

create_radiotherapy_setting(radiotherapyId, payload)

Source code in onconova/oncology/controllers/radiotherapy.py 
264
265
266
267
268
269
270
271
272
273
274
@route.post(
    path="/{radiotherapyId}/settings",
    response={201: ModifiedResourceSchema, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="createRadiotherapySetting",
)
def create_radiotherapy_setting(self, radiotherapyId: str, payload: scm.RadiotherapySettingCreate):
    instance = orm.RadiotherapySetting(
        radiotherapy=get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    )
    return 201, payload.model_dump_django(instance=instance, create=True)

delete_radiotherapy(radiotherapyId)

Source code in onconova/oncology/controllers/radiotherapy.py 
65
66
67
68
69
70
71
72
73
74
75
76
@route.delete(
    path="/{radiotherapyId}",
    response={204: None, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="deleteRadiotherapyById",
)
def delete_radiotherapy(self, radiotherapyId: str):
    instance = get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    case = instance.case
    instance.delete()
    orm.TherapyLine.assign_therapy_lines(case)
    return 204, None

delete_radiotherapy_dosage(radiotherapyId, dosageId)

Source code in onconova/oncology/controllers/radiotherapy.py 
174
175
176
177
178
179
180
181
182
183
184
@route.delete(
    path="/{radiotherapyId}/dosages/{dosageId}",
    response={204: None, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="deleteRadiotherapyDosage",
)
def delete_radiotherapy_dosage(self, radiotherapyId: str, dosageId: str):
    get_object_or_404(
        orm.RadiotherapyDosage, id=dosageId, radiotherapy__id=radiotherapyId
    ).delete()
    return 204, None

delete_radiotherapy_setting(radiotherapyId, settingId)

Source code in onconova/oncology/controllers/radiotherapy.py 
288
289
290
291
292
293
294
295
296
297
298
@route.delete(
    path="/{radiotherapyId}/settings/{settingId}",
    response={204: None, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="deleteRadiotherapySetting",
)
def delete_radiotherapy_setting(self, radiotherapyId: str, settingId: str):
    get_object_or_404(
        orm.RadiotherapySetting, id=settingId, radiotherapy__id=radiotherapyId
    ).delete()
    return 204, None

get_all_radiotherapies_matching_the_query(query)

Source code in onconova/oncology/controllers/radiotherapy.py 
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
@route.get(
    path="",
    response={
        200: Paginated[scm.Radiotherapy],
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapies",
)
@paginate()
@ordering()
@anonymize()
def get_all_radiotherapies_matching_the_query(self, query: Query[scm.RadiotherapyFilters]):  # type: ignore
    queryset = orm.Radiotherapy.objects.all().order_by("-period")
    return query.filter(queryset)

get_all_radiotherapy_dosage_history_events(radiotherapyId, dosageId)

Source code in onconova/oncology/controllers/radiotherapy.py 
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
@route.get(
    path="/{radiotherapyId}/dosages/{dosageId}/history/events",
    response={
        200: Paginated[HistoryEvent.bind_schema(scm.RadiotherapyDosageCreate)],
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getAllRadiotherapyDosageHistoryEvents",
)
@paginate()
@ordering()
def get_all_radiotherapy_dosage_history_events(
    self, radiotherapyId: str, dosageId: str
):
    instance = get_object_or_404(
        orm.RadiotherapyDosage, id=dosageId, radiotherapy__id=radiotherapyId
    )
    return pghistory.models.Events.objects.tracks(instance).all()  # type: ignore

get_all_radiotherapy_history_events(radiotherapyId)

Source code in onconova/oncology/controllers/radiotherapy.py 
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
@route.get(
    path="/{radiotherapyId}/history/events",
    response={
        200: Paginated[HistoryEvent.bind_schema(scm.RadiotherapyCreate)],
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getAllRadiotherapyHistoryEvents",
)
@paginate()
@ordering()
def get_all_radiotherapy_history_events(self, radiotherapyId: str):
    instance = get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    return pghistory.models.Events.objects.tracks(instance).all()  # type: ignore

get_all_radiotherapy_setting_history_events(radiotherapyId, settingId)

Source code in onconova/oncology/controllers/radiotherapy.py 
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
@route.get(
    path="/{radiotherapyId}/settings/{settingId}/history/events",
    response={
        200: Paginated[HistoryEvent.bind_schema(scm.RadiotherapySettingCreate)],
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getAllRadiotherapySettingHistoryEvents",
)
@paginate()
@ordering()
def get_all_radiotherapy_setting_history_events(
    self, radiotherapyId: str, settingId: str
):
    instance = get_object_or_404(
        orm.RadiotherapySetting, id=settingId, radiotherapy__id=radiotherapyId
    )
    return pghistory.models.Events.objects.tracks(instance).all()  # type: ignore

get_radiotherapy_by_id(radiotherapyId)

Source code in onconova/oncology/controllers/radiotherapy.py 
55
56
57
58
59
60
61
62
63
@route.get(
    path="/{radiotherapyId}",
    response={200: scm.Radiotherapy, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapyById",
)
@anonymize()
def get_radiotherapy_by_id(self, radiotherapyId: str):
    return get_object_or_404(orm.Radiotherapy, id=radiotherapyId)

get_radiotherapy_dosage_by_id(radiotherapyId, dosageId)

Source code in onconova/oncology/controllers/radiotherapy.py 
139
140
141
142
143
144
145
146
147
148
@route.get(
    path="/{radiotherapyId}/dosages/{dosageId}",
    response={200: scm.RadiotherapyDosage, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapyDosageById",
)
def get_radiotherapy_dosage_by_id(self, radiotherapyId: str, dosageId: str):  
    return get_object_or_404(
        orm.RadiotherapyDosage, id=dosageId, radiotherapy__id=radiotherapyId
    )

get_radiotherapy_dosage_history_event_by_id(radiotherapyId, dosageId, eventId)

Source code in onconova/oncology/controllers/radiotherapy.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
@route.get(
    path="/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}",
    response={
        200: HistoryEvent.bind_schema(scm.RadiotherapyDosageCreate),
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapyDosageHistoryEventById",
)
def get_radiotherapy_dosage_history_event_by_id(
    self, radiotherapyId: str, dosageId: str, eventId: str
):
    instance = get_object_or_404(
        orm.RadiotherapyDosage, id=dosageId, radiotherapy__id=radiotherapyId
    )
    return get_object_or_404(
        pghistory.models.Events.objects.tracks(instance), pgh_id=eventId  # type: ignore
    )

get_radiotherapy_dosages_matching_the_query(radiotherapyId)

Source code in onconova/oncology/controllers/radiotherapy.py 
130
131
132
133
134
135
136
137
@route.get(
    path="/{radiotherapyId}/dosages",
    response={200: List[scm.RadiotherapyDosage], 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapyDosages",
)
def get_radiotherapy_dosages_matching_the_query(self, radiotherapyId: str): 
    return get_object_or_404(orm.Radiotherapy, id=radiotherapyId).dosages.all()  # type: ignore

get_radiotherapy_history_event_by_id(radiotherapyId, eventId)

Source code in onconova/oncology/controllers/radiotherapy.py 
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@route.get(
    path="/{radiotherapyId}/history/events/{eventId}",
    response={
        200: HistoryEvent.bind_schema(scm.RadiotherapyCreate),
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapyHistoryEventById",
)
def get_radiotherapy_history_event_by_id(self, radiotherapyId: str, eventId: str):
    instance = get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    return get_object_or_404(
        pghistory.models.Events.objects.tracks(instance), pgh_id=eventId  # type: ignore
    )

get_radiotherapy_setting_by_id(radiotherapyId, settingId)

Source code in onconova/oncology/controllers/radiotherapy.py 
253
254
255
256
257
258
259
260
261
262
@route.get(
    path="/{radiotherapyId}/settings/{settingId}",
    response={200: scm.RadiotherapySetting, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapySettingById",
)
def get_radiotherapy_setting_by_id(self, radiotherapyId: str, settingId: str): 
    return get_object_or_404(
        orm.RadiotherapySetting, id=settingId, radiotherapy__id=radiotherapyId
    )

get_radiotherapy_setting_history_event_by_id(radiotherapyId, settingId, eventId)

Source code in onconova/oncology/controllers/radiotherapy.py 
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
@route.get(
    path="/{radiotherapyId}/settings/{settingId}/history/events/{eventId}",
    response={
        200: HistoryEvent.bind_schema(scm.RadiotherapySettingCreate),
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapySettingHistoryEventById",
)
def get_radiotherapy_setting_history_event_by_id(
    self, radiotherapyId: str, settingId: str, eventId: str
):
    instance = get_object_or_404(
        orm.RadiotherapySetting, id=settingId, radiotherapy__id=radiotherapyId
    )
    return get_object_or_404(
        pghistory.models.Events.objects.tracks(instance), pgh_id=eventId  # type: ignore
    )

get_radiotherapy_settings_matching_the_query(radiotherapyId)

Source code in onconova/oncology/controllers/radiotherapy.py 
240
241
242
243
244
245
246
247
248
249
250
251
@route.get(
    path="/{radiotherapyId}/settings",
    response={
        200: List[scm.RadiotherapySetting],
        404: None,
        **COMMON_HTTP_ERRORS,
    },
    permissions=[perms.CanViewCases],
    operation_id="getRadiotherapySettings",
)
def get_radiotherapy_settings_matching_the_query(self, radiotherapyId: str): 
    return get_object_or_404(orm.Radiotherapy, id=radiotherapyId).settings.all()  # type: ignore

revert_radiotherapy_dosage_to_history_event(radiotherapyId, dosageId, eventId)

Source code in onconova/oncology/controllers/radiotherapy.py 
226
227
228
229
230
231
232
233
234
235
236
237
238
@route.put(
    path="/{radiotherapyId}/dosages/{dosageId}/history/events/{eventId}/reversion",
    response={201: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="revertRadiotherapyDosageToHistoryEvent",
)
def revert_radiotherapy_dosage_to_history_event(
    self, radiotherapyId: str, dosageId: str, eventId: str
):
    instance = get_object_or_404(
        orm.RadiotherapyDosage, id=dosageId, radiotherapy__id=radiotherapyId
    )
    return 201, get_object_or_404(instance.events, pgh_id=eventId).revert()

revert_radiotherapy_setting_to_history_event(radiotherapyId, settingId, eventId)

Source code in onconova/oncology/controllers/radiotherapy.py 
340
341
342
343
344
345
346
347
348
349
350
351
352
@route.put(
    path="/{radiotherapyId}/settings/{settingId}/history/events/{eventId}/reversion",
    response={201: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="revertRadiotherapySettingToHistoryEvent",
)
def revert_radiotherapy_setting_to_history_event(
    self, radiotherapyId: str, settingId: str, eventId: str
):
    instance = get_object_or_404(
        orm.RadiotherapySetting, id=settingId, radiotherapy__id=radiotherapyId
    )
    return 201, get_object_or_404(instance.events, pgh_id=eventId).revert()

revert_radiotherapy_to_history_event(radiotherapyId, eventId)

Source code in onconova/oncology/controllers/radiotherapy.py 
120
121
122
123
124
125
126
127
128
@route.put(
    path="/{radiotherapyId}/history/events/{eventId}/reversion",
    response={201: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="revertRadiotherapyToHistoryEvent",
)
def revert_radiotherapy_to_history_event(self, radiotherapyId: str, eventId: str):
    instance = get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    return 201, get_object_or_404(instance.events, pgh_id=eventId).revert()

update_radiotherapy(radiotherapyId, payload)

Source code in onconova/oncology/controllers/radiotherapy.py 
78
79
80
81
82
83
84
85
86
@route.put(
    path="/{radiotherapyId}",
    response={200: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="updateRadiotherapy",
)
def update_radiotherapy(self, radiotherapyId: str, payload: scm.RadiotherapyCreate):
    instance = get_object_or_404(orm.Radiotherapy, id=radiotherapyId)
    return payload.model_dump_django(instance=instance).assign_therapy_line()

update_radiotherapy_dosage(radiotherapyId, dosageId, payload)

Source code in onconova/oncology/controllers/radiotherapy.py 
162
163
164
165
166
167
168
169
170
171
172
@route.put(
    path="/{radiotherapyId}/dosages/{dosageId}",
    response={200: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="updateRadiotherapyDosage",
)
def update_radiotherapy_dosage(self, radiotherapyId: str, dosageId: str, payload: scm.RadiotherapyDosageCreate): 
    instance = get_object_or_404(
        orm.RadiotherapyDosage, id=dosageId, radiotherapy__id=radiotherapyId
    )
    return payload.model_dump_django(instance=instance)

update_radiotherapy_setting(radiotherapyId, settingId, payload)

Source code in onconova/oncology/controllers/radiotherapy.py 
276
277
278
279
280
281
282
283
284
285
286
@route.put(
    path="/{radiotherapyId}/settings/{settingId}",
    response={200: ModifiedResourceSchema, 404: None, **COMMON_HTTP_ERRORS},
    permissions=[perms.CanManageCases],
    operation_id="updateRadiotherapySetting",
)
def update_radiotherapy_setting(self, radiotherapyId: str, settingId: str, payload: scm.RadiotherapySettingCreate): 
    instance = get_object_or_404(
        orm.RadiotherapySetting, id=settingId, radiotherapy__id=radiotherapyId
    )
    return payload.model_dump_django(instance=instance)
runner