This wiki has undergone a migration to Confluence found Here
Difference between revisions of "FHIR Ballot Prep"
Jump to navigation
Jump to search
| (37 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
| − | This page lists the tasks to be completed by work groups in preparation for the R4 release of the FHIR core specification. The timelines for implementation guide publication and balloting may differ. Implementation Guides may choose to either publish in sync with the core specification (and actively manage dependencies as underlying resources and profiles are updated) or may choose to ballot later, once the FHIR specification is finalized. (The disadvantage of the latter approach is that changes to the core specification identified as part of implementation guide revision won't be able to be applied until a subsequent release.) | + | A calendar has not yet been established for the FHIR R5 cycle. General ballot timelines for implementation guides can be found on the [[https://confluence.hl7.org/display/HL7/HL7+Calendars HL7 confluence page]] |
| + | |||
| + | <!--This page lists the tasks to be completed by work groups in preparation for the R4 release of the FHIR core specification. The timelines for implementation guide publication and balloting may differ. Implementation Guides may choose to either publish in sync with the core specification (and actively manage dependencies as underlying resources and profiles are updated) or may choose to ballot later, once the FHIR specification is finalized. (The disadvantage of the latter approach is that changes to the core specification identified as part of implementation guide revision won't be able to be applied until a subsequent release.) | ||
| + | |||
| + | [http://wiki.hl7.org/index.php?title=Category:FHIR_IG_Proposal Here] is a link for Implementation Guide proposals | ||
Notes: | Notes: | ||
| − | * R4 is the first FHIR publication that | + | * R4 is the first FHIR publication that will contain Normative content. For those who aren't familiar with HL7 processes, Normative means that, once the specification passes, we will no longer make breaking changes to the specification from that point forward - ever. The rules for change in FHIR for normative content are described [[http://hl7.org/fhir/versions.html#b-compat here]]. |
* R4 is also the first time we're expecting to have multiple "ballots" for FHIR core content. This means that there will be '''one''' FHIR specification hosted on the web. However, each page in the specification will identify both what level it's being balloted at (not balloted, draft, STU or normative) as well as which ballot it's part of. Multiple ballots are necessary to allow content to proceeed by different paths - balloting at different levels requires separate ballots and if there's a need to allow some content to be demoted to a lower level while other content remains on the normative path, that content needs to be packaged separately. | * R4 is also the first time we're expecting to have multiple "ballots" for FHIR core content. This means that there will be '''one''' FHIR specification hosted on the web. However, each page in the specification will identify both what level it's being balloted at (not balloted, draft, STU or normative) as well as which ballot it's part of. Multiple ballots are necessary to allow content to proceeed by different paths - balloting at different levels requires separate ballots and if there's a need to allow some content to be demoted to a lower level while other content remains on the normative path, that content needs to be packaged separately. | ||
| Line 8: | Line 12: | ||
For this WGM: | For this WGM: | ||
* Discuss the candidate normative artifacts and evaluate whether your WG/organization would like to see the list changed. The current candidate list is: | * Discuss the candidate normative artifacts and evaluate whether your WG/organization would like to see the list changed. The current candidate list is: | ||
| − | **Framework, XML, JSON, RESTful API, Search | + | **Framework, XML, JSON, RESTful API, Search, Data types |
**CodeSystem, ValueSet, ConceptMap. (But not all operations on those resources) | **CodeSystem, ValueSet, ConceptMap. (But not all operations on those resources) | ||
**Bundle, OperationOutcome, Parameters, StructureDefinition, SearchParameter, CapabilityStatement, OperationDefinition | **Bundle, OperationOutcome, Parameters, StructureDefinition, SearchParameter, CapabilityStatement, OperationDefinition | ||
**Patient, Observation | **Patient, Observation | ||
* Look at the revised workflow patterns ([[http://hl7.org/fhir/definition.html Definition]], [[http://hl7.org/fhir/request.html Request]], [[http://hl7.org/fhir/event.html Event]]) and consider how to apply them to your artifacts | * Look at the revised workflow patterns ([[http://hl7.org/fhir/definition.html Definition]], [[http://hl7.org/fhir/request.html Request]], [[http://hl7.org/fhir/event.html Event]]) and consider how to apply them to your artifacts | ||
| − | * Look at the new quality criteria - for resources and other artifacts - and plan for how you'll work at meeting them | + | * Look at the [[FHIR_Conformance_QA_Criteria|new quality criteria]] - for resources and other artifacts - and plan for how you'll work at meeting them |
* Identify what your target FMM levels are for the artifacts you control | * Identify what your target FMM levels are for the artifacts you control | ||
* Identify any new resources or IGs you want in R4 | * Identify any new resources or IGs you want in R4 | ||
| Line 27: | Line 31: | ||
* all of the above plus: | * all of the above plus: | ||
** Get all content "rock solid" with both WG and community in agreement that content is ready to be set in stone | ** Get all content "rock solid" with both WG and community in agreement that content is ready to be set in stone | ||
| + | |||
==Ballot schedule== | ==Ballot schedule== | ||
===January 2018 Cycle=== | ===January 2018 Cycle=== | ||
| + | |||
'''Single FHIR Core 'For Comment' Ballot, possible IG R3-based STU ballots, possible IG R4-based 'For Comment' ballots''' | '''Single FHIR Core 'For Comment' Ballot, possible IG R3-based STU ballots, possible IG R4-based 'For Comment' ballots''' | ||
| − | The purpose of this ballot is to provide an early review of candidate normative content to ensure quality is in place and identify as many substantive issues as possible in advance of the normative ballot. It also provides a QA point for other resources as we prepare for the May STU ballot. Tracker items received as a result of this ballot don't require formal resolution or change application prior to the opening of the following ballot, though work groups should do their best - prioritizing normative - to resolve what they can. Unresolved | + | The purpose of this ballot is to provide an early review of candidate normative content to ensure quality is in place and identify as many substantive issues as possible in advance of the normative ballot. It also provides a QA point for other resources as we prepare for the May STU ballot. Tracker items received as a result of this ballot don't require formal resolution or change application prior to the opening of the following ballot, though work groups should do their best - prioritizing normative - to resolve what they can. Unresolved comments will carry forward but will not carry ballot weight unless someone references them in a subsequent ballot. |
*2017-10-18 - Deadline for connectathon proposals to FMG | *2017-10-18 - Deadline for connectathon proposals to FMG | ||
*2017-10-25 - Work groups inform the FMG of any implementation guides they'd like to ballot in Dec. cycle (strong preference to not ballot against R3 at this time unless essential for regulatory or similar reasons) | *2017-10-25 - Work groups inform the FMG of any implementation guides they'd like to ballot in Dec. cycle (strong preference to not ballot against R3 at this time unless essential for regulatory or similar reasons) | ||
| − | + | *2017-10-28 - Initial vocabulary harmonization proposals are due | |
| + | *2017-11-12 - Deadline for Notice of Intent to Ballot if balloting implementation guides | ||
*2017-11-15 - Work groups identify any changes (additions or removals) to the candidate list of Normative content | *2017-11-15 - Work groups identify any changes (additions or removals) to the candidate list of Normative content | ||
| + | *2017-11-25 - Final vocabulary harmonization proposals are due | ||
| + | *2017-11-28 - Harmonization for the upcoming ballot cycle | ||
| + | *2017-12-03 - WG's have completed reconciliation for previous IG ballots if re-balloting an IG | ||
*2017-12-10 - Substantive change freeze for core. | *2017-12-10 - Substantive change freeze for core. | ||
**Normative candidates SHOULD have QA spreadsheet filled in and pass all QA. Related change logs should be clear. Should be no "Deferred" substantive changes | **Normative candidates SHOULD have QA spreadsheet filled in and pass all QA. Related change logs should be clear. Should be no "Deferred" substantive changes | ||
| Line 44: | Line 54: | ||
*2017-12-17 - Final freeze (including IGs) | *2017-12-17 - Final freeze (including IGs) | ||
*2017-12-22 - Ballot opens | *2017-12-22 - Ballot opens | ||
| + | *2018-01-10 - Final date for WG-approved resource, profile & IG proposals intended to be FMM 1 or higher in R4 | ||
*2018-01-22 - Ballot closes | *2018-01-22 - Ballot closes | ||
*2018-01-27 - 2018-02-02: Jan WGM (New Orleans) | *2018-01-27 - 2018-02-02: Jan WGM (New Orleans) | ||
| Line 52: | Line 63: | ||
This will be the "primary" ballot for R4. The normative content will be broken up into multiple packages (likely 3) to allow some packages to pass while others are dropped to 'STU' if necessary. FMM levels will be locked prior to this ballot and content here will require reconciliation. (Balloters might reference previously submitted tracker items, including items submitted as part of the For Comment ballot.) | This will be the "primary" ballot for R4. The normative content will be broken up into multiple packages (likely 3) to allow some packages to pass while others are dropped to 'STU' if necessary. FMM levels will be locked prior to this ballot and content here will require reconciliation. (Balloters might reference previously submitted tracker items, including items submitted as part of the For Comment ballot.) | ||
| + | *2018-02-14 - Last date to inform FMG of intention to ballot IGs as part of May ballot. | ||
*2018-02-21 - Deadline for connectathon proposals to FMG; Deadline for resource and IG proposals that are candidates for STU in R4 | *2018-02-21 - Deadline for connectathon proposals to FMG; Deadline for resource and IG proposals that are candidates for STU in R4 | ||
| − | *2018-02- | + | *2018-02-25 - NIB for any IG required (and core) |
*2018-03-04 - FHIR Core substantive change freeze. IGs can still make changes. Work groups must inform product director what resources are to be treated as "draft" for this ballot (and for R4). | *2018-03-04 - FHIR Core substantive change freeze. IGs can still make changes. Work groups must inform product director what resources are to be treated as "draft" for this ballot (and for R4). | ||
*2018-03-11 - FHIR Core content total freeze. Normative candidates SHALL have QA spreadsheet filled in and pass all QA. Normative content should have tracker items cleared and no outstanding deferred QA tracker items. QA period opens for core and IG processes | *2018-03-11 - FHIR Core content total freeze. Normative candidates SHALL have QA spreadsheet filled in and pass all QA. Normative content should have tracker items cleared and no outstanding deferred QA tracker items. QA period opens for core and IG processes | ||
** Note: After this date, substantive changes can only be made to artifacts and pages marked "Normative" if they are in response to a ballot comment or the artifact has been dropped from its normative package back to STU status | ** Note: After this date, substantive changes can only be made to artifacts and pages marked "Normative" if they are in response to a ballot comment or the artifact has been dropped from its normative package back to STU status | ||
*2018-03-25 - QA changes may be applied | *2018-03-25 - QA changes may be applied | ||
| − | *2018-04-01 - Final content freeze - no changes except with permission of product director | + | *2018-04-01 - Final content freeze - no changes except with permission of product director (both core and all IGs) |
*2018-04-06 - Ballot opens | *2018-04-06 - Ballot opens | ||
*2018-05-07 - Ballot closes | *2018-05-07 - Ballot closes | ||
| Line 70: | Line 82: | ||
*2018-06-06: Deadline for connectathon proposals to FMG | *2018-06-06: Deadline for connectathon proposals to FMG | ||
*2018-07-01: Work groups notify the FMG whether they need to reballot normative packages (due to substantive change), STU resources (due to significant refactoring) or IGs during the Sept. cycle | *2018-07-01: Work groups notify the FMG whether they need to reballot normative packages (due to substantive change), STU resources (due to significant refactoring) or IGs during the Sept. cycle | ||
| + | ** Implementation Guide proposals due to FMG for new FHIR IGs | ||
| + | ** Scope changes to what artifacts are present in the normative candidate releases is due to FMG | ||
| + | *2018-07-15: Notice of Intent for ballot due | ||
| + | *2018-08-05: Reconciliation packages must be posted by this date at the absolute latest | ||
*2018-08-10: All substantive reconciliation applied. FHIR Core is frozen, limited QA process for content subject to ballot only | *2018-08-10: All substantive reconciliation applied. FHIR Core is frozen, limited QA process for content subject to ballot only | ||
*2018-08-17: Pre-ballot (and connectathon) content freeze. Publication process begins, including ensuring that content is appropriately flagged for ballot status and there are no last minute QA issues | *2018-08-17: Pre-ballot (and connectathon) content freeze. Publication process begins, including ensuring that content is appropriately flagged for ballot status and there are no last minute QA issues | ||
| − | *2018-08-24: | + | *2018-08-24: Ballot opens |
*2018-09-24: Ballot closes and initial triage occurs. Note: No substantive changes allowed for normative candidates unless they drop to STU. | *2018-09-24: Ballot closes and initial triage occurs. Note: No substantive changes allowed for normative candidates unless they drop to STU. | ||
===R4 Publication=== | ===R4 Publication=== | ||
| − | + | These are the publication deadlines leading to the publication of the FHIR R4 core specification and any IGs that plan to *publish* on the same cycle. | |
| − | *2018-09-29 | + | *2018-09-29 - 10-05: October WGM (Baltimore). |
| − | *2018-10- | + | *2018-10-06: Notification of Ballot opens for "final" targeted R4 normative ballots |
| − | *2018-11-01: Substantive content freeze for core R4 publication including all substantive QA changes. Decision based on vote results and withdrawals about which normative packages to drop to STU. | + | *2018-10-12: Final reconciliation packages posted for Normative Sept. ballots |
| + | * Working on R3/R4 conversions (see [[Progress on FHIR R3/R4 conversions]]) | ||
| + | ** Changes will be auto-deferred after this date | ||
| + | *2018-10-31: Final reconciliation package posted for STU ballot | ||
| + | *2018-11-01: Substantive content freeze for core R4 publication including all substantive QA changes. Decision based on vote results and withdrawals about which normative packages to drop to STU. Profiles publishing as part of R4 and implementation guides aiming to publish simultaneously with R4 may continue to make substantive changes. | ||
| + | *2018-11-06: Targeted R4 normative ballot opens | ||
*2018-11-11: Final content freeze for R4 publication and start of QA period. No changes permitted for FHIR Core without product director permissions. Implementation Guides may update based on their QA processes | *2018-11-11: Final content freeze for R4 publication and start of QA period. No changes permitted for FHIR Core without product director permissions. Implementation Guides may update based on their QA processes | ||
*2018-11-25: QA period closes, QA change application begins | *2018-11-25: QA period closes, QA change application begins | ||
*2018-12-02: FHIR core and FHIR IGs are all locked. No further changes without product director permission | *2018-12-02: FHIR core and FHIR IGs are all locked. No further changes without product director permission | ||
| − | **Finalization of FMM levels, final internal publication clean-up, publication process | + | **Finalization of FMM levels, final internal publication clean-up, publication process |
| − | * | + | *2018-12-06: Targeted FHIR core ballot closes |
| + | *2018-12-07: One-time meeting to reconcile any ballot comments - all out of scope comments will be found Not Related | ||
| + | *2018-12-08: Recirculation ballot opens? | ||
| + | *2018-12-10: Seek approval for publication from TSC (possibly pending recirculation) | ||
| + | *2018-12-22: Recirculation ballot closes? | ||
| + | *before 2018-12-31: Publication of R4 | ||
The world rejoices, Grahame sleeps | The world rejoices, Grahame sleeps | ||
| + | |||
| + | ===IGs published with R4=== | ||
| + | *2018-11-18: Content is final, work group performs and applies QA | ||
| + | *2018-12-02: IG is locked | ||
| + | ** qa.html contains no errors or warnings (or Grahame has pre-approved all remaining errors/warnings as insignificant | ||
| + | ** WG submits publication request and notifies fmgcontact@hl7.org of their desire to publish with R4 | ||
| + | *2018-12-05: FMG votes on whether to publish the IG after reviewing IG and QA page | ||
| + | *2018-12-10: TSC votes on whether to publish the IG (at the same time they vote on R4) | ||
| + | |||
| + | Sometime before Dec. 31, depending on FHIR Core recirculation requirements, IG is published alongside R4 spec | ||
| + | |||
| + | ===Jan 2019 ballot cycle for FHIR IGs=== | ||
| + | NOTE: There will be no deadline extensions for this cycle. If you miss a deadline, your content will not appear in the January ballot and will have to wait for the May cycle. | ||
| + | |||
| + | *2018-10-17 - [[:Category:FHIR_IG_Proposal|IG proposals]] due to the FHIR Management Group. (Earlier is better) | ||
| + | *2018-10-28 - NIBs due, IG must be publishing on the CI build and "functionally complete" | ||
| + | ** FMG will be evaluating "need to ballot" - each ballot must be necessary | ||
| + | ** All artifact types, all key behaviors, etc. present. If there are bugs in the publication process, they must be identified by this point and must be resolved to the point that the build at least runs successfully and any tooling-related issues must be agreed to be resolvable | ||
| + | *2018-11-18 - Content deadline for QA. All content must be final from the workgroup perspective - no changes other than QA fixes from this point - no new artifacts or content | ||
| + | ** Reconciliation packages posted to ballot desktop for previous ballots (if any) | ||
| + | *2018-12-02 - Final freeze. If there are QA errors at this point, you don't publish. No slippage for any reason | ||
| + | *2018-12-07 - Ballot opens | ||
| + | --> | ||
Latest revision as of 21:16, 24 April 2019
A calendar has not yet been established for the FHIR R5 cycle. General ballot timelines for implementation guides can be found on the [HL7 confluence page]
