android-fhir icon indicating copy to clipboard operation
android-fhir copied to clipboard

Add support for "Help" questionnaire item control

Open williamito opened this issue 3 years ago • 3 comments

Is your feature request related to a problem? Please describe. Both NLM Form Builder (https://lhcformbuilder.nlm.nih.gov/beta/) and Structor (https://formdesigner.helsenorgelab.no/) support adding help text via the questionnaire item control type "help" (see value-set http://hl7.org/fhir/R4/valueset-questionnaire-item-control.html). In addition, many LOINC forms loadable from the NLM Form Builder use help text. We should also prioritize supporting this control to have parity with these two popular tools.

Here's an example in use:

"item": [
  {
    "text": "Sex of the patient, created for HL7 v3's \"Administrative gender\" concept, which represents the sex of a person used for adminstrative purposes (such as registering a patient in a hospital EHR). [https://www.hl7.org/fhir/v3/AdministrativeGender/index.html]",
    "type": "display",
    "linkId": "/72143-1-help",
    "extension": [
      {
        "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
        "valueCodeableConcept": {
          "coding": [
            {
              "system": "http://hl7.org/fhir/questionnaire-item-control",
              "code": "help",
              "display": "Help-Button"
            }
          ],
          "text": "Help-Button"
        }
      }
    ]
  }
]

Describe the solution you'd like Support in SDC Library for the "help" item control type.

williamito avatar Aug 02 '22 22:08 williamito

Here are some mocks for this.

(1) Place the 'question' help button next to the 'instructions' text field. (2) Show the help text in a container that appears below the instructional text. Click on help button icon again to hide the text. (3) Place the 'questionnaire' help button in the top bar (default location for help button in Android)

Screen Shot 2022-08-04 at 10 35 21

shelaghm avatar Aug 04 '22 17:08 shelaghm

Thanks @williamito for flagging this. @shelaghm any preference or best practice we can draw on for which approach should be prioritized?

@Tarun-Bhardwaj let's discuss priority of this

fredhersch avatar Aug 05 '22 01:08 fredhersch

@jingtang10 can you help us to estimate the size of this. Ty

fredhersch avatar Aug 05 '22 01:08 fredhersch

in progress.

santosh-pingle avatar Aug 30 '22 06:08 santosh-pingle

Here are some mocks for this.

(1) Place the 'question' help button next to the 'instructions' text field. (2) Show the help text in a container that appears below the instructional text. Click on help button icon again to hide the text. (3) Place the 'questionnaire' help button in the top bar (default location for help button in Android)

Screen Shot 2022-08-04 at 10 35 21

@shelaghm can you please share figma link on chat for Help button v2(in-line)?

santosh-pingle avatar Sep 09 '22 07:09 santosh-pingle

@santosh-pingle you can download the SVG for help icon here (it is open source) https://fonts.google.com/icons?selected=Material%20Symbols%20Outlined%3Ahelp%3AFILL%400%3Bwght%40400%3BGRAD%400%3Bopsz%4048

shelaghm avatar Sep 09 '22 19:09 shelaghm

@shelaghm Can you please also update style for below items

  • Help
  • Only one answer can be selected. If none apply ...
  • Background drawable where above 2 texts are shown.

santosh-pingle avatar Sep 12 '22 05:09 santosh-pingle