Appworx Documentation - Read the Docs · 2019-04-02 · Appworx Documentation, Release 0.0.1 ipwhois==0.12.0 kombu==3.0.8 Markdown==2.3.1 Pillow==3.1.1 PyPDF2==1.19 python-dateutil==2.2

Appworx DocumentationRelease 0.0.1

Sphinx

April 07, 2016

Contents

1 Requirements 31.1 Server Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.2 Python Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.3 Installation on Dev environment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.4 Installation on Production server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.5 Installation on Staging server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

2 Modules 52.1 Account module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52.2 API module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72.3 Contacts module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92.4 History module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.5 Image module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102.6 Integration module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112.7 Leads module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.8 Messaging module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122.9 Note module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.10 Referrals module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132.11 Report module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142.12 Sessions module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152.13 Sharing module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152.14 Signature module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.15 Statistics module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.16 Telederm module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162.17 Utils module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172.18 Video module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

3 Database Structure 19

4 Server Structure 21

5 Indices and tables 23

i

ii

Appworx Documentation, Release 0.0.1

Contents:

Contents 1


2 Contents

CHAPTER 1

Requirements

1.1 Server Requirements

Debian dependency are in file requirements/server.packages.debian. For debian system install next packages:

sudo apt-get install build-essential nginx-full exim4 uwsgi-plugin-python python-virtualenv mercurial python-dev libxml2-dev libxslt1-dev libffi-dev libcairo2-dev libcairo2 python-cairo libpango1.0-dev libpq-dev postgresql zlib1g-dev libjpeg8-dev libfreetype6-dev xmlsec1 redis-server

# Create symlinks for PIL librarysudo ln -s /usr/lib/x86_64-linux-gnu/libfreetype.so /usr/lib/sudo ln -s /usr/lib/x86_64-linux-gnu/libz.so /usr/lib/sudo ln -s /usr/lib/x86_64-linux-gnu/libjpeg.so /usr/lib/

1.2 Python Requirements

All python requirements stored in requirements/main.txt

For install requirements use next command:

pip install -r requirements/main.txt

List of all python requirements:

boto==2.27.0celery==3.1.7django==1.6.11django-admin-sortable2==0.2.7django-cachebuster==0.2.1django-celery==3.1.1django-cors-headers==1.1.0django-dynamic-fixture==1.6.5django-filter==0.7django-kombu==0.9.4django-mobi==0.1.7django-postman==3.0.2django-s3-folder-storage==0.2django-storages==1.1.8djangorestframework==2.3.12django-rest-swagger==0.3.5djangosaml2==0.10.0django-tinymce==1.5.2hashlib==20081119

3


ipwhois==0.12.0kombu==3.0.8Markdown==2.3.1Pillow==3.1.1PyPDF2==1.19python-dateutil==2.2python-memcached==1.53raven==5.12.0reportlab==2.7requests==2.1.0rest-condition==1.0.2sorl-thumbnail==11.12South==0.8.4suds==0.4urbanairship==0.6.2WeasyPrint==0.23xlwt==0.7.5path.py==5.1

-e hg+https://bitbucket.org/anger/alphabet-paginator#egg=alphabet_paginator-e hg+https://bitbucket.org/caktus/django-countries#egg=django_countries

-e hg+https://bitbucket.org/userzimmermann/django-piston3@6fe03c1edf0a36acf5770f1aa7945f773ed6c310#egg=django-piston3django-redis-sessions==0.5.0django-redis-cache==1.6.5

1.3 Installation on Dev environment

1.4 Installation on Production server

1.5 Installation on Staging server

4 Chapter 1. Requirements

CHAPTER 2

Modules

2.1 Account module

Accounts module

Admin Panel:

Model Name Admin UrlClinics /cpr-admin/accounts/clinic/Devices /cpr-admin/accounts/device/Diagnose Overrides /cpr-admin/accounts/diagnosisoverride/Diagnoses /cpr-admin/accounts/diagnosis/Distributors /cpr-admin/accounts/distributor/Doctor types /cpr-admin/accounts/doctortype/Patients /cpr-admin/accounts/patient/Platforms /cpr-admin/accounts/platform/Referring Doctors /cpr-admin/accounts/referringdoctor/Treatment Overrides /cpr-admin/accounts/treatmentoverride/Treatments /cpr-admin/accounts/treatment/Users /cpr-admin/accounts/doctor/

