Add functionality to

• Collect all the requisite information required to generate a vaccine certificate as defined by the FHIR International Patient Summary (IPS) being defined by the WHO Covid-19 Digital certificate working group. (The required resources will be made available via a FHIR API to be consumed by a program like DIVOC that is able to generate vaccine certificates.)

Save a questionnaire response and an encounter either separately or as a bundle

Applies to the mADX project for measure reporting. How do we go about defining a measure, running the measure operation to be able to generate a report of measures for tracking different defined indicators

We shall be mainly working on the following FHIR resources

• Patient
• Related Person (Optional ?)
• Questionnaire
• QuestionnaireResponse
• Encounter
• Observation
• ServiceRequest
• DiagnotsticReport
• CarePlan
• Location (Optional)

Later on, we can circle back and then link the ML kit portion

At the FHIR SDK the application will rely on the following :

• Data Access API - Set of APIs for performing CRUD operations on FHIR resources in the SQLite DB
• Search API - On-device fluent search API allows the application to compose complex search queries to filter FHIR resources and build lists
• Data Capture API - SDC specification implementation
• Sync API - Provides sync capabilities between a FHIR server and the local DB

NB. support for displaying forms and submitting (via Questionnaire/QuestionnaireResponse) and support for clinical decision support may also be core features

Common Features to the Core Android SDK app

• Patient registration
• Patient search
• Patient profile view
• Sync support
• Multilingual support (Optional ?)

G6PD specific features

• Image processing engine (IPE)
• Results interpretation module (RIM)

Identify who is going to do what and when in terms of sopping, design, implementation, QA etc.

• How do we go about Structure-mapping and dynamic tasking
• Build a UI powered by Tasking - Task generation automation

How to replicate

• Have a chat @KipSigei for a quick demo on how the web app behaves when we try to access the current HAPI FHIR instance.

Possible fix

• White list the web app on the HAPI FHIR server CORS settings

Generation tasks
This is can be a subproject on its own due to its complexity

Questionnaire response to a task generation

• Who, When and how

Generation task offline
-Generation of tasks offline on the Android client

Need to Identify the scope of each application and also set milestone deliverables for each application

This is a subtask of #50

This issues has been resolved through the implementation of the current FHIR core app

User story :
As a CHW, I want to register a patient so that they can be enrolled on the platform.
The patient details will be based on the FHIR resource as a Questionnaire
Acceptance criteria :

• On the landing page, you can view a list of already enrolled patients on the platform.
• The patient list should show details of the patient (ID, Firstname, Lastname, Gener, DOB)
• Click on the add patient button to be presented with a form to fill in patient details.
• On clicking a patient you can view the patient profile (details here)

This is a subtask of #51

As we look to a migration to FHIR there are several things we need to explore on the web front.

First, we will need to potentially support two versions of OpenSRP web. One that we can use to support current projects and one that runs fully off a FHIR backend like HAPI.

Current Functionality

• User management - need to work on both OpenSRP web and HAPI
• Locations - need to work on both OpenSRP web and HAPI
• User permissions - ??

Patient Data View

We will use FHIR to view data for all OpenSRP projects. This mean patient views will be powered by a FHIR backend (eg. HAPI).

For existing projects, we will create a beam process to extract data from OpenSRP and into HAPI.

For the patient view we should explore multiple strategies:

• I recommend we first setup the SMART Patient Browser - https://github.com/smart-on-fhir/patient-browser. Goal here would be set it up pointing to HAPI and see if it support a form of authentication. Ideally, we could connect to Keycloak.

• IHRIS - This is a Vue app developed by intrahealth that is able to view provider data pointing at a HAPI server. They use SDC configs to configure views I believe. We should evaluate if we want to borrow from this approach or potentially even build off their app (note would require us switching to Vue). Here is a writeup Craig did on this.

• We roll on own. There are a number of interesting FHIR react libraries

• https://github.com/1uphealth/fhir-react (storybook of components: http://storybook-fhir-react-lib.s3-website-us-east-1.amazonaws.com/?path=/story/allergyintolerance--default-visualization-dstu-2)

• https://github.com/symptomatic/fhir-starter

• https://github.com/Vermonster/fhir-kit-create-react (this one looks pretty nice) http://fhir-kit-react.herokuapp.com/ - note example uses Ant too.

• https://github.com/Vermonster/fhir-kit-client

