Stream: committers
Topic: Multi-cardinality "return" parameter
Bryn Rhodes (Oct 15 2020 at 20:39):
When an Operation has a return parameter with 0..*
, it's clear enough that if the actual result returns more than one, it needs to use a Parameters, and that implies that it should always return with a Parameters if the return parameter is 0..*
, but I don't think the language here in Operations says that clearly:
http://hl7.org/fhir/operations.html#response
"If there is only one out parameter, which is a Resource with the parameter name "return" then the parameter format is not used, and the response is simply the resource itself. "
Is this worth clarifying, or is it obvious enough already?
Grahame Grieve (Oct 15 2020 at 21:18):
I guess it could be even more explicit
Bryn Rhodes (Oct 15 2020 at 21:23):
Just wondering out loud here, but the whole reason we defined a multi-cardinality out parameter was to support streaming, is it possible to go one further and say something like, "operations that return a single out parameter with multiple cardinality use the searchset bundle approach, just like any other read/search interaction would?"
Josh Mandel (Oct 15 2020 at 22:14):
(You would also need the restriction that the single out parameter with multiple cardinality is a resource not a datatype )
Gino Canessa (Oct 15 2020 at 23:49):
Note from the current docs:
If the response is a Bundle, the correct Bundle.type is 'collection', unless it has search semantics, such as matching resource counts, and page links (next etc).
Last updated: Apr 12 2022 at 19:14 UTC