Uploaded image for project: 'FHIR Specification Feedback'
  1. FHIR Specification Feedback
  2. FHIR-35348

Clarify meaning of “required search params”

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • International Patient Access (FHIR)
    • 0.1.0
    • Patient Care
    • STU
    • Finding and Retrieving Patient Information
    • Hide

      Commit crafted during call with reporter:

      > Servers SHALL support the required, and SHOULD support the recommended search parameters [documented](#search-resources); therefore clients may use any of these required search parameters to narrow the scope of the search and reduce the number of resources returned. Except for these required search parameters, servers are not obligated to support other search parameters. For this reason, clients should always check the [self link in the returned result of the search](http://hl7.org/fhir/search.html#errors) to see what parameters were processed (or consult the [CapabilityStatement](CapabilityStatement-ipa-server.html) in advance to know which parameters are supported). 

       

      Here: https://github.com/HL7/fhir-ipa/commit/929d087333e6ed090e1eccf506c41a83b789403d

      Show
      Commit crafted during call with reporter: > Servers SHALL support the required, and SHOULD support the recommended search parameters [documented] (#search-resources); therefore clients may use any of these required search parameters to narrow the scope of the search and reduce the number of resources returned. Except for these required search parameters, servers are not obligated to support other search parameters. For this reason, clients should always check the [self link in the returned result of the search] ( http://hl7.org/fhir/search.html#errors ) to see what parameters were processed (or consult the [CapabilityStatement] (CapabilityStatement-ipa-server.html) in advance to know which parameters are supported).    Here:  https://github.com/HL7/fhir-ipa/commit/929d087333e6ed090e1eccf506c41a83b789403d
    • Isaac Vetter / Rob Hausam: 7-0-0
    • Clarification
    • Non-substantive

    Description

      At http://hl7.org/fhir/uv/ipa/2022Jan/fetching.html#fetching-patient-records the following note inhibits the development of interoperable clients:
       

      Note that servers may decline to perform some searches unless particular parameters are specified.

      This note should be removed; if servers need to impose limitations, these should be the result of consensus and documented at the IPA level so clients have a shot at interoperating. This is consistent with the intention expressed in the following statement:

      but except for the few search parameters documented clearly below, servers are not obliged to support search parameters

      – i.e., if the required parameters are indeed documented “clearly” there should http://hl7.org/fhir/uv/ipa/2022Jan/fetching.html#search-resourcesnot be ambiguity about whether clients can rely on them to work consistently.

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            jmandel Josh Mandel
            Josh Mandel
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: