Highlight missing fields and Show validation popup.

catalog/src/main/assets/layout_default.json

@@ -10,6 +10,7 @@
  {
  "linkId": "2",
  "type": "string",
+ "required": true,
  "item": [
  {
  "linkId": "2.1",

catalog/src/main/assets/layout_paginated.json

@@ -29,6 +29,7 @@
  {
  "linkId": "1.2",
  "type": "string",
+ "required": true,
  "item": [
  {
  "linkId": "1.2.1",
@@ -183,7 +184,8 @@
  "linkId": "2.1",
  "type": "date",
  "text": "Date of birth",
- "prefix": "2."
+ "prefix": "2.",
+ "required": true
  },
  {
  "linkId": "2.2",
@@ -347,6 +349,7 @@
  {
  "linkId": "3.6",
  "type": "string",
+ "required": true,
  "item": [
  {
  "linkId": "14.1",
@@ -420,6 +423,7 @@
  {
  "linkId": "4.2",
  "type": "string",
+ "required": true,
  "item": [
  {
  "linkId": "16.1",
@@ -446,6 +450,7 @@
  {
  "linkId": "4.3",
  "type": "choice",
+ "required": true,
  "extension": [
  {
  "url": "http:https://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
@@ -847,7 +852,8 @@
  "linkId": "10.1",
  "type": "dateTime",
  "text": "What was the date and time of the ultrasound?",
- "prefix": "10."
+ "prefix": "10.",
+ "required": true
  }
  ]
  }

datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireFragment.kt

@@ -24,18 +24,20 @@ import android.widget.Button
 import androidx.appcompat.view.ContextThemeWrapper
 import androidx.core.content.res.use
 import androidx.fragment.app.Fragment
+import androidx.fragment.app.activityViewModels
 import androidx.fragment.app.setFragmentResult
 import androidx.fragment.app.viewModels
 import androidx.lifecycle.lifecycleScope
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
+import com.google.android.fhir.datacapture.validation.Invalid
 import com.google.android.fhir.datacapture.views.QuestionnaireItemViewHolderFactory
 import com.google.android.material.progressindicator.LinearProgressIndicator
 import org.hl7.fhir.r4.model.Questionnaire
 
 /**
  * A [Fragment] for displaying FHIR Questionnaires and getting user responses as FHIR
- * QuestionnareResponses.
+ * QuestionnaireResponses.
  *
  * For more information, see the
  * [QuestionnaireFragment](https://github.com/google/android-fhir/wiki/SDCL%3A-Use-QuestionnaireFragment)
@@ -74,8 +76,23 @@ open class QuestionnaireFragment : Fragment() {
  paginationPreviousButton.setOnClickListener { viewModel.goToPreviousPage() }
  val paginationNextButton = view.findViewById<View>(R.id.pagination_next_button)
  paginationNextButton.setOnClickListener { viewModel.goToNextPage() }
- requireView().findViewById<Button>(R.id.submit_questionnaire).setOnClickListener {
- setFragmentResult(SUBMIT_REQUEST_KEY, Bundle.EMPTY)
+ view.findViewById<Button>(R.id.submit_questionnaire).setOnClickListener {
+ viewModel.validateQuestionnaireAndUpdateUI().let { validationMap ->
+ if (validationMap
+ .filter { (_, validations) -> validations.filterIsInstance<Invalid>().isNotEmpty() }
+ .isEmpty()
+ ) {
+ setFragmentResult(SUBMIT_REQUEST_KEY, Bundle.EMPTY)
+ } else {
+ val errorViewModel: QuestionnaireValidationErrorViewModel by activityViewModels()
+ errorViewModel.setQuestionnaireAndValidation(viewModel.questionnaire, validationMap)
+ QuestionnaireValidationErrorMessageDialogFragment()
+ .show(
+ requireActivity().supportFragmentManager,
+ "QuestionnaireValidationErrorMessageDialogFragment"
+ )
+ }
+ }
  }
  val questionnaireProgressIndicator: LinearProgressIndicator =
  view.findViewById(R.id.questionnaire_progress_indicator)

datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireValidationErrorMessageDialogFragment.kt

@@ -0,0 +1,160 @@
+/*
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http:https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.google.android.fhir.datacapture
+
+import android.app.Dialog
+import android.os.Bundle
+import android.view.LayoutInflater
+import android.view.View
+import android.view.ViewGroup
+import android.widget.TextView
+import androidx.annotation.VisibleForTesting
+import androidx.appcompat.view.ContextThemeWrapper
+import androidx.core.content.res.use
+import androidx.fragment.app.DialogFragment
+import androidx.fragment.app.activityViewModels
+import androidx.lifecycle.ViewModel
+import androidx.lifecycle.ViewModelProvider
+import androidx.recyclerview.widget.DiffUtil
+import androidx.recyclerview.widget.LinearLayoutManager
+import androidx.recyclerview.widget.ListAdapter
+import androidx.recyclerview.widget.RecyclerView
+import com.google.android.fhir.datacapture.validation.Invalid
+import com.google.android.fhir.datacapture.validation.ValidationResult
+import com.google.android.fhir.datacapture.views.MarginItemDecoration
+import com.google.android.material.dialog.MaterialAlertDialogBuilder
+import org.hl7.fhir.r4.model.Questionnaire
+
+/**
+ * [Dialog] to highlight the required fields that need to be filled by the user before submitting
+ * the [Questionnaire]. This is shown when user has pressed internal submit button in the
+ * [QuestionnaireFragment] and there are some validation errors.
+ */
+internal class QuestionnaireValidationErrorMessageDialogFragment(
+ /**
+ * Factory helps with testing and should not be set to anything in the regular production flow.
+ */
+ private val factoryProducer: (() -> ViewModelProvider.Factory)? = null
+) : DialogFragment() {
+
+ override fun onCreateDialog(savedInstanceState: Bundle?): Dialog {
+ isCancelable = false
+ return MaterialAlertDialogBuilder(requireContext()).setView(onCreateCustomView()).create()
+ }
+
+ @VisibleForTesting
+ fun onCreateCustomView(layoutInflater: LayoutInflater = getLayoutInflater()): View {
+ val themeId =
+ layoutInflater.context.obtainStyledAttributes(R.styleable.QuestionnaireTheme).use {
+ it.getResourceId(
+ // Use the custom questionnaire theme if it is specified
+ R.styleable.QuestionnaireTheme_questionnaire_theme,
+ // Otherwise, use the default questionnaire theme
+ R.style.Theme_Questionnaire
+ )
+ }
+
+ return layoutInflater
+ .cloneInContext(ContextThemeWrapper(layoutInflater.context, themeId))
+ .inflate(R.layout.questionnaire_validation_error_dialog, null)
+ .apply {
+ findViewById<RecyclerView>(R.id.recycler_view).apply {
+ layoutManager = LinearLayoutManager(context)
+ addItemDecoration(
+ MarginItemDecoration(
+ context.resources.getDimensionPixelOffset(R.dimen.instructions_top_margin)
+ )
+ )
+ val viewModel: QuestionnaireValidationErrorViewModel by
+ activityViewModels(factoryProducer)
+ adapter =
+ ErrorAdapter().apply { submitList(viewModel.getItemsTextWithValidationErrors()) }
+ }
+ findViewById<View>(R.id.positive_button).setOnClickListener { dialog?.dismiss() }
+ }
+ }
+
+ class ErrorAdapter :
+ ListAdapter<ValidationErrorDataModel, ErrorViewHolder>(ValidationDiffCallback) {
+
+ override fun onCreateViewHolder(parent: ViewGroup, viewType: Int) =
+ ErrorViewHolder(parent, R.layout.questionnaire_validation_dialog_item)
+
+ override fun onBindViewHolder(holder: ErrorViewHolder, position: Int) {
+ holder.bind(getItem(position))
+ }
+ }
+
+ class ErrorViewHolder(parent: ViewGroup, layout: Int) :
+ RecyclerView.ViewHolder(LayoutInflater.from(parent.context).inflate(layout, parent, false)) {
+
+ val textView: TextView = itemView.findViewById(R.id.text_view)
+
+ fun bind(data: ValidationErrorDataModel) {
+ textView.text =
+ itemView.context.getString(
+ R.string.questionnaire_validation_error_item_text_with_bullet,
+ data.questionnaireItemText
+ )
+ }
+ }
+}
+
+private val ValidationDiffCallback =
+ object : DiffUtil.ItemCallback<ValidationErrorDataModel>() {
+ override fun areItemsTheSame(
+ oldItem: ValidationErrorDataModel,
+ newItem: ValidationErrorDataModel
+ ) = oldItem.linkId == newItem.linkId
+
+ override fun areContentsTheSame(
+ oldItem: ValidationErrorDataModel,
+ newItem: ValidationErrorDataModel
+ ) = oldItem.questionnaireItemText == newItem.questionnaireItemText
+ }
+
+internal class QuestionnaireValidationErrorViewModel : ViewModel() {
+ private var questionnaire: Questionnaire? = null
+ private var validation: Map<String, List<ValidationResult>>? = null
+
+ fun setQuestionnaireAndValidation(
+ questionnaire: Questionnaire,
+ validation: Map<String, List<ValidationResult>>
+ ) {
+ this.questionnaire = questionnaire
+ this.validation = validation
+ }
+
+ /** @return Texts associated with the failing [Questionnaire.QuestionnaireItemComponent]s. */
+ fun getItemsTextWithValidationErrors(): List<ValidationErrorDataModel> {
+ val invalidFields =
+ validation?.filterValues { it.filterIsInstance<Invalid>().isNotEmpty() } ?: emptyMap()
+ return questionnaire
+ ?.item
+ ?.flattened()
+ ?.filter { invalidFields.contains(it.linkId) }
+ ?.map {
+ ValidationErrorDataModel(
+ it.linkId,
+ if (it.text.isNullOrEmpty()) it.localizedFlyoverSpanned.toString() else it.text
+ )
+ }
+ ?: emptyList()
+ }
+}
+
+data class ValidationErrorDataModel(val linkId: String, val questionnaireItemText: String)

datacapture/src/main/java/com/google/android/fhir/datacapture/QuestionnaireViewModel.kt

@@ -30,10 +30,13 @@ import com.google.android.fhir.datacapture.enablement.EnablementEvaluator
 import com.google.android.fhir.datacapture.fhirpath.ExpressionEvaluator.detectExpressionCyclicDependency
 import com.google.android.fhir.datacapture.fhirpath.ExpressionEvaluator.evaluateCalculatedExpressions
 import com.google.android.fhir.datacapture.utilities.fhirPathEngine
+import com.google.android.fhir.datacapture.validation.Invalid
 import com.google.android.fhir.datacapture.validation.NotValidated
 import com.google.android.fhir.datacapture.validation.QuestionnaireResponseItemValidator
+import com.google.android.fhir.datacapture.validation.QuestionnaireResponseValidator
 import com.google.android.fhir.datacapture.validation.QuestionnaireResponseValidator.checkQuestionnaireResponse
 import com.google.android.fhir.datacapture.validation.Valid
+import com.google.android.fhir.datacapture.validation.ValidationResult
 import com.google.android.fhir.datacapture.views.QuestionnaireItemViewItem
 import com.google.android.fhir.search.search
 import kotlinx.coroutines.flow.Flow
@@ -96,6 +99,10 @@ internal class QuestionnaireViewModel(application: Application, state: SavedStat
  * needed to avoid spewing validation errors before any questions are answered.
  */
  private var isPaginationButtonPressed = false
+
+ /** Forces response validation each time [getQuestionnaireItemViewItems] is called. */
+ private var forceValidate = false
+
  init {
  when {
  state.contains(QuestionnaireFragment.EXTRA_QUESTIONNAIRE_RESPONSE_JSON_URI) -> {
@@ -304,6 +311,23 @@ internal class QuestionnaireViewModel(application: Application, state: SavedStat
  }
  }
 
+ /**
+ * Validates questionnaire and return the validation results. As a side effect, it triggers the UI
+ * update to show errors in case there are any validation errors.
+ */
+ internal fun validateQuestionnaireAndUpdateUI(): Map<String, List<ValidationResult>> =
+ QuestionnaireResponseValidator.validateQuestionnaireResponse(
+ questionnaire,
+ questionnaireResponse,
+ getApplication()
+ )
+ .also { result ->
+ if (result.values.flatten().filterIsInstance<Invalid>().isNotEmpty()) {
+ forceValidate = true
+ modificationCount.update { it + 1 }
+ }
+ }
+
  internal fun goToPreviousPage() {
  when (entryMode) {
  EntryMode.PRIOR_EDIT,
@@ -618,7 +642,8 @@ internal class QuestionnaireViewModel(application: Application, state: SavedStat
 
  val validationResult =
  if (modifiedQuestionnaireResponseItemSet.contains(questionnaireResponseItem) ||
- isPaginationButtonPressed
+ isPaginationButtonPressed ||
+ forceValidate
  ) {
  QuestionnaireResponseItemValidator.validate(
  questionnaireItem,

datacapture/src/main/res/layout/questionnaire_validation_dialog_item.xml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="utf-8" ?>
+<!--
+ Copyright 2021 Google LLC
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+ http:https://www.apache.org/licenses/LICENSE-2.0
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<com.google.android.material.textview.MaterialTextView
+ xmlns:android="http:https://schemas.android.com/apk/res/android"
+ xmlns:tools="http:https://schemas.android.com/tools"
+ android:id="@+id/text_view"
+ style="?attr/questionnaireValidationDialogBodyStyle"
+ android:layout_width="match_parent"
+ android:layout_height="wrap_content"
+ tools:text="Option"
+/>