Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Working in a Managed Service or Training authoring extension has some significant differences from International authoring:
Extension mainline branch The promoted project content "mainline" is an extension base branch instead of MAIN (International mainline). This doesn't directly affect authoring interactions, but project leads and release quality assurance testers need to know what this means when releases are prepared.
Extension module Content changes are saved in the extension module rather than the SNOMED CT core module or model module.
Language and/or dialect variations Each extension may have language reference sets and dialect variations which modify the task presentation and interactions (see Working in an extension task below). Since AP 7.1.0 the Authoring Platform also supports searching using the Chinese (ISO 639-1 code zh) character set when the relevant language reference set is configured.
Template-based authoring constraints Templates are not yet available for extension-based authoring due to current constraints on language and dialect variations support for templates, so any features dependent on the use of templates are not available. When suitable templates become available which can support the variations needed for extension-based authoring, these features can be enabled, but until then they are switched off by project configuration settings.
International SNOMED CT International dependency version Member countries can extend SNOMED CT International Edition concepts by adding content within their own extension. Extensions are usually upgraded when an International SNOMED CT Member release becomes available which is typically one month before the public release date (on the current bi-annual release cycle).
Key differences compared to working in an International authoring task are:
There is no Create New Concept from Template option via the left-hand action menu button bar.
Taxonomy Language options: As well as the FSN in en-US, there are additional options for Preferred Term (PT) in en-US (default) and PT in extension dialects. When PT dialect options are selected, any translated PTs available in that dialect will be shown in the taxonomy listing (if no translated PTs are available, it will show the en-US PT).
Search
Filter by language/dialect options: Search results can be filtered by FSN in en-US, or PT in the available extension languages / dialects.
There is no Switch to Template search option (Text Search and ECL Search only), and by implication no Transform using template feature (this is only available for template search matches).
There is no template-based authoring Batch mode tab in the Task View context panel options. However, as noted below, batch translation description imports are supported for extension authoring.
Upload a Batch. Available from the left-hand menu button bar, this feature supports uploading of formatted text files which can contain multiple description additions, description changes, and description inactivations, for batch processing and review of translation terms via authoring tasks within a Managed Service extension project. This is not to be confused with the template-based batch authoring features, which support logical as well as lexical modelling for International authoring.
Editor
Concept descriptions presentation: Extensions may show additional descriptions for Preferred Terms in their dialect variations.
Concept dialect PT automation: When creating a new concept, the en-US PT will be automatically populated from the FSN term (as for International), but the additional dialect variations will not be populated since their terms need manual translation verification.
More details pop-ups - Module Id: New concepts created in an extension are saved in the extension module. This can be seen in the
A new release of the International Edition is published monthly.
In SNOMED CT directional relationships can be made between concepts with a source concept and a destination concept. This is done by authoring axioms which are turned into relationships during the classification process.
On upgrading, an extension may contain one or more axioms which refer to a concept in the International Edition where the concept has become inactive in the new release.
Axioms are not allowed to refer to a concept which is inactive, so such issues must be identified via an Integrity Report (and content updated to resolve them), as part of the extension upgrade process.
The Integrity Report also automatically resolves issues due to an inactive concept having an active description which is missing an "inactive concept" indicator, and also when an inactive description is referenced in a language reference set.
With the new concept loaded in the Edit Panel, press the More details icon button to the left of the concept header.
The More Details pop-over dialogue shows the extension Module Id for the new concept.
The example shows a Belgian module concept.
Press any description row More details icon button (to the left of the description row) to see a similar pop-over for each description.
The example shows a Belgian module concept, in which the fr and nl languages can also be seen in the Lang. (language reference set) setting for each translated description, as well as its extension Module Id.
Note that en:US is the language reference set for the FSN and first PT.
More detailsClosing information pop-overs
Press the More details icon button to toggle its related pop-over open/closed.
Press anywhere in the Edit Panel outside a pop-over box to close all open pop-overs.
The preferred terms in the Search results are updated to show the selected language option.
If there is no translated term available in a selected extension language-dialect, the terms will fall back to the en-US PT (required for all concepts).
So a mix of the selected language/dialect and en-US terms should be expected if full coverage of PT translations is not available for a given extension and set of search matches.
When searching, the search query will match against any content, including translated terms, and the default search results presents the matched concepts using the Preferred Term in the first available extension language or dialect.
The search results panel is initially empty, awaiting entry of a search query (type at least three characters to trigger type-ahead searching).
Extension authoring search has two additional filtering options (not available in International authoring), to focus the results based on:
Language Reference Set membership (multiple combination options).
Extension language or dialect Preferred Terms (single selection option).
These are available below the Active Only | Inactive Only | Active and Inactive publication status filter button and the Switch to ECL button in the search panel header bar (below the search query box).
To constrain the search to a specific language reference set, press the Language Refsets multi-option selector, and make a selection of any combination from those available.
The search results will only show matches to content found in the selected language reference sets.
The screenshot example shows the options available in the ms-belgium extension, which are:
US English
Belgian French language reference set
Belgian Dutch language reference set
GB English
Enable the desired filtering by pressing the relevant checkboxes (toggle on/off).
Once a specific selection has been made, the choices made are shown in the button in place of the initial Language Refsets label.
The initial search filtering is equivalent to enabling all options.Be aware that some combinations of language reference set constraints and language or dialect filtering may give no results - for instance, searching for a Dutch word with only the French Language Reference Set selected - since the Dutch word is only present in the Belgian Dutch language reference set, it will only be found if that option is selected.
To constrain the search to a specific language or dialect, press the Filter by single option selector.
A list of language display options are presented for the Fully Specified Name (FSN) and Preferred Term (PT) for each available language/dialect.
As an example, these are the options for ms-belgium:
FSN in US
PT in FR
From the Dashboard - My Tasks view, press Upload a Batch in the left-hand menu bar.
Content translation terms are imported via .tsv (tab-separated values) text files, with three format types corresponding to the following actions:
Description Additions
Description Changes
Description Inactivations
The Upload a Batch pop-up form is presented, centred on the page and overlaying the Dashboard - My Tasks view which is dimmed but still visible "below" the form.
This form has the following fields and calls to action:
Task Title (single line text entry, freely editable)
Select Project (drop-down select list of projects available to the authenticated author)
PT in NL
Press an option to select that language/dialect for the Search results preferred terms (PT in FR is the default option for ms-belgium).
Each extension will show variations matching the PT language and dialect options presented when editing a new concept.
These are defined in the extension codesystem metadata when the extension is first setup for authoring.
Select Assignee (drop-down select list of all registered AP accounts)
Select Reviewer (drop-down select list of all registered AP accounts)
Number of Concepts Per Task (drop-down select list)
Select Import Type (drop-down select list; must match the upload file format)
Select Batch File (opens the browser's local file selector dialogue to specify a batch file for upload)
Create Tasks (inactive until a batch .tsv file is uploaded)
Cancel (closes the pop-up form without making any changes)
When all fields are defined, the Create Tasks button is enabled - press the button to upload the batch file start the import process.The imported changes are allocated to new tasks according to the number of change rows and the maximum number of concepts per task defined on the form, which has the following options: _5, 10, 15, 20, 15, 50, 100 (default), 200, 500.
So, for instance if the source file contains 41 rows, and the number of concepts per task is set to 15, then 3 new tasks will be created, with the last one containing 11 changes, and the others 15 each.
The default option of 100 is chosen so that most use cases only need one new task, but a smaller number may make it easier to review changes.
If multiple tasks are created they are identified by reference numbers which are automatically suffixed to the Task Title.
Following upload and processing of the batch file, successful complete of processing is indicated via a header notification for "All tasks loaded", newly created task(s) in the My Tasks listing, and a browser download .tsv file which contains the import result for each processed row from the uploaded batch source file.
The example below shows a success result file for 3 description additions to existing published International concepts, adding Maori language translations in the New Zealand (NZ) extension:
Following successful import, the changes made can be seen in the Authoring Platform by opening each related import task.
On first opening the task, the edit panel will be empty, since no manual editing has occurred.
Use the Switch to Feedback View context tab to see each modified concept in the To Review list.
Loading the modified concepts into the Review Panel highlights their changes, in exactly the same way as those made manually via regular editing.
The example shown here shows two NZ extension description changes made via batch import.
Another example showing two NZ extension description inactivations made via batch import.
Another example showing three Maori translated terms added to existing International published concepts, with the new descriptions added to the NZ extension module.
(Google translations of en-US terms into Maori are for illustration purposes only!)
In the Task View - Context Panel tab, when alternative language reference sets are available. the search panel shows additional options for:
Language Refsets reference set selection (combination checklist)
Filter by term (single choice selector)
The language reference set selection controls which results to include, and the term choice decides which language is used to search and present the results.
To search using Chinese queries, first select Filter by PT in ZH.
Enter a character in the query box to trigger searching.
The results panel shows "Searching..." until all results become available.
Some searches with small results sets may be almost instantaneous - larger results sets may take a few seconds to load.
Since a character-based writing system such as Chinese can associate each logogram with an entire sound or phrase, the three-character minimum used to optimize type-ahead search phrases for other languages and dialects does not apply when Filter by PT in ZH is selected.
This will however be re-applied if the Filter by selection is changed to a non-Chinese option (for instance FSN in US).
With an International published concept loaded into the editor, view the concept descriptions.
Translated terms appear as individual descriptions set to be the Preferred Term (PT) for the languages-dialects available in a specific SNOMED CT extension.
The example shown here is the International published concept which was loaded by searching for the French word "événement" and pressing "événement accidentel" in the search results.
Note the language-dialect acceptability settings for each description row:
The first description is always the Fully Specified Name (FSN). This is always defined as Preferred in the en-US dialect.
The second description is the International Edition PT, which is defined as a SYN (synonym) set to Preferred in the en-US dialect.
The third description is the
In the Taxonomy panel, press the Language drop-down selector control in the top right corner of the panel.
A list of language display options are presented for the Fully Specified Name (FSN) and Preferred Term (PT) for each available language-dialect.
As an example, these are the options for ms-belgium:
FSN in US
PT in US
The fourth description is the Dutch language PT, which is defined as a SYN set to Preferred in the nl language.
Use the More details buttons on the description rows to compare details for the various concept descriptions:
The FSN and en-US PT are defined in the SNOMED CT core module with Lang. setting en.
The extension translated PTs are defined in the Belgian module, with Lang. settings fr and nl respectively.
The SCTID of each translated PT contains the Belgian extension namespace identifier: 1000172.
Since this is an International Edition published concept the More Details panels include an Eff. Time (Effective Time) value (the release of SNOMED CT in which they were last published).
The Effective Time for extension descriptions will be the last publication date for their extension, whereas the FSN and en-US PT show International Edition release dates.
As can be seen in this example, the description Effective Time may differ from that of the concept itself.
PT in FRPT in NL
Press an option to select that language-dialect for the Taxonomy listing preferred terms.
The preferred terms in the Taxonomy listing are updated to show the selected language option.
Preferred terms that are not yet translated
If no translated term is available in a selected extension language-dialect, the terms will fall back to the en-US PT (required for all concepts), so a mix of the selected language-dialect and en-US terms should be expected until full coverage of PT translations is available for a given extension.
Hovering over one of the newly presented entries presents a tooltip which expands the full name of the context-specific language reference set and the acceptability setting.
When working in a task within a Managed Service extension, context-specific language reference set acceptability entries can be enabled in Concept Editor within the Edit Panel, by selecting from a list of those available in the author's Settings and Preferences.
From the Task View , press the cogwheel icon in the upper right of the page header, to open the Settings and Preferences pop-up dialogue.
When context-specific language reference sets are available, they are listed above the Page Layout section.
Each entry has a checkbox to enable display of those entries in the Concept Editor.
Check the box for the desired entry, then press Save in the Setting and Preferences dialogue.
The Settings and Preferences dialogue closes, and a header notification for "Application preferences updated" is presented.
With the settings saved, and an appropriate concept loaded into the Edit Panel, the language acceptability entries for each term are updated to include those for the selected context-specific language reference set (abbreviated in the same style as the other language acceptability entries).
Term matches to the search query are then listed, along with the total number of concepts found.
Use the Act on concept search results and Work with large concept search results sets features as needed.
Editing the query will immediately trigger a search and present an updated results set (due to the relaxed trigger requirement of only a single character when Filter by PT in ZH is selected).
The search results are filtered to only show projects matching the search query which are also in the selected category.
If more than one category is available, select another to filter the same query on a different category.
The results then only show those matching the query which are also in the new selected category.
In the Dashboard - All Projects view, when an author has access roles granted in projects which span more than a single category, a drop-down selector will appear to the right of the Search All Projects query slot in the view header.
The default selection is All (to search all projects).
Entering a query will trigger a type-ahead search of all projects after each character is entered.
Keep typing to narrow down the results set as the query becomes more defined.
Press the caret-down icon button to the right-hand side of the category selector to show a drop-down list of project categories.
Select a category.
Google sheets can be used to quickly generate .tsv files from a worksheet tab, via its File > Download > Tab separated values (current sheet) menu function. Google sheets also offers useful file sharing and commenting options, so can be an efficient approach to defining, reviewing, and refining extension translation terms prior to importing into the Authoring Platform.
Here are some example .tsv translations (New Zealand) batch upload files:
Reference file:
Reference file:
Reference file:
With a published unchanged source concept from the extension loaded into the Editing panel, press the caret-up button on the right of the concept header panel to open the concept header extended menu.
Press Request Promotion in the extended menu options list.
project lead (account name)
project lead (display name)
706689003
Application programme software (physical object)
He raupaparorohiko raupaparorohiko
mi
cI
SYNONYM
Maori
PREFERRED
442376007
Test with result pending (observable entity)
Whakamatau me te hua ka tatari
mi
cI
SYNONYM
Maori
PREFERRED
70056012
Insertion of catheter into heart chamber
cI
SYNONYM
NZ English
ACCEPTABLE
US English
ACCEPTABLE
GB English
ACCEPTABLE
3658267015
Inflammatory disorder due to increased blood urate level
ci
SYNONYM
NZ English
PREFERRED
US English
ACCEPTABLE
GB English
ACCEPTABLE
150085018
Gout
CS
SYNONYM
NZ English
ACCEPTABLE
US English
PREFERRED
GB English
PREFERRED
51631000210119
Screening for diabetes mellitus during pregnancy
Outdated
706690007
Web-based application software (physical object)
Me tono rorohiko-a-paetukutuku
mi
cI
SYNONYM
Maori
PREFERRED
51691000210118
GDM-Gestational diabetes mellitus screening
Erroneous
The Promote concept pop-up dialogue box is then presented, with the concept SCTID and FSN noted in the dialogue header, and a notification that dependencies are being checked against this concept.There are two possible check outcomes:
No dependencies found
Dependencies are found
If no dependencies are found, the Promote concept notification box is updated accordingly, and option buttons to Cancel or Continue are presented.
Press Cancel to return to concept editing without requesting promotion.
Press Continue to make the promotion request.
If dependencies are found, a tabulated list of the dependencies are shown in the dialogue box, followed by option buttons to Cancel, Continue without Dependencies, or Continue with Dependencies are presented.
Press Cancel to return to concept editing without requesting promotion.
Press Continue without Dependencies to make the promotion request for just the request concept itself.
Press Continue with Dependencies to make the promotion request including all the listed dependency concepts as well as the request concept.
The form processing triggers a new content request in the International CRS platform, with a related AP header notification.
Following creation of a linked International CRS request, the AP header notification is updated to include the CRS ticket reference.
A CRS Request section with the reference link is added to the Task Details (the CRS ticket number is the link text).
Follow the link to open the International CRS request ticket.
International CRS access
The CRS link expects the requisite group memberships are already granted to the AP Author's account for the International CRS platform to view the linked CRS request details.
Additional permissions may need to be requested via Technical Support if this is not the case.
At this point the promotion request is completed in the Authoring Platform, and fulfilment of the request moves to the International CRS platform process flow.
The linked CRS ticket includes the extension promotion request concept details.
If Continue with Dependencies was followed, the linked CRS ticket includes the extension promotion request concept and its dependencies details.
Published unedited concepts only
The Request Promotion option only appears if the concept has been published in an extension release.
Previously published concepts modified in the extension since publication cannot be promoted to the International Edition until after re-publication in the extension.
Pressing Request Promotion on a previously published concept that has subsequently been changed but not yet re-published will present an error notification in the concept header, with the related change(s) highlighted in the editing panel:
If this concept needs to be promoted to the International Edition before the next local extension release, the concept can be reverted to its published version to allow the promotion request to proceed.
Of course any local extension changes made since publication are then discarded, so that may have to be considered when the International CRS promotion request is reviewed.
To apply a suggested resolution to an individual concept, press the Save and next icon button in the Resolution panel.
A header notification indicates that the concept is being saved.
Drools Rules warnings may appear briefly when saving the concept, but do not prevent saving.
Saved concepts can be reviewed later via the usual feedback and review process, so integrity resolution save warnings can be followed-up as needed.
After manually saving a concept, the next concept in the Issues List is automatically previewed for issue resolution.
The saved concept is removed from the list, and the Total Items count is decremented.
Once loaded, the new first item on the Issues List is previewed, ready to repeat the process for this next concept.
As well as resolving each suggested resolution manually on a concept-by-concept basis, a number of concepts can be selected and processed automatically as a batch.
To do this, press the checkboxes alongside each desired Issues List item to define a batch list.
With the desired concepts selected via their check-boxes, press the Auto-fix icon button to the upper-right corner of the Issues List.
A header notification shows that the selected concept resolution suggestions are being saved.
A header notification shows the number of concepts which were successfully saved, and the Issues List updates to preview the new first item, with the Total Items count decremented by the number of saved concepts.
For rapid processing of the entire list, press the Select all checkbox in the Issues List header.
With all Issues List concepts selected, press the Auto-fix icon button to processing the entire list.
Whilst most integrity check suggestions will likely save without manual intervention, with a long Issues List , it's also quite probable that some suggested resolutions will trigger Drools Rules errors that prevent saving.
Once the automated process has saved all the items that don't need manual resolution, a header notification shows the number saved successfully, and also the number that failed to validate on attempting to save.
The items that were unable to be saved due to validation errors remain on the Issues List , with the new first item automatically previewed, and the item count is updated to show the total remaining.
These items must be manually fixed concept-by-concept by editing in the Resolution preview panel.
To see the errors that prevented automated saving, press Save and next in the Resolution preview panel.
The header and concept panel notifications are the same as those that would be obtained through normal editing.
Use the Resolution panel editor details information and the Search and Taxonomy View context tabs to identify alternative solutions to resolve the issue.
When the last item on the list has been successfully saved, the Integrity Report automatically runs again to confirm the changes.
When the Integrity Report completes with no issues, the usual Task Details view is presented.
From this point onwards the Integrity Report check will no longer be triggered when opening the task.
All concepts saved from Integrity Report issue resolutions are available in the task Feedback context tab, in the same way that manually authored content is listed (any other concepts edited in the task will also be in this list).
Load a list concept in the Feedback Preview panel to see its change details.
On first opening a task which has upgraded content, an Integrity Report check is triggered which scans the content for issues.
Whilst this is proceeding, the task content area shows the Integrity Report check is running. Please Wait... notice.
On completion of the checks, if integrity issues have been found the Integrity Report view is presented.
This contains the following:
Left-hand context tab panel, containing:
Issues List - all concepts with integrity issues, with select and preview actions
Search
Taxonomy View
Right-hand concept preview/edit panel, showing:
Prior Version of the concept with issues
Suggested Resolution for the issue
The and tab views are the same as those available in the , and are provided here to support investigation and location of alternative target concepts to resolve the integrity issue.
When first presented, this view automatically previews the first concept in the list (as indicated by the inactive status of its preview icon in the Issues List.
List paging controls and visible list size options are presented below the list.
Each concept in the list can be individually previewed and resolved via editing in the Resolution panel, but the platform can also apply the suggested resolutions automatically if they do not cause validation errors.
