The Description file holds descriptions that describe

Specref

RefType	file
t	Description

holds

Gloss

Space	true
t	descriptions

that describe

Gloss

Space	true
t	SNOMED CT concepts.

A

Gloss

Space	true
t	description

is used to give meaning to a

Gloss

Space	true
t	concept

and provide well-understood and standard ways of referring to a

Gloss

Space	true
t	concept.

...

Caption label

CapId	description-file-detailed-specification
CapType	Table

Description file - Detailed Specification

Bookmarked content insert

Start	filespec
Page	REUSE:Description File

Only one

Gloss

Space	true
t	description

...

Field

...

Data type

...

Immutable

...

Purpose

...

id

...

SCTID

...

Y

...

Uniquely identifies the description .

...

effectiveTime

...

Time

...

N

...

Specifies the inclusive date at which the component version's state became the then current valid state of the component

...

active

...

Boolean

...

N

...

Specifies whether the description 's state was active or inactive from the nominal release date specified by the effectiveTime .

...

moduleId

...

SCTID

...

N

...

Identifies the description version's module. Set to a child of 900000000000443000 $$ Module $$ within the metadata hierarchy .

...

conceptId

...

SCTID

...

Y

...

Identifies the concept to which this description belongs. Set to an Identifier of a concept in the 138875005 $$ SNOMED CT Concept $$ hierarchy within the Concept file. Note that versions of descriptions and concepts don't belong to each other. Which version of any given description is combined with which version of its owning concept depends on the point in time at which they are accessed.

...

languageCode

...

String

...

Y

...

Specifies the language of the description text using the two character ISO -639-1 code. Note that this specifies a language level only, not a dialect or country code.

...

typeId

...

SCTID

...

Y

...

Identifies whether the description is an FSN, Synonym or other description type. This field is set to a child of 900000000000446008 $$ Description type $$ in the Metadata hierarchy .

...

term

...

String

...

N

...

The description version's text value, represented in UTF-8 encoding.

...

caseSignificanceId

...

SCTID

...

N

...

Identifies the concept enumeration value that represents the case significance of this description version. For example, the term may be completely case sensitive, case insensitive or initial letter case insensitive. This field will be set to a child of 900000000000447004 $$ Case significance $$ within the metadata hierarchy .

Only one description record with the same id field will be current at any point in time. The current record will be the one with the most recent

Specref

RefType	(field)
t	effectiveTime

before or equal to the point in time under consideration.

If the

Gloss

Space	true
t	active

field of this record is false ('0'), then the

Gloss

Space	true
t	description

is

Gloss

Space	true
t	inactive

at that point in time. If the

Gloss

Space	true
t	active

field is true ('1'), then the

Gloss

Space	true
t	description

is associated with the

Gloss

Space	true
t	concept

identified by the conceptId field.

The conceptId field, the languageCode field and the

Specref

RefType	(field)
t	typeId

field will not change between two rows with the same id, in other words they are immutable. Where a change is required to one of these fields, then the current row will be de-activated component will be inactivated (by appending a row with the same id and the

Gloss

Space	true
t	active

field set to false) and a new row with another row will be added representing a new component with a new id will be appended. Only limited changes may be made to the ' term ' field field, as defined by editorial rules.

Each

Gloss

Space	true
t	concept

will have at least one

Gloss

Space	true
t	active description

with a

Specref

RefType	(field)
t	typeId

of | Synonym | for a given languageCode (like "en"

Concept

t	900000000000013009\|synonym\|
ShowFormat	inline

and at least one

Gloss

Space	true
t	active description

with a

Specref

RefType	(field)
t	typeId

of

Concept

t	900000000000003001 \|Fully specified name\|

.

Where a

Gloss

Space	true
t	concept

only has one

Gloss

Space	true
t	active description

with a

Specref

RefType	(field)
t	typeId

of

Concept

t	900000000000003001 \|Fully specified name\|
ShowFormat	inline

across all

Gloss

Space	true
t	language

). Where a concept only has one active description with a typeId of | Fully Specified Name | for a given language code, then that Description can be taken as the Fully Specified Name for that language and each of its dialects, and need not therefore be explicitly included in language reference sets for that language. Where a concept only has one active description with a typeId of | Fully Specified Name | across all language codes within a release, then that

Gloss

Space	true
t	Description

can be taken as the

Gloss

Space	true
t	Fully Specified Name

for all

Gloss

Space	true
t	languages

and

Gloss

Space	true
t	dialects,

and need not therefore be explicitly included in any language reference sets in every

Gloss

Space	true
t	language

Gloss

Space	true
t	reference set

associated with that release.

The Term

Specref

RefType	(field)
t	term

field will be restricted as follows:

to an overall maximum length of 32Kb;
to a maximum length, configurable for each
Gloss
Space true
t description type
(
as defined
by the Description Type reference set
in the
Concept
t 900000000000538005 |Description format reference set|
ShowFormat inline
member associated with that
Gloss
t description type
- see
the " SNOMED CT Release Format 2 -
the Description Format Reference Set
Specifications"
specifications document for more details
);
.
The
Concept
t 900000000000538005 |Description format reference set|
ShowFormat inline
also defined the format of the term field (plain text, limited HTML, XHTML
, DITA
)
will also be configurable
for each
Gloss
t description type
, using the same mechanism as above;
.
Control characters (including TABs, CRs and LFs) will not appear in
Concept
t 900000000000540000 |Plain text|
and
ShowFormat inline
or
Concept
t 900000000000541001 |Limited HTML|
format
format types.

Search

Versions Compared

Old Version 1

New Version Current

Key

Related Links

Search

Page History

Versions Compared

Old Version 1

New Version Current

Key

Related Links