Stream: committers/notification
Topic: Reference or Inclusion of Source Documents
Lisa Nelson (May 17 2020 at 11:26):
@Grahame Grieve @Lloyd McKenzie
Grahame, we have an outstanding open question that didn't get resolved at Connectathon. (BTW GREAT event--just super busy and no chance to just run into you in the hallway to follow up on this question.)
We have a spreadsheet of concept information that is generated within the Gravity Community, and we use it as a base reference for tracking where we stand with content identified as needed, code submissions/discussions with Code System vendors, assigned temporary codes to support testing, etc. We want to include the spreadsheet in the FHIR IG specification.
Our first preference is to point to it from Confluence (while we are still in development mode), but before going to ballot we would like to be able to include it wholly in the IG as a persisted downloadable reference document. We are able to load it into the IG materials (using Trifolia). However, having it loaded in generates an error.
(I know the CARIN IG has a similar need and they are including the document. Amol @Amol Vyas or Igor, @Igor Sirkovich can you please confirm the approach you are taking and if you also are getting errors due to including the file?
What do you advise for handling this need?
Lisa
@Natasha Kreisle
Lloyd McKenzie (May 17 2020 at 14:41):
The IGPublisher has no issues propagating binary content into the spec (whether that's images or spreadsheets or whatever). My guess is that - if there is an issue - it's with Trifolia. Can you indicate what error you're seeing? (If Trifolia is still trying to send binaries "inside" the hyperlink, that's not allowed for large files by the HTTP spec (not to mention that it's just generally a bad idea because you can't then reference the same file from multiple locations).
Amol Vyas (May 18 2020 at 00:17):
@Lisa Nelson : The CARIN BB IG is using the data:URI mechanism to reference an immutable document (based on how DaVinci PDex was using it at that time. @Mark Scrimshire). If you're seeing errors during coding/compile time, I would check the syntax otherwise a runtime error usually means you've reached an HTTP server or client limitation. Also, I do agree with @Lloyd McKenzie that this kind of referencing mechanism is not sustainable.
@Lloyd McKenzie : What is the best practice approach for IGs to refer to supporting documents in an immutable way? Could an acceptable way be to perhaps refer to a commit-specific permanent link of the document under source control (for example, a GitHub url)?
@Saul Kravitz
Lloyd McKenzie (May 18 2020 at 02:14):
Moving this discussion to #committers (the notification stream is really for automated messages)
Last updated: Apr 12 2022 at 19:14 UTC
