SNOMED Documentation Search


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

Current Version - Under Revision

Add new

$gterm

for each of the

$gterm

member attributes, if necessary. If the

$gterm

attributes describing the pattern are adequate to describe the

$gterm

's attributes, then these can be used instead, and you can skip to the next section.

You may wish to create your own

$gterm

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

$gterm

for some of the attributes, and reuse existing

$gterm

for other attributes, if you wish.

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

$gterm

:

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

 

 

Field

Data type

Value

id

SCTID

A unique id in your

$gterm

.

effectiveTime

Time

The nominal date of release for your

$gterm

.

active

Boolean

'1'

moduleId

SCTID

The module

$gterm

for your authoring organization .

Then, link it with an |is a|

$gterm

into the |

$gterm

attribute | metadata

$gterm

.

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

 

 

Field

Data type

Value

id

SCTID

A unique id in your

$gterm

.

effectiveTime

Time

The nominal date of release for your

$gterm

.

active

Boolean

'1'

moduleId

SCTID

The module

$gterm

for your authoring organization .

sourceId

SCTID

The

$gterm

of the

$gterm

describing the

$gterm

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

$gterm

(for FSN,

$gterm

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

$gterm

.

effectiveTime

Time

The nominal date of release for your

$gterm

.

active

Boolean

'1'

moduleId

SCTID

The module

$gterm

for your authoring organization .

conceptId

SCTID

The

$gterm

of the

$gterm

describing the attribute that you've just added.

languageCode

String

The

$gterm

of the

$gterm

.

typeId

SCTID

Create up to three

$gterm

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

$gterm

member records).

If any of the

$gterm

member attributes are to be limited to a range of values, then add a

$gterm

for each allowed value in the range, and link the

$gterm

using an |Is a|

$gterm

to the member attribute. Then add two

$gterm

for the FSN and

$gterm

of each allowed

$gterm

.

In order to limit the range of an attribute, it must have a type of |

$gterm

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

$gterm

:

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

 

 

Field

Data type

Value

id

SCTID

A unique id in your

$gterm

.

effectiveTime

Time

The nominal date of release for your

$gterm

.

active

Boolean

'1'

moduleId

SCTID

The module

$gterm

for your authoring organization .

Then, link it with an |is a|

$gterm

into the attribute that you've just added in the |Reference set attribute| metadata

$gterm

.

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

 

 

Field

Data type

Value

id

SCTID

A unique id in your

$gterm

.

effectiveTime

Time

The nominal date of release for your

$gterm

.

active

Boolean

'1'

moduleId

SCTID

The module

$gterm

for your authoring organization .

sourceId

SCTID

The

$gterm

of the

$gterm

describing the allowed

$gterm

that you've just added.

destinationId

SCTID

The

$gterm

of the

$gterm

describing the attribute that you've just added.

relationshipGroup

Integer

'0'

typeId

SCTID

|is a|

characteristicTypeId

SCTID

|Stated relationship|

And finally, add two

$gterm

for the allowed

$gterm

$gterm

:

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

 

 

Field

Data type

Value

Id

SCTID

A unique id in your

$gterm

.

effectiveTime

Time

The nominal date of release for your

$gterm

.

active

Boolean

'1'

moduleId

SCTID

The module

$gterm

for your authoring organization .

conceptId

SCTID

The

$gterm

of the

$gterm

describing the allowed

$gterm

that you've just added.

languageCode

String

The

$gterm

of the

$gterm

.

typeId

SCTID

Create two

$gterm

, with each of the following types:

FSN

,

$gterm

term

String

Terms for the |Fully specified name| and a |Synonym| . The |Synonym| will be the string used to commonly refer to the allowed

$gterm

(and therefore should be the one shown in pick lists used when maintaining

$gterm

member records).


Feedback