0.8.1.2 (Minor Release)

Previously serialization of csv's outsie the standard asci charecter set
would throw an error in the search extract. We now properly encode strings in these cases.

0.8.3 (Minor Release)

opal.log.ConfidentialEmailer

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".

0.8.2.1 (Minor Release)

A minor release that adds the karma config to the python egg

0.8.2 (Minor Release)

OPAL_LOCATION is added as a system variable when running js tests

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.

A Data Dictionary In The Extract

The Extract zip file has a data dictionary with human readable metadata about each field.

Enhanced Application menus

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.

PUT to the episode API returns the episode with all its subrecords

Previously it only returned the episode. Now it matches the episode create api end point

Episode/Patient links in admin

In the admin, episodes and patients lists now have links to the patient detail pages.

User data for the client

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.

Episode.getFullName()

Adds a utility method to the Episode service that returns a human readable patient name.

Plugin.get_javascripts, Plugin.get_styles

Enhances the API available for plugins to include javascript and css by adding methods on
opal.core.plugins.OpalPlugin

'element_type' argument for the form template tags

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.

OPAL_LOGO_PATH

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.

Inactive episodes in PatientLists

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.

Notice of future removals

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.

Misc changes

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.

Minor fixes

Fixes a bug where the allergies form rendered the provisional field twice

Updates to the Dependency Graph

Upgrades Font Awesome from 4.3.0 -> 4.7.0
Upgrades Jinja2 from 2.8 -> 2.9.6

0.8.1 (Minor Release)

Cookies for the future

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.

Patients as a service

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 arguments

PatientList.get_queryset() is now passed an extra keyword argument - user.
This is the current User object.

Overriding default Menu Items behaviour

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.

Subrecord List API

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/.

Removals

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

Pending removals

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.

Misc Changes

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.

A Minor release that updates a filter and the users name to the edit teams modal header.

We now have a past angular filter, which returns true if a date is in the past.

Both the future and past filters take an optional argument, includeToday as to whether today is considered true, ie the past including today.

We also add the user's first name and last name in the edit team modal.

0.8.0 Major Release

0.8.0 (Major Release)

Plugins

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

opal.core.api.patient_from_pk

A decorator that changes a method that is passed a pk, to a method that is passed a patient.

ToDictMixin._bulk_serialise

Adds a flag to the to dict mixin to determine whether the item is serialised as part of Episode/Patient.to_dict.

Fixes bugs in add many subrecord radio buttons

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.

Angular UI Libraries

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.

Defaults for Client Side subrecords

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.

Choices in form templatetags

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.

element name in template tags

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..." %}

Model removals

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.

Python 3

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.

Tabbed Patient List Groups

Adds the class opal.core.patient_lists.TabbedPatientListGroup which displays groups of related lists as tabs at the top of each member list.

PatientList sort order

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.

PatientList Arbitrary columns

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.

Template re-naming

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.

Authorization and permissions

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

Form Validation

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.

Removals

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/admit and /api/v0.1/episode/refer.
• The models GP, CommunityNurse and LocatedModel.
• 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 static argument from the forms input tag. Developers should move to the static tag.
• The _modal option to set on subrecords. This is because we now use large modals across the board.

Misc changes

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.

Updates to the Dependency Graph

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

0.7.3 Minor Release

Fixes a bug whereby celery tasks are not autodiscovered - will have affected users of async extract functionality.

0.7.2 Minor release

Fixes a bug with the copy to category API where the episode is not setting category name correctly onto itself.

Allows date searching in advanced search.

Removes the hangover use of options in the list of teams per episode in the patient list.

0.7.1 Minor release

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

Updates to the Dependency Graph

• Django Axes 1.4.0 -> 1.7.0