Search



Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Description file holds that describe . A is used to give meaning to a and provide well-understood and standard ways of referring to a .

...

Specref
RefTypefile
tDescription
holds
Gloss
Spacetrue
tdescriptions
that describe
Gloss
Spacetrue
tSNOMED CT concepts.
A
Gloss
Spacetrue
tdescription
is used to give meaning to a
Gloss
Spacetrue
tconcept
and provide well-understood and standard ways of referring to a
Gloss
Spacetrue
tconcept.

Caption label
CapIddescription-file-detailed-specification
CapTypeTable
Description file - Detailed Specification

Bookmarked content insert
Startfilespec
PageREUSE:Description File

Only one

Gloss
Spacetrue
tdescription

...

 

...

 

...

 

...

Field

...

Data type

...

Immutable

...

Purpose

...

id

...

SCTID (data type)

...

Y

...

Uniquely identifies the .

...

effectiveTime (field)

...

Time (data type)

...

N

...

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

...

active (field)

...

Boolean (data type)

...

N

...

Specifies whether the 's state was or from the nominal release date specified by the effectiveTime (field) .

...

moduleId (field)

...

SCTID (data type)

...

N

...

Identifies the version's module. Set to a of

Scg expression
ShowPartsid+term
900000000000443000|Module|
within the metadata .

...

conceptId

...

SCTID (data type)

...

Y

...

Identifies the to which this belongs. Set to an of a in the

Scg expression
ShowPartsid+term
138875005|SNOMED CT Concept|
within the Concept file. Note that versions of and don't belong to each other. Which version of any given is combined with which version of its owning depends on the point in time at which they are accessed.

...

languageCode

...

String (data type)

...

Y

...

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

...

typeId (field)

...

SCTID (data type)

...

Y

...

Identifies whether the is an FSN, or other type. This field is set to a of

Scg expression
ShowPartsid+term
900000000000446008|Description type|
in the Metadata .

...

term

...

String (data type)

...

N

...

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

...

caseSignificanceId (field)

...

SCTID (data type)

...

N

...

Identifies the enumeration value that represents the case significance of this version. For example, the term may be completely case sensitive, case insensitive or initial letter case insensitive. This field will be set to a of

Scg expression
ShowPartsid+term
900000000000447004|Case significance|
within the metadata .

Only one 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 effectiveTime

Specref
RefType(field)
teffectiveTime
before or equal to the point in time under consideration.

If the

Gloss
Spacetrue
tactive
field of this record is false ('0'), then the
Gloss
Spacetrue
tdescription
is
Gloss
Spacetrue
tinactive
at that point in time. If the
Gloss
Spacetrue
tactive
field is true ('1'), then the
Gloss
Spacetrue
tdescription
is associated with the
Gloss
Spacetrue
tconcept
identified by the conceptId field.

The conceptId field, the languageCode field and the typeId

Specref
RefType(field)
ttypeId
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
Spacetrue
tactive
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
Spacetrue
tconcept
will have at least one
Gloss
Spacetrue
tactive description
with a typeId
Specref
RefType(field)
ttypeId
of
Concept
t900000000000013009|
| for a given languageCode (like "en"). Where a only has one with a typeId (field) of | | for a given code, then that can be taken as
synonym|
ShowFormatinline
and at least one
Gloss
Spacetrue
tactive description
with a 
Specref
RefType(field)
ttypeId
 of
Concept
t900000000000003001 |Fully specified name|
.

Where a

Gloss
Spacetrue
tconcept
only has one
Gloss
Spacetrue
tactive description
with a
Specref
RefType(field)
ttypeId
of
Concept
t900000000000003001 |Fully specified name|
ShowFormatinline
across all
Gloss
Spacetrue
tlanguage
the for that and each of its , and need not therefore be explicitly included in for that . Where a only has one with a typeId (field) of | | across all codes within a release, then that
Gloss
Spacetrue
tDescription
can be taken as the
Gloss
Spacetrue
tFully Specified Name
for all
Gloss
Spacetrue
tlanguages
and
Gloss
Spacetrue
tdialects,
and need not therefore be explicitly included in any in every
Gloss
Spacetrue
tlanguage
Gloss
Spacetrue
treference set
associated with that release.

The term

Specref
RefType(field)
tterm
field will be restricted as follows:

  • to an overall maximum length of 32Kb;
  • to a maximum length, configurable for each

    type (

    Gloss
    Spacetrue
    tdescription type
    as defined

    by the Type

    in the

    Concept
    t900000000000538005 |Description format reference set|
    ShowFormatinline
    member associated with that
    Gloss
    tdescription type
    - see

    the " - Specifications"

    the  Description Format Reference Set specifications document for more details

    );

    .

  • The

    Concept
    t900000000000538005 |Description format reference set|
    ShowFormatinline
    also defined the format of the term field (plain text, limited HTML, XHTML

    ,

    )

    will also be configurable

    for each

    type, using the same mechanism as above;

    Gloss
    tdescription type.

  • Control characters (including TABs, CRs and LFs) will not appear in

    Concept
    t900000000000540000 |Plain text|

    and

    ShowFormatinline
    or
    Concept
    t900000000000541001 |Limited HTML|

    format

     format types.

Related Links

Scroll Pagebreak