• Data Editing and form collection - Need to fill this out but there is a smart on fhir app that links data lookup to web FHIR questionnaires.

Reveal

• If we migrate Reveal to the FHIR SDK - we we'll need to evaluate how plan definitions would work in the future and if we would need to rebuild the UI for those.
• we need to verify how team assignment would work and if the current opensrp web interface would support the plan location assignment.

User story :
As a CHW, I want to view a patient's profile so that I can be able to view their bio-data and history

Acceptance criteria :

• On the landing page, you can view a list of card that contain patient biodata such as name, address, telephone number
• The patient profile can be extracted from patient & observation history FHIR resources
• Allow for scroll view if details do not fit in the field of view

For covid app

• Ability to show registered patients and their vaccine completion status. Eg. Completed Dose 1 of 2
• Ability to click on the patient and view information and view information on the patient (eg. contact information) and vaccine services received.

How will we run the apply operation from HAPI FHIR Server which is currently not supported to generate the plan/activity definitions?

Alternaternatives
Add the CQF ruler lib (CQF Ruler provides clinical reasoning on top of Hapi) - Can be part of the core codebase. If so who will be tasked to write that code base? (Google or Ona)

Configure questionnaires to collect data for

1. Registration
2. Observation
3. Immunization
4. COVID-19 Screening

Create a skeleton sample app to list all patients

Resource Mapper will be used to convert QuestionnaireResponse to FHIR resources.

Documentation: FHIR SDC Extraction. Current resource mapper is definition-based extraction.

The current resourcemapper is still at early stages and needs some work. This was done as PoC.

Open Items

• Moving away from extending HAPI fhir objects
• Refactor ResourceMapper code
• Testing parsing different types of widgets: string, date, radio button, checkboxes, integer
• Merge ResourceMapperHAPI with the current ResourceMapper
• Have the pr on android-fhir merged

This is a broad issue that includes support for login on the device, ACLs for users and general user administration support. This is supported on OpenSRP core through OAuth/Keycloak. This is a requirement on G6PD.

User story :
As a CHW, I want to do a basic search for a patient so that I can be able to retrieve their details

Acceptance criteria :

• Filter by First name or Filter by the Last name
• Display results
• On clicking a patient show patient profile view

This is a subtask of #50

Research and Development :

• Check out the CQL Evaluator Sample app
• Understand it capabilities and documents its pros/cons/issues for improvement

Add view and funtionality to

