Versions and url/reference search parameters

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive with Modification
    • Priority: Medium
    • FHIR Core (FHIR)
    • STU3
    • FHIR Infrastructure
    • Normative
    • Search
    • Hide

      "Note that for uri search parameters that search the canonical urls of conformance resources (e.g. StructureDefinition.url, ValueSet.url, etc), servers SHOULD support searching by Canonical URLs, and SHOULD support automatically detecting a |[version] portion, and interpreting that portion as a search on the version element of such conformance resources."


      * Make sure that all search parameters that search on elements of type 'canonical' are using the search type "reference".
      * Explain somewhere (at the definition of canonical?) why Conformance.url itself is not a canonical.
      * Correct the sentence "_tag, _profile and _security parameters are all token types (see below)." in http://hl7.org/fhir/search.html#profile, since _profile is a canonical, thus searched by a reference search type
      * The section on Reference search parameters is already substantial and should additionally talk about using [|version] (and business versions). Since there is already narrative on _history "versioned references", this might quickly become confusing to the reader. We suggest splitting up this section in several parts: 1) text relevant to both canonicals and References, 1) text specific to references (like _history) and 2) text specific to canonicals. And be carelful not to use the phrase "version specific", so we better use "canonical with version" or "reference with _history" or somesuch.

      Show
      Clean up the narrative about canonical and version from at "uri" search parameter ( http://build.fhir.org/search.html#uri), to read: "Note that for uri search parameters that search the canonical urls of conformance resources (e.g. StructureDefinition.url, ValueSet.url, etc), servers SHOULD support searching by Canonical URLs , and SHOULD support automatically detecting a | [version] portion, and interpreting that portion as a search on the version element of such conformance resources." * Make sure that all search parameters that search on elements of type 'canonical' are using the search type "reference". * Explain somewhere (at the definition of canonical?) why Conformance.url itself is not a canonical. * Correct the sentence "_tag, _profile and _security parameters are all token types (see below)." in http://hl7.org/fhir/search.html#profile, since _profile is a canonical, thus searched by a reference search type * The section on Reference search parameters is already substantial and should additionally talk about using [|version] (and business versions). Since there is already narrative on _history "versioned references", this might quickly become confusing to the reader. We suggest splitting up this section in several parts: 1) text relevant to both canonicals and References, 1) text specific to references (like _history) and 2) text specific to canonicals. And be carelful not to use the phrase "version specific", so we better use "canonical with version" or "reference with _history" or somesuch.
    • Josh Mandel/Christiaan Knaap: 4-0-1
    • Enhancement
    • Non-substantive
    • STU3

      This issue surfaced when discussion searching on _profile with a specific version (https://chat.fhir.org/#narrow/stream/23-conformance/subject/_profile.20search.20for.20specific.20version)

      In STU3, searching on "canonicals" (which were normal uris then) was done using parameters of type "uri". However, this was changed to a new paramter type "reference".

      The documentation in R4 of the uri/reference type does not yet reflect this: the uri search param type references how to search for specific versions (in the canonical sense), using [|version], however the new reference type (which _profile would now be) does not. It does talk about versions, but this is about record versions (/_history/xxxxx in the url). We need to tell these two apart, and make sure the uri search parameter no longer mentions canonical versioning.

            Assignee:
            Unassigned
            Reporter:
            Ewout Kramer
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: