Page tree

Table: Description file - Detailed Specification

Field

Data type

Purpose

Part of Primary Key

id

SCTID

Uniquely identifies the description.

NO

YES
(Full/Snapshot) 

effectiveTime

Time

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

Note: In distribution files the effectiveTime should follow the short ISO date format (YYYYMMDD) and should not include the hours, minutes, seconds or timezone indicator.

YES

YES (Full)
Optional (Snapshot) 

active

Boolean

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

YES

NO

moduleId

SCTID

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

YES

NO

conceptId

SCTID

Identifies the concept to which this description applies. Set to the identifier of a concept in the 138875005 | SNOMED CT Concept| hierarchy within the Concept. Note that a specific version of a description is not directly bound to a specific version of the concept to which it applies. Which version of a description applies to a concept depends on its effectiveTime and the point in time at which it is accessed.

NO

NO

languageCode

String

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.

NO

NO

typeId

SCTID

Identifies whether the description is fully specified name a synonym or other description type. This field is set to a child of 900000000000446008 | Description type| in the Metadata hierarchy.

NO

NO

term

String

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

YES

NO

caseSignificanceId

SCTID

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.

YES

NO

  • No labels