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

Confusing text around canonical syntaxes (pipe vs. version parameter)

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R4
    • FHIR Infrastructure
    • References
    • 2.3.0.5
    • Hide

      Will re-word as proposed

      Show
      Will re-word as proposed
    • Rick Geimer / Gino Canessa: 13-0-2
    • Clarification
    • Non-substantive
    • R5

    Description

      The current text:


      References of type canonical may include a version, in order be precise about which version of the resource is being referred to. To do this, append the version to the reference with a '|' like this:

      <valueSet value="http://hl7.org/fhir/ValueSet/my-valueset|0.8"/>

      This is a version specific reference to a value set. Note that this refers to the ValueSet.version not the ValueSet.meta.versionId. Searching for this on a FHIR server would look like this:

      GET fhir/ValueSet?url=http://hl7.org/fhir/ValueSet/my-valueset&version=0.8

      Is quite confusing. My reading would indicate that the second example matches the ValueSet.meta.versionId, which is incorrect.

      Recommend changing to:


      References of type canonical may include a version, in order be precise about which version of the resource is being referred to. To do this, append the version to the reference with a '|' like this:

      <valueSet value="http://hl7.org/fhir/ValueSet/my-valueset|0.8"/>

      Resolving the pipe ('|') syntax (above) is done in the same way as using a GET with the version parameter:

      GET fhir/ValueSet?url=http://hl7.org/fhir/ValueSet/my-valueset&version=0.8

      Both of these examples are references to a specific version of value set. Note that this refers to the ValueSet.version not the ValueSet.meta.versionId.


      Attachments

        Activity

          People

            GrahameGrieve Grahame Grieve
            ginocanessa Gino Canessa
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: