Release File Specification

Search

SNOMED CT Document Library

    Loading...

Versions Compared

Old Version 3

changes.mady.by.user David Markwell

Saved on

compared with

New Version Current

changes.mady.by.user Peter G. Williams

Saved on

Key

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

...

Purpose

The

Concept
t900000000000538005|Description format reference set|
ShowFormatinline
specifies the text format and maximum length of each supported
Gloss
PreSpacefalse
tdescription type
. This permits additional
Gloss
SpacePreSpacetruefalse
tdescription types
to be specified in future in addition to the three existing
Gloss
PreSpacefalse
tdescription types
  (
Gloss
PreSpacefalse
tsynonym
,
Gloss
SpacePreSpacetruefalse
tfully specified name
and
Gloss
PreSpacefalse
ttextual definition
).

...

Data structure

The

Concept
t900000000000538005|Description format reference set|
ShowFormatinline
is a C-I (
Gloss
PreSpacefalse
tcomponent
- Integer
Specref
RefType(data type)
tInteger
)
Gloss
SpacePreSpacetruefalse
treference set
which is used to specify the length and format of the
Gloss
SpacePreSpacetruefalse
tterms
in
Gloss
SpacePreSpacetruefalse
tdescriptions
of this
Gloss
PreSpacefalse
tdescription type
. Its structure is shown in the following table.

Field

Data type

Purpose

id (field)

UUID (data type)

A 128 bit unsigned Integer (data type), uniquely identifying this

Gloss
treference set member
.

Different versions of a reference set member share the same id (field) but have different effectiveTime (field). This allows a reference set member to be modified or made active (field) (i.e. removed from the active set) at a specified time.

effectiveTime (field)

Time (data type)

The inclusive date or time at which this version of the identified

Gloss
Spacetrue
treference set member
became the current version.

The current version of this

Gloss
Spacetrue
treference set member
at time T is the version with the most recent effectiveTime (field) prior to or equal to time T .

active (field)

Boolean (data type)

The state of the identified

Gloss
Spacetrue
treference set member
as at the specified effectiveTime (field) .

If active (field) = 1 (true) the

Gloss
Spacetrue
treference set member
is part of the current version of the set, if active (field) = 0 (false) the
Gloss
Spacetrue
treference set member
is not part of the current version of the set.

moduleId (field)

SCTID (data type)

Identifies the

Gloss
Spacetrue
tSNOMED CT module
that contains this
Gloss
Spacetrue
treference set member
as at the specified effectiveTime (field) .

The value must be a

Gloss
Spacetrue
tsubtype
of
Concept
t900000000000443000|Module (core metadata concept)|
ShowFormatinline
within the metadata
Gloss
thierarchy
.

refsetId (field)

SCTID (data type)

Identifies the

Gloss
Spacetrue
treference set
to which this
Gloss
Spacetrue
treference set member
belongs.

In this case, set to

Concept
t900000000000538005|Description format reference set (foundation metadata concept)|

referencedComponentId (field)

SCTID (data type)

A reference to the

Gloss
Spacetrue
tsubtype
of
Concept
t900000000000446008|Description type (core metadata concept)|
ShowFormatinline
which specifies the
Gloss
Spacetrue
tdescription type
to which this format applies.

descriptionFormat (field)

SCTID (data type)

A reference to a

Gloss
Spacetrue
tsubtype
of
Concept
t900000000000539002|Description format (foundation metadata concept)|
ShowFormatinline
attribute which specifies the format of
Gloss
Spacetrue
tterms
in
Gloss
Spacetrue
tdescriptions
of this
Gloss
tdescription type
.

descriptionLength (field)

Integer

The maximum length in bytes of the

Gloss
Spacetrue
tterms
in
Gloss
Spacetrue
tdescriptions
of this
Gloss
tdescription type
.

...

The following metadata supports the

Gloss
Spacetrue
tdescription
format
Gloss
treference set
:

...

Concept
t900000000000454005|Foundation metadata concept|
Caption label
CapIddescription-format-reference-set-data-structure
CapTypeTable
Description format reference set - Data structure


Refset spec table
Sizefs7
RefsetTypeDescription Format Reference Set
Metadata
The following metadata supports the 
 Gloss
PreSpacefalse
tdescription
 format 
 Gloss
PreSpacefalse
treference set
:
 Caption label
CapIddescription-format-reference-set-in-the-metadata-hierarchy
CapTypeTable
Description Format Reference Set in the Metadata Hierarchy

 Scg expression
Borderridge

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



 Excerpt Include
REUSE:Notes on Reference Set Example Tables
REUSE:Notes on Reference Set Example Tables
nopaneltrue
...
 Concept
t900000000000455006|Reference set|
...
  •  Concept
    t900000000000538005|Description format|
...
Descriptor
The table below shows the descriptor that defines the structure of the 
 Concept
t900000000000538005|Description format reference set|
.
 Caption label
CapIdrefset-descriptor-rows-for-description-format-reference-set
CapTypeTable
Refset Descriptor rows for Description Format Reference Set

refsetId
referencedComponentId (Referenced component)
attributeDescription (Attribute description)
attributeType (Attribute type)
attributeOrder (Attribute order)
 
 Concept
t900000000000456007|Reference set descriptor|
 Concept
t900000000000538005|Description format|
 Concept
t900000000000462002|Description type component|
 Concept
t900000000000461009|Concept type component|
0
 
 Concept
t900000000000456007|Reference set descriptor|
 Concept
t900000000000538005|Description format|
 Concept
t900000000000539002|Description format|
 Concept
t900000000000461009|Concept type component|
1
 
 Concept
t900000000000456007|Reference set descriptor|
 Concept
t900000000000538005|Description format|
 Concept
t900000000000544009|Description length|
 Concept
t900000000000478000|Unsigned integer|
2
 
Note: The table above omits the initial four columns of data present in the release file. These follow the standards versioning pattern id (field), effectiveTime (field), active (field), active (field). Additionally, to aid understanding, the table above also shows the 
 Gloss
Spacetrue
tterm
from one of the 
 Gloss
Spacetrue
tdescriptions
associated with each of the identified 
 Gloss
tconcept
. The release file only contains the 
 Gloss
tidentifier
. 
...
Example Data
...
This example holds the all the members of the 
 Concept
t900000000000538005|Description format reference set|
ShowFormatinline
in the 
 Gloss
SpacePreSpacetruefalse
tSNOMED CT International Release
 for July 2014. Other members may added to future versions of the 
 Gloss
SpacePreSpacetruefalse
tInternational Release
 if new 
 Gloss
SpacePreSpacetruefalse
tdescription types
 are introduced. Owners of Extensions that support additional 
 Gloss
SpacePreSpacetruefalse
tdescription types
 must also add members to the 
 Concept
t900000000000538005|Description format reference set|
.

 Caption label
CapIdsample-content-from-the-description-format-reference-set
CapTypeTable
Sample Content from the Description Format Reference Set

refsetId
referencedComponentId (Description type component)
descriptionFormat (Description format)
descriptionLength (Description length)
 Concept
t900000000000538005|Description format|
 Concept
t900000000000003001|Fully specified name|
 Concept
t900000000000540000|Plain text|
255
 Concept
t900000000000538005|Description format|
 Concept
t900000000000013009|Synonym|
 Concept
t900000000000540000|Plain text|
255
 Concept
t900000000000538005|Description format|
 Concept
t900000000000550004|Definition|
 Concept
t900000000000540000|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 
 Specref
RefType(field)
, effectiveTime 
tid
, 
 Specref
RefType(field)
, active 
teffectiveTime
, 
 Specref
RefType(field)
, active 
tactive
, 
 Specref
RefType(field)
tactive
. Additionally, to aid understanding, the tables above also show the 
 Gloss
SpacePreSpacetruefalse
tterm
 from one of the 
 Gloss
SpacePreSpacetruefalse
tdescriptions
 associated with each of the identified 
 Gloss
PreSpacefalse
tconcept
. The release file only contains the 
 Gloss
PreSpacefalse
tidentifier
.