• Enrol a patient in a Covid-19 vaccine care plan and record-related vaccinations
• Capture the required information to generate a vaccine certificate for the international patient summary.
• Easily author / adapt the vaccination form using SDC/FHIR questionnaires. This form when completed will be programmed to automatically update the appropriate FHIR resources (eg. Immunization). A form builder will not be included in the work but these forms can easily be authored with a tool like (https://lhcformbuilder.nlm.nih.gov)
• Generate a Care Plan - When the patient has registered a care plan for Covid-19 will be set-up with tasks created for a single or multi-dose administration (depending on the vaccine being administered).

• Create a new subdomain for the FHIR patient viewer https://web-fhir.opensrp-stage.smartregister.org/
• Deploy the patient viewer POC

This is a broad issue but includes encrypting data on the device, server and when transmitting it over the wire. This is supported in the current OpenSRP core and is part of the G6PD requirements.

The patient questionnaire will be downloaded from HAPI and use for patient registration.

Currently, it's a file on the apk.

This is a subtask of #50

• clone fhircore app, set up and run demo
• convert gender question to a select/radio button
• ensure it saves to db.

• Follow up on the review of the current POC
• Follow up on any design changes recommended by the team

This includes patient demographic info or any information collected against the patient.

How will we be storing the FHIR resources

• Repo
• Sync from serverside
• In-app

This is broad but includes validating that data rules for fields are not broken e.g. a number-only field should not allow text, some fields cannot be left blank etc.

We need a mechanism to support changing the app language based on preference by the app user. The SDK does this by checking the global setting of the phone and then setting the translation of the FHIR resource

1. Add translation for different languages for LTR Locale
2. Add translation for different languages for RTL Locale

Use the Android FHIR SDK to represent a real-world care journey without requiring Smart Guidelines

• Ability to easily author / adapt the ANC enrollment form using SDC/FHIR questionnaires. This form when completed will be programmed to automatically update the appropriate FHIR resources (eg. Patient and CarePlan). A form builder will not be included in the work but these forms can easily be authored with a tool like https://lhcformbuilder.nlm.nih.gov

• WHO Antenatal Care Guideline implementation - use the WHO Antenatal Care Implementation Guide, https://build.fhir.org/ig/who-int/anc-cds/, to define the information collected during ANC enrollment and care plans to enrol clients in, e.g. https://www.hl7.org/fhir/careplan-example-pregnancy.json.html

Consider ktfmt, https://github.com/facebookincubator/ktfmt

google/android-fhir#246

We need mockups for covid-19 app

• Login page
• Navigation drawer
• Register page (search button included)
• Search page
• View patient profile
• Add vaccine/care plan
• View vaccination status
• View vaccination certificate

User story :
As a CHW, I want to search for a patient so that I can be able to retrieve their details

• Search can be implemented based on FHIR parameters
• Search will be based on the search API in the Android FHIR SDK

Acceptance criteria :

• Clicking on the search icon should present you with a patient search screen - related to issue no #385
• Able to add the search criteria via a selection list - related to issue #385
• If the query returns a result, display search results and on select view and on click view patient details in a patient profile view
• If the query is null result display not found message/notification

This issue is related to the below-listed issues on Android FHIR SDK. Part of the implementation will be done there

• Investigate using DSL in Kotlin for search #57
• Create a search panel in the patient list view in the reference app #385
• Support contains for string search #376

Sub Tasks

• Basic Patient search #20
• Search from a list of patients (eg. pre-enrolled) in a FHIR datastore on the device or from the server #53
• Filter and pagination #54
• Handle "OR" in search filters #292

For ANC app

• Ability to search from a list of patients (eg. pre-enrolled) in a FHIR datastore on the device or against the entire access permitted patient list on the health information system.

For the Covid app, we can add a filter in the search for

• [Overdue](Filter patients whose second dose is overdue #176) - Missed appointment for/next jab
• Record Jab - Start the care plan
• Partially vaccinated - If had the first dose, the due date of 2nd dose
• Vaccinated - If completed vaccination, view the certificate

User story :
As a CHW, I want to register a patient so that they can be enrolled on the platform.
The patient details will be based on the FHIR resource as a Questionnaire
Acceptance criteria :

• On the landing page, you can view a list of already enrolled patients on the platform. - Design mocks will be required issue
• The patient list should show details of the patient (ID, Firstname, Lastname, Gener, DOB)- Design mocks will be required issue
• On clicking a patient you can view the patient profile (details here)
• Click on the add patient button to be presented with a form to fill in patient details.
• Provide an option to save the response which will be saved as an FHIR QuestionnaorResponse

Related item on Android FHIR SDK

• Support for uploading resources to FHIR server #366
• API for validation in the sdc lib [#374] (google/android-fhir#374)

Sub Tasks

• Basic Patient registration #19
• Input validation #56
• Save FHIR resource to SQLite DB & Sync to FHIR server #55
• Patient Profile view #22

From the discussion on hapi FHIR Authentication refer to document here
We need to extend the hapi fhir Authorization Interceptor to allow us talk to keycloak and obtain a login attempt response

We expect to have non-general functionality that we would want specific users to be able to load into the single app.

For example, we will implement an image processing engine that is only used by specific users completing questionnaires with a call out to image interpretation.

Conceptually, this is similar to app-store-like apps, e.g. the Roblox app, which is a single app that can load specific games that are not predefined or compile into the app.

Validate details as entered by the user for data types and also mandatory/optional fields based on the questionnaire

• Currently, fhircore is part of android-fhir as a submodule.
• There is a need to have fhircore standalone so that devs and anyone else can easily build
• This will also allow CI/CD process to be set up

Save questionnaire resource to SQLite DB and ensure it syncs to FHIR server

• Sync offline data for patient registration and vaccine administration automatically sync to the FHIR server.
• Check for new patients/updates associated with that vaccine site or worker.

For ANC App

• The application will be able to support all key workflows offline including patient registration and ANC visit administration. The app will be able to automatically sync with a FHIR server. This will include checking for new patients/updates associated with that.

How to be able to go about saving locally stored FHIR resources from the SQLite DB to the HAPI FHIR server. MIght be done on the Android FHIR SDK. Link to similar issue in Android FHIR SDK

Data dictionary to define:-

• Patient form questionnaire - fields required and the correct labels & translations
• Vaccine form questionnaire - fields required and the correct labels & translations

Permission management and user roles assignment