SNOMED Documentation Search


 Other Documents
Skip to end of metadata
Go to start of metadata

Current Version - Under Revision

Add new concepts for each of the Reference Set member attributes, if necessary. If the Reference Set attributes describing the pattern are adequate to describe the Reference Set 's attributes, then these can be used instead, and you can skip to the next section.

You may wish to create your own Reference Set attributes for one of the following reasons:

  • You wish to give one or more of the attributes a different name than that of the pattern;
  • You wish to make the purpose of a particular attribute more explicit in the metadata;
  • You wish to limit the set of allowed values for one or more of the attributes;
  • You wish to make the type of one or more of the attributes more specific than that given in the pattern.

You may add new concepts for some of the attributes, and reuse existing concepts for other attributes, if you wish.

For each attribute that you wish to create, first add a concept :

Table 92. Reference Set Management Example - Add Reference Set Concept

 

 

Field

Data type

Value

id

SCTID

A unique id in your namespace .

effectiveTime

Time

The nominal date of release for your reference set .

active

Boolean

'1'

moduleId

SCTID

The module Identifier for your authoring organization .

Then, link it with an |is a| Relationship into the | Reference set attribute | metadata hierarchy .

Table 93. Reference Set Management Example - Link to Metadata Hierarchy

 

 

Field

Data type

Value

id

SCTID

A unique id in your namespace .

effectiveTime

Time

The nominal date of release for your reference set .

active

Boolean

'1'

moduleId

SCTID

The module Identifier for your authoring organization .

sourceId

SCTID

The Identifier of the concept describing the Reference set attribute that you've just added.

destinationId

SCTID

|Reference set attribute|

relationshipGroup

Integer

'0'

typeId

SCTID

|is a|

characteristicTypeId

SCTID

|Stated relationship|

Then, add up to three Descriptions (for FSN, Preferred Term and optionally Purpose) for each of the new attributes:

Table 94. Reference Set Management Example - Add Descriptions

 

 

Field

Data type

Value

Id

SCTID

A unique id in your namespace .

effectiveTime

Time

The nominal date of release for your reference set .

active

Boolean

'1'

moduleId

SCTID

The module Identifier for your authoring organization .

conceptId

SCTID

The Identifier of the concept describing the attribute that you've just added.

languageCode

String

The language of the Description .

typeId

SCTID

Create up to three Descriptions for each new attribute, with the following types: |Fully specified name| , |Synonym| , |Purpose| . The first two are mandatory, the third is optional.

term

String

Terms for the |Fully specified name| , a |Synonym| and the |Purpose| . The |Synonym| will be the string used to commonly refer to the attribute (and therefore should appear as a column header in tables showing the Reference Set member records).

If any of the Reference Set member attributes are to be limited to a range of values, then add a concept for each allowed value in the range, and link the concept using an |Is a| relationship to the member attribute. Then add two Descriptions for the FSN and Preferred Term of each allowed attribute value .

In order to limit the range of an attribute, it must have a type of | Concept type component| (as held in the attributeType field of the Descriptor - see the next section).

For each allowed value that an attribute can take, add a concept :

Table 95. Reference Set Management Example - Add Allowed Attribute Value Concept

 

 

Field

Data type

Value

id

SCTID

A unique id in your namespace .

effectiveTime

Time

The nominal date of release for your reference set .

active

Boolean

'1'

moduleId

SCTID

The module Identifier for your authoring organization .

Then, link it with an |is a| Relationship into the attribute that you've just added in the |Reference set attribute| metadata hierarchy .

Table 96. Reference Set Management Example - Link Allowed Attribute Value to Metadata

 

 

Field

Data type

Value

id

SCTID

A unique id in your namespace .

effectiveTime

Time

The nominal date of release for your reference set .

active

Boolean

'1'

moduleId

SCTID

The module Identifier for your authoring organization .

sourceId

SCTID

The Identifier of the concept describing the allowed attribute value that you've just added.

destinationId

SCTID

The Identifier of the concept describing the attribute that you've just added.

relationshipGroup

Integer

'0'

typeId

SCTID

|is a|

characteristicTypeId

SCTID

|Stated relationship|

And finally, add two Descriptions for the allowed attribute value concept :

Table 97. Reference Set Management Example - Add Description for Allowed Attribute Value

 

 

Field

Data type

Value

Id

SCTID

A unique id in your namespace .

effectiveTime

Time

The nominal date of release for your reference set .

active

Boolean

'1'

moduleId

SCTID

The module Identifier for your authoring organization .

conceptId

SCTID

The Identifier of the concept describing the allowed attribute value that you've just added.

languageCode

String

The language of the Description .

typeId

SCTID

Create two descriptions , with each of the following types:

FSN

,

Synonym

term

String

Terms for the |Fully specified name| and a |Synonym| . The |Synonym| will be the string used to commonly refer to the allowed attribute value (and therefore should be the one shown in pick lists used when maintaining Reference Set member records).


Feedback