Stream: shorthand
Topic: Sushi generated artifacts misses description for examples ?
Kevin Power (Jan 15 2022 at 22:16):
We have example instances in our IG, and I am noticing when the artifacts page is generated, the Description from the FSH doesn't make it to the description attribute in the SD. And actually, if the example is an InstanceOf a resource that has an attribute named "description" that is what is used on the artifact page.
As I type this, I don't know if this is a sushi thing, or perhaps a template issue? I will still start here.
Here is the examples section in the artifact page I am talking about:
http://build.fhir.org/ig/HL7/genomics-reporting/artifacts.html#13
Here is our FSH file for examples:
https://github.com/HL7/genomics-reporting/blob/master/input/fsh/CGExamples.fsh#L992
The FSH file line I am pointing to is an example of a DocRef, and you can see on the artifacts page the table has '... details about how this VCF was generated ...' but in our example, that text is only used as the text of the DocumentReference.description, but somehow makes it way into our ImplementationGuide file as the description as the resource[].description for this instance.
Tagging @Chris Moesel and @Lloyd McKenzie -- any help would be appreciated.
Kevin Power (Jan 15 2022 at 22:33):
Actually, I might be onto something else here. We have a bit of a hodge-podge right now where we have some artifacts defined in our own IG file, and some that are not. I have been wanting to fix that anyway by just using the IG file generated by Sushi, so I tried that and it seems to have fixed this problem. Now, it introduced several other things, but I will work on those.
Sorry for interrupting your weekend (as I am QUITE sure Chris and Lloyd were just waiting for something to do today :smile:)
Elliot Silver (Jan 15 2022 at 22:34):
I see you're resolving this yourself, but for reference, to see if this is a sushi thing or a template issue, you can look in your fsh-generated directory.
Kevin Power (Jan 15 2022 at 22:35):
Yup @Elliot Silver -- Of course, as soon as I post this, that thought hit me and I reviewed it, which led me down the path of 'ahhhh, maybe this is the problem'
Kevin Power (Jan 15 2022 at 22:37):
My dad used to say "Measure Twice, Cut Once" - Perhaps I should remind myself of that before posting questions too soon :smile:
Elliot Silver (Jan 15 2022 at 22:37):
No problem, we all do it.
Chris Moesel (Jan 18 2022 at 14:45):
@Kevin Power - you're probably also running into this situation a bit as well: https://chat.fhir.org/#narrow/stream/215610-shorthand/topic/instance.20title/near/266818927
That chat talks most about title, but it applies to instances w/ description as well. As noted in the chat, we logged SUSHI#1003 to reconsider this behavior.
Last updated: Apr 12 2022 at 19:14 UTC