Urls:

5


Url nameaccounts/dashboard/ dashboardaccounts/dashboard/(?P<page>d+) dashboard_pageaccounts/add/ add_useraccounts/edit/(?P<user_id>d+) edit_useraccounts/delete/(?P<user_id>d+) delete_useraccounts/passreset/ forgot_password1accounts/passresetdone/ password_reset_doneaccounts/passresetconfirm/(?P<uidb36>[-w]+)/(?P<token>[-w]+)/ forgot_password3accounts/passresetcomplete/ forgot_password4accounts/password_change/ password_changeaccounts/password_change_done/ password_change_doneaccounts/autocomplete/ patient_autocompleteaccounts/patient/(?P<patient_id>d+)/video/(?P<video_id>w+)/ patient_videoaccounts/patient/(?P<patient_id>d+)/video/ patient_videoaccounts/view-patient/(?P<patient_id>d+)/(?P<image_id>w+)/ view_patientaccounts/view-patient/(?P<patient_id>d+)/v/(?P<video_id>w+)/ view_patientaccounts/view-patient/(?P<patient_id>d+)/ view_patientaccounts/delete-patient/(?P<patient_id>d+)/ delete_patientaccounts/update-patient/(?P<patient_id>d+)/ update_patientaccounts/edit-patient/(?P<patient_id>d+)/ edit_patientaccounts/new-patient/ new_patientaccounts/add-photos/(?P<patient_id>d+)/ add_photosaccounts/grid_view/(?P<patient_id>d+)/ grid_viewaccounts/main_view/(?P<patient_id>d+)/ main_viewaccounts/test_view/ test_view

6 Chapter 2. Modules


2.1.1 admin

2.1.2 auth

2.1.3 backends

2.1.4 decorators

2.1.5 forms

2.1.6 handlers

2.1.7 helpers

2.1.8 middleware

2.1.9 models

2.1.10 views

2.1.11 management

2.2 API module

API

Url Nameapi/login/$ login_handlerapi/eclinical/clinic/(?P<clinic_id>w+)/$ eclinical_clinic_detailapi/eclinical/clinic/$ eclinical_clinic_handlerapi/eclinical/doctor/(?P<doctor_id>w+)/$ eclinical_doctor_detailapi/eclinical/doctor/$ eclinical_doctor_handlerapi/eclinical/patient/(?P<patient_id>w+)/$ eclinical_patient_detailapi/eclinical/patient/$ eclinical_patient_handlerapi/eclinical/image/sync/(?P<image_id>w+)/$ eclinical_image_sync_handlerapi/eclinical/image/(?P<clinic_id>w+)/$ eclinical_image_handlerapi/doctor/(?P<doctor_id>w+)/ doctor_handlerapi/doctor/ doctor_handlerapi/patient/with_initial/(?P<letter>.*)/ patient_with_initial_handlerapi/patient/(?P<patient_id>d+)/ patient_handlerapi/patient/initial/ patient_initial_handlerapi/patient/image/(?P<image_id>d+)/ patient_image_handlerapi/patient/image/ patient_image_handlerapi/patient/video/(?P<video_id>d+)/ patient_video_handlerapi/patient/video/ patient_video_handlerapi/patient/ patient_handlerapi/patient_notes/(?P<id>d+)/ patient_notes_handlerapi/patient_notes/ patient_notes_handlerapi/patient_diagnosis/(?P<patient_id>d+)/ patient_diagnosis_handler

Continued on next page

2.2. API module 7


Table 2.1 – continued from previous pageUrl Name

api/patient_treatment/(?P<patient_id>d+)/ patient_treatment_handlerapi/diagnosis/ diagnosis_handlerapi/treatment/ treatment_handlerapi/body_part/(?P<id>d+)/ body_part_handlerapi/body_part/ body_part_handlerapi/image/(?P<image_id>d+)/$ image_handlerapi/image/dates/(?P<patient_id>d+)/$ patient_image_dates_handlerapi/image/dates/(?P<patient_id>d+)/(?P<year>d{4})/(?P<month>d{2})/(?P<day>d{2})/$ patient_image_dates_handlerapi/image/ image_handlerapi/thumbnail/photo/ photo_thumbnail_handlerapi/thumbnail/avatar/ avatar_thumbnail_handlerapi/video/(?P<video_id>d+)/$ video_handlerapi/video/dates/(?P<patient_id>d+)/$ patient_video_dates_handlerapi/video/dates/(?P<patient_id>d+)/(?P<year>d{4})/(?P<month>d{2})/(?P<day>d{2})/$ patient_video_dates_handlerapi/video/ video_handlerapi/lead/practice/$ lead_patient_viewapi/lead/$ lead_handlerapi/clinic/$ clinic_handlerapi/clinic_data/$ clinicdata_handlerapi/mobile_signup/$ mobilesignup_handlerapi/data/$ data_handlerapi/report/report_type/(?P<report_type_id>d+)/$ report_type_handlerapi/report/report_type/$ report_type_handlerapi/report/report_section/(?P<report_section_id>d+)/$ report_section_handlerapi/report/report_section/$ report_section_handlerapi/report/report_subsection/(?P<report_subsection_id>d+)/$ report_subsection_handlerapi/report/report_subsection/$ report_subsection_handlerapi/report_mailer/(?P<patient_id>d+)/$ report_mailer_handlerapi/send-report/(?P<patient_id>d+)/ report_handlerapi/telederm/(?P<patient_id>d+)/$ telederm_show_handlerapi/messaging/$ messages_handlerapi/messaging/(?P<pk>d+)/$ message_handlerapi/messaging/thread/(?P<pk>d+)/$ thread_handlerapi/referrals/$ referrals_handlerapi/device/$ device_handlerapi/docs/ api_docsapi/v2/patientapi/v2/doctorapi/v2/referringdoctorapi/v2/imageapi/v2/imagenoteapi/v2/videoapi/v2/bodypartapi/v2/treatmentapi/v2/diagnoseapi/v2/messageapi/v2/threadapi/v2/reportapi/v2/device

Continued on next page



Table 2.1 – continued from previous pageUrl Name

api/v2/clinicapi/v2/cmsapi/v2/drugapi/v2/userfileapi/v2/contentblockapi/v2/contentblockmediaapi/v2/patientformtemplateapi/v2/patientformapi/v2/auditapi/v2/imagepairapi/v2/galleryapi/v2/publicgalleryapi/v2/procedureapi/v2/docs/api/v2/authenticate/web/api/v2/authenticate/clinic/ authenticate-clinicapi/v2/authenticate/doctor/ authenticate-doctorapi/v2/authenticate/patient/ authenticate-patientapi/v2/authenticate/referringdoctor/ authenticate-referringdoctorapi/v2/authenticate/patient_gateway/ authenticate-patient-gatewayapi/v2/authenticate/logout/ authenticate-logoutapi/v2/authenticate/forgot_password/ authenticate-forgot-passwordapi/v2/authenticate/reset_password/ authenticate-reset-password

2.2.1 handlers

2.2.2 middleware

2.2.3 models

2.2.4 api v2

2.3 Contacts module

Admin Panel:

Model Name Admin UrlContacts /cpr-admin/contacts/contact/

Urls:

Uri Namecontact/new/$ new_contact

2.3. Contacts module 9


2.3.1 admin

2.3.2 forms

2.3.3 models

2.3.4 views

2.4 History module

Admin Panel:

Model Name Admin UrlLog items /cpr-admin/history/logitem/

2.4.1 admin

2.4.2 models

2.5 Image module

Admin Panel:

Model Name Admin UrlBody parts /cpr-admin/image/bodypart/Image filters /cpr-admin/image/imagefilter/Images /cpr-admin/image/image/User files /cpr-admin/image/userfile/

Urls:

Uri Nameimage/replace-image/(?P<image_id>d+)/$ replace_imageimage/edit-image/(?P<image_id>d+)/$ edit_imageimage/blur-image/$ blur_imageimage/save-image/(?P<image_id>d+)/$ save_imageimage/delete-image/(?P<image_id>d+)/ delete_imageimage/get/(?P<path>.+)$ get_imageimage/save_crop_image/(?P<image_id>d+)/ save_crop_imageimage/download-images/(?P<patient_id>d+)/(?P<image_id>d+)/(?P<dtype>this|date|patient)

