Purpose
The | Module dependency reference set| represents dependencies between different SNOMED CT release modules. In each case, the dependency indicates which targetEffectiveTime of each particular module a given sourceEffectiveTime of the dependent module requires.
Data structure
The 900000000000534007 | Module dependency reference set| is a String - String reference set which is used to represent dependencies between modules, taking account of module versioning. Its structure is shown in the following table.
Field | Data type | Purpose | Part of Primary Key | |
id | A 128 bit unsigned Integer, uniquely identifying this reference set member. Different versions of a reference set member share the same id but have different effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.
| NO | YES (Full /Snapshot) | |
The inclusive date or time at which this version of the identified reference set member became the current version. Note: In distribution files the effectiveTime should follow the short ISO date format (YYYYMMDD) and should not include the hours, minutes, seconds or timezone indicator. The current version of this reference set member at time T is the version with the most recent effectiveTime prior to or equal to time T .
| YES | YES (Full) Optional (Snapshot) | ||
The state of the identified reference set member as at the specified effectiveTime . If active = 1 (true) the reference set member is part of the current version of the set, if active = 0 (false) the reference set member is not part of the current version of the set. Note: A module dependency should only be inactivated if it is found to be erroneous.
| YES | NO | ||
Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime . The value must be a subtype of 900000000000443000 | Module (core metadata concept)| within the metadata hierarchy. The moduleId for in the Module Dependency Reference Set represents the source module (i.e. the module declaring a dependency on another module). Note: In all other situations moduleId is mutable. However, in the Module Dependency Reference Set a change to the moduleId would also change the source of the dependency. Therefore, it should not be treated as mutable.
| YES | NO | ||
Identifies the reference set to which this reference set member belongs.
In this case, always 900000000000534007 | Module dependency reference set| as there is only one Module Dependency Reference set.
| NO | NO | ||
A reference to the SNOMED CT component to be included in the reference set. This refers to the target of the dependency (i.e. the module on which the module identified by moduleId depends). | NO | NO | ||
The effective time of the dependent source module (identified by moduleId). This specifies a version of that module, consisting of all components that have the same moduleId as this refset member in their states as at the specified targetEffectiveTime . | YES | NO | ||
The effective time of the target module required to satisfy the dependency (identified by referencedComponentId). This specifies a version of that module, consisting of all components with the moduleId specified by referencedComponentId in their states as at the specified targetEffectiveTime . | YES | NO |
Rules and Guidance
Introduction to Modules
Each row in the release files for components and reference set members has a moduleId. This refers to the module that the component is maintained in. Each module is either part of the SNOMED International Release or part of a single SNOMED CT Extension . The moduleId has a partition-id which indicates whether it is part of the SNOMED International Release and, if not, its namespace identifier indicates the SNOMED CT Extension that it belongs to.
A module is simply a collection of SNOMED CT components maintained as a unit by a single organization. It is the organization 's responsibility to organize the components in each extension that it is responsible for into one or more modules, in a way that best fits its business needs.
A module is represented by a descendant of 900000000000443000 | Module| in the metadata hierarchy. The immediate subtype descendants of 900000000000443000 | Module| represent groups of modules maintained by an organization and subtypes of these can be used to arrange that organizations modules into a number of groups. For example, all modules maintained by SNOMED International will be children of 900000000000445007 | SNOMED International maintained module| .
At any point in time a component must be in one, and only one module. It is possible for components and reference set members to be moved between modules (subject to constraints explained elsewhere). In this case, a new row is added to the release file with the same id but with a new effectiveTime and a new moduleId.
Introduction to Module Dependencies
Each extension must include one or more modules. Each module must be part of either the SNOMED International Release or one and only one extension. A module may not move from one extension to another over time. If components or reference set members in a module are to be moved from an extension to the SNOMED International Release or to another extension, they must either be added to an existing or newly created module maintained by the destination organization.
The 900000000000443000 | Module| sub-hierarchy does NOT represent dependencies between module. Instead, module dependencies are modeled using the 900000000000534007 | Module dependency reference set| .
At the point of release, if any component within a module has changed, then a new row must be added to the | Module dependency reference set| for each dependency of that module. The effectiveTime of the added rows must set to the date of the new release. The updated | Module dependency reference set| records indicate that some components within the module have been updated in this release. If there have been no additions, updates or inactivations of components or reference set members within a module, then a new | Module dependency reference set| records need not be added unless there is a requirement to declare that the unchanged module is compatible with a later release of the module(s) on which it dependents.
Identifying and Versioning Module Dependencies
id
The recommended practice is for the refset.id column to contain the same identifier for all versions of the dependencies between the same pair of modules. This approach means that at any given time only one version of each module has effective dependencies. The dependencies of earlier versions can be reviewed by reviewing a snapshot for the effectiveTime of the earlier release.
Value of the id column
An alternative approach has been suggested by some people in which a new identifier is allocated to each dependency of each module. This would then mean that all past dependencies would be visible in a snapshot view. It would also mean that it would be possible release updated dependencies for an existing module version while also releasing more up-to-date versions of the same module with different dependencies. This added flexibility comes at the price of additional complexity and for the time-being the International Release modules continue to use the simpler approach in which each new version of a dependency supersedes the dependency between earlier versions of the same pair of modules.
effectiveTime
The effectiveTime of at least one row for each pair of modules should be the same as the sourceEffectiveTime. Otherwise, there will be a period of time when a snapshot view will not show the dependencies. However, it is theoretically possible for an additional row to be added with a later effectiveTime in cases where an otherwise unchanged release of an extension, declares itself to be compatible with an updated release of the target module (in this case the effectiveTime and targetEffectiveTime are changed but the sourceEffectiveTime remains unchanged.
active
A module dependency only needs to be inactivated if the dependency is found to be erroneous. This is because, the module dependency is specific to a particular version of the source and target module. Therefore, if that dependency was valid at the outset it remains valid indefinitely in respect of those specified module versions, even if the dependencies between subsequent versions differ.
refsetId
Module version dependencies are represented using a single 900000000000534007 | Module dependency reference set| . Thus all module dependency rows have the same refsetId ( 900000000000534007 | Module dependency reference set (foundation metadata concept)| ).
It is the responsibility of the organization owning and maintaining a dependent module to identify all modules on which it depends. They do this by adding rows to the 900000000000534007 | Module dependency reference set| within the dependent module. Because these added member must be in the dependent module, the moduleId of the reference set member record is also the identifier of the dependent (source) module.
Module Identification
Source Module (moduleId)
The moduleId column not only indicates that this reference set member is in the specified module, it also indicates that this is the module that is the source of the dependency. As a result, in this reference set the moduleId column is immutable (i.e Mutable=NO). This is an exception to the usual rule and implies that a member of this reference set cannot move from one module to another.
Target Module (referencedComponentId)
The target module on which the source module depends is identified by the referencedComponentId. Like the source module this is also immutable and this implies that if a module ceases to be dependent on another module, a new row inactivating the dependency can be added but the same member cannot be used to represent a different dependency (even if that dependency is a direct replacement of the inactivated dependency). However as noted above,
A module version may depend on one or more other module versions, and many module versions may have a dependency on a single module version. Cyclic module version dependencies are not allowed. If module-A depends on module-B, then module-B cannot depend on module-A.
Dependencies are not transitive and this means that dependencies cannot be inferred from a chain of dependencies. If module-A depends on module-B and module-B depends on module-C, the dependency of module-A on module-C must still be stated explicitly.
Any release should consist of a set of module versions that are certified as being compatible. Each release should also identify other module versions that it is dependent on even when these are outside the scope of the release. For example, the dependencies of modules in an Extension on the International Release must be stated.
Dependencies are specified between module versions, not just dependencies between modules. Therefore, it is possible to specify a dependency from a module released on one date to an earlier version of another module. The version of the dependent module is specified by the sourceEffectiveTime and the version of the module on which it depends is specified by the targetEffectiveTime.
Metadata
The following metadata in the "Foundation metadata concept " hierarchy supports this reference set :
Reference Set Descriptor and Example Data
Notes on the tables used to show descriptors and examples
The reference set example tables on this page have been revised as follows to aid clarity and understanding:
- The first four columns which are present in all release files are not shown. The omitted columns (id, effectiveTime, active, moduleId) are used in the same way in all referenced sets to support identification, versioning and packaging. They do not directly affect the specific features of a particular reference set or reference set type.
- Reference set columns that contain SNOMED CT identifiers are expanded to show details of the concept or description referenced by that identifier. In some cases, the term is shown in the same column using the expression syntax, in other cases an additional column with a name suffix '_term' has been added. In the standard reference set files only the identifier is present in the column and there is no added column for the term. When using reference sets, the term and other details of the component are looked up from the relevant component release files.
Descriptor
The table below shows the descriptor that defines the structure of the 900000000000534007 | Module dependency reference set| .
refsetId | referencedComponentId (Referenced component) | attributeDescription (Attribute description) | attributeType (Attribute type) | attributeOrder (Attribute order) | |
|---|---|---|---|---|---|
0 | |||||
1 | |||||
2 |
Note: The table above omits the initial four columns of data present in the release file. These follow the standards versioning pattern id, effectiveTime, active, active. Additionally, to aid understanding, the table above also shows the term from one of the descriptions associated with each of the identified concept. The release file only contains the identifier.
Example Data
Example The table below holds example entries for the 900000000000534007 | Module dependency reference set| in a snapshot view of the January 2014 SNOMED CT International Release .
This SNOMED CT International Release contains three modules:
- 900000000000012004 | SNOMED CT model component| which has no dependencies;
- 900000000000207008 | SNOMED CT core| which depends on the 900000000000012004 | SNOMED CT model component| ; and
- 449080006 | SNOMED CT to ICD-10 rule-based mapping module| which depends on both the other modules.
In this case all the 2014-01-31 modules depend on 2014-01-31 versions of the other modules. However, in some case a module may depend on an earlier version of another model (e.g. an extension module may be releases after the SNOMED CT International Release to which it applies).
Dependencies are not transitive. The fact that 449080006 | SNOMED CT to ICD-10 rule-based mapping module| is dependent on 900000000000207008 | SNOMED CT core| may seem to imply a dependency on 900000000000012004 | SNOMED CT model component| . However, in practice all dependencies must be explicitly specified, not just immediate dependencies.
moduleId | refsetId | referencedComponentId (Dependency target) | sourceEffectiveTime (Source effective time) | targetEffectiveTime (Target effective time) |
|---|---|---|---|---|
20140131 | 20140131 | |||
20140131 | 20140131 | |||
20140131 | 20140131 |
Feedback
Overview
Content Tools
Apps