Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-33675

Add support for input / keyboard hints

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • Structured Data Capture (SDC) (FHIR)
    • current
    • FHIR Infrastructure
    • SDC Form Filler
    • Hide

      Will define the extension sdc-questionnaire-keyboard as 0..1 on item

      Will use the value set as proposed, excluding 'plain' and 'multiline'.  The former is the default and doesn't require declaration.  The latter is already distinguished by the 'string' or 'text' types. 

      Definition: For string or text items, indicates the 'keyboard type' that should be used by the user interface to guide entry.

      Rationale: This may affect what characters are accessible or most easily available as well as what prediction algorithm is used.  It is most typically used by mobile devices

      Comment: The assertion applies on a per item basis and is not inherited.  If the item is 'text', only 'chat' should be declared if this extension is present.

      Will add this to both the "behavior" and 'rendering' profiles as optional, not mustSupport.

      This will be a next release change.

      Show
      Will define the extension sdc-questionnaire-keyboard as 0..1 on item Will use the value set as proposed, excluding 'plain' and 'multiline'.  The former is the default and doesn't require declaration.  The latter is already distinguished by the 'string' or 'text' types.  Definition: For string or text items, indicates the 'keyboard type' that should be used by the user interface to guide entry. Rationale: This may affect what characters are accessible or most easily available as well as what prediction algorithm is used.  It is most typically used by mobile devices Comment: The assertion applies on a per item basis and is not inherited.  If the item is 'text', only 'chat' should be declared if this extension is present. Will add this to both the "behavior" and 'rendering' profiles as optional, not mustSupport. This will be a next release change.
    • Brian Postlethwaite/Paul Lynch: 4-0-0
    • Enhancement
    • Compatible, substantive

    Description

      Mobile devices have the ability to display keyboards with different layouts for different types of input. As an example, they can show a dedicated keyboard type containing only digits, a minus sign and a decimal point for numeric input. Or a keyboard with an easy to reach `@` sign to enter an email address. The FHIR SDC specification so far is not providing a way to explicitly request this kind of behaviour. Inputs are defined as item type "string", their format can be constrained through the "regex" extension, but there is no way to hint the desire for a particular kind of keyboard.
       
      Based on the discussion on chat.fhir.org (https://chat.fhir.org/#narrow/stream/179255-questionnaire/topic/SDC.20.3A.20How.20to.20show.20the.20correct.20keyboard.20i.2Ee.2E.20alphanumeric.20.2E.2E.2E) it is therefore proposed to introduce such a hint to the SDC IG.
       
      The proposed way to implement this through an extension, with a proposed name of
      `http://hl7.org/fhir/StructureDefinition/inputType` of value type "code", with a value set containing at least the hints "number", "phone", "email", and "plain".

      Other candidate hints are "multiline", "url", and "chat".

      They should trigger the following keyboard behaviours:
      plain: Normal, plain text input

      phone: Keyboard type optimised for input of phone numbers (digits with letters, different prediction)

      email: Keyboard type optimised for input of email addresses (easy access to at-sign, different prediction)

      number: Keyboard type optimised for entering digits (useful for strings as well, such as for entering numerical identifiers)

       
      Potential candidates:
      multiline: Keyboard optimised for entering longer, multiline passages of text (potentially different capitalisation and behaviour of Enter key)

      url: Keyboard type optimised for input of URLs (different prediction, easy access to forward slash)

      chat: Keyboard type optimised for input of chat messages (easy access to emojis)

        

      Attachments

        Activity

          People

            lloyd Lloyd McKenzie
            tiloc Tilo Christ (Inactive)
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: