edc-adverse-event


Nameedc-adverse-event JSON
Version 0.3.82 PyPI version JSON
download
home_pagehttps://github.com/clinicedc/edc-adverse-event
SummaryAdverse event and death classes for clinicedc/edc projects
upload_time2024-03-27 19:50:10
maintainerNone
docs_urlNone
authorErik van Widenfelt
requires_python>=3.11
licenseGPL license, see LICENSE
keywords django edc adverse events clinicedc clinical trials
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage
            |pypi| |actions| |codecov| |downloads|

edc-adverse-event
-----------------

Create an AE application
------------------------

Create an AE app that will house your AE concrete models, admin site, list data, and action items.

Adverse events models
---------------------

Model mixins exist for you to create the following concrete models in your AE app:

* AE Initial: The initial report of a adverse event
* AE Followup: 1 or more follow-ups to the initial AE report
* AE Special Interest
* AE SUSAR
* AE External Reviewer
* Death Report
* Death Report External Reviewer

TMG: Trial Management Group forms

* AE Tmg:

Settings
--------

These are the ``settings`` attributes you need to define for ``edc_adverse_event``:

.. code-block:: python

    # settings.py

    ...

    ADVERSE_EVENT_APP_LABEL="edc_adverse_event"  # replace with your AE app label
    ADVERSE_EVENT_ADMIN_SITE="edc_adverse_event_admin"  # replave with your AE app admin site name

    ...

Define a list_data.py
---------------------

There are a few FK fields on the AE models. You need to define a ``list_data.py`` that will be read to populate the FK list models.

The list model tables are:
* ``edc_adverse_event.aeclassification`` (See AeInitial)
* ``edc_adverse_event.saereason`` (See AeInitial)

.. code-block:: python

    # list_data.py

    list_data = {
        "edc_adverse_event.aeclassification": [
            (ANAEMIA, "Anaemia"),
            ("diarrhoea", "Diarrhoea"),
            (RENAL_IMPAIRMENT, "Renal impairment"),
            (OTHER, "Other"),
        ],
        "edc_adverse_event.saereason": [
            (NOT_APPLICABLE, "Not applicable"),
            (DEAD, "Death"),
            ("life_threatening", "Life-threatening"),
            ("significant_disability", "Significant disability"),
            (
                "in-patient_hospitalization",
                (
                    "In-patient hospitalization or prolongation "
                    "(17 or more days from study inclusion)"
                ),
            ),
            (
                "medically_important_event",
                "Medically important event (e.g. recurrence of symptoms not requiring admission, "
                "Hospital acquired pneumonia)",
            ),
        ],
    }

    preload_data = PreloadData(
        list_data=list_data, model_data={}, unique_field_data=None)


Register AE Action Items
------------------------

The AE action items are not registered by default. To register, in the root of your AE app add an ``action_items.py``:

.. code-block:: python

    # action_items.py

    from edc_adverse_event.action_items import AeInitialAction
    from edc_adverse_event.action_items import AeFollowupAction
    from edc_adverse_event.action_items import AeSusarAction
    from edc_adverse_event.action_items import AeTmgAction

    site_action_items.register(AeInitialAction)
    site_action_items.register(AeFollowupAction)
    site_action_items.register(AeTmgAction)
    site_action_items.register(AeSusarAction)



.. |pypi| image:: https://img.shields.io/pypi/v/edc-adverse-event.svg
    :target: https://pypi.python.org/pypi/edc-adverse-event

.. |actions| image:: https://github.com/clinicedc/edc-adverse-event/actions/workflows/build.yml/badge.svg
  :target: https://github.com/clinicedc/edc-adverse-event/actions/workflows/build.yml

.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-adverse-event/branch/develop/graph/badge.svg
  :target: https://codecov.io/gh/clinicedc/edc-adverse-event

.. |downloads| image:: https://pepy.tech/badge/edc-adverse-event
   :target: https://pepy.tech/project/edc-adverse-event

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/clinicedc/edc-adverse-event",
    "name": "edc-adverse-event",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": "django Edc adverse events, clinicedc, clinical trials",
    "author": "Erik van Widenfelt",
    "author_email": "ew2789@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/61/0e/1aa85d71ab696ac17579f8feb25875aeebd8da138eea0abdce4868629734/edc-adverse-event-0.3.82.tar.gz",
    "platform": null,
    "description": "|pypi| |actions| |codecov| |downloads|\n\nedc-adverse-event\n-----------------\n\nCreate an AE application\n------------------------\n\nCreate an AE app that will house your AE concrete models, admin site, list data, and action items.\n\nAdverse events models\n---------------------\n\nModel mixins exist for you to create the following concrete models in your AE app:\n\n* AE Initial: The initial report of a adverse event\n* AE Followup: 1 or more follow-ups to the initial AE report\n* AE Special Interest\n* AE SUSAR\n* AE External Reviewer\n* Death Report\n* Death Report External Reviewer\n\nTMG: Trial Management Group forms\n\n* AE Tmg:\n\nSettings\n--------\n\nThese are the ``settings`` attributes you need to define for ``edc_adverse_event``:\n\n.. code-block:: python\n\n    # settings.py\n\n    ...\n\n    ADVERSE_EVENT_APP_LABEL=\"edc_adverse_event\"  # replace with your AE app label\n    ADVERSE_EVENT_ADMIN_SITE=\"edc_adverse_event_admin\"  # replave with your AE app admin site name\n\n    ...\n\nDefine a list_data.py\n---------------------\n\nThere are a few FK fields on the AE models. You need to define a ``list_data.py`` that will be read to populate the FK list models.\n\nThe list model tables are:\n* ``edc_adverse_event.aeclassification`` (See AeInitial)\n* ``edc_adverse_event.saereason`` (See AeInitial)\n\n.. code-block:: python\n\n    # list_data.py\n\n    list_data = {\n        \"edc_adverse_event.aeclassification\": [\n            (ANAEMIA, \"Anaemia\"),\n            (\"diarrhoea\", \"Diarrhoea\"),\n            (RENAL_IMPAIRMENT, \"Renal impairment\"),\n            (OTHER, \"Other\"),\n        ],\n        \"edc_adverse_event.saereason\": [\n            (NOT_APPLICABLE, \"Not applicable\"),\n            (DEAD, \"Death\"),\n            (\"life_threatening\", \"Life-threatening\"),\n            (\"significant_disability\", \"Significant disability\"),\n            (\n                \"in-patient_hospitalization\",\n                (\n                    \"In-patient hospitalization or prolongation \"\n                    \"(17 or more days from study inclusion)\"\n                ),\n            ),\n            (\n                \"medically_important_event\",\n                \"Medically important event (e.g. recurrence of symptoms not requiring admission, \"\n                \"Hospital acquired pneumonia)\",\n            ),\n        ],\n    }\n\n    preload_data = PreloadData(\n        list_data=list_data, model_data={}, unique_field_data=None)\n\n\nRegister AE Action Items\n------------------------\n\nThe AE action items are not registered by default. To register, in the root of your AE app add an ``action_items.py``:\n\n.. code-block:: python\n\n    # action_items.py\n\n    from edc_adverse_event.action_items import AeInitialAction\n    from edc_adverse_event.action_items import AeFollowupAction\n    from edc_adverse_event.action_items import AeSusarAction\n    from edc_adverse_event.action_items import AeTmgAction\n\n    site_action_items.register(AeInitialAction)\n    site_action_items.register(AeFollowupAction)\n    site_action_items.register(AeTmgAction)\n    site_action_items.register(AeSusarAction)\n\n\n\n.. |pypi| image:: https://img.shields.io/pypi/v/edc-adverse-event.svg\n    :target: https://pypi.python.org/pypi/edc-adverse-event\n\n.. |actions| image:: https://github.com/clinicedc/edc-adverse-event/actions/workflows/build.yml/badge.svg\n  :target: https://github.com/clinicedc/edc-adverse-event/actions/workflows/build.yml\n\n.. |codecov| image:: https://codecov.io/gh/clinicedc/edc-adverse-event/branch/develop/graph/badge.svg\n  :target: https://codecov.io/gh/clinicedc/edc-adverse-event\n\n.. |downloads| image:: https://pepy.tech/badge/edc-adverse-event\n   :target: https://pepy.tech/project/edc-adverse-event\n",
    "bugtrack_url": null,
    "license": "GPL license, see LICENSE",
    "summary": "Adverse event and death classes for clinicedc/edc projects",
    "version": "0.3.82",
    "project_urls": {
        "Homepage": "https://github.com/clinicedc/edc-adverse-event"
    },
    "split_keywords": [
        "django edc adverse events",
        " clinicedc",
        " clinical trials"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "50d1b0c4ecff19e92c1db66ab16828bd676194b28cda27d0003ba4dcdec341b5",
                "md5": "99f286be26488b9ea2a1f876ebce76d8",
                "sha256": "256b8fbbc473a018200291e198c3aeb15f1bcfe120848cb87fbf1b8856bfb149"
            },
            "downloads": -1,
            "filename": "edc_adverse_event-0.3.82-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "99f286be26488b9ea2a1f876ebce76d8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 160920,
            "upload_time": "2024-03-27T19:50:07",
            "upload_time_iso_8601": "2024-03-27T19:50:07.044963Z",
            "url": "https://files.pythonhosted.org/packages/50/d1/b0c4ecff19e92c1db66ab16828bd676194b28cda27d0003ba4dcdec341b5/edc_adverse_event-0.3.82-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "610e1aa85d71ab696ac17579f8feb25875aeebd8da138eea0abdce4868629734",
                "md5": "65fa62a88273770379a43c6d7f7a4d98",
                "sha256": "2ca49e815c65cb58ce3c874aa43294a6cf6e5d74360444e0e62ac3aa21918ef9"
            },
            "downloads": -1,
            "filename": "edc-adverse-event-0.3.82.tar.gz",
            "has_sig": false,
            "md5_digest": "65fa62a88273770379a43c6d7f7a4d98",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.11",
            "size": 91978,
            "upload_time": "2024-03-27T19:50:10",
            "upload_time_iso_8601": "2024-03-27T19:50:10.300710Z",
            "url": "https://files.pythonhosted.org/packages/61/0e/1aa85d71ab696ac17579f8feb25875aeebd8da138eea0abdce4868629734/edc-adverse-event-0.3.82.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-27 19:50:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "clinicedc",
    "github_project": "edc-adverse-event",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "lcname": "edc-adverse-event"
}
        
Elapsed time: 0.28609s