search

HL7 / US-Core

FHIR R4 version of US Core IG
29 stars 28 forks source link

Clarify patient/category search for DiagnosticReport #16

Open jmandel opened 5 years ago

jmandel commented 5 years ago

http://build.fhir.org/ig/HL7/US-Core-R4/StructureDefinition-us-core-diagnosticreport-lab.html#mandatory-search-parameters uses an example with a specific category (LAB). Is this the only category for which a server needs to support search? If so, should add this to the header that currently just says ("SHALL support searching using the combination of the patient and category search parameters")

(And... what should a server do if another category is supplied by the client?)

brettmarquard commented 5 years ago

That particular profile is 'scoped' to lab only -- is this page more clear for the generic DiagnosticReport Notes profile? https://build.fhir.org/ig/HL7/US-Core-R4/StructureDefinition-us-core-diagnosticreport-note.html

jmandel commented 5 years ago

Note that the same issue comes up on other pages where the text says "by category" but the example suggests that only a single (fixed) category value needs to be supported. E.g. http://build.fhir.org/ig/HL7/US-Core-R4/StructureDefinition-us-core-careplan.html#mandatory-search-parameters

jmandel commented 5 years ago

@brettmarquard the other example you linked to says:

SHALL support searching using the combination of the patient and code search parameters:

... which I take to mean that a client can supply any code it wants, and the search should work. (So in that case, for DiagnosticReport notes, the code isn't "fixed in place" to a single value.)

brettmarquard commented 5 years ago

The mentioned profiles (us-core-careplan, and us-core-diagnosticreport-lab) have 'fixed' categories. @jmandel Should we add a note in implementation guidance to make that clear?

Healthedata1 commented 5 years ago

The quick start is generated using a script and template. And the search parameter is fixed in the formal notation. but not in the text since is describing the parameter in general. also mention in the implementation notes. Do you have a suggestion for making it clearer. WE will try to avoid manually editing these and update the script if possible.

jmandel commented 5 years ago

My suggestion would be instead of

SHALL support searching using the combination of the patient and category search parameters:

to say

SHALL support searching using the patient search parameter with a fixed category

Or something to that effect. If you want to try to address this purely within the "Implementation Notes," then state "The server SHALL support queries with a fixed category of http://hl7.org/fhir/us/core/CodeSystem/careplan-category|assess-plan and MAY support other categories."

Healthedata1 commented 5 years ago

I will need to defer this til later not trivial change to the script right now.

brettmarquard commented 5 years ago

This won't be resolved prior to STU comment period -- @Healthedata1 will review new ways to generate.