Stream: IG creation
Topic: Narrative size of strucDefs
Patrick Werner (Sep 12 2019 at 20:42):
The generated narrative of StrucDef contains the Treeview, including inline css. So if your profile contains a lote of nodes the narrative size explodes:
http://build.fhir.org/ig/HL7/genomics-reporting/obs-variant.profile.xml.html
narrative = 350,000 chars ~300kb on the narrative alone.
Patrick Werner (Sep 12 2019 at 20:44):
So:
- could the narrative generation for StrucDefs be disabled?
- do we need a narrative of StrucDefs? If yes what should be the content?
Lloyd McKenzie (Sep 12 2019 at 21:22):
The general principle is that we should have narrative everywhere. If we expect others to do that, we sort of need to set the example.
Eric Haas (Sep 12 2019 at 21:38):
can you overide the generated narrative with your own?
Eric Haas (Sep 12 2019 at 21:38):
for SDs
Lloyd McKenzie (Sep 12 2019 at 22:21):
Yes, but why would you?
Patrick Werner (Sep 13 2019 at 00:58):
Because the generated narrative is 350.000 characters long and a copy of the rendered tree view.
Patrick Werner (Sep 13 2019 at 00:58):
Including CSS
Patrick Werner (Sep 13 2019 at 00:59):
300kb overhead due to the narrative isn‘t acceptable. Could the narrative generation be overwritten/ modified?
Patrick Werner (Sep 13 2019 at 01:00):
I would replace it with some explaining text and a link into the profile inside of the IG
Patrick Werner (Sep 13 2019 at 01:19):
also if you look at this: http://build.fhir.org/ig/HL7/genomics-reporting/obs-variant.profile.xml.html
you have to scroll for ages until you reach the parts you want to look at.
Grahame Grieve (Sep 13 2019 at 14:54):
ok so the that prompted me to get round to doing something I meant to do do before, and that is that the next release of the IG publisher will create the anchor "end-xhtml" at the end of the narrative, so that you can add a 'jump past the narrative' link
Grahame Grieve (Sep 13 2019 at 14:56):
I've never been sure about the utility of putting in the entire tree or not. You might have seen the tree appear in places where the narrative is viewed - it works... tolerably well.
Grahame Grieve (Sep 13 2019 at 14:56):
that doesn't mean that a simpler text-centered representation wouldn't be better.... but I don't have a good one of them to pull out of my hat....
Grahame Grieve (Sep 13 2019 at 14:57):
maybe the FL discussion will bring us to that.... though I'm not convinced about that
Patrick Werner (Sep 13 2019 at 15:05):
could the narrative creation mechanism in the IG publisher be modified or overwritten by the IG authors? Or is it hardcoded? Propably part of the template?
Grahame Grieve (Sep 13 2019 at 15:13):
it's hard coded for the core conformance resources (CodeSystem, ValueSet, ConceptMap, StructureDefinition, StructureMap, OperationDefinition, SearchParameter, CapabilityStatement, GraphDefinition)
Grahame Grieve (Sep 13 2019 at 15:13):
it can be changed for other resources using a liquid template.
Last updated: Apr 12 2022 at 19:14 UTC
