All pages
Powered by GitBook
1 of 8

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Manage Releases in Simplex

Simplex Release Cycle Overview

The Simplex release cycle is organized into three sequential stages that guide an extension from active editing through to publication, see the diagram below.

  1. Editing

    • This is the active development phase.

    • Key activities include:

      • Dependency configuration (linking to a parent or international edition and updating dependency versions).

      • Content development, where content managers upload and modify extension content.

      • Validation, where automated checks are run to identify issues (with the ability to rerun validation if errors occur).

      • Review, allowing users to inspect changes via a daily build and download reports (e.g., XLS).

    • Any system or validation errors must be resolved before moving forward.

  2. Preparing Release

    • This stage begins once editing is complete.

    • It focuses on:

      • Release validation, ensuring the content is technically and semantically sound.

      • Final content review, confirming that all changes are correct and approved.

    • The release cannot proceed until these checks are completed and content changes are approved.

  3. Release Ready for Publication

    • The final stage before completion.

    • Includes a technical review to confirm the extension meets publication requirements.

    • Once ready, the extension can be published, completing the release cycle.

Simplex Release Process

Accessing the Release Cycle in Simplex

  1. Open your extension in Simplex.

  2. From the left-hand menu, select Manage Edition.

  3. The Manage Edition page displays the current release cycle, showing progress from editing through to publication and providing access to validation, review, and release actions.

Accessing the Release Cycle Area

Provide Feedback

Release Management

Overview

Release Management in Simplex ensures that new versions of SNOMED CT Extensions or Editions are delivered in a controlled, consistent, and predictable way.

The release process involves multiple stakeholders and may include third-party contributors. Effective release management ensures that technical, content, and governance aspects of a release are considered holistically, from the end of the Editing cycle through to publication.


Scope of Release Management

In Simplex, Release Management covers all activities required to move an extension from content completion to publication, including:

  • Release design and configuration

  • Validation of content and dependencies

  • Coordination and scheduling of release activities

  • Review, approval, and publication of releases across environments

These activities ensure that releases are traceable, secure, and aligned with agreed quality standards.


The Release Manager is accountable for ensuring that all content created during the Editing cycle is ready for release in Simplex.

This role acts as the central point of coordination between contributors, validators, and stakeholders, ensuring that content is complete, validated, approved, and suitable for publication.

Key responsibilities include:

  • Confirming that externally developed content is complete and correctly integrated into Simplex

  • Managing dependencies and release configuration

  • Running and reviewing validation checks


Validation and review are central to Release Management in Simplex.

During this phase, the Release Manager ensures that:

  • Release-level validation is run and passed

  • Validation findings are reviewed and resolved

  • All content changes are formally reviewed and approved

Only once these conditions are met can the release progress toward publication.


Successful publication marks the completion of the release cycle and makes the SNOMED CT Extension available for use.

Before publishing a release, the Release Manager ensures that:

  • The exact scope and content of the release are agreed and finalised

  • All checks, validations, and approvals have been completed

  • Communications and stakeholder expectations are managed


Simplex provides structured workflows and controls to support a wide range of release scenarios, from small incremental updates to complex, multi-stakeholder releases, while maintaining consistency and quality. The effort required for Release Management, therefore, depends on factors such as:

  • The scope and complexity of the release

  • The volume and type of content changes

  • The involvement of external contributors or third-party suppliers

