Stream: questionnaire
Topic: Extension: displayCategory
Diane (Jul 12 2021 at 18:39):
Can someone explain why the FHIR standards were written to disallow Extension: displayCategory from displaying help/instructions on the group header? Our questionnaires contain a great deal of instructional information to help the users fill out each group of questionnaires and the users think this is very helpful. Some of the instructions don't make sense to place against the individual questions, as they are intended to explain the context of the group of questions.
Brian Postlethwaite (Jul 12 2021 at 22:50):
For that type of usage, just put display items into the group. You can then place them wherever in the group. (top bottom middle etc)
That's what we do.
And if you want it to be formatted too, use the markdown extension on the text.
Diane (Jul 12 2021 at 23:34):
Great idea, Brian.
Lloyd McKenzie (Jul 13 2021 at 01:47):
displayCategory is, quite literally a category for display items. It wouldn't make sense for them to be on group headings (group headings are expected to be headings, not help text or similar content). If you don't have a heading for your group, you're allowed to omit the text.
Diane (Jul 14 2021 at 06:21):
Ok. Understand about the displayCategory now. Makes sense. It looks like we also can't put a help-button because it is a display item onto either the group header or the display? Some of our help messages are really long, so we hide them in the help button. The help is for the context of the group as a whole.
"valueCodeableConcept" : {
"text" : "Help-Button",
"coding" : [
{
"code" : "help",
"display" : "Help-Button",
"system" : "http://hl7.org/fhir/questionnaire-item-control"
}
]
}
Lloyd McKenzie (Jul 14 2021 at 15:31):
When you designate a display item as 'help text', it's up to the form filler how to display that. It could be a collapsible section, it could be flyover, it could be a link or button to a pop-up or to a separate page, or it could be displayed inline. Some form fillers might make different choices based on the length of the text.
Brian Postlethwaite (Jul 14 2021 at 20:17):
(and form factor of the rendering device i.e. mobile/tablet)
Diane (Jul 14 2021 at 21:11):
But, you cannot ever put the 'help text' on the group header or on a display item. It has to go on regular questionnaire items?
Brian Postlethwaite (Jul 14 2021 at 21:24):
Back in dstu2 we had http://hl7.org/fhir/dstu2/extension-questionnaire-tooltip.html and http://hl7.org/fhir/dstu2/extension-questionnaire-help.html that seemed to cover this.
In the current SDC build there is also this one
http://hl7.org/fhir/R4/extension-questionnaire-supportlink.html
And re-reading the spec on the http://hl7.org/fhir/R4/extension-questionnaire-displaycategory.html
and the associated binding, sounds like this is the extension that replaced those above ones, and yet does not actually do this.
Brian Postlethwaite (Jul 14 2021 at 21:25):
Maybe for discussion on tomorrows call?
Diane (Jul 14 2021 at 21:35):
How do I find out the link to the call?
Lloyd McKenzie (Jul 14 2021 at 22:08):
A display item is a regular questionnaire item. A 'group' can't itself be help text - a group is a collection of child items
Lloyd McKenzie (Jul 14 2021 at 22:09):
Call details are here: https://confluence.hl7.org/display/FHIRI/Projects
Diane (Jul 15 2021 at 00:05):
@Lloyd McKenzie I agree. We don't want a group by itself with help text.
Diane (Jul 15 2021 at 00:07):
I have gotten a questionnaire containing the help button in the group header to validate. My working questionnaire is at: http://hapi.fhir.org/baseR4/Questionnaire/2394725?_pretty=true
But, it will need to be clarified on the call if this is the correct syntax, because it seems like putting a display type in a group is not what the spec intends?
I removed the displayCategory extension, which is what my team members were using because Questionnaires created in Fall 2020 that used the NLM Form Builder had the displayCategory extension for creating the help-button.
Instead, used this syntax that I found in a different Questionnaire created in a more recent version of the NLM Form Builder. The first item in the group is this:
{
"text" : "Help for the user to understand this group.",
"type" : "display",
"linkId" : "1.1-help",
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
"valueCodeableConcept" : {
"text" : "Help-Button",
"coding" : [
{
"code" : "help",
"display" : "Help-Button",
"system" : "http://hl7.org/fhir/questionnaire-item-control"
}
]
}
}
]
}
(question items go here)
Lloyd McKenzie (Jul 15 2021 at 01:31):
Looks fine to me
Lloyd McKenzie (Jul 15 2021 at 01:32):
The extension appears on display items and the display items nest inside the items (group or question) that they're providing display text for.
Brian Postlethwaite (Jul 15 2021 at 09:04):
I think we've lost the ability to have a help text tool tip associated with a group item that we used to have then.
Which is what I understood was being asked.
Brian Postlethwaite (Jul 15 2021 at 09:05):
Tool tip and help text aren't display items to me. They are extra info for an existing item.
Lloyd McKenzie (Jul 15 2021 at 14:00):
We agreed quite a while back that they are display items - and that you simply nest them inside the element they're associated with. (You could make the same argument that child questions are additional info for the same item :smile: )
Last updated: Apr 12 2022 at 19:14 UTC
