Name pattern for templates
The name of a template is presented by the name of Confluence page. In the past, they are presented as Template Name +version + Status, For example,
- Computed tomography of [body structure] (procedure) - In PROD
- [Fracture morphology] of [bone structure] (disorder) v2 - Ready for implementation
Going forward, all new templates would not include version and status in the template name. A new Confluence page property table has been introduced to cover status and version. This will avoid changing the name of Confluence page which caused broken links.
The version number for the final publication needs to be included in the name for template to overcome the rule of unique name for Confluence pages. The version number for 'Ready for implementation' and 'In PROD' should be aligned with the version in the Authoring platform. The format of version number please see the section below. For example, if a new version of Computed tomography of body structure template is under development, the template name should be:
Computed tomography of [body structure] (procedure) - v2.0
with page property table:
| Status | In progress |
| Version | 1.2 |
| Version in PROD | 1.0 |
The template name indicate the number of version v2.0 for the final publication. The page property table indicates that the status is in progress with version 1.2. When the template status has reached 'Ready for implementation' and 'In PROD', the version number needs to be changed to 2.0.
The example of template specification can be found in the Template for simple disease (disorder) - v2.0
Format for Templates
- Descriptions:
- All essential descriptions
- Fully specified name (FSN)
- Preferred term (PT)
- Synonym (SYN)
- Metadata about descriptions
- Description type (FSN, PT, SYN)
- Language and acceptability
- Case significance
- Variables in description should be presented by square brackets [ ] with label inside the brackets. The label should be the representative of value rather than attribute name. For example, [bone structure] is a suitable slot name. The attribute finding site is not a suitable slot name. The same label should be used for the variable in concept model.
- All essential descriptions
- Concept model:
- There are three different cardinality restrictions, attribute group cardinality constraint, attribute cardinality constraint and attribute in group cardinality constraint. For each attribute in the concept model, two cardinality constraints should be specified at least. The 'Attribute group cardinality' is always required to specify if an attribute is grouped or not. In addition, for a grouped attribute, the 'attribute in group cardinality' needs to be specified. For an ungrouped attribute, the 'attribute cardinality' also needs to be specified.
- IS A relationship for proximal primitive parent concept
- Attribute and values constraints
- Role group cardinality for A/V
- Variables in description should be presented by squire brackets [ ] with label inside the brackets and followed by the expression constraint
- Definition status:
- The value should be 900000000000073002 |Sufficiently defined concept definition status (core metadata concept)|
- The value should be 900000000000073002 |Sufficiently defined concept definition status (core metadata concept)|
- Applies to:
- Domain for the template which can be presented by expression
- Domain for the template which can be presented by expression
- Replaced by:
- Link to the new template
- Link to the new template
- Template language:
- SNOMED expression representation by Template Language
- SNOMED expression representation by Template Language
- Link to the misaligned concept report
- Add the link to QI report
- Rules for generating descriptions
- describing rules for generating different description. For example, removing semantic tag and word 'structure' for body structure are standard rules for all descriptions
- Additional rules can be added for specific template in order to generate readable FSNs
- JIRA ticket
- Link to the JIRA ticket for template development and implementation workflow
Template status
- In progress - not ready for use, still being created and is subject to change
- For review - considered final, but awaiting approval and is subject to change
- Ready for implementation - final, approved, awaiting implementation in the authoring platform/template service
- In PROD - available in the authoring platform/template service
- On hold - postponed the development
- Outdated - still in production before it is replaced by new template
- Archived - no longer available in the authoring platform/template service (the link to the new template should be added under the 'Replaced by' section), or the draft template is not needed before it is moved into the production.
Version number
The version number of templates should follow the format of Release.Draft.
The version number of a template in status of 'Ready for implementation' or 'In PROD' should be in the format of 1.0, 2.0. The same version number should be used in the Authoring Platform.
The version number of a template in status of 'In progress' or 'For review' should be in the format of 0.1, 1.1, 2.3.
Notes:
- A new Confluence page should be created for a new version of the template. The older version will be achieved when the new template has been implemented in the production.
- Confluence page for template should added a label 'template'. This label is used for generate template reports.
- The expression constraint language should be used to indicate range.
- All concepts in template should be presented by concept id and FSN by using 'SNOMED CT Expression' macro. (open the macro browser by selecting + for insert more content or entering '{' on the page, then search 'sct' and select the macro)
- The hierarchical relationships between templates should be arranged by subpages in Confluence
- A new template should be created for updates with an increased version number for any subsequent changes to a published template in the Authoring Platform. The link to the current version in production should be provided in the page property table.
- Authors also needs to check the JIRA ticket for those with 'Ready for implementation' before making updates to the template. If the technical development has started, authors need to communicate with the developer to confirm if it is okay to make updates directly. If not, a new template should be created with a new version number.