All pages
Powered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

Authoring Concepts

Authoring concepts in an extension may involve adding new concepts, inactivating concepts, or modifying existing concepts.

Provide Feedback

Add Concept in an Extension

Purpose

Concepts may be added to an extension to provide new clinical ideas which are not represented in the International Edition. The primary reason for adding concepts to an extension is to represent meanings which are outside the scope of the International Edition, yet within the scope of SNOMED CT. These might be concepts which have local relevance, within a single country, territory or organization. Concepts may also be added to an extension to represent metadata about the extension, for example module concepts, reference set concepts, or new attributes.

For a more detailed introduction on the purposes for adding concepts to an extension, please refer to the Purpose section.

Principles

Overview

Key principles for authoring concepts in an extension include

  • Concepts added to an extension must have a moduleId that includes the namespace identifier assigned to that extension producer by SNOMED International

  • An extension concept must comply with the logical design of SNOMED CT components and maintain referential integrity

  • Concepts added to an extension should conform to the policies stated in

  • Use caution when authoring an intermediate concept in an extension, i.e. a concept which is a supertype of a concept in the International Edition

A concept created in an extension must conform to the logical design of SNOMED CT concepts. An overview of the logical model is provided in the image below. This means that every concept created in an extension must have:

  • At least one relationship

  • At least one description of type

  • At least one description of type

Concepts created in an extension may also have additional descriptions and defining relationships.

Additional defining relationships may include relationships and attribute relationships. When specifying attribute relations for an extension concept it is important to ensure compliance with the SNOMED CT concept model. The concept model specifies the attributes that can be applied to particular types of concepts and it specifies the permitted values for each of these attributes. There are also additional rules on the cardinality and grouping of particular types of relationships. Please see the and the for details on the concept model rules.

As discussed in , all extensions have modules which depend on the modules in the International Edition. Extensions may also have modules which depend on the modules from other extensions. Despite the dependencies between modules from various editions, all concepts in an extension must be a subtype of the root concept, . This ensures that a concept in an extension can be queried and retrieved in a similar way to any concept in the International Edition. Put another way, queries which use subsumption should be able to identify a concept which belongs to a module in an extension because it is a subtype of a concept from the International Edition.

Extension concepts must be a subtype of the SNOMED CT root concept

When an extension producer creates a new concept and states one or more relationships to define that concept the immediate effect is to make the new concept a leaf concept in the SNOMED CT subtype hierarchy. That is to say the new concept at this point has no known subtypes.

There are several situations in which this new concept may acquire new subtypes:

  1. Other concepts in the same extension module may be stated to be a subtypes of the new concept

  2. The organization responsible for another module that depends on this extension module may, in the future, state that some concepts in their module are subtypes of this new concept

  3. When a Description logic classifier is applied to the contents of the module (and the set of modules it depends upon), the defining relationships associated with a new fully defined concept may lead to additional subtype relationships being inferred. These inferred subtypes may be concepts in the extension module itself or in any module on which the extension module depends (including International Edition modules).

Situations 1 and 2 above both result in the subtypes of the new concept either belong to the extension module or a module that depends on the extension module. This does not create any exceptions.

In contrast, situations 3 and 4 can result in the new concept becoming an intermediate concept that sits between two concepts from the International Edition (or from another module on which the extension module depends). This means that the new concept is inferred to be a supertype of a concept from the International Edition (or another module that the extension module depends on). Since, all extension concepts are a subtype of a concept from the International Edition, the new concept represents an intermediate node in the inferred hierarchy between two International Edition concepts. This intermediate concept is only present in the editions that include the extension, so it does not directly alter the International Edition. However, it does create a situation in which the inferred view of the International Edition hierarchy seen by those using the extension differs from the view seen by other users of the International Edition.

Situation 3 does not impact the logical definition of the inferred subtypes in the International Edition since concepts will only be inferred as subtypes if they already share the logical definition of a fully-defined supertype. However, if (as in situation 4) an International Edition concept is stated to be a subtype of the new extension concept, the impact can be more profound. In this case, the logical inference is that all defining attribute relationships of the new concept must also apply to the subtype concepts. Finally, situation 5 directly changes the logical definition of a concept from a module published by another organization. This can have a profound effect not only on that concept itself, but also on subtypes of that concept and on the inferred subtype hierarchy of the International Edition as seen by users of the extension.

In summary, extension producers should try to avoid the authoring scenarios described in situations 3, 4, and 5 above. Doing so will prevent unexpected or undesirable behaviour, which can be directly attributed to modifying the definitions of International concepts. These situations are, however, permitted if they are necessary to meet legitimate clinical needs or to correct identified clinical issues.

A good way to assess the impact of a change is to compare the transitive closure of subtype ( ) relationships after classifying the terminology with and without the extension. As a general rule, the transitive closure of the International Edition should not be modified by classifying it together with an extension.

The following 3 examples illustrate the impact of adding extension concepts as leaf concepts or intermediate concepts (after classification). The impact is considered in terms of how each addition effects subsumption testing using an example international concept 'G'.

Table: Example 1 - Primitive Extension Concept as a Leaf Concept

Table: Example 2 - Extension Concept as an Intermediate Concept (No impact on subsumption)

Table: Example 3 - Extension Concept as an Intermediate Concept (Impact on subsumption)

Concepts added to an extension are represented in a concept file. These concepts are part of a module which includes the namespace identifier assigned to the extension producer by SNOMED International. Each concept also requires additional components and reference set members to be defined. At a minimum, the following components and derivatives should be created:

  • The concept component, which represents the actual clinical meaning required in the extension

  • At least one description component of type

  • At least one description component of type

The table below provides a summary of the process to follow when adding a new concept to an extension.

File Type
Process

