All pages
Powered by GitBook
1 of 3

Loading...

Loading...

Loading...

Language Reference Set

Language Reference Set

Whenever a new description is added in an extension, the language preferences associated with that description must be specified. This is done by adding rows to a language reference set to indicate whether each description is | acceptable| or | preferred| in the given language or dialect.

Attributes

As previously mentioned, all reference sets use six common attributes. In addition to these, a | Language type reference set| also includes an acceptabilityId. The table below explains how each of these attributes is populated in a | Language type reference set| .

Table: Summary of language reference set attributes

Attribute
Data Type
Use in a Language Reference Set

In the image below, two rows from the are shown. Note that these rows specify French Canadian language preferences for the concept .

Please note the following:

  • The id column shows a UUID that has been uniquely generated for each refset member.

  • The moduleId indicates that these refset members belong to the .

  • The refsetId indicates that both members are part of the .

Identifies the module to which this reference set member belongs. For members in an extension, this will always be a module created by the extension producer.

refsetId

SCTID

This refers to the concept id of a descendant of [

referencedComponentId

SCTID

The referencedComponentId refers to the id of the description whose acceptability is being defined.

acceptabilityId

SCTID

The acceptabilityId indicates whether the description referenced by the referencedComponentId is [

The referencedComponentId indicates the description for which the acceptability is being specified.
  • The acceptabilityId indicates that both of these descriptions are | Preferred| in this language.

  • id

    UUID

    Can be generated using a standard UUID generator.

    effectiveTime

    Time

    Specifies the date on which this version of the reference set member was released.

    active

    Boolean

    Indicates whether or not the reference set member is active at the given effectiveTime. This value is set to "1" for new reference set members.

    moduleId

    Example

    20581000087109 | Canada French language reference set|
    | Herpes labialis|
    | Canada Health Infoway French module|
    | Canada French language reference set|
    Provide Feedback
    Rows from the |Canada French language reference set

    SCTID

    Module Dependency Reference Set

    Module Dependency Reference Set

    Every extension must contain at least one module, which is used to organize the extension content. The dependencies that the extension modules have on other modules (including on the | SNOMED CT core module| and the | SNOMED CT model component module| ) must be specified in the extension. This is done by adding new members to the | Module dependency reference set| . Each new versioned release of the extension requires a new version to be created for each extension member of the | Module dependency reference set| .

    Attributes

    As previously mentioned, all reference sets use six common attributes. In addition to these, a | Module dependency reference set| also includes a sourceEffectiveTime and targetEffectiveTime. The table below explains how each of these attributes is populated in a | Module dependency reference set| .

    Table: Summary of module dependency reference set attributes

    Attribute
    Data Type
    Use in a Module Dependency Reference Set

    The table below shows three rows from the in the 20170301 US Edition of SNOMED CT. Please note that the SCTIDs in the moduleId and referenceComponentId columns have been replaced with their preferred terms for improved readability.

    Table: Module dependency reference set rows

    id
    effectiveTime
    active
    moduleId
    refsetId
    referencedComponentId
    sourceEffectiveTime
    targetEffectiveTime

    Please note the following:

    • The first row states that the 20170731 version of the source module is dependant on the 20170731 version of the target module .

    • The second row states that the 20170901 version of the source module is dependant on the 20170731 version of the target module .

    • The third row states that the 20170901 version of the source module is dependant on the 20170731 version of the

    Identifies the module to which this reference set member belongs to. In the , this also represents the moduleId of the dependent module (which is the source of the dependency). The module dependencies are therefore always specified within the dependent module. This ensures that anyone who has access to an extension module can access the relevant dependencies.

    refsetId

    SCTID

    In a , this always refers to the concept . All module dependencies are included in this common reference set.

    referencedComponentId

    SCTID

    The referencedComponentId specifies the module that is the target of the dependency. The value of this attribute is the id of the module on which the source module (referred to by the moduleId attribute) is dependent.

    sourceEffectiveTime

    Time

    Specifies the version of the dependent module (referred to by the moduleId attribute) for which the dependency applies. The snapshot view of the dependent module at the given sourceEffectiveTime represents the state of the terminology in which the dependency applies.

    targetEffectiveTime

    Time

    Specifies the version of the target module (referred to by the referencedComponentId attribute) on which the dependent module depends. The snapshot view of the target module at the given targetEffectiveTime represents the state of the terminology in which the dependency applies.

    900000000000534007

    20170731

    20170731

    5e28836d-1647-5e4c-8345-181f8696f0c4

    20170901

    1

    900000000000534007

    20170901

    20170731

    c4f97804-9fb2-52a8-8772-987e6db9c372

    20170901

    1

    900000000000534007

    20170901

    20170731

    target module
    . Note that this is an example of a transitive dependency that must be explicitly stated.

    id

    UUID

    Can be generated using a standard UUID generator.

    effectiveTime

    Time

    Specifies the date on which this version of the reference set member was released.

    active

    Boolean

    Indicates whether or not the reference set member is active at the given effectiveTime. This value is set to "1" for new reference set members.

    moduleId

    1244116f-fdb5-5645-afcc-5281288409da

    20170731

    Example

    | Module dependency reference set|
    | SNOMED CT core module|
    | SNOMED CT model component module|
    | US National Library of Medicine maintained module|
    | SNOMED CT core module|
    | US National Library of Medicine maintained module|
    Provide Feedback

    SCTID

    1

    | SNOMED CT model component module|
    | Module dependency reference set|
    | Module dependency reference set|
    | Module dependency reference set|
    900000000000207008 | SNOMED CT core module|
    900000000000012004 | SNOMED CT model component module|
    731000124108 | US National Library of Medicine maintained module|
    900000000000207008 | SNOMED CT core module|
    731000124108 | US National Library of Medicine maintained module|
    900000000000012004 | SNOMED CT model component module|

    Essential Reference Sets

    All extensions must specify their extension module dependencies and language preferences. In this section, we describe the essential reference sets that support this.

    • Language Reference Set

    • Module Dependency Reference Set

    Provide Feedback