android-fhir

The FHIR Engine v1.0.0 release includes major enhacements made to the sync API as well as changes in the search API and the dependencies of the library.

Feature Highlights

Upload strategies

The newly introduced upload strategies strike a balance between customizability and robustness of the sync logic, allowing applications to customize the way FHIR resources are uploaded to the FHIR server without having to deal with the implementation details. For example, applications can now upload changes using JSON patches, and bundle the changes in fewer requests to improve sync performance. Uploading using HTTP POST will be available soon, too. See available upload strategies and how to use them in a FhirSyncWorker.

Revamped sync status

The new sync status provides more accurate information on the sync jobs, combining job history with the status of the current job. See example.

Updated build rules

The application's build file no longer needs to include the force blocks to manually fix guava, jackson, and HAPI versions. See example.

Changelog

Sync API 🌟

• Create new resources on the server using POST [#760]
  • Resource consolidation for resources created with POST [#2217]
  • Adding PerResourceLocalChangeFetcher [#2257]
  • Refactor syncUpload Method to improve flow and error handling [#2173]
  • Remove UploadStrategy.AllChangesBundlePut option from engine [#2431]
• Store sync progress in a local storage in the engine [#2119]
• Restore granular upload progress updates and database consolidation [#2392]
• Synchronize sync workers [#2385]
• Fix error with Json patches for the same field [#2342]

Search API 🔎

• Allow sorting data in the include and revinclude search API [#2378]

Other fixes 🛠️

• Dependency versions fix [#2380]

@aditya-07 @jingtang10 @omarismail94 @anchita-g @santosh-pingle @MJ1998 @vitorpamplona @vorburger

The 1.1.0 release of Structure Data Capture Library includes the following changes:

Enhancements 🌟

• Enhanced expression support
  • Handle fhirpath expression in x-fhir-query [#1658]
  • Candidate expression support [#1789]
  • EnableWhenExpression context literal fhirpath supplement implementation [#1957]
  • CQF expression support [#1945]
  • Variable support in answer expression [#2052]
  • Support answer options toggle extension [#2034]
  • Variable support for enableWhenExpression [#2096]
  • Allow usage of variable and context in answer expression [#2039]
  • Support fhirpath supplement %questionnaire and %qItem literals [#2163]
• Save draft answers in decimal text boxes [#1923]
• Required and Optional labels for required and optional input [#1954]
• Multiple initial values for repeating question [#2019]
• Make questionnaire properties accessible for custom components [#2023]
• Optimize flatten and descendent traversal [#2079]
• Support multiple Instructions [#2092]
• Populate reference initial values in dropdown list [#2065]
• Implement questionnaire-unit and questionnaire-unitOption extensions [#2014]
• Support entry format for date and time [#1850]
• Support initialSelected in answer options [#2032]
• Support cancel button [#1829]
• Definition based extraction for repeated groups [#1794]
• Handle repeated answers in questionnaire validation [#487]
• Definition Based Extraction: Issue in extracting Observation value of type valueCoding #1769
• Support minLine attribute [#1518]

Fixes 🔨

• Hide initial validation error message for modal and open choice widgets [#1514]
• Fix mismatched nested items with skip logic [#1972]
• Fix FHIRPath constant value null casting [#2012]
• Do not replay earlier updates in DialogSelectViewHolderFactory [#2080]
• Nested items of group are not rendering when loading Questionnaire using QuestionnaireResponse [#1998]
• Make help card show/hide state per page [#2054]
• Handle code systems correctly [#2136]
• Fix calculated expression beyond initial changes [#2354]
• Fix cursor skipping back while start typing a value in numeric field [#1914]
• Create nested items correctly [#1881]
• Validate current page items before entering review page [#1682]
• Support definition based extraction for lists with non-primitive types [#1769]
• Fix mismatched answers in open choice and drop down widgets [#1537]
• Refactor Auto complete widget [#1398]
• Fix enableWhen in repeated group [#1895]
• Pass original response items instead of copy to getEnabledResponses [#1776]
• Fix failed mapping of repeated groups when questionaire response is passed as argument [#1900]
• Fix enable when expressions for display items [#1835]

Style update 👗

• Make horizontal boolean type options full screen width [#1968]
• Refactor text overflow in dropdown [#1966]
• Make spacing a configurable attribute [#1986]
• Make image size consistent [#2057]
• Fix cropped help icon [#2093]
• Review screen style changes [#1737]
• Remove extra space when the group headers have no text to show [#1339]
• Customize bottom container style and behavior [#1842]
• Improve overriding dimens [#1832]
• Show dateformat text in lowercase for date and date time label [#1969]

Thanks to all the contributors to this release:
@FikriMilano @maimoonak @omarismail94 @santosh-pingle @khyativyasargus @shelaghm @MJ1998 @KhumboLihonga @LZRS @PallaviGanorkar @jingtang10 @aditya-07 @nsabale7 @joiskash @vbothe23 @Itskiprotich

The FHIR Engine 0.1.0-beta05 release includes the following changes:

Sync module changes (esp. upload redesign) continued

• Add a LocalChangeFetcher #2135
• Add ResourceConsolidator #2137
• Introduce Patches: changes to be uploaded to the server #2156
• Remove UploadWorkManager #2166
• Refactoring UploadRequestGenerator for Upload Sync Redesign #2168
• Introducing Upload Strategies #2171
• Refactor syncUpload Method to improve flow and error handling #2173
• Add resource UUID to LocalChangeEntity, fixing changing UUID issue for the same resource #2210
• Update the version of resource after updates are downloaded from the server #2272

Improvements in tests and testing infrastructure

• Add tests to sync classes #1505
• Clean up SyncJobStatus and add FhirSynchronizer test #2184
• Set up CodeQL #2185
• Set up Dependency graph for Dependencies and Dependents #2194
• Set up Dependabot #2195
• Fix broken CI for trivial PRs #2197
• Remove CQL dependencies in the engine/benchmark module #2229
• SdkSuppress FhirSyncWorkerBenchmark oneTimeSync_50patients (re. #2235) #2236

Dependency updates

• Migrates engine to HAPI 6.8 while forcing Workflow to stay on 6.0 #2245
• Update gradle build tool from 8.0.2 to 8.1.1 #2158
• Bump com.android.tools.build:gradle from 8.1.1 to 8.1.2 #2219
• Bump actions/upload-artifact from 2 to 3 #2249
• Bump actions/checkout from 3 to 4 #2248
• Bump styfle/cancel-workflow-action from 0.7.0 to 0.12.0 #2250
• Bump com.diffplug.spotless:spotless-plugin-gradle from 6.21.0 to 6.22.0 #2252
• Bump com.spotify.ruler:ruler-gradle-plugin from 1.2.1 to 1.4.0 #2253
• Bump com.squareup:kotlinpoet from 1.12.0 to 1.14.2 #2255
• Bump androidx.build.gradle.gcpbuildcache from 1.0.0-beta01 to 1.0.0-beta05 #2266

Documentation and codelabs

• Update dependencies in engine colab #2268

Contributors:
@aditya-07 @anchita-g @jingtang10 @omarismail94 @roywanyaga @santosh-pingle @vorburger

The Knowledge Manager 0.1.0-alpha02 release (com.google.android.fhir:knowledge:0.1.0-alpha02) adds the capability to download and manage FHIR NPM packages as well as other API improvements and fixes. In more detail:

• Implement a simple NpmManager [#2028]
• Fix the version collision in Knowledge Manager [#2043]
• Allow custom package server in Knowledge Manager [#2244]

The FHIR Engine 0.1.0-beta04 release includes the following enhancements and fixes:

Sync API:

• Support sending gzipped request body when uploading [#1988]
• Support basic and bearer HTTP authentication [#2037]
• Support headers in the http requests and using ETags for upload [#1989]
• Refactor upload work manager for enable future customization [#2021, #2149]
• Handle local insert-delete sequence as no-op when squashing [#1951]

Search API:

• Implement _revinclude [#1947]
• Add _tag and _profile search parameters for x-fhir-query [#1935]
• Fix Date/DateTime and Token indexes to speed up search [#2040]

Other:

• Setup benchmarking for the sync worker [#1996]
• Enforce Java 11 usage and update dependencies [#2072]
• Store timeStamp as Instant instead of human readable string format in LocalChangeEntity [#2083]
• Fix engine and knowledge library versions in workflow and testing [#2085]
• Upgrade AGP and Dependencies [#2064]

Warning: This release includes a database schema change. Applications upgraded to this version of the library cannot be downgraded to a previous version without the application crashing due to database incompatibility.

This workflow-0.1.0-alpha03 release contains the following enhancements and fixes:

Enhancements:

• CarePlan can be generated without an Encounter [#1741]
• Cache ModelResolver and use cached FhirContext to increase performance [#1753]
• Migration of the CQL Translator, Engine and Evaluator to version 2.4 [#1771]
• Workflow library is now integrated with Knowledge Manager [#1854]
• A compiled Library cache that survives multiple executions of the evaluator has been added to improve workflow performance [#2033]

Fixes:

• CQL logic in a PlanDefinition is now correctly evaluated by specifying a data endpoint when invoking $apply [#1982]

This knowledge-0.1.0-alpha01 release of the Knowledge Manager library allows developers to import knowledge artifacts and Implementation Guides and store them locally on device.

Functionalities

• Import Implementation Guide
• Import individual knowledge artifacts
• Provide APIs to access Knowledge Artifacts
• Delete Knowledge Artifacts

Future work

• Download published Implementation Guides using the NPM package manager
• Integration with other Android FHIR SDK Libraries through the Knowledge Manager APIs

The FHIR Engine 0.1.0-beta03 release includes the following enhancements and fixes:

Search API:

• Include resource type as parameter in has function in the Search DSL [#1921]
• Add Coding type to token index [#1609]
• Remove old indexes when resource is updated [#1840]
• Allow developers to add custom search parameter to the engine [#1382]

Sync API:

• Add sync progress status update [#1484]
• Refactor and simplify Sync API [#1578]
• Fix engine upload sync [#1893]
• Remove SyncedResourceEntity from database [#1889]
• Add Bundle request support for downloading resources [#1888]

Other:

• Log HTTP API calls that are invoked by the FHIR Engine while syncing [#1426]
• Update HAPI structures dependency to 6.0.1 [#1616]
• Bump the Android minSdk level to 24 [#1628]

Warning: This release includes a database schema change. Applications upgraded to this version of the library cannot be downgraded to a previous version without the application crashing due to database incompatibility.

Warning: As a result of the effort to generalize the sync API, applications that use lastUpdated timestamp to download FHIR resources are now required to manage the timestamp in the application. See DemoDataStore and TimestampBasedDownloadWorkManagerImpl for a reference implementation. The default sync download implementation has also been updated. See ResourceParamsBasedDownloadWorkManager.

The first production release 🚀 of Structure Data Capture Library includes the following changes:

Enhancements ✨

This release adds the following widget-specific features:

• [New Widget] Add support for Attachment widget [#1621]
  • Attachment widget clear preview if no answer [#1821]
  • UI changes for Attachment widget [#1796]
• Automatically add date separator between day month year [#1802]
• Support choice orientation in boolean view [#1515]
• Text input filtering in Dropdown component [#764]
• Add itemMedia extension support [#802]
• Add itemAnswerMedia extension support for images [#1614]
• Add mimeType extension support [#1674]

We've also made these improvements to the library:

• Remove Engine dependency from SDC library [#1705]
• Add read-only mode in the SDC library [#1704]
• Add basic support for repeated groups [#726]
• Highlight missing fields and show validation popup [#1576]
• Load different profiles for definition based extraction [#1659]
• Support added for CodeType value in itemExtractionContext extension [#1770]
• Support definition-based extraction for lists with non-primitive types [#1769]
• Hide items if all items they depend on are also hidden [#1765]
• Add Questionnaire Fragment extra to show or hide submit button [#1845]
• Add Builder to Questionnaire Fragment [#1848]

Bug Fixes 🔧

This release fixes the following issues in the widgets:

• Remove asterisk for required questions [#544]
• Show time-picker in input mode [#1620]
• Set slider max and min value from the questionnaire [#1715]
• Move error message for boolean/single/multiple choice type widgets to above the choices [#1586]
• Cleanup the state of SliderViewHolder when item is recycled [#1818]
• Show submit button in review mode [#1817]
• Refactor edit text widget to fix integer issue [#1718]
• Enable "Next button" on paginated view when nested answer is chosen [#1677]
• Scroll down the RecyclerView to show the Add answer button [#1636]
• Hides error textview in the header for textInputLayout views [#1725]
• Fix DateTime picker component behaviour [#1870]
• Handle out-of-range integer input [#1718]
• Maintain selection state of radio buttons and boolean choices in nested questions [#1784, #1812]

We've also fixed other bugs in the library:

• Skip hidden pages [#1622]
• Cleaned up old state for dropdown [#1775]
• Add Reference class to display string function [#1735]
• Stop validating disabled questions [#1760]
• Extract repeating order elements properly for definition-based extraction [#1520]
• Fix unit tests in QuestionnaireViewModelTest [#1820]
• Rename view holder factories and reorganise files [#1883]

Thanks to all contributors in the community who have helped us reach this important milestone! 🎉🎉🎉

The 'sdc-0.1.0-beta06' release of Structured Data Capture library includes the following enhancements and bug fixes.

Enhancements:

• Answer expression extension implementation [#1480]
• Implement calculated expression extension [#971]
• Definition based extraction for custom extensions [#1381]
• Add ability to validate the min/max for Date on a FHIR Questionnaire [#1040]
• Update Material3 chip style [#1592]
• Support slider step value extension [#1260]
• Display category extension for instructions [#1450]
• Add asterisks symbol for required fields in Questionaire [#544]
• Flyover text added for open choice view [#1516]
• Add support for "Help" questionnaire item control [#1528]
• Support Android API Level 24+ [#1628]
• Update HAPI structures lib version to 6.0.1 [#1616]
• SDC catalog app - Added behaviors tab - showcasing calculated expressions [#1524]

Bugs:

• FhirPathEngine should use existing ValidationSupport instead of init again [Issue #1173]
• Match questionnaire items and questionnaire response items by link id [#1664]
• Fix logic to copy questionnaire response item by matching the ID [#1633]
• Add left margin to radio buttons and check boxes [#1477]
• Skip hidden field from validation [#1579]

This 'workflow-0.1.0-alpha02' release contains the following enhancements and fixes

New features:

• Creating a MinSDK=26 property for the Workflow [#1651]
• Generate CarePlan via $apply [#656, #915, #1334, #1403, #1407]
• Library evaluation implementation [#1326]
• Import XML versions of compiled CQL Libraries [#1423]
• Compile CQL to ELM in the SDK [#1365]

Bugs:

• NullPointerException inside LibraryContentProvider breaks the compiler's workflow [#1566]

The sdc-0.1.0-beta05 release of Structured Data Capture library includes a number of enhancements and bug fixes.

Enhancements:

• Add functionality to skip pages entirely in a paginated questionnaire [#1187]
• Copy text field from questionnaire to questionnaire response [#1502]
• Add variable Extension support [#1059]
• Feature to review question/answers in list view in Questionnaire Fragment [#227]
• Use entryMode extension to allow different pagination behaviours regarding validation. [#1272]

Bugs:

• Input of one date picker view gets updated in another date picker view in layout. [#1580]
• Choice with Radio Button input resets answer in paginated layout [#1521]
• Double selection of a dropdown [#1554]
• Open choice/Drop Down view issue [#1537]
• Re-selecting an option in a drop down item with valueString answer options is causing app to crash [#1542]
• sdc-beta04 regression in decimal data entry [#1551]
• Apply separate style to question text if type is group. [#1546]
• Single choice does not unselect the answer option on click. [#1512]
• use android lib cancel [#1510]
• Date picker - Keyboard doesn't open when clicking text field [#1418]

Code Health

• Refactor validation result to be a sealed class [#1553]

This engine-0.1.0-beta02 release of the FHIR Engine library will add in additional features in line with the FHIR Specification for search, sync and data-access APIs. The following items have been added:

Enhancements for Sync API

• Support configuration of HTTP Client timeouts [#1316]
• Provide Conflict Resolution capabilities for Downloaded Resources [#1329]
• Separate Internal and exposed class from SDK and optimize code [#1530]

Enhancements for Search API

• Use parametrized tests for Number Search [#545]
• Add X-FHIR-Query support in the FHIR Engine library [#1479]

Enhancements for Data Access API

• Purge API implementation [#1472]
• Use ResourceType for FHIR Engine data access APIs [#1277]

Bugs fixed for Sync API

• Sync time is not updating in hamburger menu after manual sync with server and toast message shows older time [#1135]
• Sync.poll doesn't retry if the request fails for some reason [#1164]
• Sync time is not updating in hamburger menu after manual sync [#1162]
• Make the _lastUpdated search parameter configurable. [#1420]

Bugs fixed for Search API

• Update search indexing logic to consider search params in full Class hierarchy [#1305]
• FHIR Engine sort by DateTime property not working [#1363]

The 0.1.0-beta04 release of Structured Data Capture library includes a number of enhancements and bug fixes. Some highlights:

• The library size is reduced by removing the mlkit dependency (#1331) to a separate module
• The styling of widgets have been updated to be in line with Material3
• Major changes to questionnaire validation and pagination
• Major improvements to the auto complete widget [#1398]
• Total revamp of the library wiki
• A new codelab is created in the repository

The following items have been added:

Enhancements:

• Add support for the 'text' field type to render multiline text input [#1517]
• Update the answer in the text field while the user is typing [#1501]
• Rewrite logic to find questionnaire item for EnableWhen evaluation [#1496]
• Rename attributes and default styles [#1488]
• Migrating Validation Result logic from View factory to QuestionnaireViewModel [#1468]
• Move the build stage up [#1449]
• Questionnaire jsons with required field for error workflow [#1356]
• Move barcode contrib code into its own Gradle module [#1331]
• Update single, boolean choice drawables [#1441]
• Validator API should throw an exception if inital value and intial value expression are both present [#1297]
• Fix extraction for choice type values [#1352]
• Date changed to short format instead of default (medium) [#1348]
• Allow pre-filled questionnaire response to be supplied by URI on top of JSON string [#916]
• Remove extra space from a Questionnaire View when the group headers have no text to show [#1339]
• Response validation occurs before data entry [#1001]
• Support enableWhenExpression [#819]
• Add submit questionnaire button to sdc module [#1088]
• Refactor Auto complete widget [#978]

Bugs:

• Single choice does not unselect the answer option on click [#1519]
• Multiple choice background color when option gets selected in m3 [#1435]
  questionnaireStateFlow not emitting as expected [#1427]
• Corrects misleading error message in QuestionnaireViewModel [#1461]
• Not enough space between title, hint and view [#1417]
• Update subtitle and flyover text in paginated questionnaire json in catalog app [#1455]
• DatePicker widget does not show white background [#1410]
• answerOption.valueString crashes SDC library [#1360]
• Accept integer data types in FHIR questionnaire [#1219]
• Set questionnaire theme in OptionSelectDialogFragment [#1027]
• Fix issue with empty context with initial expression [#1033]
• Add functionality to skip pages entirely in a paginated questionnaire [#1187]

Styling and Material3:

• Update material3 theme in catalog and datacapture [#1376]
• Update material design dependency version to 1.6.0 [#1012]
• Update material3 typography [#1446]
• Update Widget.Material3.* as default style in datacapture [#1444]
• Cleanup and moved Date and Time pickers to material [#1312]
• DataCapture, date picker custom style [#1108]
• Multiple choice background color when option get selected in m3 [#1432]

Documentation:

• Initial version of the SDC lib codelab [#1429]
• Update README.md for the data capture codelab [#1436]
• Update Structured Data Capture Library codelab [#1448 ]
• Adjust sourceRoots to only include main dir [#1508]
• Regenerate docs at latest public version using #1503 code [#1504]
• Move Dokka configs for different modules into a common DokkaConfig.kt file [#1503]
• Improve Kdoc comments for QuestionnaireFragment [#1470]
• Add generated docs for sdc-0.1.0-beta03, engine-0.1.0-beta01, workflow-0.1.0-alpha01 [#1467]
• Adds Gradle task dokkaHtml to run Dokka document generation [#1466]

The sdc-0.1.0-beta03 release of the data-capture library will add in additional features in line with the FHIR SDC Specification. The following items have been added:

Enhancements:

• Support optionExclusive extension in questionnaires [#1281]
• Add subtitle text to the questionnaire item view [#1113]
• Add material date picker to datacapture module [#1109]
• Internationalization for the Questionnaire answerOption item using Translation Extensions [#929]
• Pop up numeric keyboard for a question that requires phone number [#650]
• Horizontal layout support for radio buttons in the datacapture library [#542]

Bugs:

• Soft keyboard is not opened for open choice view [#1293]
• Date picker questionnaire with required field true does not show calendar icon [#1292]
• Extra blank space get added below question text if subtitle text is not present [#1291]
• Hidden questionnaire items not handled in QuestionnaireResponseValidator [#1051]
• Mismatch between setting questionnaireResponse.questionnaire and validating it [#1028]
• In some Questionnaire form, instead of link it shows html code [#968]
• Issues while reselecting single answer option initially set in questionnaire.item.initial [#765]
• Integrate barcode reader function to the latest merged version of SDC [#687]
• In paginated layout extra display text is shown at the top [#1314]
• Stoping users from being able to input/edit date or time in the respective viewholders [#1311]

This engine-0.1.0-beta01 release of the FHIR Engine library will add in additional features in line with the FHIR Specification for search, sync, security & privacy and data-access APIs. The following items have been added:

Sync API:

• Include resource version along with the SquashedLocalChange in the FhirEngine.syncUpload [#1096]
• Use Fhir Bundle type transaction for uploading the local changes to the server [#1021]
• Reorgnize the data source interface [#1199]
• FhirEngine Sync Download API Re-design [#1205]
• Device goes OOM when downloading a lot of resources [#862]
• Provide Resource Sync map based DownloadManager implementation in the ENgine [#1258]

Search API:

• URI filter in the search API [#951]
• Refactoring quantity index table by removing the canonical columns [#733]

Security & Privacy

• Enable dependency licence check [#750]
• Support encryption of SQLite DB with SQLCipher [#392]

Data Access API

• Refactor database index table's foreign key by adding a new local UUID to resource entity [#98]
• Design and implementation for generation of UUID by FHIR Engine [#784]

The engine-0.1.0-alpha06 release includes the following enhancements and fixes:

• Public releases cannot be used due to internal dependency issue #1005

If your application depends on both the Structured Data Capture library (0.1.0-beta02 and above) and FHIR Engine library (alpha versions), please update your dependency to this version.

This 0.1.0-beta02 release of the Data Capture Library include the following features and fixes:

• Public releases cannot be used due to internal dependency issue #1005
• Refactor definition-based extraction for multiple resource and create extraction context #670

This workflow-0.1.0-alpha01 release contains the following enhancements and fixes

New features:

• $measure-evaluate operation API #657

This sdc-0.1.0-beta01 release of the data-capture library will add in additional features in line with the FHIR SDC Specification. The following items have been added:

Enhancements:

• API for loading large questionnaires [#672]
• Read-only itemControl support [#763]
• Reduce the library size by removing npm package dependency [#808]
• API change for data capture config [#809]

Bugs:

• Crash while using the questionnaire response without disabled items generated by the SDK to resume form filling [#836]
• Reference/Gallery app get crashed when request focus get switched to bottom view [#863]
• Read only view in questions/forms too light [#917]
• UI improvements [#969]
• Multi select widget displays error incorrectly [#976]