This is a major release with breaking changes from upstream dependencies. You are almost certain to require changes to your application. Please see the upgrade guide for further details.
Opal now includes core lookuplist data in an opal.core.referencedata plugin
which is installed and loaded by default by the startproject scaffolding.
Opal 0.10 changes several behaviours related to cascading deletions which, despite being Django defaults, were confusing to users and developers in our use case.
When we delete and look up list instance, we no longer delete all subrecords that use that instance. Instead we set the look up list instances name in the free text field on the subrecord.
When you delete a user, it will no longer delete all related episodes and subrecords
Episode categories now enforce a set of valid Episode.stage values.
EpisodeCategory now includes the .get_stages() and .has_stage(stage) methods,
while Episode has a set_stage setter which is used by the UpdateFromDictMixin JSON API.
Adds the utility generator lookuplists.lookuplists() which wil yield every lookuplist
currently available.
Disoverable features now have a filter method which allows you to filter features
with matching attributes.
The 'opal.core.pathways.context_processors.pathways' Context Processor will allow you to access your pathways from templates without having to explicitly load them in a view. In turn, this allows patterns like:
{% include pathways.YourPathway.get_display_name %}
.update_from_dict() will now raise the new error
opal.core.errors.MissingConsistencyTokenError if it is called without a consistency
token when one is set on the model. Previously it would raise APIError.
The JSON API will now return a more specific message in the response boday, explaining that the problem is a missing consistency token.
Adds the --many-files option to the dump_lookup_lists command which will write
each installed lookup list to a separate file in the ./data/lookuplists directory
of the application.
We remove a number of stale unused templates:
- changelog.html
- contact.html
- extract_footer.html
- tagging_detail.html
- _helpers/inline_form.html
- responsive/_phone_episode_list.html'
- responsive/_tablet_episode_list.html
As Django ships with a LoginRequiredMixin of its own we no longer roll our own
in `opal.core.views.
Adds a --failfast option to the test harness to stop test runs on the first
failure.
If you are a plugin developer upgrading an existing plugin you will have to
manually add support for --failfast passthrough to your runtests.py.
If you are a plugin developer upgrading an existing plugin you will have to
manually add support for --failfast passthrough to your runtests.py.
The rest of the api is still the same but now
we run python manage.py scaffold {my_app_name}
As previously noted in console warnings, the Angular Episode service no longer
supports the discharge_date, date_of_admission, date_of_episode properties.
These were replaced by .start and .end.
- Django: 1.8.13 -> 1.10.8
- Django Reversion: 1.8.7 -> 1.10.2
- Django Rest Framework: 3.2.2 -> 3.4.7
- Psycopg2: 2.5 -> 2.7
- Jinja2: 2.9.6 -> 2.10
- Ffs: 0.0.8.1 -> 0.0.8.2
- Requests: 2.7.0 -> 2.18.4
- django-celery: 3.1.17 -> 3.2.2
- celery: 3.1.19 -> 3.1.25
Removes the undocumented collapsed_multisave tag from the pathways templatetag
library.
Adds a setting OPAL_FAVICON_PATH to specify the application Favicon to use.
Adds the rows option to the textarea template tag which just fills in the html textarea
rows attribute. Text areas are defaulted to 5 rows (the same as before).
Configures the setting CSRF_FAILURE_VIEW to use the bundled opal.views.csrf_failure view.
Adds the utility function opal.utils.get. Similar to the getattr builtin, get looks
for a method named get_$attr and will call that if it exists.
Adds the method .get_absolute_url() to opal.core.pathways.Pathway and
opal.core.patient_lists.PatientList.
Adds the Opal error SignatureError.
Pathway slugs may now include hyphens as well as numbers, lower case letters and underscores.
Bugfix: in edit_item.js $scope.episode_category is now set from episode.category_name as opposed to episode.category (which was always null)
Fixes some instances of progressbars not being reset if unexpected error states occur.
Improves the rendering of patient detail pages where no patient with the ID from route params exits. (Displays a polite message instead of erroring.)
Incorrect pluralisation of subrecord names in the Admin view has been fixed. (Migrations will have to be run in all models which extend the changed core Opal models (this is due to a minor upstream Django bug)
Minor change to the diagnosis form.
And hello episode.start and episode.end. These fields on the Episode model
replace the multiple ways of recording Episode duration in Opal.
There is a migration that sets start to date_of_episode if it exists, otherwise
it uses date of admission.
end will be date_of_episode if it exists, otherwise it will use discharge_date.
Note that this means we no longer refer to start and end properties on the
Episode category. If you override start and end in a custom episode category
you should update to use the Episode model fields. This logic should be moved into
your flows and you'll need to put in a migration to populate existing
episodes.
We also remove the episode fields date_of_episode discharge_date, and
date_of_admission.
Warning: Backwards migrations will not migrate back to date_of_episode but to
a admission and discharge. Take backups before running these migrations!
The fields start and end are both cast to moments (rather than raw js Dates) on
episode.initialisation
Moves the opal-pathway module into the opal core. Pathways is an extensible way of creating forms that involve multiple subrecords.
Adds in the {% timepicker %} template tag, that follows the same convention as the other template tags, ie {% timepicker field="Dinner.time" %}
Previously we declared CATEGORIES globally. This has now been removed
Episodes in the patient list are now ordered by start, first_name and surname
Improvements and better documentation and guides for theming applications. Particularly
of note are changes to opal.html and base.html, as well as the addition of the
static_page.html template.
This version also includes extensive improved support for customising the templates that display patient lists, detail views, menus and forms amongst other things.
For full documentation, consult the theming guide in the documentation.
Search is now completely pluggable, you need to have some angular controller called SearchCtrl, but apart from that you can plugin your own implementation.
Previously they only worked with angular paths, now they work with a combination of actual paths and angular url paths (e.g. /search/#/extract)
Add the allow_add_patient and allow_edit_teams options to the patient lists.
We added support for a --file or -f option for the load_lookup_lists command which
allows the user to specify a particular file outside of the default locations.
The default Location record display template will no longer include references
to Episode.start. and Episode.stop labelled as admisssion and discharge to support
the majority case where an episode relates to something other than an inpatient episode!
Applications wishing to retaint this functionality should update their own temaplates to display start/stop details.
Previously these would make their http request when imported into a file. They now require you to call .load() for them to return the promise that loads in their respective data.
Adds a custom email logger. This enables Django error emails which remove any confidential patient data.
Also adds in the karma config to the MANIFEST.in so that we include the karma configs on pip install. It also moves it to "opal/tests/js_config/karma_defaults.js".
If you run opal test js, your karma config is now run in an environment that has access to the OPAL_LOCATION variable which points to the opal parent directory.
The Extract zip file has a data dictionary with human readable metadata about each field.
The application menu API, previously python dicts stored in attributes on either plugin or
application subclasses, now consists of the new opal.core.menus.MenuItem class, enabling
enhanced customisation and flexibility.
Previously it only returned the episode. Now it matches the episode create api end point
In the admin, episodes and patients lists now have links to the patient detail pages.
Adds a User Angular service that enables applications to use user data.
Also adds some directives to make it easy to render User names and avatars.
Adds a utility method to the Episode service that returns a human readable patient name.
Enhances the API available for plugins to include javascript and css by adding methods on
opal.core.plugins.OpalPlugin
Numeric database fields are now set as the html5 type="number" when rendering them with the forms templatetag library. This means on mobile devices it will bring up the numeric keypad. The element type can now be set via the template tag API with the 'element_type' argument.
This new setting allows applications to set the path at which the app logo is served.
If OPAL_LOGO_PATH is set, the value is passed to the {% static %} templatetag to set
the src atribute of an image in the default application header and login screen.
Changes the behaviour of opal.core.PatientList.to_dict to serialise inactive
episodes by default rather than filtering by Episode.active == True.
opal.core.TaggedPatientList.to_dict continues to filter by Episode.active ==
True by default.
The context variables brand_name settings and extra_application in opal.views.IndexView
are no longer helpful thanks to the settings context processor. These will be removed in
0.9.0 and emit warnings until then.
Adds a new filter - underscore-to-spaces for removing underscores from strings.
The options for SymptomComplex.duration have moved from the default form template to a choices
declaration on the model. These are scheduled to move again to a lookuplist.
The default value of Subrecord.get_display_name now uses Django Meta.verbose_name.
Fixes a bug where the allergies form rendered the provisional field twice
Upgrades Font Awesome from 4.3.0 -> 4.7.0 Upgrades Jinja2 from 2.8 -> 2.9.6
We now use the $cookies api as part of moving to angular v1.5.8.
The default expiry of cookies is now a year in the future.
The cookie name previously stored as opal.lastPatientList is now
opal.previousPatientList.
Patient becomes a service in angular. This takes in a patient as loaded by the patient loader or another service. It casts the data to Episode or Item instances as appropriate.
PatientList.get_queryset() is now passed an extra keyword argument - user.
This is the current User object.
The get_menu_items method of Opal Application objects is now passed an extra keyword argument - user.
This is the current User object.
The templatetag application_menuitems now uses this method to render navigation menus, allowing dynamic customisation of menu contents based on user.
Opal 0.8.1 removes some minor features which, to our knowledge are not used by any applications in active development.
- ReopenEpisodeCtrl - applications may implement their own 're-open' episode flow, but Opal no longer handles this out of the box.
- Subrecord._bulk_serialise - this flag has been removed
We have re-named opal.core.views._build_json_response to opal.core.views.json_response. This will issue a
warning for the remainder of the 0.8.x branch, before being removed entirely in Opal 0.9.0.
We have added a list method to the default Opal JSON API for subrecords - you may now obtain a list of all instances
of a given subrecord from the API endpoint /api/v0.1/$api_name/.
Updates the custom UserAdmin so that the email, first and last name fields from the Django User model
are in the add user form not just the edit user form.
The default test runner generated by plugin scaffolding now uses opal.urls as the default url conf in the test settings. This allows you to test urls generated by Opal - for instance default form or record templates, or simply raw templates from our generic template view.
Plugins have been refactored and are now DiscoverableFeatures. This should have no impact on existing
plugins, however the functions opal.core.plugins.register and opal.core.plugins.plugins are slated for
removal in 0.9.0
When creating new plugins we will place the plugin definition class in plugin.py rather than __init__.py
A decorator that changes a method that is passed a pk, to a method that is passed a patient.
Adds a flag to the to dict mixin to determine whether the item is serialised as part of Episode/Patient.to_dict.
Previously multiple radio buttons for the same subrecord field on the same page would not appear to the user to update correctly. This has now been fixed.
0.8.0 consolidates Angular UI libraries bundled with Opal. We have removed Angular Strap, and switched all components using it to their Angular UI Bootstrap equivalents.
This is a breaking change.
Applications taking advantage of the Forms templatetag library should require no updates, but will see
some minor differences in visual style of widgets.
Detailed upgrade guides for the components affected (Typeahead, Popover, Tooltip, Datepicker, Timepicker) are available in the upgrade reference documentation.
We pull through default values from subrecord fields into the Opal Schema and use those values when initializing the relevant
Item instance for a new subrecord. This should greatly reduce the need to use custom Angular subrecord services to set defaults.
Template tags that use the 'field' attribute to point to a subrecord field will now infer a lookup list from the Choices of the field if it exists.
Note unlike the traditional choices implementation only the last value of the choices is used and saved to the database
Colours = (
('P', 'Purple'),
('R', 'Red'),
)What is displayed to the user and saved to the database is 'Purple' or 'Red' respectively.
The html attribute 'name' for form elements generated with the Opal {% forms %} templatetag library used to be inferred from the model name. Although this remains the default you can also set it with an angular expression:
{% select field="Demographics.first_name" element_name="...Your Angular expression..." %}The models Team, GP, CommunityNurse and LocatedModel - marked for removal since 0.6.0
have now been removed.
As part of this change, the add episode modal previously available at
/templates/modals/add_episode.html/ is now not available at the url with a trailing slash.
Any controllers attempting to open the modal e.g. custom list flows should update their
$modal.open call to remove the trailing slash.
Opal 0.8.0 is the first version of Opal to support Python 3. This has meant changing the default
ordering of PatientList instances to 0 rather than None.
Moving forwards we expect all new code in Opal to be compatible both Python 2.7 / 3.4 / 3.5 / 3.6.
This introduces an explicit Opal dependency on the Six module for maintaining codebases that span Python 2.x and 3.x.
Adds the class opal.core.patient_lists.TabbedPatientListGroup which displays groups of related
lists as tabs at the top of each member list.
To enable custom sort orders for individual PatientLists we introduce the comparator_service attribute.
This names an Angular service which will return a list of comparator functions.
We now explicitly enable columns in spreadhseet lists that are not tied to subrecords. These can be included in PatientList schema instances as explicit Column() entries.
Modal_base has now been moved into a folder called base_templates. Its also now got a form_modal_base and a two_column_form_modal_base. The latter two templates add validation around saving.
The standard edit item models and others now inherit from the form_modal_base.
All APIs should be permissioned with Django REST framework permission classes. The default implementation uses opal.core.api.LoginRequiredViewset, a standard DRF viewset that requires the user to be logged in.
We now require the user to be logged in for any use of the search functionality.
Added a custom interceptor that logs the user out if the we receive a 403 or 401 from the server
Adds the checkForm directive
e.g.
<button check-form="form" ng-click="sendDataToTheServer">click me</button>This adds default form submission behaviour to the a button. It will check if the form is valid, and if its not it will mark the button as disabled until it becomes valid.
It will also set the form as submitted.
We also now show the required error if the form has been submitted or if the field is dirty, so that the user doesn't get an ugly "fill this field in now" message when opening the modal/pathway but will get the error after they click submit.
Opal 0.8.0 removes a number of un-used features that have been slated for removal for some time:
Options- both from the JSON API, and the Angular service.- The legacy APIs
/api/v0.1/episode/admitand/api/v0.1/episode/refer. - The models
GP,CommunityNurseandLocatedModel. opal.models.Tagging.import_from_reversion. This one-off classmethod on tagging was introduced to aid with the upgrade from Opal 4.x to 5.0 and has no further utility.- The
staticargument from the formsinputtag. Developers should move to thestatictag. - The _modal option to set on subrecords. This is because we now use large modals across the board.
The opal.core.api.EpisodeViewSet.create now expects tagging to be an object rather than a list, similar to how it details with demographics and location.
The API will no longer serialise the _ft or _fk_id fields of FreeTextOrForeignKey fields - these are internal implementation details of the server that are not useful on the client side.
Adds a Unique Together constraint for (Tagging.user, Tagging.episode, Tagging.value)
Look up lists now load in from individual apps. The look for a file at {{ app }}/data/lookuplists.json
The default admin url is now /admin/ - rather than /admin/? this results in more readable
admin urls and is closer to what most applications do with the Django admin.
The roles field opal.models.UserProfile.roles has been updated to be blank=True. This allows the editing
of users without specific roles assigned in the Django admin. Although this introduces no changes at the
database level, this does introduce a migration.
Upgrades angular to v1.5.8 (from 1.3.11) you can see their change log here
Updates angular-cookies and angular-mocks to v1.5.8 (both from 1.3.11)
Updates angular-ui-select to 0.19.4 from 0.13.2
The flow enter and exif functions now take an optional context argument. When called from PatientList or PatientDetail controllers this is the parent scope when the flow has been entered.
Note: The current Flow API is likely to undergo substantial revision in Opal 0.9 / 0.10 do contact us on the mailing list if you are relying heavily upon it or would like to let us know your needs.
Adds a past filter, future and past filters now take a boolean argument as to whether you should include today
Fixes a bug whereby celery tasks are not autodiscovered - will have affected users of async extract functionality.
Fixes a bug with the copy to category API not setting category name.
Removes the hangover use of options in the list of teams per episode in the patient list
Completes the refactor of front end data, no longer using the /api/v0.1/options/ API internally.
This is slated for removal in 0.8.0.
Updates DRF APIs - we now expect either Token or DjangoSession auth.
Fixes several small bugs with scaffolded applications - the setting of STATIC_ROOT and
SECRET_KEY, generating forms for NullBooleanFields, requirements.txt.
Adds an aligned_pair templatetag to the panels library.
Updates the label for Demographics.birth_place to indicate that this should be a country.
Adds the clipboard directive to give the user one click copy to clipboard.
Adds a tag-select directive that renders a widget for editing the tags for an episode.
Adds metadata to the scope for patient detail views
- Django Axes 1.4.0 -> 1.7.0
Refactors EpisodeCategory to be a discoverable feature.
Renames Episode.category -> Episode.category_name.
The Restful Episode JSON API previously available at /episode/:pk/ is now moved into
/api/v0.1/episode/:pk/ for consistency with the rest of our JSON APIs.
The Opal Angular layer has been updated to reflect this, and
should handle the transition seamlessly, but code calling the API directly should update
to reflect the new URL.
Establishes a new way to define defaults for records initialized in Javascript without requiring that we hard-code API names to defaults in a global namespace.
Flow.enter() and Flow.exit() now no longer take options positional arguments - instead
the controllers they initialize have Metadata and Referencedata as optional resolves
arguments.
AddEpisodeCtrl now no longer requires options as a resolves() option, but requires Referencedata instead.
The input form helper will now infer the max length of char fields from the max length of the
database field, and render relevant Angular directives.
The EpisodeDetailCtrl and EpisodeDetailMixin controller and service have been removed - these
were not used anywhere other than in the Wardround plugin, and redundant after enhancements to
Patient Detail and Custom DetailViews in 0.6.
Adds a datetimepicker templatetag that will render widgets for a Datetime field including time.
Adds a date_of_birth_field templatetag that renders a date of birth field complete with inteligent
validation. (Note this change also includes removing the old _partial/ template)
Updates dependency graph:
- Django -> 1.8.13
Detail views
Moves from episode oriented detail to patient oriented detail. (All episodes plus x-episode views are available from a patient detail screen)
Tagging
As a performance optimisation for the frequent access of historic tags, untagging an episode simply renders the tag inactive rather than deleting it and relying on Django-Reversion for access to historical data.
Date Formatting
We now expect 'd/m/y' date formatting by default.
Patient lists
Lists are now declarative, and separate from teams. They are implemented as subclasses of opal.core.patient_lists.PatientList.
Forms vs. Modals
Introduces a distinction between a form and a modal. By default, we now use forms for subrecords, only overriding the modal if there is something we want to do differently specifically in the modal.
Command line tools
Adds $opal checkout for switching between applications or application versions.
The 'opal.context_processors.models' Context Processor will allow you to access your subrecords from templates without having to explicitly load them in a view. In turn, this allows patterns like:
{% include models.Demographics.get_detail_template %}
Full upgrade instructions to work through any backwards incompatible changes are provided in the Opal docs.
Changes the way old tags are handled.
Tags are no longer deleted episodes, rather they're marked as archived.
- Include local storage
- Speed up loading of the lookup lists
- Fix pagination issues in search
- Speed up loading of many to many fields
- Increase test coverage
- Add some extra help fields to {% forms %} helpers
- Fixes bug with $rootScope.open_modal() where keystrokes were being intercepted
Speed improvements on page load allow us to only show record panels if a record of that type exists disable modal buttons while saving
Minor bug fixes
Search
Complete re-design of Search interface to provide a single search box on every page and pagination for resulta. Puts in place a pluggable interface that could be swapped out for e.g. ElasticSearch. New Service for PatientSummary()
Analytics
Moves Analytics integration into Opal core with the ability to blacklist pages that should never be reported
List view
Removed old spreadsheet-style cell based navigation and moved to row-wise nav with clearer highlighting of the active row. Updated scrolling and loading behaviour to snap to viewport and not display the page build.
Subrecord metadata
Added four new utility fields to Patient and Episode subrecords:
created_by, updated_by, created, updated
Select2 and list fields
Added support for select2 as an input widget and Subrecord fields that can be lists of things.
Also
Numerous small bugfixes. Refactoring of the models package into a models module. Updated Underscore.js -> 1.8.3 Updated Angular.js -> 1.3.11
Refactors opal.models to be a models.py file rather than a package. Adds several improvements to forms helpers -> Help argument, other argument to select.
Updates dependency graph:
- Angular-strap -> 2.3.1
Upgrades dependency graph:
- Django -> 1.8.3
- Django-reversion -> 1.8.7
- jQuery -> 1.11.3
- D3 -> 3.5.6
- C4 -> 0.4.10
South has been removed, now using django migrations
Fixes some search results appearing duplicated.
New Design
Completely re-designed UI following extensive user research and multiple iterations.
Managementcommands and scaffolding
Features the opal command line tool for common administrative tasks http://opal.openhealthcare.org.uk/docs/guides/command_line_tool/
** Form helpers templatetag library**
New template library for consistent form controls in line with our new interface guidelines http://opal.openhealthcare.org.uk/docs/reference/form_templatetags/
API Documentation
Opal JSON APIs are now fully self-documenting for all updated instances http://opal.openhealthcare.org.uk/docs/guides/json_api/
Bugfixes, significant flexibility in template customisability.
Minor UI updates.
Numerous small bugfixes.
Adds the concept of undischarging patients.
Numerous small bugfixes.
Search overhaul - introduces advanced searches.
Initial public release