Stream: IG creation
Topic: Search parameters for a resource profile
Vassil Peytchev (Nov 19 2021 at 00:00):
In the IG's capability statement, I have listed all the search parameters that are expected in each resource. Is there a way to list them in the profiles page of each resource, as they are in the core spec:
image.png
Eric Haas (Nov 19 2021 at 05:57):
I used notes markdown files to add script generated quick start sections. These files if present are injected at the bottom of the profile pages
John Moehrke (Nov 19 2021 at 12:48):
Eric, that would be a nice improvement in the IG Publisher that all of us would benefit from.
Eric Haas (Nov 19 2021 at 14:18):
The note and intros are already a feature
John Moehrke (Nov 19 2021 at 15:08):
I expected you had come up with a transform of the CapabilityStatement encoding of the parameters that could be moved into the IG build / template so that we get a more useful rendering of CapabilityStatement... Of course one can hand write the intro or note.
Eric Haas (Nov 19 2021 at 15:31):
My scripts use all Excel/Python/Jinja2 to generate inputs ( markdown files and resources) for the ig-publisher. They are public on github and I believe Mitre has used them too and I believe integrated them with fsh. You need to generate the CapabilityStatement from some source and that is what the excel is - but you it alsoe makes the notes for the search which is highly customization to make it readable and richly documented. it would be trivial to write a script to make a simple table from the CapabilityStatement and inject as a profile note. I leave that as an exercise for the reader.
Lloyd McKenzie (Nov 19 2021 at 18:35):
I think John's point was "let's move the script into the standard template" - so that all IGs get the benefit, and most IG authors won't have to worry about script writing or maintenance.
Vassil Peytchev (Nov 19 2021 at 18:52):
The snipets generated from the StructureDefinitions, ImplementationGuide resource, CapabilityStetements, and SearchParameters should all be part of the Publisher. The Structure definitions, ImplementationGuide Resource, CapabilityStatements, SearchParameters need to have a simple offline app to help to create and edit.
I would like to start with the IG Publisher generating some snippets for search parameters on the CapabilityStatement page (I've got a hammer, and that looks like nail). If the template can actually create the "note" files as an input to the IG Publisher, that is a second part that can be done in parallel.
Is there an explanation of the sequence of processing that occurs in the IG Publisher so that it is clear at which point what is possible?
Grahame Grieve (Nov 19 2021 at 18:55):
I'm ok with generating something for search parameters but what? List what's changed? List just what's in a particular capability statement? Merge with referenced Search Parameters?
Vassil Peytchev (Nov 19 2021 at 18:57):
I see listing just what's in a particular capability statement as the most direct useful thing to do.
Eric Haas (Nov 20 2021 at 03:28):
Lloyd McKenzie said:
I think John's point was "let's move the script into the standard template" - so that all IGs get the benefit, and most IG authors won't have to worry about script writing or maintenance.
Creating a searchparameter table based on an existing CapabilityStatement is trivial and could be a useful artifact and should be discussed in Ig-publications.
But...The idea that ig-publishing is a non technical endeavor is a fallacy. External scripting is necessary and I think unavoidable unless you want to maintain complex technical artifacts manually.
Lloyd McKenzie (Nov 22 2021 at 15:33):
External scripting should NOT be necessary. Very few IGs have any external scripting, and our objective should absolutely be to eliminate it from the IG source and have it live only in templates. IG-specific scripting inevitably means variation in appearance and we should be working toward minimizing that.
Eric Haas (Nov 22 2021 at 15:42):
Our goal is to make guides better and easier to read.
Lloyd McKenzie (Nov 22 2021 at 15:46):
Absolutely. That's a good objective. And some IGs that include custom scripts to experiment and try to improve things is fine - but the objective should be to come to consensus as a community and propagate the changes into the templates so that everyone can benefit and there's consistency across all IGs.
Last updated: Apr 12 2022 at 19:14 UTC
