Versioning of each technical “Product” or asset (i.e. API, Design Principle(s), Data Library) is managed using Semantic Versioning 2.0.0.
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards-compatible manner, and
- PATCH version when you make backwards-compatible bug fixes.
Additional labels for pre-release and build metadata are available as extensions to the MAJOR.MINOR.PATCH format.
A pre-release version MAY be denoted by appending a hyphen (refer to Semantic Versioning - Item 9)
For examples: 1.0.0-alpha.1 is a valid pre-release version.
The following pre-release labels will be used across all products:
||Complete enough for internal testing.|
||early||Complete enough for external testing.|
||late||Complete enough for external testing. Usually feature complete.|
||Almost ready for final release. No new feature enhancements.|
rc = Release Candidate.
Taking a similar approach to the FHIR Maturity Model National Data Opt-out Programme will only freeze / master a technical specification once it has been independently implemented in at least three systems and demonstrated to interoperate.
||Alpha; rapid iterations, fail fast, exploration, proof of concepts, approach flexible.||Draft may not have been implemented at all but has been published.|
||Early Beta; rapid iterations, community engaged, scope flexible, high-level approach agreed in principle.||Draft partially implemented in one or more prototype systems.|
||Late Beta; slower iterations, community engaged, scope largely agreed, high-level approach fixed.||Draft partially implemented two or more commercial systems.|
||Release Candidate; slower iterations, community engaged, scope fixed, detailed approach fixed, no new features, bug fixes and amendments for clinical safety & IG only.||Draft implemented in at least two commercial systems.|
||Stable; release version.||Draft implemented in at least three commercial systems with full accreditation and assurance mechanisms in place.|