Clarify the use of CapabilityStatement.rest.searchParams

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive
    • Priority: Medium
    • FHIR Core (FHIR)
    • R5
    • FHIR Infrastructure
    • CapabilityStatement (Conformance)
    • Hide

      We will clarify that rest.searchParam is only for searches executed against the base endpoint.

      We believe that the number of search parameters that apply to all resources with no differentiation in terms of the set of capabilities available is somewhat uncommon.  Because of this, we prefer search parameters per resource to be declared on a per resource basis.  It's possible that CapabilityStatement2 might provide more efficiency here when it becomes more fully developed.

      Show
      We will clarify that rest.searchParam is only for searches executed against the base endpoint. We believe that the number of search parameters that apply to all resources with no differentiation in terms of the set of capabilities available is somewhat uncommon.  Because of this, we prefer search parameters per resource to be declared on a per resource basis.  It's possible that CapabilityStatement2 might provide more efficiency here when it becomes more fully developed.
    • Clarification
    • Non-substantive

      There are two places a server can document what search parameters are supported:

       

      • rest.resource.searchParam - this seems mostly clear.  The only confusion is how it overlaps with...
      • rest.searchParam - this is the obvious place to put non-resource related (system-level) search params, but you could also interpret this to be a place to put search params that apply to all resource types (e.g. _id).

       

      There has been discussion on chat.fhir about this:

      https://chat.fhir.org/#narrow/stream/179166-implementers/topic/CapabilityStatement.2Erest.2EsearchParams.20.20for.20common.20params

       

      It seems like the consensus is that rest.searchParam should not include any resource-level search params.  So any params that a server allows for all resource types (e.g. _id, _count, _include, _revInclude) should be duplicated in the searchParam of every instance of rest.resouce.

       

      This tracker is just asking to do an update to the description to make this guidance more clear.

       

      Alternatively, you could create a new property to hold common searchParams.  CapabilityStatement is already a pretty big document for some servers, and duplicating params in every resource just adds to the bloat.

            Assignee:
            Unassigned
            Reporter:
            Cooper Thompson
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: