Description Format Reference Set

Purpose

The 900000000000538005 |Description format reference set| specifies the text format and maximum length of each supported description type. This permits additional description types to be specified in future in addition to the three existing description types ( synonym, fully specified name and textual definition).

Data structure

The 900000000000538005 |Description format reference set| is a C-I ( component- Integer) reference set which is used to specify the length and format of the terms in descriptions of this description type. Its structure is shown in the following table.

Description format reference set - Data structure

Field	Data type	Purpose	Mutable	PK*
id	UUID	A 128 bit unsigned Integer, uniquely identifying this reference set member. Different versions of a reference set member share the same id but have different effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.	NO	YES (Full /Snapshot)
effectiveTime	Time	The inclusive date or time at which this version of the identified reference set member became the current version. 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. The current version of this reference set member at time T is the version with the most recent effectiveTime prior to or equal to time T.	YES	YES (Full) Optional (Snapshot)
active	Boolean	The state of the identified reference set member as at the specified effectiveTime . If active = 1 (true) the reference set member is part of the current version of the set, if active = 0 (false) the reference set member is not part of the current version of the set.	YES	NO
moduleId	SCTID	Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime . The value must be a subtype of 900000000000443000 |Module (core metadata concept)| within the metadata hierarchy.	YES	NO
refsetId	SCTID	Identifies the reference set to which this reference set member belongs. In this case, a subtype descendant of: 900000000000538005 |Description format reference set (foundation metadata concept)|	NO	NO
referencedComponentId	SCTID	A reference to the SNOMED CT component to be included in the reference set. Refers to the concept that represents the description type for which this row defines the format.	NO	NO
descriptionFormat	SCTID	A reference to a subtype of 900000000000539002 |Description format (foundation metadata concept)| attribute which specifies the format of terms in descriptions of this description type.	NO	NO
descriptionLength	Integer	The maximum length in bytes of the terms in descriptions of this description type.	NO	NO

PK* indicates if the attribute is part of the primary key for that file/table.

---

Metadata

The following metadata supports the description format reference set:

Description Format Reference Set in the Metadata Hierarchy

9900000000000454005 |Foundation metadata concept| 900000000000455006 |Reference set| 900000000000538005 |Description format|

---

Reference Set Descriptor and Example Data

Notes on the tables used to show descriptors and examples

The reference set example tables on this page have been revised as follows to aid clarity and understanding:

• The first four columns which are present in all release files are not shown. The omitted columns (id, effectiveTime, active, moduleId) are used in the same way in all referenced sets to support identification, versioning and packaging. They do not directly affect the specific features of a particular reference set or reference set type.

• Reference set columns that contain SNOMED CT identifiers are expanded to show details of the concept or description referenced by that identifier. In some cases, the term is shown in the same column using the expression syntax, in other cases an additional column with a name suffix '_term' has been added. In the standard reference set files only the identifier is present in the column and there is no added column for the term. When using reference sets, the term and other details of the component are looked up from the relevant component release files.

Descriptor

The table below shows the descriptor that defines the structure of the 900000000000538005 |Description format reference set| .

Refset Descriptor rows for Description Format Reference Set

refsetId	referencedComponentId (Referenced component)	attributeDescription (Attribute description)	attributeType (Attribute type)	attributeOrder (Attribute order)
900000000000456007 |Reference set descriptor|	900000000000538005 |Description format|	900000000000462002 |Description type component|	900000000000461009 |Concept type component|	0
900000000000456007 |Reference set descriptor|	900000000000538005 |Description format|	900000000000539002 |Description format|	900000000000461009 |Concept type component|	1
900000000000456007 |Reference set descriptor|	900000000000538005 |Description format|	900000000000544009 |Description length|	900000000000478000 |Unsigned integer|	2

---

Example Data

This example holds the all the members of the 900000000000538005 |Description format reference set| in the SNOMED CT International Release for July 2014. Other members may added to future versions of the International Release if new description types are introduced. Owners of Extensions that support additional description types must also add members to the 900000000000538005 |Description format reference set| .

Sample Content from the Description Format Reference Set

refsetId	referencedComponentId (Description type component)	descriptionFormat (Description format)	descriptionLength (Description length)
900000000000538005 |Description format|	900000000000003001 |Fully specified name|	900000000000540000 |Plain text|	255
900000000000538005 |Description format|	900000000000013009 |Synonym|	900000000000540000 |Plain text|	255
900000000000538005 |Description format|	900000000000550004 |Definition|	900000000000540000 |Plain text|	4096

---

Note: The tables above omit the initial four columns of data present in the release file. These follow the standards versioning pattern id, effectiveTime, active, moduleId. Additionally, to aid understanding, the tables above also show the term from one of the descriptions associated with each of the identified concept. The release file only contains the identifier.