Coordinating resolution of issues identified during validation or review
  • Ensuring that only authorised and approved content progresses through the release cycle

  • The release meets agreed technical, clinical, and governance requirements
    The production environment is protected through formal release controls

    Role of the Release Manager

    Validation, Review, and Approval

    Publication and Release Control

    Effort and Complexity Considerations

    Publish your Release

    Preparing for Release

    Editing a Release in Simplex

    Overview

    In Simplex, the Editing cycle represents the phase in which extension content is created and prepared for release. While Simplex manages the overall lifecycle of an extension, the actual content development and editing activities take place outside of Simplex, using SNOMED International’s open authoring tools.

    The Editing cycle brings together content produced by contributors and prepares it for validation and release through Simplex.


    Content Development Outside Simplex

    Simplex does not function as a primary authoring tool. Instead, it acts as an integration and release management platform that consumes content developed in external systems.

    During the Editing cycle, content may be created and maintained using the following tools:

    • Snap2SNOMED

      Used for creating and maintaining maps. Please see

    • Refset and Translation Tool

      Used for creating SNOMED CT subsets, including simple reference sets within the extension. Please see

    • SNOMED CT Translation Tool

      Used for creating and maintaining translations of SNOMED CT content. Please see

    • Spreadsheets

      Used for creating new concepts, including simple modelled concepts required for the extension. Please see

    These activities are typically carried out by extension contributors including subject matter experts (clinical and terminological), and members of the National Release Center.

    The purpose of the Editing cycle in Simplex is to bring externally created content together so that it can be validated and prepared for release.

    At the end of the Editing cycle:

    • Content must be in a format suitable for import into Simplex

    • All required content types must be complete

    • Dependencies must be correctly configured. This means that the content of the various derivatives and extension content should depend on the version of International Edition specified as the dependency for this release, please see )

    Once content has been successfully integrated and validated, the Editing cycle is considered complete and the extension can progress to release preparation.

    The extension must be ready to move into release validation and review

    Integrating Content into Simplex

    Manage Maps in Simplex
    Manage Subsets in Simplex
    Manage Translations in Simplex
    Manage Extension Concepts in Simplex
    Dependency Configuration

    Dependency Configuration

    Video

    This video explains how to start a new release cycle in Simplex. - You will learn how to select and upgrade your extension's dependency version to prepare for content development.

    Step by Step Instructions

    1. Navigate To Manage Edition

    To start a new release cycle in Simplex, navigate to the Manage Edition section to begin managing your extension's release cycle.

    Navigate To Manage Edition

    2. Open Current Editing Site Window

    The "Manage Edition" interface shows the different phases of the release cycle - starting with the editing phase. - Steps for preparing the release and publication are grayed out. These steps will be actionable once the new editing process is complete.

    Open Current Editing Site Window

    3. Review Dependency Configuration

    In the editing phase, first set the dependency configuration. -- The parent edition that the extension in this example depends on is the International Edition, January 2024 version.

    Review Dependency Configuration

    4. Identify New Version Availability

    The blue link indicates a new version is available due to one or more releases of the International Edition since the current version.

    Start the release cycle by clicking the link to select the new version your extension will depend on.

    In this demonstration, we will select the January 2025 version.

    Now - Run the dependency upgrade process to set the new version as the dependency for your extension.

    The system upgrades the dependency and enters maintenance mode to apply the new version settings. This may take a bit of time.

    The new version will be used to validate all artifacts and derivatives within your extension. It will also be the version used for classifying any concepts created in your extension.

    Once complete, the new version, such as the January 2025 edition, is set as the dependency.

    You are now ready to proceed to the content development phase, where you update all artefacts and derivatives.

    For more information, see the related videos on content development and release management.

    Release Validation

    Validation is a key step in the Editing Cycle in Simplex. Its purpose is to ensure that all content incorporated into the extension forms a technically valid SNOMED CT Edition package before release preparation can begin.

    Simplex runs the full set of SNOMED CT validations provided by SNOMED International. These validations are applied after content from multiple external authoring tools has been compiled into a release structure within Simplex.

    Validation helps identify issues early, ensures consistency across content types, and protects the quality of the final release.


    Validation is initiated directly from the Editing stage.

    To run validation:

    Navigate to Manage Edition.
  • In the Editing stage, locate the Validation box.

  • Click Run validation.

  • Once started, Simplex executes the full validation suite against the current state of the compiled extension content.

    The Editing cycle cannot progress until validation has completed and all blocking issues have been resolved.


    Simplex applies the standard SNOMED CT validation rules, also applied for the International Edition of SNOMED CT: This includes checks that:

    • Assert referential integrity between components (for example, ensuring references point to valid concepts)

    • Validate terms and descriptions, including:

      • Detection of duplicate terms within a hierarchy

      • Identification of invalid characters or formatting issues

    • Ensure consistency and correctness across release files

    Some validation rules also assert Machine Readable Concept Model (MRCM) constraints. While Simplex does not support stated modelling directly, these rules are still be included as part of the standard validation set and applied where relevant.


    Once validation completes, the results are displayed in the right-hand panel of the screen.

    Validation issues are categorised as:

    • Errors

      Issues that prevent the release from progressing. All errors must be fixed before release preparation can be completed.

    • Warnings

      Issues that do not necessarily block the release but should be addressed to improve content quality.

    A summary count of errors and warnings is shown at the top of the results panel.


    The validation results panel provides a detailed, actionable view of identified issues.

    For each issue, Simplex displays:

    • The component identifier (for example, a Concept ID)

    • The assertion text, which is a human-readable explanation of the issue

    • Links that allow the user to explore the affected component in context

    Users can click on component IDs to open the Simplex Browser, making it easier to understand where and why the issue occurs.

    A help link titled “How to fix these errors and warnings?” is available to provide additional guidance on interpreting and resolving validation findings.


    Simplex acts as a validation and coordination platform; it does not directly edit content.

    All validation issues must be fixed in the original authoring tool where the content was created, for example:

    • Subset issues are fixed in the Refset and Translation Tool Editor

    • Mapping issues are fixed in Snap2SNOMED

    • Translation issues are fixed in the SNOMED CT Translation Tool

    • Concept or spreadsheet-based content is corrected at source

    Simplex clearly identifies which components are affected, helping contributors locate and correct issues efficiently.


    After issues have been fixed in the source tools:

    1. Updated content must be re-imported into Simplex.

    2. Validation must be run again from the Editing stage.

    This cycle continues until all errors are resolved and the content meets the required quality threshold.


    Validation results can be downloaded directly from the results panel.

    Downloaded reports can be shared with:

    • Content editors

    • Subject matter experts

    • External contributors

    This supports collaborative issue resolution and ensures that all stakeholders have clear visibility of required fixes.


    The Validation step in the Editing Cycle is considered complete when:

    • Validation has run successfully

    • All errors have been resolved

    • Any remaining warnings have been reviewed and addressed where appropriate.

    Once validation is complete, the extension is ready to progress to release preparation.

    Overview

    Please refer to the following page of the Extensions Practical Guide for general advice regarding the review and validation of an extension:

    Video

    Running Validation

    What is Validated?

    Validation Results and Issue Types

    Understanding Validation Results

    Fixing Validation Issues

    Re-running Validation After Fixes

    Downloading and Sharing Validation Results

    Completion of the Validation Step

    5. Start Release Cycle With New Version

    6. Choose Dependency Version

    7. Run Dependency Upgrade

    8. Monitor Upgrade Progress

    9. Validate Artifacts Against New Version

    10. Confirm New Version Set

    11. Prepare For Content Development

    Provide Feedback
    Identify New Version Availability
    Start Release Cycle With New Version
    Choose Dependency Version
    Run Dependency Upgrade
    Monitor Upgrade Progress
    Validate Artifacts Against New Version
    Confirm New Version Set
    Prepare For Content Development

    Review Extension

    The Review stage begins once validation has completed successfully. At this point, all automated checks have finished and the focus shifts to confirming and understanding the changes that have been made since the last release.

    The review stage is used to:

    • Confirm what content has changed

    • Check that changes align with the intended scope of work

    Identify unexpected or missing changes

  • Decide whether the content is ready to progress


  • After validation has run:

    • The validation process indicator stops spinning

    • The validation duration is displayed

    • The time since the last validation run is shown

    • Validation results show Errors: 0, Warnings: 0 (ideally)

    This confirms that the content is structurally valid and ready to be reviewed.


    The primary review tool is the Daily Build summary in the SNOMED CT Browser.

    1. Open the SNOMED CT Browser using the link in the Review box

    1. Select the Daily Build tab

    The Daily Build shows a summary of authoring changes since the last release, including:

    • New concepts

    • Inactivated or reactivated concepts

    • Description changes

    • New reference sets

    • Reference sets Changes

    • Reference Set member changes

    This view allows reviewers to quickly assess:

    • The volume of changes

    • The types of changes made

    • Whether the changes match expectations for the current work cycle

    You can review the detail behind each summary row by selecting it.

    When you click a row in the Daily Build report (for example, the row showing the number of New Concepts or Reference Sets with member changes):

    • The view updates automatically

    • A detailed list of the relevant components is displayed

    • Each item is shown with its concept name and SCTID

    For example:

    • Selecting New Concepts displays all concepts added since the last release. Here, you can see that two concepts has been added in the extension. Clicking each of these rows will display the details of the concept in the right side of the browser.

    • Selecting Reference Sets with member changes displays the reference sets that have been modified. In this example, you see that 5 reference sets have Member Changes.


    During review, you should confirm:

    • All expected changes are present

    • No unexpected changes appear

    • Change counts are reasonable for the scope of work

    If the review is satisfactory:

    • The content can move forward to the next workflow stage (frelease preparation)

    If issues are identified:

    • Further authoring may be required

    • Validation and Review should be re-run after changes are made


    For more detailed inspection or for sharing with stakeholders, changes can also be reviewed by downloading a change report.

    Change reports are useful when:

    • A detailed audit is required

    • Changes need to be reviewed offline

    • Formal sign-off processes are in place

    Please refer to the following page of the Extensions Practical Guide for general advice regarding the review and validation of an extension:

    Validation Completed

    Reviewing Changes Using the Daily Build Summary

    How to access the Daily Build

    Using the Review to Decide Next Steps

    Reviewing via Change Reports

    Review and Validation
    Review and Validation