Stream: shorthand
Topic: Comments in IG
Michaela Ziegler (Dec 08 2021 at 13:28):
Is it possible with FSH to set comments in instances that are shown afterwards in the published IG?
Chris Moesel (Dec 08 2021 at 15:02):
Hi @Michaela Ziegler. That's an interesting idea, but one we have not considered yet. I'm not sure how it would work, but we can add it to our backlog as something to look into.
Michaela Ziegler (Dec 08 2021 at 15:04):
@Chris Moesel that would be great!
Chris Moesel (Dec 08 2021 at 15:13):
Hmmm... actually, it could be a little complicated for us. We produce the instances as JSON, and JSON does not allow comments (as noted in the spec here). I was remembering a feature that allowed comments in a special fhir_comments property, but it looks like that feature hasn't been in the spec since DSTU2 -- so it seems it might not be valid in R4. We can still look into it, but I'm not sure if there will be an easy way forward. I guess we'll see.
Elliot Silver (Dec 08 2021 at 17:42):
It's not a shorthand issue, but the lack of comments in JSON has been a pain for me. I can't comment out an element, I can't leave myself a to-do. I'm sure JSON has its reasons, but I have mine too.
And while you're at it, get off my lawn!
John Moehrke (Dec 08 2021 at 18:23):
json element that is a comment
Chris Moesel (Dec 08 2021 at 18:46):
JSON5 supports comments. It would be nice if we could allow JSON5 for at least those instances that are marked as examples in IGs.
John Moehrke (Dec 08 2021 at 18:55):
I would like my FSH files to be exposed, but the current discussions is to derive fresh and clean FSH from the StructureDefinitions. To me, this is good but not fully satisfying.
That said. there is the -intro and -notes and description... that are all rich text markdown... so there are plenty of ways to communicate to the reader
Grahame Grieve (Dec 08 2021 at 19:59):
fhir_comments was removed very deliberately. I disagreed.
Grahame Grieve (Dec 08 2021 at 20:02):
I could upgrade the IG publisher to accept Json5 in the input resources, and then use normal json everywhere else
Chris Moesel (Dec 08 2021 at 20:11):
I always thought fhir_comments was weird, so I'm not particularly sad to see it go. I think JSON5 would be cool for sure, but just to be up front about this -- I'm not yet ready to commit my team on implementing this SUSHI-side. So... if you implement it in the publisher, it might be a while before SUSHI actually generates JSON5 w/ comments.
Grahame Grieve (Dec 08 2021 at 20:28):
oh it was weird, sure. but people might find json5 useful in a non-sushi context. But I'm not going to do it right now
Last updated: Apr 12 2022 at 19:14 UTC
