All pages
Powered by GitBook
1 of 4

Loading...

Loading...

Loading...

Loading...

Add Members to a Reference Set

Purpose

Reference set members can be added within an extension for a variety of reasons, including:

  • To add members to a subset in the extension that is used nationally or locally

  • To adapt a reference set created by another organization, by adding new members that are required nationally or locally

Principles

Specifying members of a reference set can be done in different ways. It will depend on the requirements for the reference set what approach is feasible and possible. Please refer to the Practical Guide to Reference Sets for detailed instructions on the and for identifying the SNOMED CT components that will be referenced by the members of the reference set.

However, each reference set member will be represented in the reference set in accordance with the following principles and process.

Reference set members may be added to reference sets belonging to modules in

  • The producers extension

  • The International Edition

  • Other extensions (which the producers extension modules are dependent on)

Reference set members created in the extension should be created within the module of the extension producer, so that it is possible to distinguish the reference set members created within the producers extension from reference set members created by other organisations (i.e. belonging to other modules).

Even though the individual reference set members belong to the module of the extension producer, the actual components that are referenced by the reference set member, may belong to modules in

  • The International Edition

  • The extension in which the reference set and its members are produced

  • Other extensions (which the producers extension modules are dependent on)

The table below provides a summary of the process to follow when adding members to a reference set.

File Type
Process

Attributes specific to the reference set type are set. For more information, please refer to the .

Reference Set

A new refset row is created with a unique id. The data type for this id is UUID and the id can be generated using a UUID generator. Note that a namespace identifier will not be part of this id.

Versioning and module identification attributes are set accordingly:

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

  • active is set to reflect the status of the reference set member, i.e. 1 for active

  • moduleId is set to identify a module concept managed by the extension producer

Attributes common for all reference set types are set accordingly:

  • refsetId is set to the identifier of the concept used to identify and name the reference set. Note, the value of refsetId will be the same for all members in the reference set

  • referencedComponentId is set to the identifier of the SNOMED CT component or reference set, which is referenced by this specific reference set member

Referenced Components

Process

Provide Feedback

Modify Members of a Reference Set

Purpose

There are a number of reasons for modifying members of a reference set in an extension (depending on the type of reference set), including:

  • Updating map records to

    • Refine map rules or map advice

    • Change the target of a map

  • Changing the acceptability of a description in a language reference set

  • Changing the order of subset members specified in an

Principles for modifying reference sets include:

  • Reference sets can be modified by

    • Adding or inactivating reference set members. Please refer to the guidance on or .

    • Modifying mutable attribute values of reference set members. To see what attributes are mutable for each reference set type, please refer to the specification of the specific reference set type in the . If the reference set type is a locally defined reference set, please consider any mutability constraints on the individual attributes.

The table below provides a summary of the process to follow when modifying an existing member in a Reference Set.

Table: Modify reference set member

File Type
Process

Don't modify immutable attributes of a reference set.

  • In the case where the modification of an immutable attribute is required, this should be done by inactivating the reference set member and creating a new reference set member with the required, updated values.

  • If circumstances require you to modify reference set members that belong to another module than the producers extension, following options exist:

    • Inactivating the specific reference set member in your own module and create a new reference set member with the updated value

      • The benefit of this approach is that you retain the definition and representation of the reference set member as it was intended by its original authors, and the new reference set member will be easily identified as a local reference set member, as the identifier of that reference set member is not available in the original reference set

    • Create a new version of the specific reference set member in your own module, and make the necessary modifications

  • Attributes common for all reference set types are set accordingly:

    • refsetId is retained as the value from the previous version of this refset member. A member cannot move from one reference set to another

    • referencedComponentId id retained as the value from the previous version of this refset member. A member cannot change the component which it refers to.

    Attributes specific to the reference set type are set accordingly:

    • additional attributes - may be updated with a value, of type (and possibly range) limited by the descriptor record for this Reference Set attribute

    Concept

    The metadata concept representing the reference set is retained

    Reference Set

    A new reference set row is created and the id is retained from the previous version of the refset member.

    Versioning and module identification attributes are set accordingly:

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

    • active is set to reflect the status of the reference set member, i.e. '1' for active and '0 'for inactive

    • moduleId is set to identify a module managed by the extension producer

    Principles

    Process

    | Ordered type reference set|
    Provide Feedback

    In this case, the existing member record should be inactivated, and a new one created.

    release file specification
    authoring
    methods
    Add Members to a Reference Set
    Remove Members from a Reference Set
    reference set release files specification

    Remove Members from a Reference set

    Purpose

    Reference set members may be inactivated when

    • The reference set member is no longer relevant or valid in the reference set in which it is being used

    • The reference set to which the reference set member belongs is inactivated

    Principles

    Any inactivation of reference set members should be done in the module of the reference set producer.

    Process

    The table below provides a summary of the process to follow when removing members from a reference set.

    File Type
    Process

    Reference Set

    The following steps should be taken to inactivate a reference set member

    Create a new version of the reference set member to be inactivated.

    Versioning and module identification attributes are set accordingly:

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

    • active is set to reflect the status of the reference set member, i.e. 0 for inactive

    • moduleId is set to identify a module managed by the extension producer

    All other attribute values are retained.

    Provide Feedback

    Authoring Reference Set Members

    Reference set members may also be added, modified or inactivated in an extension, to meet evolving requirements.

    The sections that follow will examine the purpose, principles and process for each of these authoring tasks.

    Provide Feedback