It is also possible (although caution is advised) that the creator of the new concept might state that the concept is a supertype of a concept in the International Edition or in another module on which the extension module depends .

  • it is also possible (although caution is advised) that an extension producer might add a defining relationship to a concept in the International Edition (or in another module on which the extension module depends), and this new defining relationship may lead to a variety of new relationships (including subtype relationships) being inferred by a Description logic classifier.

  • At least one relationship of type | is a| , which ensures that the concept is a descendant of | SNOMED CT Concept|
  • A language reference set row for each new description to specify the acceptability of the description within the relevant language or dialect

  • To prepare for publication, a new row representing the concept definition is added to the

    The attributes of the reference set member representing the stated axiom are set as follows:

    • id is set to the new relationship identifier allocated within the extension namespace.

    • effectiveTime is set to the date the extension will be published

    Description

    A description of type of and at least one description of type of is added.

    For more information on creating descriptions, please refer to

    Language reference set

    The new descriptions of the concept are referenced in at least one language refset to indicate language preferences.

    The diagram illustrates how all concepts from Extension B are related to concepts in the International Edition. This is because the concept is either a direct child of a concept in the International Edition or because it is subsumed by concepts in the International Edition through subtype relationships defined by concepts in Extension A.

    Illustration

    Impact on hierarchy

    A primitive extension concept, which is created as a leaf concept, must always be a subtype of an international edition concept, and will not be classified as a supertype of an international concept.

    Impact on subsumption

    The addition of this type of content does not impact subsumption testing of concepts in the international edition, because it will remain distal in the hierarchy to all International content after classification. In this case, the transitive closure of the International Edition will stay the same, except for the addition of the new inferred | is a| relationship associated with the concept from the extension.

    Illustration

    Impact on hierarchy

    The definition of a concept in an extension module may result in it being classified as an intermediate concept in the SNOMED CT polyhierarchy, as illustrated in the diagram above.

    This scenario results in the creation of two new inferred | is a| relationships in the extension, i.e. the relationships G | is a | X and X | is a | E. The inferred relationship G | is a | E (green dotted line), which is present in the international edition, becomes redundant when classified together with the extension (therefore marked grey in the diagram).

    Impact on subsumption

    This type of intermediate extension concept does not change the results of subsumption testing between international concepts. It does, however, have an impact on which relationships from the international edition are non-redundant in the extension edition. In this example, the inferred relationship G |is a| E becomes redundant when combined with the inferred relationships from the extension.

    Extension producers can handle this redundancy by:

    • Inactivating the inferred relationship from the International Edition, i.e. inactivate the relationship G | is a | E. For more information, see Inactivate Relationship in an Extension.

    Illustration

    Impact on hierarchy

    The definition of a concept in an extension module may result in it being classified as an intermediate concept in the SNOMED CT polyhierarchy, as illustrated in the diagram above.

    This scenario results in the creation of three new inferred | is a| relationships in the extension, i.e. the relationships G | is a | X and X | is a | D and X | is a | E. The inferred relationshipG | is a | E (green dotted line), which is present in the international edition, becomes redundant when combined with the inferred relationships from the extension. Furthermore, the definition of the extension concept X results in a modification of the definition of the international concept G, as G is now a subtype of the international concept D.

    Impact on subsumption

    This type of intermediate extension concept may change the results of subsumption testing for particular international concepts, when used within the local edition. Extension producers should therefore exercise extreme caution when introducing this type of concept addition.

    When using the International Edition on its own, the concept G will not be treated as a subtype of the concept D. However, users of this example extension edition will see the international concept G as a subtype of the international concept D. This means that queries over international concepts stored in clinical data will lead to different results, depending on which edition is used. Therefore, intermediate concepts of this type may have serious consequences on the comparability and interoperability across SNOEMD CT Editions.

    Concept

    A new concept identifier is allocated within the extension namespace.

    The attributes of the new concept are set as follows:

    • id is set to the new concept identifier allocated within the extension namespace

    • effectiveTime is set to the date the extension will be published

    • active is set to 1 to indicate that the new concept will be active at the time of publication

    • moduleId is set to the conceptId of a module that is managed by the extension producer

    • definitionStatusId is set to state whether the concept is primitive or fully defined

    Stated Axiom

    Authoring the concept definition involves specifying the defining properties of the concept, i.e. stating the axioms that represent necessary conditions for the meaning of the concept. For more information, see SNOMED CT Logic Profile Specification and SNOMED CT OWL Guide.

    Essential Descriptions and Relationships

    Additional Descriptions and Relationships

    Retaining Referential Integrity

    Leaf and Intermediate Extension Concepts

    For more information about classification please see Classifying an Edition.

    If an extension producer makes any changes or additions within their extension, which result in modification of the transitive closure of the International Edition, they must report this to SNOMED International. This will allow the issue that necessitated the change to be assessed and where appropriate resolved in the Internation Edition.

    Examples

    Process

    Constraints on Concept Requests
    | Is a|
    | Fully specified name|
    | Synonym|
    | Is a|
    SNOMED CT Editorial Guide
    SNOMED CT Machine Readable Concept Model
    module dependencies
    138875005 | SNOMED CT Concept|
    | is a|
    | is a|
    | Fully specified name|
    | Synonym|
    Provide Feedback
    Logical Model Overview
    active is set to '1' to indicate that the new relationship will be active at the time of publication
  • moduleId is set to identify a module concept from the extension

  • referencedComponentId is set to the identifier generated for the new concept

  • owlExpression is set to the text of the OWL expression representing the defining properties of the new concept

  • | Fully specified name|
    | Synonym|
    Add Description in an Extension
    OWL axiom reference set.

    Inactivate Concept in an Extension

    Inactivate Concept in an Extension

    Purpose

    Concepts may be inactivated in an extension for various reasons including:

    • The concept is erroneous, obsolete or out of scope

    • The concept is ambiguous, and must be replaced with one or more concepts whose meaning is clear

    • The concept is redundant, because another concept has the same clinical meaning or definition

    Please note that concepts that are promoted from the extension into the International Edition (or a module on which the extension module depends) are not inactivated in the extension. For more information on concept promotion, please refer to .

    Concepts in an extension can be inactivated if necessary. This is accomplished by creating a new inactive version of the concept, and new inactive versions of any relationships in which that concept participates. This inactivation process is explained in more detail below.

    Concepts which belong to the International Edition (or to a module on which the extension depends) should generally not be inactivated in an extension (please refer to ). Extension producers should submit any requests for inactivation to SNOMED International (or the module owner). In most situations, in which an extension producer needs to exclude specific international concepts in their extension, this should be done by creating a reference set of either the 'included' or 'excluded' concepts. For more information, refer to in the .

    Please note that if a situation arises in which an error is detected in the International Edition that causes inference errors in the extension, then this must be submitted to SNOMED International for correction. If a correction in the International Edition is not available prior to the release of the extension, then the error may be corrected in the Extension Edition, as long as this is reconciled in the next version of the extension that uses the corrected International Release.

    When inactivating a concept in an extension, key steps include:

    • Inactivating the concept

    • Inactivating any relationship in which the inactive concept participates

      • This includes any relationship in which the inactive concept is the source concept, the destination concept or the relationship type

    Please note that active descriptions should not be inactivated when a concept is inactivated. This provides a mechanism to see the terms associated with concepts that have previously been entered into a clinical record, and to support historical queries on data that was captured using a previous version of the terminology.

    The table below provides a summary of the process to follow when inactivating a concept in an extension.

    File Type
    Process

    Representing the reasons for inactivation and possible replacements in the appropriate reference sets

    The attributes of the new version of the concept are set as follows:

    • id is set to the UUID of the reference set member referencing the concept being inactivated

    • effectiveTime is set to the date the extension will be published

    Inferred Relationships File

    An inactive concept does not participate in any active relationships. This means that when inactivating a concept, all active relationships, in which the concept was used as the source, destination or type, must be inactivated. As a result, the inactive concept is removed from the subtype hierarchy, and will no longer have any defining relationships. This reinforces the point that an inactive concept should not be used in any new data entry, as it will not be subsumed by any other concept.

    Concept inactivation indicator reference set

    +

    Historical association reference set

    A new row is added to the , and the relevant to indicate the reason that the concept was inactivated, and to specify any relevant associations with active concepts (e.g. possible replacements for the inactivated concept).

    When inactivating a concept, it is best practice is to specify the reason that the concept was inactivated in the . Please refer to for an example of the , and to for a list of valid inactivation indicator values.

    Additionally, depending on the inactivation reason, a row should be added to the relevant . This helps to support extension consumers with the change management process, by (for example) specifying possible replacements for the inactivated concept. Please refer to for a list of historical association reference sets, and an example of the .

    Please refer to for further information.

    Concept

    A new row representing an inactivated version of the concept is added to the Concept file.

    The attributes of the new version of the concept are set as follows:

    • id is set to the conceptId of the concept being inactivated

    • effectiveTime is set to the date the extension will be published

    • active is set to '0' to indicate that the concept will become inactive at the time of publication

    • moduleId is set to identify a module in the extension

    • definitionStatusId is set to

    Stated Axiom

    Inactivating a concept's active relationships involves adding a new row to the OWL axiom reference set file, which inactivates the member of the reference set representing the stated axiom of the concept being inactivated.

    For more information please refer to Remove Members from a Reference Set.

    Principles

    Inactivating Extension Concepts

    Inactivating International Concepts

    Process

    Concepts should NOT be used for data entry once they have been inactivated. However, inactive concepts should be retained to support historical records entered prior to the inactivation.

    Promotion and Demotion
    Management of Inactivated International Concepts within an Extension
    Practical Guide to Reference Sets
    Provide Feedback
    active is set to '0' to indicate that the reference set member will become inactive at the time of publication
  • moduleId is set to identify a module in the extension

  • referencedComponentId is set to the concept identifier of the concept being inactivated

  • 900000000000074008 | Primitive|
    | Concept inactivation indicator attribute value reference set|
    | Historical association reference set|
    | Historical association reference set|
    | Concept inactivation indicator attribute value reference set|
    | Historical association reference set|
    | REPLACED BY association reference set|
    Attribute Value Reference Set
    Component Inactivation Reference Sets
    Historical Association Reference Sets
    Exclude Content
    Managing Component Inactivation

    Modify-concept-in-an-extension

    Modify Concept in an Extension

    Purpose

    The main reasons for modifying a concept in an extension are:

    • The concept is marked as fully defined, but should be primitive

    • The concept is marked as primitive, but has now been fully defined

    • The concept is inactive but needs to be reactivated

    • The concept is active, but needs to be inactivated (Note - This scenario is described further in .)

    If an extension producer needs to modify the definition of a concept, this will necessitate adding, modifying or inactivating the relationships for which the given concept is the source. For more information, please refer to .

    If an extension producer needs to modify the terms used to describe the concept, this will necessitate adding, modifying or inactivating the descriptions associated with the concept. For more information, please refer to .

    The clinical meaning of each concept in SNOMED CT is permanent, and can not be modified over time. This clinical meaning is captured by the concept's Fully Specified Name. Changing the clinical meaning of a concept therefore requires inactivating the concept, and creating a new concept that represents the new meaning.

    The following changes, however, are permitted:

    • Modifying mutable attribute values, such as definitionStatusId.

    • Adding, modifying or inactivating descriptions, including changing the concept's Fully Specified Name to conform to editorial policy (as long as there is no change in clinical meaning). Please refer to .

    • Changing the way that a clinical meaning is formally defined. This can be done by adding, modifying or inactivating the concept's defining relationships and/or changing the definition status of the concept. Please refer to .

    The attributes of a concept may be modified, as long as the change is limited to the values of its mutable attributes. The values of immutable attributes should never be modified.

    The effectiveTime attribute is used to support the versioning of each concept. Permitted concept modifications therefore include:

    • active : Changing the concept's active attribute from active to inactive, or from inactive to active.

    • definitionStatusId : Changing the concept's definition status from primitive to fully defined, or from fully defined to primitive.

    • moduleId : Changing the concept's module. For example, this may occur when a concept is promoted. Please refer to .

    It should be noted that extensions should not modify the attributes of an international concept, unless this modification is necessary to meet legitimate clinical needs or to correct identified clinical issues. Any new version of an international concept that is created by an extension producer (other than SNOMED International) and which modifies the concept's mutable attributes, should be:

    • Assigned to an extension module (and not an international module) to reflect the fact that the modification was not made by SNOMED International.

    • Submitted to SNOMED International with an explanation as to why the change was necessary.

    The table below provides a summary of the process to follow when modifying a concept in an extension.

    File Type
    Process

    Concept

    A new row, which represents the new version of the concept, is added to the concept file.

    The attributes of the new version of the concept are set as follows:

    • id is set to the conceptId of the concept being modified

    • effectiveTime is set to the date the extension will be published

    • active is set to indicate whether or not the concept is active at the given effective time ('1' for active and '0' for inactive)

    • moduleId is set to the conceptId of a module that is managed by the extension producer

    • definitionStatusId is set to indicate whether the concept is primitive or fully defined

    Principles

    Overview

    Modifying Mutable Attribute Values

    Process

    Inactivate Description in an Extension
    Authoring Relationships
    Authoring Descriptions
    Authoring Descriptions
    Authoring Relationships
    Promotion and Demotion
    Provide Feedback