Stream: bulk data
Topic: OpenAPI file
Richard Braman (FLY.HEALTH) (Apr 21 2021 at 07:31):
I cant seem to find the openapi3 file for Bulk data IG in git hub or on the web. Is there one ?
Richard Braman (FLY.HEALTH) (May 03 2021 at 21:54):
Richard Braman (FLY.HEALTH) said:
I cant seem to find the openapi3 file for Bulk data IG in git hub or on the web. Is there one ?
I finally found one deep in the IG package, but it is incomplete. I made one that is adapted from BCDA, which supports group and patient export including job status and download. I'll work on adding a system level export. Can we add this to the IG once its done?
Josh Mandel (May 03 2021 at 21:56):
In general we haven't done IG-specific work to publish OpenAPI files, since requirements and expectations differ from system to system. In no case that I'm aware of is an OpenAPI file manually maintained and updated as part of a FHIR IG release. To the extent that the IG Publisher creates useful OpenAPI outputs, those of course will be bundled in the Bulk Data IG (just as they are bundled in any other IG).
Josh Mandel (May 03 2021 at 22:06):
Would be great to share anything you create here though; it may be useful for others, and it'll help us to better understand requirements!
Richard Braman (FLY.HEALTH) (May 05 2021 at 17:35):
Most of the other IGs distribute the full-ig.zip as a download . I cant seem to find that for Bulk Data. Usually in that package there is an openapi3 file. Is this something publisher creates for bulk fhir? If so, you can you supply a URL? It should be https://hl7.org/fhir/uv/bulkdata/downloads.html for it to be in line with USCore, Carin, Davnci, etc.
Richard Braman (FLY.HEALTH) (May 05 2021 at 17:37):
The openapi files are useful for automating the creation of test suites, postman collections, and api proxies.
Richard Braman (FLY.HEALTH) (May 05 2021 at 17:39):
I will post my draft here by COB.
Josh Mandel (May 05 2021 at 18:06):
May be an issue of the age of the 1.0 release; does http://hl7.org/fhir/uv/bulkdata/2021May/downloads.html help, for the current ballot?
Richard Braman (FLY.HEALTH) (May 06 2021 at 02:16):
Josh Mandel said:
May be an issue of the age of the 1.0 release; does http://hl7.org/fhir/uv/bulkdata/2021May/downloads.html help, for the current ballot?
Yes , it does Help. I now have the IG Metadata. The OpenAPI file in the balloted version is still the manually generated one. I have convinced myself that only SUSHI published IGs get proper OpenAPI 3 files created.
Richard Braman (FLY.HEALTH) (May 10 2021 at 16:07):
bulk-data.openapi.yml Here ya go. This is the OpenAPI spec for the FHIRFLY bulk data server.
Yunwei Wang (May 10 2021 at 18:32):
@Richard Braman (FLY.HEALTH) Did you create it manually?
Richard Braman (FLY.HEALTH) (May 10 2021 at 20:10):
I partially created it. It was somewhat in place when I was working on CMS BCDA and then we worked on it a bit more and they released it. It was not created manually but rather from annotations in the code (API methods).
Last updated: Apr 12 2022 at 19:14 UTC