download_images

image/images-actions/ images_actionsimage/test_view/ test_viewimage/save_upload/(?P<tmp>tmp)?/ save_image_uploadimage/add/(?P<patient_id>d+)/ add_images



2.5.1 admin

2.5.2 forms

2.5.3 handlers

2.5.4 models

2.5.5 serve_static

2.5.6 utils

2.5.7 views

2.5.8 management

2.5.9 templatetags

2.6 Integration module

Admin Panel:

Model Name Admin UrlGateway datas /cpr-admin/integration/gatewaydata/Gateways /cpr-admin/integration/gateway/

Urls:

Uri Nameintegration/api/search_patientsintegration/api/pull_or_syncintegration/api/gateway=([a-z]+)/deferred_authenticateintegration/saml2_sso/gateway=([a-z]+)/login$ saml_login_handler

2.6. Integration module 11


2.6.1 admin

2.6.2 models

2.6.3 tests

2.6.4 translation

2.6.5 api

2.6.6 emrs

2.6.7 emrs

2.6.8 saml

2.6.9 management

2.7 Leads module

Admin Panel:

Model Name Admin UrlLead images /cpr-admin/leads/leadimage/Leads /cpr-admin/leads/lead/

2.7.1 admin

2.7.2 forms

2.7.3 models

2.7.4 tests

2.8 Messaging module

Admin Panel:

Model Name Admin UrlApps /cpr-admin/messaging/app/Attachments /cpr-admin/messaging/attachment/Secure messages /cpr-admin/messaging/securemessage/

Urls:

Uri Namemessaging/inbox/$ inboxmessaging/inbox/(?P<option>w+)/$ inboxmessaging/reply/(?P<message_id>[d]+)/$ replymessaging/assign_to/(?P<message_id>[d]+)/$ assign_to



2.8.1 api

2.8.2 forms

2.8.3 handlers

2.8.4 middleware

2.8.5 models

2.9 Note module

Admin Panel:

Model Name Admin UrlDrug manufacturers /cpr-admin/note/drugmanufacturer/Drug product types /cpr-admin/note/drugproducttype/Drugs /cpr-admin/note/drug/Image notes /cpr-admin/note/imagenote/Patient notes /cpr-admin/note/note/

Urls:

Uri Namenote/add-note/$ add_notenote/delete-note/$ delete_notenote/add-image-note/$ add_image_notenote/add-image-note-async$ add_image_note_asyncnote/add-patient-note-async$ add_patient_note_asyncnote/delete-image-note-async/(?P<note_id>d+)/$ delete_image_note_asyncnote/delete-patient-note-async/(?P<note_id>d+)/$ delete_patient_note_async

2.9.1 admin

2.9.2 forms

2.9.3 models

2.9.4 views

2.9.5 templatetags

2.10 Referrals module

Admin Panel:

Model Name Admin UrlReferral doctors /cpr-admin/referrals/referraldoctor/Referral images /cpr-admin/referrals/referralimage/Referral patients /cpr-admin/referrals/referralpatient/

Urls:

2.9. Note module 13


Uri Nameinbox/$ referrals_inboxinbox/(?P<option>w+)/$ referrals_inboxmark_as_archived/(?P<referral_id>[d]+)/$ mark_as_archived

2.10.1 forms

2.10.2 handlers

2.10.3 models

2.10.4 signals

2.10.5 tests

2.11 Report module

Admin Panel:

Model Name Admin UrlContent block medias /cpr-admin/report/contentblockmedia/Content blocks /cpr-admin/report/contentblock/Marketing contents /cpr-admin/report/marketingcontent/Report datas /cpr-admin/report/reportdata/Section overrides /cpr-admin/report/sectionoverride/Sections /cpr-admin/report/section/Sub section overrides /cpr-admin/report/subsectionoverride/Sub sections /cpr-admin/report/subsection/

Urls:



Uri Namereport/report/system_activity/$ report_system_activityreport/report/system_overall/$ report_system_overallreport/report/system_membership/$ report_system_membershipreport/report/system_diskusage/$ report_system_diskusagereport/report/send_system_overall/$ send_overall_reportreport/report/(?P<patient_id>d+)/$ report_initial_consultationreport/report/initial_consultation_pdf/(?P<patient_id>d+)/$ initial_consultation_pdfreport/report/(?P<patient_id>d+)/report_compare$ report_comparereport/report_single_photo/(?P<patient_id>d+)/report_single_photo$ report_single_photoreport/report/content/$ report_contentreport/report/content/add_section/$ add_sectionreport/report/content/add_subsection/(?P<section_id>d+)/$ add_sub_sectionreport/report/content/list/$ content_listreport/report/content/create_block/$ create_blockreport/report/content/update_block/(?P<block_id>d+)/$ update_blockreport/report/content/delete/(?P<block_id>d+)/$ delete_blockreport/report/content/manage/$ manage_sectionsreport/report/edit_subsection/$ edit_subsectionreport/report/edit_section/$ edit_sectionreport/report/delete_section/(?P<section_id>d+)$ delete_sectionreport/report/delete_sub_section/(?P<sub_section_id>d+)$ delete_sub_sectionreport/gateway_report/(?P<pk>d+)/$ gateway_report

2.11.1 admin

2.11.2 forms

2.11.3 models

2.11.4 report_generator

2.11.5 tests

2.11.6 views

2.11.7 templatetags

2.12 Sessions module

2.12.1 middleware

2.13 Sharing module

Admin Panel:

Model Name Admin UrlGallerys /cpr-admin/sharing/gallery/Image pairs /cpr-admin/sharing/imagepair/Procedures /cpr-admin/sharing/procedure/

2.12. Sessions module 15


2.13.1 models

2.13.2 signals

2.14 Signature module

Admin Panel:

Model Name Admin UrlAnswers /cpr-admin/signature/answer/Form templates /cpr-admin/signature/formtemplate/Patient forms /cpr-admin/signature/patientform/Questions /cpr-admin/signature/question/

2.14.1 api

2.14.2 admin

2.14.3 models

2.15 Statistics module

Admin Panel:

Model Name Admin UrlIp stats /cpr-admin/statistics/ipstat/

2.15.1 admin

2.15.2 models

2.15.3 signals

2.16 Telederm module

Admin Panel:

Model Name Admin UrlCase datas /cpr-admin/telederm/casedata/

Urls:

Uri Nametelederm/case_data/(d+)/$ case_data_viewtelederm/case_data/(d+)/edit/$ case_data_edittelederm/case_data/claim/$ case_data_claim



2.16.1 admin

2.16.2 forms

2.16.3 models

2.16.4 views

2.17 Utils module

2.17.1 context_processors

2.17.2 decorators

2.17.3 enum_choices

2.17.4 utils

2.17.5 widgets

2.18 Video module

Admin Panel:

Model Name Admin UrlCase datas /cpr-admin/video/video/

Urls:

Uri Namevideo/edit-video/(?P<video_id>d+)/$ edit_videovideo/save-video/(?P<video_id>d+)/$ save_videovideo/delete-video/(?P<video_id>d+)/ delete_videovideo/get/(?P<path>.*)$video/download-videos/(?P<patient_id>d+)/(?P<video_id>d+)/(?P<dtype>this|date|patient) download_videosvideo/video-actions/ video_actionsvideo/save_upload/(?P<tmp>tmp)?/ save_video_uploadvideo/add/(?P<patient_id>d+)/ add_videos

2.18.1 forms

2.18.2 models

2.18.3 views

2.17. Utils module 17



CHAPTER 3

Database Structure

19


20 Chapter 3. Database Structure

CHAPTER 4

Server Structure

21


22 Chapter 4. Server Structure

CHAPTER 5

Indices and tables

• genindex

• modindex

• search

• Python Requirements

• Installation on Production server

• Installation on Staging server

• Installation on Dev environment

23

Documents

Appworx Documentation - Read the Docs · 2019-04-02 · Appworx Documentation, Release 0.0.1 ipwhois==0.12.0 kombu==3.0.8 Markdown==2.3.1 Pillow==3.1.1 PyPDF2==1.19 python-dateutil==2.2