Release File Specification

Search

SNOMED CT Document Library

    Loading...

Versions Compared

Old Version 2

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.


Warning
titleDeprecation Notice

The Ordered Reference Set pattern is now deprecated as it has been replaced with two reference set types each of which is specific to one of the two distinct use cases supported by the Ordered Reference set pattern.

The recommended Reference sets to address the purposes identified below are now:

  • 4.2.2. Ordered Component Reference Set
    • This allows an ordered or prioritized list of components to be represented.
    • It omits the linkedToId field in the pattern shown below as this is not required to address this use case.
  • 5.2.1.5 Ordered Association Reference Set
    • This enables representation of alternative navigation hierarchies (in which child concepts are ordered) and also also supports representation of groups of ordered components.
    • The linkedToId field in the pattern shown below is replaced by the targetComponentId (this name is used to align with the 5.2.1.4 Association Reference Set (used from unordered associations).

Deprecation does not prevent continued use of an existing reference set pattern. However it does indicate that a different solution is now specified and recommended to meet the requirements for this pattern

Purpose

An

Concept
t447258008|Ordered type reference set|
ShowFormatinline
allows a collection of
Gloss
PreSpacefalse
tcomponents
to

...

An

Scg expression
ShowPartsid+term
447258008|Ordered type reference set|
allows a collection ofto be defined with a specified given a priority ordering. This type ofcan of
Gloss
PreSpacefalse
treference ret
can also be used to specify ordered associations between different
Gloss
PreSpacefalse
tcomponents
. These can be used to specify several interrelated subsets of components and to define alternative hierarchies for navigation and selection ofor.

...

of

Gloss
PreSpacefalse
tconcepts
or
Gloss
PreSpacefalse
tdescriptions
.

Data structure

An

Gloss
PreSpacefalse
tOrdered reference set
is an Integer 
Gloss
PreSpacefalse
tComponent
 
Gloss
PreSpacefalse
treference set

...

Anis an Integer is used to represent ordered lists and alternative hierarchies. Its structure is shown in the following table.


Caption label

...

CapId

...

ordered-

...

reference-

...

set-data-structure
CapTypeTable
Ordered reference set - Data structure


b926-808cc51f55f0__eTable 22. Ordered reference set - Data structureid+terma
_65975d1e-3ac7-4e5e-b926-808cc51f55f0__e

 

 

Field

Data type

Purpose

id

Specref
RefType
(field)
tid

UUID

Specref
RefType
(data type)
tUUID

A 128 bit unsigned Integer

Specref
RefType(data type)
tInteger
, uniquely identifying this
Gloss
PreSpacefalse
treference set member
.

Different versions of a reference set member share the same id

Specref
RefType(field)
tid
but have different effectiveTime
Specref
RefType(field)
teffectiveTime
. This allows a reference set member to be modified or made active
Specref
RefType(field)
tactive
(i.e. removed from the active set) at a specified time.

effectiveTime

Specref
RefType
(field)
teffectiveTime

Time

Specref
RefType
(data type)
tTime

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

Gloss
PreSpacefalse
treference set member
became the current version.

The current version of thisat this

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

Specref
active
RefType(field)
tactive

Boolean

Specref
RefType
(data type)
tBoolean

The state of the identifiedas identified

Gloss
PreSpacefalse
treference set member
as at the specified effectiveTime
Specref
RefType(field)
teffectiveTime
.

If active

Specref
RefType(field)
tactive
= 1 (true) theis the
Gloss
PreSpacefalse
treference set member
is part of the current version of the set, if active
Specref
RefType(field)
tactive
= 0 (false) theis the
Gloss
PreSpacefalse
treference set member
is not part of the current version of the set.

moduleId

Specref
RefType
(field)
tmoduleId

SCTID

Specref
RefType
(data type)
tSCTID

Identifies the

Gloss
PreSpacefalse
tSNOMED CT module
that contains this
Gloss
PreSpacefalse
treference set member
as at the specified
Specref
RefType(field)
teffectiveTime
Identifies thethat contains thisas at the specified effectiveTime (field) .

The value must be aof

Scg expression
ShowParts
Gloss
PreSpacefalse
tsubtype
of
Concept
t900000000000443000|Module
(core
metadata
concept)|
ShowFormatinline
within the metadata
Gloss
PreSpacefalse
thierarchy
.

refsetId

Specref
RefType
(field)
trefsetId

SCTID

Specref
RefType
(data type)
tSCTID

Identifies theto which thisbelongsthe

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

In this case, set to aof Scg expressionShowPartsid+terma

Gloss
PreSpacefalse
tsubtype
of
Concept
t447258008|Ordered
type
reference
set|

Specref
referencedComponentId
RefType(field)
treferencedComponentId

SCTID

Specref
RefType
(data type)
tSCTID

The identifier of athat a

Gloss
PreSpacefalse
tSNOMED CT component
that is included in the ordered list of alternative hierarchy.

order

Specref
RefType
(field)
torder

Integer

Specifies the sort order

Specref
RefType(field)
torder
of the list. The list is ordered by applying an ascending sort of the order
Specref
RefType(field)
torder
value.

The value of order

Specref
RefType(field)
torder
=1 represents the highest priority. A value of '0' is not allowed. Duplicate values are permitted and the sort order between two members with the same order value is not defined.

If the linkedToId

Specref
RefType(field)
tlinkedToId
value is not 0, sorting occurs within subgroups that share the same linkedToId
Specref
RefType(field)
tlinkedToId
.

Note: The name "order" is a reserved word in some database environments. Please consider this when using this column.

linkedToId

Specref
RefType
(field)
tlinkedToId

SCTID

Specref
RefType
(data type)
tSCTID

The identifier of athat a

Gloss
PreSpacefalse
tSNOMED CT component
that acts as a grouper or hierarchy node, collecting together a subgroup from within the list.

This field either enableslinked enables

Gloss
PreSpacefalse
treference set member
linked into a number of subgroups. These subgroups can be nested allowing representation of alternative hierarchies.

To link members into a subgroup, all components in the same subgroup should reference the same

Gloss
PreSpacefalse
tcomponent
. This can either be a component that represents the name of that subgroup or the first member of the subgroup. In the latter case, the first row of each subgroup will contain the same identifier in referencedComponentId
Specref
RefType(field)
and linkedToId
treferencedComponentId
and
Specref
RefType(field)
tlinkedToId
and with order
Specref
RefType(field)
torder
=1.

To link a number ofto of

Gloss
PreSpacefalse
tchildren
Gloss
PreSpacefalse
tconcepts
to a single parent
Gloss
PreSpacefalse
tconcept
, one member record should exist per
Gloss
PreSpacefalse
tchild
, with the referencedComponentId
Specref
RefType(field)
treferencedComponentId
field referencing the parent and this field referencing the . The order
Gloss
PreSpacefalse
tchild
Gloss
PreSpacefalse
tconcept
. The
Specref
RefType(field)
torder
field is then used to order
Specref
RefType(field)
theunder the parent
torder
the
Gloss
PreSpacefalse
tchildren
Gloss
PreSpacefalse
tconcepts
under the parent
Gloss
PreSpacefalse
tconcept
.

For ordered lists that do not require grouping or hierarchical arrangement the value of linkedToId

Specref
RefType(field)
tlinkedToId
should be the digit zero (0).

...

Metadata

The following metadata in the "Foundation metadata

Gloss
PreSpacefalse
tconcept
" supports this:

...

Scg expression
ShowPartsid+term
900000000000454005|Foundation metadata concept|

...

Scg expression
ShowPartsid+term
900000000000455006|Reference set|

...

  • Scg expression
    ShowPartsid+term
    447258008|Ordered type reference set|
    ...

Figure 9. Ordered References Sets in the Metadata Hierarchy

...

Gloss
PreSpacefalse
thierarchy
supports this
Gloss
PreSpacefalse
treference set

Caption label
CapIdordered-references-sets-in-the-metadata-hierarchy
CapTypeTable
Ordered References Sets in the Metadata Hierarchy

Refset spec table
Sizefs7
RefsetTypeOrdered Reference Set
  •    
     Concept
    t900000000000454005|Foundation metadata concept|
     
    •  Concept
      t900000000000455006|Reference set|
       
      •  Concept
        t447258008|Ordered type reference set|
 Excerpt Include
REUSE:Notes on Reference Set Example Tables
REUSE:Notes on Reference Set Example Tables
nopaneltrue
Descriptor Template
...
The tables below show the descriptor that defines the structure of the 
scg-expression
 Concept
ShowParts
t
id+term
447258008|Ordered 
 
 type 
 
 reference 
 
 set|
ShowFormatinline
pattern and an example of descriptor for a specificthat a  
 Gloss
PreSpacefalse
treference set
 that follows this pattern.
 Caption label
...
CapId
...
refset-
...
descriptor-
...
rows-
...
for-ordered-reference-set
CapTypeTable
Refset Descriptor rows for Ordered Reference Set
...
 Scg expression
ShowPartsid+term
447258008|Ordered type reference set|
...
 
...
 
...
 
...

refsetId
referencedComponentId
attributeDescription
attributeType
attributeOrder
scg-expression
 Concept
ShowParts
t
id+term
900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expressionShowPartsid+term
 Concept
t447258008|Ordered 
 
 type 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
449608002|Referenced 
 
 component|
 Scg expressionShowPartsid+term
 Concept
t900000000000460005|Component 
 
 type|
0
  
id+term
 Scg expression
ShowParts
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 
scg-expression
 Concept
ShowParts
t
id+term
447258008|Ordered 
 
 type 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
447255006|Priority 
 
 order 
 
 reference 
 
 set 
 
 attribute|
scg-expression
 Concept
ShowParts
t
id+term
900000000000478000|Unsigned 
 
 integer|
1
 Concept
t
 Scg expressionShowPartsid+term
900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expressionShowPartsid+term
 Concept
t447258008|Ordered 
 
 type 
 
 reference 
 
 set|
 Scg expressionShowParts
 Concept
t
id+term
447257003|"Linked 
 
 to" 
 
 reference 
 
 set 
 
 attribute|
scg-expression
 Concept
ShowParts
t
id+term
900000000000460005|Component 
 
 type|
2
anchor
Example Data
...

 Caption label
CapIdsample-content-for-an-ordered-reference-set
CapTypeTable
Sample Content for an Ordered Reference Set

...
 Scg expression
ShowPartsid+term
447570008|SNOMED CT top level navigation hierarchy ordered reference set|
...
 
...
 
...
 
...
 
...
refsetId
...
referencedComponentId (Referenced component)
...
attributeDescription (Attribute description)
...
attributeType (Attribute type)
...
attributeOrder (Attribute order)
...
 
...
 Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
...
 Scg expression
ShowPartsid+term
447570008|SNOMED CT top level navigation hierarchy ordered reference set|
...
 Scg expression
ShowPartsid+term
449608002|Referenced component|
...
 Scg expression
ShowPartsid+term
900000000000461009|Concept type component|
...
0
...
 
...
 Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
...
 Scg expression
ShowPartsid+term
447570008|SNOMED CT top level navigation hierarchy ordered reference set|
...
 Scg expression
ShowPartsid+term
900000000000479008|Attribute order|
...
 Scg expression
ShowPartsid+term
900000000000478000|Unsigned integer|
...
1
...
 
...
 Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
...
 Scg expression
ShowPartsid+term
447570008|SNOMED CT top level navigation hierarchy ordered reference set|
...
 Scg expression
ShowPartsid+term
447257003|"Linked to" reference set attribute|
...
 Scg expression
ShowPartsid+term
900000000000461009|Concept type component|
...
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 thefrom one of theassociated with each of the identified. The release file only contains the.
...
Table 25. Sample content from
 Anchor
_234ed71d-be99-4417-bf50-120bf2536215__3_234ed71d-be99-4417-bf50-120bf2536215__3
 Scg expression
ShowPartsid+term
447570008|SNOMED CT top level navigation hierarchy ordered reference set|
.
 
 
 
refsetId
referencedComponentId (Referenced component)
order (Attribute order)
linkedTo ("Linked to" reference set attribute)
 Concept
t
 Scg expressionShowPartsid+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
64572001|Disease|
1
 Concept
t
 Scg expressionShowPartsid+term
123946008|Disorder 
 
 by 
 
 body 
 
 site|
 Scg expressionShowPartsid+term
 Concept
t447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
64572001|Disease|
2
 Concept
t
 Scg expressionShowPartsid+term
370117001|Disorder 
 
 of 
 
 system|
 Scg expressionShowPartsid+term
 Concept
t447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
64572001|Disease|
3
scg-expression
 Concept
ShowParts
t
id+term
278919001|Communication 
 
 disorder|
scg-expression
 Concept
ShowParts
t
id+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
64572001|Disease|
4
 Concept
t
 Scg expressionShowPartsid+term
74732009|Mental 
 
 disorder|
scg-expression
 Concept
ShowParts
t
id+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
 Scg expressionShowPartsid+term
 Concept
t64572001|Disease|
5
scg-expression
 Concept
ShowParts
t
id+term
39898005|Sleep 
 
 disorder|
 Scg expressionShowPartsid+term
 Concept
t447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
 Scg expressionShowParts
 Concept
t
id+term
64572001|Disease|
6
scg-expression
 Concept
ShowParts
t
id+term
370118006|Disorder 
 
 of 
 
 pregnancy 
 
 / 
 
 labor 
 
 / 
 
 delivery 
 
 / 
 
 puerperium|
scg-expression
 Concept
ShowParts
t
id+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
 Scg expressionShowPartsid+term
 Concept
t64572001|Disease|
7
scg-expression
 Concept
ShowParts
t
id+term
370119003|Fetal 
 
 / 
 
 neonatal 
 
 / 
 
 perinatal 
 
 disorder|
scg-expression
 Concept
ShowParts
t
id+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
 Scg expressionShowPartsid+term
 Concept
t64572001|Disease|
8
 Concept
t
 Scg expressionShowPartsid+term
370120009|Endocrine 
 
 / 
 
 nutritional 
 
 / 
 
 metabolic 
 
 disorder|
scg-expression
 Concept
ShowParts
t
id+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
64572001|Disease|
9
 Concept
t
 Scg expressionShowPartsid+term
370121008|Disorder 
 
 of 
 
 blood 
 
 / 
 
 lymphatics 
 
 / 
 
 immune 
 
 system|
scg-expression
 Concept
ShowParts
t
id+term
447570008|SNOMED 
 
 CT 
 
 top 
 
 level 
 
 navigation 
 
 hierarchy 
 
 ordered 
 
 reference 
 
 set|
scg-expression
 Concept
ShowParts
t
id+term
64572001|Disease|
10
scg-expression
 Concept
ShowParts
t
id+term
281867008|Multisystem 
 
 disorder|