In-place register filters

[allan-on]

In-place register filters

Context

The in-place filtering is a toggle filter that filters the register based on any or all of the supported attributes
This would provide advanced filtering that's not supported by search from the search bar or by filtering of registers by passing the filter params as implemented in #2036

Example

Consider we have a register of patients screened for risk of hypertension.
It should be possible to filter the register based on the Patient condition such as low-risk, high-risk, Patients with followups e.t.c

Requirements

1. The filters should filter/work on the register being displayed/viewed without having to navigate away
2. The filters should be configurable - supplied via configs
3. It should support filtering by any of the rules defined for the register
4. We should probably define an appropriate UI/UX that provides toggling/activating of the different filters

Additional context

Resource filtering implemented/supported

• Register configuration
• [Configuration] Filtering registers based on resources attributes #2036
• [App Configuration] Update the LIST view to allow filtering of resource data sets for display using FHIR Path expressions #2001

[pld]

Cool, yea I think the UX is a big part of this, maybe we should work on mock-ups for that first, then we can circle back to the tech details? We need the UX clear so that it drives the tech

[allan-on]

I agree. Thanks

[HenryRae]

@pld @f-odhiambo @Gental-Giant @AnnieMungai @dubdabasoduba
Are there any other requirements or use cases we may want to consider for filters?

Some of the other use cases am thinking of:

1. on the home register, allow user to filter the list but due/overdue count, specific care plans(list families with patients having specific care plans).
2. allow the user to filter by more than one option
3. allow user sort filtered results

cc: @rowo

[pld]

yes all of those are valid

[allan-on]

Hi @rowo @HenryRae We need help with mockups for this implementation

[allan-on]

A similar feature implementation in Malawi Core is documented in Appointment Register Filters #2102
TL;DR

• The (Appointment) Register can be filtered by the options displayed on the Filter dialog such as Filtering by Patient categories or Appointment Reasons etc

[allan-on]

For the first version of the implementation, we'll work with the following design:

Filter UI

a. The register filters will be defined in a filter config specifying the enabling of the feature and other required filter parameters such that 1 is only visible when filtering is enabled.
b. The filter (options) form will be defined as a Questionnaire for reconfigurability and reuse. The filter icon 1 launches this filter options Questionnaire view 2.
c. The resulting count can be updated and shown when the filter is applied in 3

Filtering

a. We'll add register filter configurations as part of the register config. This register filter configuration will include the reference to the filter options Questionnaire (and the base resource on which the filter is applied?).
b. When the Questionnaire is submitted, the filter options can be read from the resulting QuestionnaireResponse. This QuestionnaireResponse will not be persisted in the DB.
c. The retrieved options would then be used to build the parameters for the filter operation that would then populate the data map used when rendering the register.

---

The above approach works when filtering using attributes of the base resource that's used in that register. e.g. For a Patient register filter by gender, is active, city etc.

Using the example in the design mocks, Patient is the base resource while Tasks are the related resource in the Patient/Client register.
To filter clients by Task status, the Task resource should be the base resource then include Patient as a related resource.

[dubdabasoduba]

@allan-on how are we mapping the QR items to Resource search Parameters?

[HenryRae]

@allan-on in this filter questionnaire, will we be able to have:

1. a different header color from default questionnaires(default questionnaires are using white as I presume)?

2. a clear action on the header? we don't have any button CTAs on the right side of the questionnaires.

Are the questionnaires configurable to that extent i.e see attached

[dubdabasoduba]

@HenryRae @allan-on I might be wrong but I am not sure we can achieve the Clear All without re-rendering the questionnaire. This is something we need to review.

[HenryRae]

please keep us posted on any findings