Stream: bulk data
Topic: Capability Statement
Michelle Vondercrone (Jul 20 2020 at 13:42):
Have a question about how the Bulk Data Capability Statement is to be exposed? Is it via the well know URL, via a metadata endpoint, or both?
All I'm seeing in the bulk data specification is the following, but no example:
To declare conformance with this IG, a server should include the following URL in its own CapabilityStatement.instantiates: http://www.hl7.org/fhir/bulk-data/CapabilityStatement-bulk-data.html
Josh Mandel (Jul 20 2020 at 13:59):
There is a slight error in that excerpt which we are doing in an upcoming technical correction. (".html" is not part of the canonical URL). but the primary Discovery mechanism we define in the guide is that a server should include this canonical URL in its own capability statement as part of the "instantiates" array.
Yunwei Wang (Jul 20 2020 at 14:00):
wellknow url is used to expose Bulk Data Server's OAuth/SMART information. The same information could also be exposed as part of CapabilityStatement.
Josh Mandel (Jul 20 2020 at 14:00):
that's how you say you support the IG overall. In general you would also list the specific operations that you support in your capability statement as well. For completeness I should also mention that there are a set of authorization related properties that you would discover at .well-known/smart-configuration as well, for a server supporting smart backend services.
Josh Mandel (Jul 20 2020 at 14:02):
(We do not have a way to discover all of those authorization details in the capability statement. )
Michelle Vondercrone (Jul 20 2020 at 17:55):
Yes, I saw the need for a technical correction in a previous post.
More questions (sorry)
1) it says to just include the URL (http://hl7.org/fhir/uv/bulkdata/CapabilityStatement/bulk-data) as the value in the instantiates element in its own capability statement - you mean the R4 or Provider Access capability statement? We have 2 different ones since they point to different authorize and manage endpoints. Is this just an extension of what we are already supporting and bulk data doesn't have its own standalone capability statement that can be called?
2) but the above is not probably totally correct because when i go here (http://hl7.org/fhir/uv/bulkdata/CapabilityStatement-bulk-data.json.html) I see example JSON for the bulk data capability statement. So this is the capability statement that can be called? This is just an example. Where is the structure of the metadata response defined? @Josh Mandel @Dan Gottlieb
Robert Scanlon (Jul 20 2020 at 19:03):
Include that in the CapabilityStatement resource returned from [fhir base url]/metadata (technically called the capabilities interaction, which is a requirement of all FHIR-conformant APIs).
Robert Scanlon (Jul 20 2020 at 19:23):
This is a little confusing because the Capability Statement you linked to (http://hl7.org/fhir/uv/bulkdata/CapabilityStatement-bulk-data.json.html) is a "requirements" CapabilityStatement, which is different than what a deployed API would return from the capabilities interaction. That returns an "instance" kind of CapabilityStatement. So it isn't an 'example' of something your server would send to clients, but rather a description of the requirements of a bulk data server (note the 'SHOULD' expectation codes in there).
Last updated: Apr 12 2022 at 19:14 UTC
