Stream: bulk data
Topic: Documenting Bulk Access, WIP
Josh Mandel (Feb 22 2018 at 19:58):
Thinking about next steps @Grahame Grieve as this specification is coming together and will change relatively quickly, it's been confusing to have this content hosted in the FHIR build and also at https://github.com/smart-on-fhir/fhir-bulk-data-docs . (We've found the standalone repo helpful for managing discrete issues and previewing changes early on, so I'd prefer not to try to converge on the main FHIR build at this stage.)
The primary concern is that when we publish R4, we risk having async API docs that become stale very quickly, but nobody will have a good way to tell for 18+ months. I want to make sure we avoid this confusion.
A couple of ideas that could help (but I'm very open to others!)
1. We could hold the Bulk data operations back from the main FHIR build until we feel like they're a bit more stable
2. We could add a note to the http.html#async in the main FHIR build, indicating that this is early-stage work with detailed conversations happening in zulip + github, with a links to these
Grahame Grieve (Feb 22 2018 at 22:15):
so I moved it out into async.html and marked it as draft
Grahame Grieve (Feb 22 2018 at 22:15):
good idea to link to ongoing work
Josh Mandel (Feb 22 2018 at 22:40):
Cool! For warning + link to ongoing work, should we link directly to resources or create a "landing page" on the HL7 wiki so we can adjust the pointers later as needed?
Grahame Grieve (Feb 22 2018 at 23:19):
well, how stable are the resources? we can do both, of course - link to stable resource and a landing page on the wiki
Josh Mandel (Feb 22 2018 at 23:23):
I think the smart repo should be pretty stable. @Dan Gottlieb do you want to propose a block of text/links for this notice?
Grahame Grieve (Feb 22 2018 at 23:25):
so should the link to this chat
Dan Gottlieb (Feb 23 2018 at 14:24):
@Josh Mandel @Grahame Grieve How about something like this for the notice?
The FHIR Asynchronous API and the $export Operation are under active development.
- Visit https://github.com/smart-on-fhir/fhir-bulk-data-docs for the most recent draft documentation and open issues
- Participate in design discussions at https://chat.fhir.org/#narrow/stream/bulk.20data
Josh Mandel (Feb 23 2018 at 15:04):
Looks good to me!
Grahame Grieve (Feb 23 2018 at 18:35):
added
Christiaan Knaap (Mar 06 2018 at 13:10):
I also like a separate name ($export is fine with me). It's easier and cleaner to distinguish from the existing $everything in code and in authorization.
Last updated: Apr 12 2022 at 19:14 UTC
