Search



Versions Compared

Key

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

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

Anchor
_7213135f-1166-4316-abc6-8ee175446270__f
_7213135f-1166-4316-abc6-8ee175446270__f
Table 10. Description file - Detailed Specification

 

 

 

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

wasorfrom the nominal release date specified by the effectiveTime (field) .

moduleId (field)

SCTID (data type)

N

Identifies

the version

theversion's module. Set to

a of

aof

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

conceptId

SCTID (data type)

Y

Identifies

the to

theto which

this belongs

thisbelongs. Set to

an of a in

anof ain the

Scg expression
ShowPartsid+term
138875005|SNOMED CT Concept|
within the Concept file. Note that versions

of and don

ofanddon't belong to each other. Which version of any

given is

givenis combined with which version of its

owning depends

owningdepends on the point in time at which they are accessed.

languageCode

String (data type)

Y

Specifies

the of the text

theof thetext using the two character-639-1 code. Note that this specifies

a level

alevel only, not

a or

aor country code.

typeId (field)

SCTID (data type)

Y

Identifies whether

the is

theis an FSN,or

other type

othertype. This field is set to

a of

aof

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

term

String (data type)

N

The version

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

caseSignificanceId (field)

SCTID (data type)

N

Identifies

the enumeration

theenumeration value that represents the case significance of

this version

thisversion. For example, the term may be completely case sensitive, case insensitive or initial letter case insensitive. This field will be set to

a of

aof

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

Only one record onerecord 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 (field) before or equal to the point in time under consideration.

If the field thefield of this record is false ('0'), then the is at theisat that point in time. If the field thefield is true ('1'), then the is theis associated with the identified theidentified by the conceptId field.

The conceptId field, the languageCode field and the typeId (field) 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 (by appending a row with the same id and the field thefield set to false) and a new row with a new id will be appended. Only limited changes may be made to the ' term ' field, as defined by editorial rules.

Each will Eachwill have at least one with onewith a typeId (field) of || for a given languageCode (like "en"). Where a only aonly has one with onewith a typeId (field) of || for a given codegivencode, then that can thatcan be taken as the for that and thefor thatand each of its, and need not therefore be explicitly included in for infor that. Where a only aonly has one with onewith a typeId (field) of || across all codes allcodes within a release, then that can thatcan be taken as the for all and thefor alland, and need not therefore be explicitly included in any in anyin that release.

The term (field) field will be restricted as follows:

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

    each type

    eachtype (as defined by

    the Type member

    theTypemember associated with

    that type

    thattype - see

    the " - Specifications"

    the Description Format Reference Set specifications document for more details

    );

    .

  • The format of the term field (plain text, limited HTML, XHTML,) will also be configurable for

    each type

    eachtype, using the same mechanism as above;

  • Control characters (including TABs, CRs and LFs) will not appear in |Plain text| and |Limited HTML| format types.

...