FHIR Chat · implementation guide with element details link · implementers

Stream: implementers

Topic: implementation guide with element details link

Sean McIlvenna (Sep 28 2017 at 20:30):

@Meenaxi Gosai and I would like to know how we can to get the ig publisher to create a link on an element in the structure definition that scrolls the user to the bottom of the page and has additional details. This is done in the core FHIR spec/output, we're just not sure how to get it to work with a custom implementation guide that has custom structure definitions.

Sean McIlvenna (Sep 28 2017 at 20:31):

I.E. Trying to get a link on "Composition.section" element, that brings the user to more information than just the label, cardinality, type.

Eric Haas (Sep 28 2017 at 22:11):

where in the core is this done?

Eric Haas (Sep 28 2017 at 22:14):

I've done using Description element since is markdown but never seen it from the content itself

Lloyd McKenzie (Sep 29 2017 at 02:24):

Definition and Usage Notes support markdown, so in theory you should be able to link to a local anchor. The problem is that both of them will render on the data dictionary page and the place where the additional text would be would be on the main page. But you should be able to jump them to there.

Sean McIlvenna (Oct 02 2017 at 15:56):

pasted-image.png
Where does this link come from? The "label" field?

Sean McIlvenna (Oct 02 2017 at 15:57):

@Lloyd McKenzie , Am I understanding that you are recommending a link be placed (using markdown) in the "alias" field, with an anchor in the "definition" field?

Eric Haas (Oct 02 2017 at 15:57):

that is a link to the definitions table ( tab at top )

Eric Haas (Oct 02 2017 at 15:58):

Does your IG have this link enabled?

Sean McIlvenna (Oct 02 2017 at 15:58):

Ok. is that coming from the jekyll templates, then? I don't think so... I think this table is automatically generated

Sean McIlvenna (Oct 02 2017 at 15:58):

Hmmmm... not sure about that (re: the ig)

Eric Haas (Oct 02 2017 at 15:58):

it is a generated artifact. to link to it need to define in ig.json

Sean McIlvenna (Oct 02 2017 at 15:59):

oh, the control file...

Sean McIlvenna (Oct 02 2017 at 15:59):

hmmm

Sean McIlvenna (Oct 02 2017 at 15:59):

gonna look up the syntax/structure of the control file. cause I'm not sure where that would be configured

Eric Haas (Oct 02 2017 at 16:00):

see tempalate IG for how I do it: https://github.com/Healthedata1/IG-Template

Eric Haas (Oct 02 2017 at 16:01):

changed link to the repo...

Sean McIlvenna (Oct 02 2017 at 16:05):

So which part of the control file indicates that links should be generated for each of the elements?

Eric Haas (Oct 02 2017 at 16:05):

define here:

       "StructureDefinition":{  
           "template-mappings":"sd-mappings.html",
           "template-base":"sd.html",
           "template-defns":"sd-definitions.html"

and for each SD - I like to explicitly define everything for each SD:

     "StructureDefinition/template-complex":{  
          "base":"StructureDefinition-template-complex.html",
         "defns":"StructureDefinition-template-complex-definitions.html"

Sean McIlvenna (Oct 02 2017 at 16:05):

ahhh! the defns file!

Sean McIlvenna (Oct 02 2017 at 16:06):

so a link is created if the defns is explicitly stated?

Sean McIlvenna (Oct 02 2017 at 16:06):

" defines the base that provides the data dictionary with anchors for each data element in a structure definition."

Sean McIlvenna (Oct 02 2017 at 16:06):

I see now

Eric Haas (Oct 02 2017 at 16:07):

that is not the same thing as your original post. a link from the content tree to some notes on the same page though - I don't know how to do that since the content tree is a generated artifact

Eric Haas (Oct 02 2017 at 16:10):

and I not sure you need to explicit define the defns; page for each SD. I just did it since I try to list everything in ig.json. I found that is more reliable results that way than being lazy and letting it default to something

Sean McIlvenna (Oct 02 2017 at 16:24):

at this point.. I'm just trying to figure out how the link is generated on the element name in the table.

Grahame Grieve (Oct 03 2017 at 02:30):

yes the -defns link tells the IG publisher where you decided to put the generated definitions, so it can link to it. If you define that, then your links should be generated

Last updated: Apr 12 2022 at 19:14 UTC