Stream: implementers
Topic: IG "Starter" Template?
Chris Moesel (Feb 14 2017 at 15:54):
I want to publish documentation for a set of profiles, extensions, value sets, and code systems. Putting together a simple IG seems the best approach. I'd like each profile/extension page to contain the stuff most people would want: Summary or Narrative, Differential/Snapshot/All tables (like in the FHIR spec), XML/JSON views of the structdef. Is there a starter template/project that provides most of this (just slap in the JSON structuredefs and a few index pages and it does the rest)? I tried using the ccda2 guide as a template (from 1.8 sources), and it works OK, but not great. Wondering if there is a better starting point...
Lloyd McKenzie (Feb 14 2017 at 17:04):
You might look at SDC. It makes things pretty easy from a maintenance perspective, though it does require the use of Ant and gets rid of the real-time publication feature. (I'm hoping to fix that over the next week or so.)
Bryn Rhodes (Feb 14 2017 at 17:05):
There's also an IG Template here: https://github.com/cqframework/igtemplate
Bryn Rhodes (Feb 14 2017 at 17:05):
It's pretty bare bones right now, but the intent is that it provides a starter template exactly like what you're looking for.
Bryn Rhodes (Feb 14 2017 at 17:06):
Commits welcome to improve the starting point, I'm using it for several IGs and committing improvements back to the template as I go.
Chris Moesel (Feb 14 2017 at 18:37):
Thanks, @Lloyd McKenzie and @Bryn Rhodes . I'll probably try out Bryn's template first, since its purpose is exactly what I'm looking for. Funny -- I'm an admin for that GitHub organization (cqframework) -- so I probably saw when that igtemplate repo was created and forgot about it!
Eric Haas (Feb 14 2017 at 23:56):
I have a template for creating IGs (see Argonaut/US-Core) and other as well uses a python script to take care of the definitions file so you don't have to and lots of Markdown too.
Chris Moesel (Feb 15 2017 at 03:28):
@Eric Haas -- is there an actual blank(-ish) template, or would someone just take the Argonaut/US-Core IG from the build and modify that?
Chris Moesel (Feb 15 2017 at 05:06):
The only Argonaut Guide I found was here, but it's based on spreadsheets, hasn't been implemented in a while, and has no python scripts. Am I looking in the right place?
Grahame Grieve (Feb 15 2017 at 05:18):
no. check https://github.com/Healthedata1/Argo-DSTU2
Eric Haas (Feb 15 2017 at 18:13):
@Chris Moesel I just uploaded this barebones template to github hopefully that will help.
Igor Sirkovich (Feb 15 2017 at 18:50):
@Eric Haas , I think this is very helpful. I'm wondering if this template would work with StructureDefinition files or just with spreadsheets.
Eric Haas (Feb 15 2017 at 19:11):
It works with both. My extensions are SD.xml files not spreadsheets. The Python script might need to be updated though if you are considering using it.
Igor Sirkovich (Feb 15 2017 at 19:42):
Thank you Eric.
Chris Moesel (Feb 16 2017 at 15:48):
Thanks Eric. I ended up using your template as a starting point and after a small amount of tweaking (specific to my use case), I'm happy with the results! I am not using your Python script, as I already had a generator that properly built out the ig.json and ig.xml files for me (as well as the listing pages). I did find one bug in one of your html files, which I'll submit a PR for.
Chris Moesel (Feb 16 2017 at 15:48):
The only thing that's still a little wonky is that the "Summary" flag doesn't get properly rendered. It shows up as ∑. I think this is an issue with the IG Publisher jar, though, as it was happening with my initial IG templates too. Anyone know how to fix that (outside of a global search and replace on the generated files)?
Eric Haas (Feb 16 2017 at 18:20):
I see that too - sometimes - that is according to Grahame a browser dependent thing or something like that. I will check to see if all the files are there. and I merged the typo fix.
Grahame Grieve (Feb 16 2017 at 20:27):
Chris, it's something weird around UTF-8 and your system and your browser. as far as I know, I am coding the UTF-8 correctly, but some browsers on some systems seem incapable of recognising that.
Grahame Grieve (Feb 16 2017 at 20:27):
specifically, the xhtml header says it is UTF-8, I am using UTF-8 correctly so far as I can tell, and I am not using a BOM (I was, but some browsers on some systems simply refused to load the pages at all)
Chris Moesel (Feb 16 2017 at 20:35):
Hmmm... When I view the real FHIR doc online, my browser renders it correctly. It's only when viewing the IG that I published that it looks weird.
Eric Haas (Mar 05 2017 at 21:13):
I've updated the IG starter template to be a bit more complete and streamlined the pages adding more boilerplate content to each. Added an extension, complex extension code system and valueset using the spreadsheets and search parameter in XML.
Last updated: Apr 12 2022 at 19:14 UTC
