Stream: shorthand
Topic: example descriptions
John Moehrke (May 16 2021 at 15:30):
I am using FSHonly -- some of my examples end up in the IG with the description I put into the FSH definition, but some do not. I can not figure out why some do and some do not.
Chris Moesel (May 17 2021 at 12:46):
@John Moehrke -- I'm not sure why that would happen either. When you say "end up in the IG" -- do you mean the IG pages (looking at them in a browser) or do you mean the IG JSON file? Is there somewhere that we can reproduce this?
John Moehrke (May 17 2021 at 12:56):
sorry, that was poor... The profiles are in the IG, and they do have a place on the table of contents and the artifacts page.. but the artifacts page is lacking the description on -some- of them
John Moehrke (May 17 2021 at 12:57):
I would actually expect none of them to make it... because I am using FSH only... but some of them make it, so I wonder why they all don't make it.
Chris Moesel (May 17 2021 at 13:04):
Oh, right. You said FSH-Only. I missed that. Is it examples or profiles? You originally said "examples", but your last note talks about "profiles". I also would not expect examples to have their descriptions appear. For profiles, however, since there is a "description" field in StructureDefinition, I wouldn't be surprised if the IG publisher pulled the description from that.
John Moehrke (May 17 2021 at 13:04):
examples
John Moehrke (May 17 2021 at 13:06):
okay, then I need to manually add the examples to the IG xml... yuck. I like FSH only, but I do have too admit this specific hitch is not fun
John Moehrke (May 17 2021 at 13:08):
I started doing this, but I have so many examples, and more examples every day... I guess I would wish for the FSH only to help me out here, but can't think of a good clean solution.
John Moehrke (May 17 2021 at 13:27):
any clue how IG build finds some of these descriptions?
Chris Moesel (May 17 2021 at 13:30):
I don't know how IG build is currently finding any of them even though you don't have them in the IG JSON. The only thing I can think of is if the example resource happens to have a top-level "description" field, then maybe the IG Publisher would pick that up?
Chris Moesel (May 17 2021 at 13:33):
I think I remember some discussion a while back about trying to come up w/ some ancillary way to organize example descriptions (outside of IG JSON). I think there were thoughts of a separate purpose-specific file as well as some ideas about special extensions that would be in the source (and could carry the title and description) but would be stripped from the example in the IG. But (obviously) that hasn't really gone anywhere.
John Moehrke (May 17 2021 at 13:33):
yes.
Last updated: Apr 12 2022 at 19:14 UTC
