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

Add Release Notes per resource type and per key module (e.g. search)

    XMLWordPrintableJSON

Details

    • Icon: Change Request Change Request
    • Resolution: Persuasive with Modification
    • Icon: Medium Medium
    • FHIR Core (FHIR)
    • R5
    • FHIR Infrastructure
    • (many)
    • Hide

      We will define a file mechanism in the FHIR source that would allow capturing (and publishing) such changes for resources, operations, etc. as well as key HTML pages.

      Will propose to FMG a policy that work groups SHALL populate these files capturing major/substantive changes for artifacts and pages that are a specific FMM level and higher. (FMG to discuss with the community what maturity is reasonable/achievable.)

      This policy would go into effect after R5 is out. (We don't have the bandwidth to retroactively do this for all changes we've made as part of R5.)

      Show
      We will define a file mechanism in the FHIR source that would allow capturing (and publishing) such changes for resources, operations, etc. as well as key HTML pages. Will propose to FMG a policy that work groups SHALL populate these files capturing major/substantive changes for artifacts and pages that are a specific FMM level and higher. (FMG to discuss with the community what maturity is reasonable/achievable.) This policy would go into effect after R5 is out. (We don't have the bandwidth to retroactively do this for all changes we've made as part of R5.)
    • Isaac Vetter/Gino Canessa: 30-0-3
    • Clarification
    • Non-substantive

    Description

      For implementers to see what has changed (and ideally to give a preview of what is about to change), we should have a Release Notes page, perhaps consisting of a note per resource type (including those renamed or removed).

       

      This may optionally contain the tracker numbers and a summary rationale.

      A possible idea for a Release Notes excerpt - manually created for BDP, taking approx 30 mins and not exhaustive.

      (note: from this short experience, this content is much easier to create in pairs, where one team member summarizes and the other types the changes)

      BiologicallyDerivedProduct

      • productCategory is now an example binding, to allow any categorization FHIR-36799
      • the boundaries with Medication and Specimen were updated [FHIR-36797, FHIR-36798] 
      • .biologicalSource was renamed .biologicalSourceEvent and definition is updated
      • .storage.temperature was renamed .storageTempRequirements and is now a Range
      • .status has been renamed .productStatus and now has an example binding
      • Search parameters added: product-category, product-code, status, request, collector 
      • Added standard extension collectionProcedure on .collection 

       

      Attachments

        Activity

          People

            Unassigned Unassigned
            costateixeira Jose Costa-Teixeira
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: