FHIR Chat · Item help · questionnaire

Stream: questionnaire

Topic: Item help


view this post on Zulip Paul Lynch (May 15 2018 at 21:45):

Where does item (question-level) help go? We've been stuffing it into questionnaire-displayCategory, which has a code for "instructions", but I think that's not right. My reading of questionnaire-displayCategory is that it is a CodableConcept describing the type of the item.

view this post on Zulip Lloyd McKenzie (May 15 2018 at 21:48):

You create a separate item of type "display", put your instructions in the 'text' element and set the category to "instructions".

view this post on Zulip Paul Lynch (May 16 2018 at 14:34):

The kind of item help I am talking about is where we have a small help button next to the item's (question's) display string. It is not a separate item itself, but tied to the item for which it is providing help. The help only appears if the user requests to see it by clicking on the help button, so that way the form is not cluttered by it when it is not needed. Is there no way to associate help with a specific item (question or section)?

view this post on Zulip Lloyd McKenzie (May 16 2018 at 14:37):

That's a rendering decision

view this post on Zulip Lloyd McKenzie (May 16 2018 at 14:42):

Whether the help is shown in-line, as a flyover, by clicking on a link or icon that produces a popup, or by pushing a button is up to the tool that displays the Questionnaire.

view this post on Zulip Paul Lynch (May 16 2018 at 14:48):

How or when it is shown is a rendering decision, but in order to associate it with an item (like having a help button appear next to the question text for questions that have help) there needs to be something in the Questionnaire that links that help to the question's item. It sounds like in Questionnaire, the help is always a completely separate item, which I think is useful for but a different case.

view this post on Zulip Lloyd McKenzie (May 16 2018 at 14:58):

It's a separate item, but can be a child item

view this post on Zulip Paul Lynch (May 16 2018 at 16:06):

I can think of (theoretical) forms where a child item of type display might mean something different. For instance, if you had a question which had sub-questions, where both the question and sub-questions took values (something we don't yet support in LHC-Forms), then whether a child display item would be help for the parent question or the sub-questions would not be discernible from the structure. However, what you are suggesting would meet LHC-Forms current functionality (and I think all the forms we have).

view this post on Zulip Lloyd McKenzie (May 16 2018 at 16:14):

It probably makes sense for us to clarify whether a 'help', 'instructions' or similar item associated with another item should be sent as a preceding, following or child element. Care to submit a change request? :)

view this post on Zulip Paul Lynch (May 16 2018 at 17:01):

Okay, thanks. Added #17208. I put it in "Structured Data Capture (SDC)"-- hope that was the right place. But, if it does not handled for FHIR Core I'm not sure how we'll handle standard Questionnaire item help.

view this post on Zulip Lloyd McKenzie (May 16 2018 at 18:17):

It's a general FHIR Core issue, so I moved it. However, I categorized it to SDC for discussion purposes


Last updated: Apr 12 2022 at 19:14 UTC