nlpmed_portal.annotations.api.views module

class nlpmed_portal.annotations.api.views.AdjudicationViewSet[source]

Bases: BaseViewSet

basename = None
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
pivot(request, *args, **kwargs)[source]
queryset
required_perms = {'DELETE': 'delete_adjudication', 'GET': 'view_adjudication', 'HEAD': 'view_adjudication', 'OPTIONS': 'view_adjudication', 'PATCH': 'change_adjudication', 'POST': 'add_adjudication', 'PUT': 'change_adjudication'}
serializer_class

alias of AdjudicationSerializer

suffix = None
timeline(request, *args, **kwargs)[source]
class nlpmed_portal.annotations.api.views.BaseViewSet[source]

Bases: ModelViewSet

destroy(request, *args, **kwargs)[source]
filter_queryset_by_scope(queryset, required_perm, project_field=None)[source]
class nlpmed_portal.annotations.api.views.ExportAnnotationViewSet[source]

Bases: ViewSet

basename = None
create(request)[source]
Parameters:

request (Any)

Return type:

Response

description = None
detail = None
download(request)[source]
meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
required_perms = {'GET': 'view_exportannotation', 'HEAD': 'view_exportannotation', 'OPTIONS': 'view_exportannotation', 'POST': 'add_exportannotation'}
serializer_class

alias of ExportAnnotationSerializer

suffix = None
class nlpmed_portal.annotations.api.views.ImportJobViewSet[source]

Bases: BaseViewSet

basename = None
confirm(request, pk=None)[source]
create(request, *args, **kwargs)[source]
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_importjob', 'GET': 'view_importjob', 'HEAD': 'view_importjob', 'OPTIONS': 'view_importjob', 'PATCH': 'change_importjob', 'POST': 'add_importjob', 'PUT': 'change_importjob'}
serializer_class

alias of ImportJobSerializer

status(request, pk=None)[source]
suffix = None
class nlpmed_portal.annotations.api.views.LabViewSet[source]

Bases: BaseViewSet

basename = None
delete_all(request, *args, **kwargs)[source]
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
pivot(request, *args, **kwargs)[source]
queryset
required_perms = {'DELETE': 'delete_lab', 'GET': 'view_lab', 'HEAD': 'view_lab', 'OPTIONS': 'view_lab', 'PATCH': 'change_lab', 'POST': 'add_lab', 'PUT': 'change_lab'}
serializer_class

alias of LabSerializer

suffix = None
class nlpmed_portal.annotations.api.views.NERAnnotationViewSet[source]

Bases: BaseViewSet

basename = None
delete_all(request, *args, **kwargs)[source]
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_nerannotation', 'GET': 'view_nerannotation', 'HEAD': 'view_nerannotation', 'OPTIONS': 'view_nerannotation', 'PATCH': 'change_nerannotation', 'POST': 'add_nerannotation', 'PUT': 'change_nerannotation'}
serializer_class

alias of NERAnnotationSerializer

suffix = None
class nlpmed_portal.annotations.api.views.NoteViewSet[source]

Bases: BaseViewSet

basename = None
delete_all(request, *args, **kwargs)[source]
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

list(request, *args, **kwargs)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_note', 'GET': 'view_note', 'HEAD': 'view_note', 'OPTIONS': 'view_note', 'PATCH': 'change_note', 'POST': 'add_note', 'PUT': 'change_note'}
serializer_class

alias of NoteSerializer

suffix = None
class nlpmed_portal.annotations.api.views.PatientAnnotationViewSet[source]

Bases: BaseViewSet

basename = None
delete_all(request, *args, **kwargs)[source]
description = None
destroy(request, *args, **kwargs)[source]
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_class()[source]

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_patientannotation', 'GET': 'view_patientannotation', 'HEAD': 'view_patientannotation', 'OPTIONS': 'view_patientannotation', 'PATCH': 'change_patientannotation', 'POST': 'add_patientannotation', 'PUT': 'change_patientannotation'}
suffix = None
class nlpmed_portal.annotations.api.views.PatientHistoryViewSet[source]

Bases: ViewSet

basename = None
description = None
detail = None
list(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
required_perms = {'GET': 'view_patientannotation_history', 'HEAD': 'view_patientannotation_history', 'OPTIONS': 'view_patientannotation_history'}
serializer_class

alias of PatientHistorySerializer

suffix = None
class nlpmed_portal.annotations.api.views.PatientViewSet[source]

Bases: BaseViewSet

basename = None
delete_all(request, *args, **kwargs)[source]
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_patient', 'GET': 'view_patient', 'HEAD': 'view_patient', 'OPTIONS': 'view_patient', 'PATCH': 'change_patient', 'POST': 'add_patient', 'PUT': 'change_patient'}
serializer_class

alias of PatientSerializer

suffix = None
class nlpmed_portal.annotations.api.views.ProjectMembershipViewSet[source]

Bases: BaseViewSet

basename = None
description = None
detail = None
get_object(*args, **kwargs)[source]

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_class()[source]

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

get_serializer_context()[source]

Extra context provided to the serializer class.

meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_projectmembership', 'GET': 'view_projectmembership', 'HEAD': 'view_projectmembership', 'OPTIONS': 'view_projectmembership', 'PATCH': 'change_projectmembership', 'POST': 'add_projectmembership', 'PUT': 'change_projectmembership'}
suffix = None
class nlpmed_portal.annotations.api.views.ProjectViewSet[source]

Bases: BaseViewSet

basename = None
daterange(request, pk=None)[source]
description = None
detail = None
get_object(*args, **kwargs)[source]

Returns the object the view is displaying.

You may want to override this if you need to provide non-standard queryset lookups. Eg if objects are referenced using multiple keyword arguments in the url conf.

get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_class()[source]

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_project', 'GET': 'view_project', 'HEAD': 'view_project', 'OPTIONS': 'view_project', 'PATCH': 'change_project', 'POST': 'add_project', 'PUT': 'change_project'}
suffix = None
class nlpmed_portal.annotations.api.views.TaskViewSet[source]

Bases: BaseViewSet

basename = None
bulk_create(request)[source]
delete_all(request, *args, **kwargs)[source]
description = None
detail = None
get_queryset()[source]

Get the list of items for this view. This must be an iterable, and may be a queryset. Defaults to using self.queryset.

This method should always be used rather than accessing self.queryset directly, as self.queryset gets evaluated only once, and those results are cached for all subsequent requests.

You may want to override this if you need to provide different querysets depending on the incoming request.

(Eg. return a list of items that is specific to the user)

get_serializer_class()[source]

Return the class to use for the serializer. Defaults to using self.serializer_class.

You may want to override this if you need to provide different serializations depending on the incoming request.

(Eg. admins get full serialization, others get basic serialization)

meta(request)[source]
name = None
permission_classes = [<class 'rest_framework.permissions.IsAuthenticated'>, <class 'nlpmed_portal.annotations.permissions.MethodBasePermission'>]
queryset
required_perms = {'DELETE': 'delete_task', 'GET': 'view_task', 'HEAD': 'view_task', 'OPTIONS': 'view_task', 'PATCH': 'change_task', 'POST': 'add_task', 'PUT': 'change_task'}
suffix = None