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

Should reference type be constrained to FHIR Ids

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • US Da Vinci HRex (FHIR)
    • 1.0.0
    • Clinical Interoperability Council
    • (NA)
    • Hide

      At this point, we won't tighten down the 'Reference' expectations in HRex because we don't know exactly what the intentions are of the leaf-level IGs. We may tighten down some of our References in the future.

      However, we will define a set of data type profiles on Reference that reflect common patterns. Specifically:

      • mandatory Reference.reference
      • mandatory Reference.identifier with mustSupport Reference.display

      We will also update our "good practice" documentation for Da Vinci (potentially to be enforced in tooling with warnings) that References should be constrained to one of these types or otherwise tightened down to clarify expectations.

      Show
      At this point, we won't tighten down the 'Reference' expectations in HRex because we don't know exactly what the intentions are of the leaf-level IGs. We may tighten down some of our References in the future. However, we will define a set of data type profiles on Reference that reflect common patterns. Specifically: mandatory Reference.reference mandatory Reference.identifier with mustSupport Reference.display We will also update our "good practice" documentation for Da Vinci (potentially to be enforced in tooling with warnings) that References should be constrained to one of these types or otherwise tightened down to clarify expectations.
    • Lloyd McKenzie/Jimmy Tcheng: 9-0-0
    • Enhancement
    • Compatible, substantive
    • Yes

    Description

      Should reference type be constrained to FHIR Ids or allow identifiers or display only or all three? 

       
      resourceType: Coverage
      id: min
      status: active
      subscriberId: '97531'
      beneficiary:
        reference: 'http://example.org/new-payer/fhir/Patient/pat1'
      payor:
        - reference: Organization/min  #<<<<<< FHIR ID

      #==========================================================

      resourceType: Coverage
      id: min
      status: active
      subscriberId: '97531'
      beneficiary:
        reference: 'http://example.org/new-payer/fhir/Patient/pat1'
      payor:
        - identifier:   #<<<<<< business identifier
          value: urn:uuid:a76d9bbf-f293-4fb7-ad4c-2851cac77162

      #==========================================================

      resourceType: Coverage
      id: min
      status: active
      subscriberId: '97531'
      beneficiary:
        reference: 'http://example.org/new-payer/fhir/Patient/pat1'
      payor:
        - display: My Organization  #<<<<<< display
       

       

      Propose guidance to use FHIR Ids and discourage use of only Identifier or display  to promote interoperability in FHIR.

      Attachments

        Activity

          People

            Unassigned Unassigned
            ehaas Eric Haas
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: