Stream: conformance
Topic: how to represent master documentation URL?
Vadim Peretokin (Aug 25 2017 at 10:53):
We're working on building the FHIR registry - think of a search engine for approved FHIR artifacts - and one of the ideas floating about is having a "master documentation URL" as resource metadata. This would be a webpage the user could always go to to learn more about the resource.
This is a bit similar to a canonical URL except a canonical URL's job is to unique identify the conformance resource and it might or might not resolve, whereas this master documentation will always resolve and doesn't have to be unique.
I'm wondering on how to best represent it. Extension? Tag?
I expect this'll be supported by the HL7 publisher so hoping to get the input of the wider community here
@Grahame Grieve @Josh Mandel @Ewout Kramer @Lloyd McKenzie @Martijn Harthoorn
Grahame Grieve (Aug 25 2017 at 10:55):
so this specific question is about how the element will be represented in the result of a search on registry.fhir.org
Grahame Grieve (Aug 25 2017 at 10:55):
Currently, on my server, I track the original claimed location of a resource - I have it in some circumstances - and return return this as a HATEOS header or a link in the Bundle.entry.
Grahame Grieve (Aug 25 2017 at 10:56):
I favor doing the same for registry.fhir.org, but asked Vadim to ask here
Vadim Peretokin (Aug 25 2017 at 10:57):
(if you go to that lucrative link, it's very much a WIP)
Grahame Grieve (Aug 25 2017 at 10:57):
ah. oops.
Vadim Peretokin (Aug 25 2017 at 10:59):
I'm fine with a link in Bundle.entry, that'll work
Grahame Grieve (Aug 25 2017 at 11:01):
and if you do just a read, as an http header
Vadim Peretokin (Aug 25 2017 at 11:03):
Yep, sounds reasonable
Grahame Grieve (Aug 25 2017 at 11:05):
helps after I had a day to think about it ;-)
Grahame Grieve (Aug 25 2017 at 11:05):
open question is the name of the link. Let me look mine up
Josh Mandel (Aug 25 2017 at 11:15):
Do we have examples of publishers who do not intend to make their canonical URLs resolvable, but who do plan to publish information about their resources at a different URL?
Josh Mandel (Aug 25 2017 at 11:16):
I'm just trying to understand the requirement here, which sounds a bit different than what Grahame described for tracing the source of things.
Vadim Peretokin (Aug 25 2017 at 11:16):
I think that would be the easiest use-case, no? Making URLs resolvable to the right resources is a bit of work, but throwing up a page and sticking that URL in all your resources is pretty simple
Josh Mandel (Aug 25 2017 at 11:17):
Standing up a web server where everything automatically redirects to a page is pretty simple too, though.
I'm just trying to understand what audience we're catering to here. Introducing a new kind of Link might actually discourage people from using canonical URLs the way we would like them to.
Josh Mandel (Aug 25 2017 at 11:18):
"Less surface area, more focus, more consistency" being my general frame of mind.
Vadim Peretokin (Aug 25 2017 at 11:18):
That makes sense
Vadim Peretokin (Aug 25 2017 at 11:20):
The original text is:
link to original source of publication (e.g. to html) [hl7.org, ihe, simplifier, affiliates]
Martijn Harthoorn (Aug 25 2017 at 12:10):
Standing up a web server where everything automatically redirects to a page is pretty simple too, though.
That is a good point. We didn't think of that in this context, but Simplifier already does that.
Martijn Harthoorn (Aug 25 2017 at 12:11):
But the question is also, how people are going to provide that information.
Martijn Harthoorn (Aug 25 2017 at 12:11):
... when they upload a resource to a registry.
Martijn Harthoorn (Aug 25 2017 at 12:12):
Do they add that manually afterwards in a form? Or (better) - do they add it to the resource (tag, extension) - or also a HTTP header?
Martijn Harthoorn (Aug 25 2017 at 12:12):
(in the post/put)
Grahame Grieve (Aug 25 2017 at 15:10):
typically, the problem for people is that putting up a web server is not simple
Grahame Grieve (Aug 25 2017 at 15:10):
the other thing is that lots of resources don't have a canonical URL
Vadim Peretokin (Aug 29 2017 at 06:05):
@Martijn Harthoorn
Currently, on my server, I track the original claimed location of a resource - I have it in some circumstances - and return return this as a HATEOS header or a link in the Bundle.entry.
That's what @Grahame Grieve proposed
Last updated: Apr 12 2022 at 19:14 UTC
