Stream: cds hooks
Topic: Where to put links
Lloyd McKenzie (Aug 12 2018 at 15:36):
Is there any guidance around when to use Card.links vs. embedding links in the markdown present in Card.detail? Is the latter even permitted?
Isaac Vetter (Aug 12 2018 at 15:40):
Hey Lloyd,
1) support of markdown isn't universal yet. For those systems that do render ghf-markdown in cards, I'd expect links to work fine.
2) Note that SMART app links are identified by the Card.link.type.
Lloyd McKenzie (Aug 12 2018 at 16:13):
Yeah, I'd expect SMART Apps to always use Card.link. So there isn't specific guidance beyond Card.link is currently more widely supported?
Isaac Vetter (Aug 12 2018 at 16:23):
In the UI representation of the card, the Card.Links will be more prominently and discretely displayed. Links in markdown will be less instrusive. I'd recommend that any links in the markdown are also returned as Card.Links for two purposes:
1) to cover EHRs that don't support markdown
2) to serve as a list of references
Robert Sax (Aug 13 2018 at 11:34):
If you return them in both places, wouldn't that confuse an EMR that implemented both per spec? There is no guidance in this regard, and nothing which groups or otherwise notes that a link is also part of the detail.
Lloyd McKenzie (Aug 13 2018 at 14:15):
For now I've gone with "if you're going to put them in the detail, still put them in the links" If the user clicks on the links in both places, they just get the same content more than once.
Kevin Shekleton (Aug 15 2018 at 13:37):
Personally, I would not put a link in both the detail and the links array. Just put it in one spot.
Lloyd McKenzie (Aug 15 2018 at 14:33):
Guidance as to which one?
Kevin Shekleton (Aug 15 2018 at 15:15):
The card.links array. It's why we have a dedicated section in the API for links :-)
Lloyd McKenzie (Aug 15 2018 at 15:29):
Should there be a "SHALL NOT" or "SHOULD NOT" on links in the detail?
Kevin Shekleton (Aug 15 2018 at 16:39):
No, I don't think so. There are cases where it is fine to put links in the detail.
Kevin Shekleton (Aug 15 2018 at 16:41):
I personally think of card.links as references to the supporting evidence (eg, a list of links to research papers/studies), references to apps, etc. Links in the card.details Markdown would be inline links.
It is hard to make a requirement on what CDS Service Providers should do or even guidance since in doing so, you are telling them how to structure/word their content. Another wrinkle is that CDS Clients (aka, EHRs) will render the cards as they see fit and this will likely impact how CDS Service Providers construct the data within their cards.
Last updated: Apr 12 2022 at 19:14 UTC
