Name for Template
Name of Confluence page should be 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
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:
- Attribute cardinality
- 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
- 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)
Notes:
- 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
- The first version of template would not require the version number. The default value 1 would be assigned in the authoring platform. For any subsequent changes to an existing template in the Authoring Platform, a new template should be created for updates with a version number.
- 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 be communicated with the developer to confirm if it is okay to make updates directly. If not, a new template should be created with a version number.