url Search Parameter type: uri vs. canonical

XMLWordPrintableJSON

    • Type: Change Request
    • Resolution: Persuasive with Modification
    • Priority: Medium
    • FHIR Core (FHIR)
    • R4
    • FHIR Infrastructure
    • (many)
    • 2.3.0.5
    • Hide

      We will add a invariant to the canonicalresource.url element (and ensure it manifests on all resources that inherit URL) that indicates that the URL SHALL NOT contain '|' or "#" (though it can contain an URL-encoded versions of these).

      We will also add a section that shows how to construct a canonical URL based on information from a metadata resource.

      Will change "Note that if a References to a canonical URL does not have a version" to "Note that if a canonical URL does not have a version"

      Show
      We will add a invariant to the canonicalresource.url element (and ensure it manifests on all resources that inherit URL) that indicates that the URL SHALL NOT contain '|' or "#" (though it can contain an URL-encoded versions of these). We will also add a section that shows how to construct a canonical URL based on information from a metadata resource. Will change "Note that if a References to a canonical URL does not have a version" to "Note that if a canonical URL does not have a version"
    • Clarification
    • Non-substantive

      This is regarding all of the types listed in Canonical URL References.

      Resources listed generally have the 

      url

      search parameter listed with a type of 

      uri

      . However, any links to them by other resources are allowed to be referenced by a canonical url (e.g., with the pipe (

      |

      ) syntax).

      For example, a 

      QuestionnaireResponse

      may (should?) link to a 

      Questionnaire

      using a canonical URL with a version. In order to search for the same 

      Questionnaire

      , the url needs to be split into parameters 

      url

      and 

      version

      . This is complicated by the fact that the pipe character is valid in URLs (as far as I can tell, general practice recommends escaping it, but I have not found an RFC that lists it as a reserved character).

      With the understanding that the 

      url

      search parameter is normative, I am not sure how to move forward (though am guessing the resolution will be clarifying text). That said, I have been asked a couple of times about how this behavior should be implemented and can note that it is done differently in various servers.

            Assignee:
            Unassigned
            Reporter:
            ginocanessa
            ginocanessa
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: