search

LinuxForHealth / FHIR

The LinuxForHealth FHIR® Server and related projects
https://linuxforhealth.github.io/FHIR
Apache License 2.0
329 stars 157 forks source link

Bulk Data 2.0.0: Support includeAssociatedData (Provenance) #3086

Open prb112 opened 2 years ago

prb112 commented 2 years ago

Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

  1. Add the valueset http://hl7.org/fhir/uv/bulkdata/ValueSet-include-associated-data.html and codesystem http://hl7.org/fhir/uv/bulkdata/CodeSystem-include-associated-data.html
  2. Add configuration to turn on feature or disable feature (add warning)
  3. Verify the value on query is correct
  4. Covert to a PackageProvider
Experimental - support is optional for a server and a client.

String of comma-delimited values.

When provided, a server with support for the parameter and requested values SHALL return or omit a pre-defined set of FHIR resources associated with the request.

A server that is unable to support the requested includeAssociatedData values SHOULD return an error and a FHIR OperationOutcome resource so the client can re-submit a request that omits those values (for example, if a server does not retain provenance data). When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error.

If multiple conflicting values are included, the server SHALL apply the least restrictive value (value that will return the largest dataset).

Note we need to add a ValueSet.

IN | includeAssociatedData | 0..* | code | http://hl7.org/fhir/uv/bulkdata/ValueSet/include-associated-data (Extensible) |

Describe the solution you'd like A clear and concise description of what you want to happen.

Describe alternatives you've considered A clear and concise description of any alternative solutions or features you've considered.

Acceptance Criteria

  1. GIVEN [a precondition] AND [another precondition] WHEN [test step] AND [test step] THEN [verification step] AND [verification step]

Additional context Add any other context or screenshots about the feature request here.

lmsurpre commented 2 years ago

this field is labeled as optional, experimental and we have no one asking for it at this time

will create new issue for this part of it:

A server that is unable to support the requested includeAssociatedData values SHOULD return an error and FHIR OperationOutcome resource so the client can re-submit a request that omits those values (for example, if a server does not retain provenance data). When a Prefer: handling=lenient header is included in the request, the server MAY process the request instead of returning an error.