Stream: implementers
Topic: Document End-Point
Thomas Gutteridge (May 11 2018 at 01:42):
In the Document Reference documentation it refers to an option for generated documents to be persisted at the "document end-point (/Document)". I can't find any other mention of this end-point or its intended behaviour. As far as I can see there is no Document resource, only DocumentReference and bundles of type 'document'. Can anyone help?
https://www.hl7.org/fhir/documentreference.html#2.42.4.1
David Hay (May 11 2018 at 03:52):
Thinks it's an old reference in the spec: here are the current references: http://hl7.org/fhir/documents.html#bundle
Thomas Gutteridge (May 11 2018 at 04:09):
I've seen that too but nowhere does it talk about /Document.
David Hay (May 11 2018 at 05:53):
yeah - that's why I think it's an old reference in the spec. We'll see what the others say...
Lloyd McKenzie (May 11 2018 at 12:49):
That's a bad reference. Can you submit a change request please? It should refer to /Bundle
Thomas Gutteridge (May 15 2018 at 01:10):
Ah, thanks. Yeah, not being familiar with the history of the spec, I couldn't immediately understand how it would have been an 'old' reference. I will try to figure out how to submit a change request...
Thomas Gutteridge (May 15 2018 at 01:19):
A couple of other questions about that section (Generating a Document Reference):
1. If the request returns the document reference in a bundle (a search result) then I can see why if 'persist' was specified then the bundle would subsequently be available at /Bundle. Would the document reference be available individually at /DocumentReference too?
2. Where it states "Other parameters may be supplied: ", is it only referring to the parameters listed (i.e. persist)? Or is it suggesting that I might invent other parameters?
3. (Not just a couple, I lied) In the example usage:
GET [service-url]/DocumentReference/?_query=generate&uri=:url&...
Why does the uri seem to start with a colon? That would make it an invalid URI; the scheme portion can't be empty. Or have I misunderstood the syntax used?
Lloyd McKenzie (May 15 2018 at 11:36):
1. Servers have the option of generating a DocumentReference when they receive a FHIR document, but there's no requirement that they do so.
2. It's saying that systems can define additional parameters for the operation
3. That looks like a typo to me. Can you submit a change request?
Thomas Gutteridge (May 15 2018 at 21:43):
Thanks for your reply, Lloyd!
Just clarifying my first question, the generate operation is required to return a search result i.e. a bundle. So assuming the server does honour the 'persist' parameter, the generated document-reference-containing bundle should be available to be read by id at /Bundle. But what I was asking was, if that were the case then would you also expect the document reference itself to be available (without the containing bundle) to be read by its id at /DocumentReference? The answer may inform what I write in my change request for the section.
Thomas Gutteridge (May 17 2018 at 22:01):
@Lloyd McKenzie While I'm waiting for my account to be approved so I can submit a change request, perhaps you have a minute to address this last query? Thank you!
David Hay (May 18 2018 at 04:46):
I would read the 'persist' parameter to simply be the creation of the document - not the DR. DR creation would be server specific functionality (though your change request might propose another parameter that did that)
Lloyd McKenzie (May 18 2018 at 06:53):
@Thomas Gutteridge, your registration should now be approved. As David says, the operation is silent on DocumentReference, so you can't expect one to be created. That said, extending the operation with a $index boolean parameter to ask for the creation of one seems like a reasonable and useful thing to do, so feel free to submit a change request proposing that as well if you wish :)
Thomas Gutteridge (May 21 2018 at 21:58):
Ugh, I didn't realise my registration would have to be manually approved. That means that my generated password was no longer in my clipboard so I can't complete the registration process. And seemingly I can't use the forgot password option because my account is not fully activated. Not sure how to contact someone that can help me out of this whole of my own digging.
Lloyd McKenzie (May 22 2018 at 03:01):
I've manually activated you, so "forgot password" should now work for you.
Thomas Gutteridge (May 22 2018 at 05:21):
Brilliant! Thank you.
Last updated: Apr 12 2022 at 19:14 UTC
