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

Ad explicit id to explain Reference

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Not Persuasive with Modification
    • Icon: Highest Highest
    • Shorthand (FHIR)
    • 3.0.0-ballot
    • FHIR Infrastructure
    • Normative
    • Language Reference
    • 3.3.6
    • Hide

      In FHIR Shorthand, the name of the Instance is the id (see Table 4 Declarations Defined by FSH) – so they generally are the same. While it's possible to override this behavior via rules, that's not the majority use case – so we risk confusing readers more by casually referring to an instance whose name is different than its id.

      To make it more clear that the id is being used when the reference is exported, we will change "assuming JaneDoe names a Patient instance" to "assuming JaneDoe is the id of a Patient instance".

      Show
      In FHIR Shorthand, the name of the Instance is the id (see Table 4 Declarations Defined by FSH ) – so they generally are the same. While it's possible to override this behavior via rules, that's not the majority use case – so we risk confusing readers more by casually referring to an instance whose name is different than its id. To make it more clear that the id is being used when the reference is exported, we will change "assuming JaneDoe names a Patient instance" to "assuming JaneDoe is the id of a Patient instance".
    • Gino Canessa / Grahame Grieve: 12-0-0
    • Clarification
    • Non-substantive

    Description

      The Reference example uses `JaneDoe`  as the name of the reference as well as the id of the resource it refers to. This may lead to the assumption that these are the same.

      Replace:

      >since JaneDoe is a Patient instance, Reference(JaneDoe) is resolved to Patient/JaneDoe

      with

      >since JaneDoe{{ is a Patient instance with id 'jane-doe', }}Reference(JaneDoe) is resolved to Patient/jane-doe

      To make it clear the name of the resource is not the id.

      Attachments

        Activity

          People

            mathompson@mitre.org MintThompson
            bvdh Bas van den Heuvel
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: