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

Extension name clashes and the dropped reverse domain name syntax

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Highest Highest
    • CDS Hooks (FHIR)
    • 1.0 [deprecated]
    • Clinical Decision Support
    • (NA)
    • Extensions
    • Hide

      I don't think that the top-level elements in the CDS Hooks defined extension element have ever been required to use reverse-domain-name-notation. It's obviously a good practice. It would be a breaking change if we made it now. 

      We will add language to the spec:

      Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, as in the examples below.

      (Update the second example to be com.example.clientConformance)

      Add the following STU Note:

      We seek implementer feedback on whether the recommendation to use namespace-based unique naming in the extension specification should be made mandatory or that we consider adding a mandatory field to extensions that indicates the source/type of the extension (as is done with FHIR).

      Show
      I don't think that the top-level elements in the CDS Hooks defined extension element have ever been required to use reverse-domain-name-notation. It's obviously a good practice. It would be a breaking change if we made it now.  We will add language to the spec: Extension structures SHOULD use a strategy for naming that ensures global uniqueness, such as reverse-domain-name notation, as in the examples below. (Update the second example to be com.example.clientConformance) Add the following STU Note: We seek implementer feedback on whether the recommendation to use namespace-based unique naming in the extension specification should be made mandatory or that we consider adding a mandatory field to extensions that indicates the source/type of the extension (as is done with FHIR).
    • Bas van den Heuvel/Ben Hamlin: 23-0-0
    • Clarification
    • Compatible, substantive

    Description

      The previous version of the spec required reverse domain name syntax to prevent name-clashes. In what way is name-clash prevented by letting go of his requirement?
      One way of addressing this is to require the reverse domain-name unless the extension has be registered with CDS-hooks in a way similar FHIR or to require a url in each extension.

      Attachments

        Activity

          People

            Unassigned Unassigned
            bvdh Bas van den Heuvel
            Bas van den Heuvel
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: