edc-action-items
Add patient action items to the Edc
Overview
Action items are reminders to submit a form.
Action items can be configured to drive data collection
for forms that do not fit well in a visit schedule;
for forms that are required based on some clinical event.
Action items are tracked. Each is allocated a unique action_identifier and maintain status (New, Open, Closed).
Actions can be chained. One action can create another action, group of actions or recreate itself.
Adverse Events, Death, OffSchedule are all good candidates.
Adverse Event reports are required based on some clinical event. Since the event must be reported, leaving the decision to report to the user is not sufficient. An action item can be opened based on the clinical event and the status of the action item tracked administratively. The action item is associtaed with the AE report. Once the report is submitted, the action item closes. If additional data is required after an initial AE report is submitted, a follow-up action can automatically be opened.
See module ambition-ae.action_items for examples.
Defining action items
In the root of your App, define an action_items module. The edc-action-item site controller will autodiscover this module and register the action item classes.
Register action item classes in the action_items module like this
site_action_items.register(AeInitialAction)A simple action item
In it define actions using the Action class.
from edc_action_item.action import Action
from edc_action_item.site_action_items import site_action_items
from edc_constants.constants HIGH_PRIORITY
from ambition_ae.action_items import AeFollowupAction, AeTmgAction
class AeInitialAction(Action):
name = AE_INITIAL_ACTION
display_name = 'Submit AE Initial Report'
model = 'ambition_ae.aeinitial'
show_on_dashboard = True
instructions = 'Complete the initial report and forward to the TMG'
priority = HIGH_PRIORITYThe action item is associated with its model
from edc_action_item.model_mixins import ActionModelMixin
from edc_identifier.model_mixins import NonUniqueSubjectIdentifierFieldMixin
class AeInitial(ActionModelMixin, NonUniqueSubjectIdentifierFieldMixin,
BaseUuidModel):
action_cls = AeInitialAction
... # field classesSomewhere in your code, instantiate the action item
AeInitialAction(subject_identifier='12345')This creates an ActionItem model instance for this subject with a status of New (if it does not exist).
Now create the associated model instance
AeInitial.objects.create(subject_identifier='12345', ...)The ActionItem model instance now has a status of Closed.
Changing the criteria to close an action
By default an action is closed once the associated model instance has been saved. For more refined behavior define close_action_item_on_save on the action item class
class AeInitialAction(Action):
...
def close_action_item_on_save(self):
self.delete_children_if_new(action_cls=self)
return self.model_obj.report_status == CLOSEDSingleton action items
To ensure an action item does not create more than one instance per subject, use the singleton attribute.
class EnrollToSubstudyAction(Action):
name = 'My Action'
display_name = 'Enroll to sub-study'
model = 'myapp.enroll'
show_link_to_changelist = True
admin_site_name = 'myapp_admin'
priority = HIGH_PRIORITY
create_by_user = False
singleton=TrueAction items that create a next action item
For an action item to open another action item(s) once closed, set next_actions.
class AeInitialAction(Action):
name = AE_INITIAL_ACTION
display_name = 'Submit AE Initial Report'
model = 'ambition_ae.aeinitial'
show_on_dashboard = True
instructions = 'Complete the initial report and forward to the TMG'
priority = HIGH_PRIORITY
next_actions = [AeFollowupAction]If the criteria for the next action is based on some other information declare get_next_actions on the action item and return the list of action items needed.
class AeInitialAction(Action):
...
def get_next_actions(self):
next_actions = []
try:
self.reference_model_cls().objects.get(
ae_initial=self.model_obj.ae_initial)
except MultipleObjectsReturned:
pass
else:
if (self.model_obj.ae_initial.ae_classification
!= self.model_obj.ae_classification):
next_actions = [self]
return next_actionsAction items with a notification
An action item can be associated with a notification from edc_notification so that when an action is created a notification (email or sms) is sent to those registered to receive it.
A subclass of Action, ActionWithNotification adds notifications to the action. The notification for the action is automatically registered when the action is registered by site_action_items.
For example:
class AeTmgAction(ActionWithNotification):
name = AE_TMG_ACTION
display_name = "TMG AE Report pending"
notification_display_name = "TMG AE Report"
parent_action_names = [AE_INITIAL_ACTION],
reference_model = "ambition_ae.aetmg"
related_reference_model = "ambition_ae.aeinitial"
related_reference_fk_attr = "ae_initial"
show_link_to_changelist = True
admin_site_name = "ambition_ae_admin"2 maintainers
Metadata
2 maintainers
Release files for edc-action-item 1.0.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| edc_action_item-1.0.3.tar.gz | 81.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| edc_action_item-1.0.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 198.9 kB
Release files / edc_action_item-1.0.3.tar.gz
| Download URL | edc_action_item-1.0.3.tar.gz |
|---|---|
| Size | 81.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8d5aadaec0fc0aea00a3a22dcdadbc5b175c5df0aeae2f9a639b7aa9a4f91db6
|
|
BLAKE2b-256 checksum How to use checksums |
176b27e76da62ebed46a78e640e283f8ca0265e66108489e1db9b9d68c8a57f2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.11
|
Release files / edc_action_item-1.0.3-py3-none-any.whl
| Download URL | edc_action_item-1.0.3-py3-none-any.whl |
|---|---|
| Size | 117.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1063fa6685038a03e11865d0c3b82e43540c6ecacb5f9291ca3adbc7abfc82b3
|
|
BLAKE2b-256 checksum How to use checksums |
f240742684f63696d56f14ff7618a2ea92c8de7785ba787aa58594a20ac601b9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.11
|
Security for edc-action-item 1.0.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
