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

don't define new major versions of a hook except for breaking changes

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive
    • Icon: Medium Medium
    • FHIRCast (FHIR)
    • 2.0.0
    • Infrastructure & Messaging
    • Encounter close event [deprecated]
    • Hide

      We will follow the guidance.

      We will check whether previous updates violated this principle in the guidance.

      We will document the principle in ReadMe.md or similar page.

      Show
      We will follow the guidance. We will check whether previous updates violated this principle in the guidance. We will document the principle in ReadMe.md or similar page.
    • Bas van den Heuvel / Trent Nolin: 7-0-0
    • Correction
    • Non-substantive
    • Yes
    • current

    Description

      The Change Log table at the bottom of an event page documents the changes made to a hook's specification. Formatting changes aren't substantive enough to document in the change log. Only breaking changes should update the major version. 

      Please revert any new versions that document changes made to the html content of the page, but not to the hook spec and make major versions into minor for non-breaking changes.  

      E.g. https://build.fhir.org/ig/HL7/fhircast-docs/3-4-2-Encounter-close.html version 2 is non-breaking, I think (I hope). Definitely a corrected example is not a change to the hook specification that should be recorded in the change log.

      Attachments

        Activity

          People

            Unassigned Unassigned
            Isaac.Vetter Isaac Vetter
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: