Conventional approach to SNOMED CT Annotations (archived)

Conventional approach to SNOMED CT Annotations (archived)

Proposed changes

An annotation attribute is a non-defining SNOMED CT attribute. An annotation is defined as the value of an annotation attribute. The proposal is to create a new subhierarchy dedicated to annotation attributes in SNOMED CT.  There are different options to store all new annotation attributes and their values. The pros and cons of each option are discussed in the design consideration.

Annotation attribute hierarchy

The existing concept 

{"timestamp":1762283180815,"msg":"A unknown Exception Occurred","errorMsg":"The provided AtlassianHostUser did not specify a user to act as.","code":"500"}
 can serve as the root for a new subhierarchy for annotation attributes. It should have an additional parent concept
{"timestamp":1762283180753,"msg":"A unknown Exception Occurred","errorMsg":"The provided AtlassianHostUser did not specify a user to act as.","code":"500"}
. The new annotation attributes, such as inactivation note and attribution, can be added as new subconcepts of |Annotation (attribute)|.

The annotation attributes accept values, such as metadata, references, notes and associate them with entities, axioms and ontologies. The Descriptions Logic reasoners do not use these annotation attributes for classifications. The proposed annotation hierarchy is shown below.

  • 246061005 |Attribute (attribute)| 

  • 900000000000457003 |Reference set attribute (foundation metadata concept)| 

    • 900000000000519001 |Annotation (attribute)| 

      • |Attribution (attribute)| - new annotation attribute

      • |Change note (attribute)| - new annotation attribute 

        • |Inactivation note (attribute)| - new annotation attribute

The descriptions in SNOMED CT are mapped to OWL annotations. They are critical clinical terms that should not be mixed with other metadata annotations. The annotation attribute hierarchy excludes the core metadata concepts for fully specified names, synonyms and definitions. 

Two new annotation type reference sets:

Metadata

The following metadata supports these reference sets :

   900000000000454005 |Foundation metadata concept|
         900000000000455006 |Reference set|
                |Component annotation type reference set|
                      |Attribution component annotation reference set|
                      |Inactivation note component annotation reference set|
                          |Change note component annotation reference set|
                |Member annotation type reference set|
                      |Change note member annotation reference set|
         900000000000457003 |Reference set attribute (foundation metadata concept)|
                900000000000518009 |Annotated component (foundation metadata concept)|
                |Annotated member (foundation metadata concept)|
                900000000000459000 |Attribute type (foundation metadata concept)|
                      900000000000460005 |Component type (foundation metadata concept)|
                            900000000000464001 |Reference set member type component (foundation metadata concept)|

                900000000000519001 |Annotation (attribute)|
                      |Attribution (attribute)|
                      |Change note (attribute)| 
                             |Inactivation note (attribute)|

Component annotation type reference set

The new component annotation type reference set replaces of the existing 900000000000516008 |Annotation type reference set| with relaxed constraints. The annotated component is changed from 900000000000461009 |Concept type component| to 

{"timestamp":1762283180842,"msg":"A unknown Exception Occurred","errorMsg":"The provided AtlassianHostUser did not specify a user to act as.","code":"500"}
. This will allow annotations to be assigned to any SNOMED CT component. The datatype of annotations is also changed from 900000000000465000 |String| to  
{"timestamp":1762283180714,"msg":"A unknown Exception Occurred","errorMsg":"The provided AtlassianHostUser did not specify a user to act as.","code":"500"}
.

The major changes are demonstrated in the Descriptor Template. The tables below show the descriptors that define the structure of the |Component annotation type reference set| pattern and examples of the descriptors for specific reference sets that follow this pattern.

Descriptor Template for Component Annotation Type Reference Set

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

900000000000456007 |Reference set descriptor|

|Component annotation type reference set| 

900000000000518009 |Annotated component|

900000000000460005 |Component type (foundation metadata concept)|

0

900000000000456007 |Reference set descriptor|

|Component annotation type reference set| 

900000000000519001 |Annotation|

900000000000459000 |Attribute type (foundation metadata concept)|

1

The attributeType for the Annotation field can be any descendant of the |Attribute type (foundation metadata concept)| in the metadata hierarchy.

Descriptor refset for Attribution component annotation Reference Set

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

900000000000456007 |Reference set descriptor|

|Component annotation type reference set| 

900000000000518009 |Annotated component|

900000000000460005 |Component type (foundation metadata concept)|

0

900000000000456007 |Reference set descriptor|

|Component annotation type reference set| 

|Attribution (attribute)|

900000000000469006 |URL|

1

The attributeType for the |Attribution (attribute)| field can be any descendant of the |Uniform resource locator (foundation metadata concept)| in the metadata hierarchy.

Descriptor refset for Inactivation note  component annotation reference set

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

900000000000518009 |Annotated component|

900000000000460005 |Component type (foundation metadata concept)|

0

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

|Inactivation note (attribute)|

900000000000465000 |String (foundation metadata concept)|

1

The attributeType for the |Inactivation note (attribute)| field can be any descendant of the |String (foundation metadata concept)| in the metadata hierarchy.

 

Component annotation reference set example

refsetId

referencedComponentId

annotation

|Attribution component annotation reference set|

784371009 |Huntington disease-like 1 (disorder)|

https://www.orpha.net/

|Inactivation note component annotation reference set|

103741018 |Radius, NOS|

"Non-conformance to the description convention for structure concept. The suffix NOS for classification should not be used."@en

|Inactivation note component annotation reference set|

425523004 |Entire bone organ of spine (body structure)|

"No suitable replacement concept identified"@en

 

Member annotation type reference set

The new Member annotation type reference set needs to be created to support annotations on members of any reference sets.  The new annotation type refset includes specific attributes:

  • refsetId - Identifies the reference set to which this reference set member belongs. In this case, a subtype descendant of |Member annotation type reference set|.

  • referencedComponentId - A referred the referencedComponentId in the referencedMember entry in a refset.

  • referencedMemberId - A reference to the UUID of a member in a reference set. The entity to which the annotation is being applied.

  • Annotation - Any descendant of 900000000000459000 |Attribute type (foundation metadata concept)| in the metadata hierarchy.

Descriptor Template for Member annotation type reference sets

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

900000000000518009 |Annotated component|

900000000000460005 |Component type (foundation metadata concept)|

0

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

|Annotated member|

900000000000464001 |Reference set member type component (foundation metadata concept)|

1

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

900000000000519001 |Annotation|

900000000000459000 |Attribute type (foundation metadata concept)|

2

The attributeType for the Annotation field can be any descendant of the |Attribute type (foundation metadata concept)| in the metadata hierarchy.

 

Descriptor refset for Change note member annotation reference set

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

900000000000518009 |Annotated component|

900000000000460005 |Component type (foundation metadata concept)|

0

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

|Annotated member|

900000000000464001 |Reference set member type component (foundation metadata concept)|

1

900000000000456007 |Reference set descriptor|

|Member annotation type reference set| 

|Change note (attribute)|

900000000000465000 |String (foundation metadata concept)|

2

The attributeType for the |Change note (attribute)| field can be any descendant of the |String (foundation metadata concept)| in the metadata hierarchy.

 

Member annotation reference set example

refsetId

referencedComponentId

referencedMemberId

annotation

|Change note member annotation reference set|

91302008 |Sepsis (disorder)|

3ddfb6d2-0874-4916-8767-8d48c781d435

“In the third International Consensus Definitions for Sepsis and Septic Shock (Sepsis-3) published in 2016, the new definition eliminated the requirement for the presence of systemic inflammatory response syndrome (SIRS) to define sepsis. The sepsis is now logically defined as Organ dysfunction syndrome (disorder) with pathological process of dysregulated host response due to infectious disease.”@en

 

 

Child Pages 

Copyright © 2025, SNOMED International