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 3

changes.mady.by.user David Markwell

Saved on

Key

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

Anchor
_31a272ae-db6b-4623-be07-a175294e9037
_31a272ae-db6b-4623-be07-a175294e9037
Purpose

An

id+term
Scg expression
ShowParts
Concept
t900000000000516008|Annotation
type
reference
set|
allows String (data type) to be associated with components for any specified purpose.

Anchor
_db4e87b5-7d46-4083-9f3b-e9262be15015
_db4e87b5-7d46-4083-9f3b-e9262be15015
Data structure

An

Gloss
tannotation reference set
String (data type)
Gloss
treference set
used to apply text annotation (field) to selected .
Gloss
tSNOMED CT components
.

Table 46. Annotation reference set - Data structure
Anchor
_db4e87b5-7d46-4083-9f3b-e9262be15015__d_db4e87b5-7d46-4083-9f3b-e9262be15015__d

 

 

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
treference set member
became the current version.

The current version of this

Gloss
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
treference set member
as at the specified effectiveTime (field) .

If active (field) = 1 (true) the

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

moduleId (field)

SCTID (data type)

Identifies the

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

The value must be a

Gloss
tsubtype
of scg-expression
Concept
ShowParts
t
id+term
900000000000443000|Module
(core
metadata
concept)|
within the metadata
Gloss
thierarchy
.

refsetId (field)

SCTID (data type)

Identifies the

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

In this case, set to

id+term
Scg expression
ShowParts
Concept
t900000000000516008|Annotation
type
reference
set|
.

referencedComponentId (field)

SCTID (data type)

The identifier of the

Gloss
tcomponent
to be annotated.

annotation (field)

String (data type)

The text annotation (field) to attach to the

Gloss
tcomponent
identified by referencedComponentId (field) .

...

The following metadata in supports this

Gloss
treference set
:

  • Anchor
    _6ade4020-50aa-4989-a779-a211ce3dfb46__5
    _6ade4020-50aa-4989-a779-a211ce3dfb46__5
    Anchor
    _6ade4020-50aa-4989-a779-a211ce3dfb46__9
    _6ade4020-50aa-4989-a779-a211ce3dfb46__9
    scg-expression
    Concept
    ShowParts
    t
    id+term
    900000000000454005|Foundation
    metadata
    concept|
    ShowFormatinline
    • Concept
      t
      Scg expressionShowPartsid+term
      900000000000455006|Reference
      set|
      Anchor
      _6ade4020-50aa-4989-a779-a211ce3dfb46__a
      _6ade4020-50aa-4989-a779-a211ce3dfb46__a
      • scg-expression
        Concept
        ShowParts
        t
        id+term
        900000000000516008|Annotation
        type|
        Anchor
        _6ade4020-50aa-4989-a779-a211ce3dfb46__7
        _6ade4020-50aa-4989-a779-a211ce3dfb46__7
        • Concept
          t
          Scg expressionShowPartsid+term
          900000000000517004|Associated
          image|

Figure 15. Annotation References Sets in the Metadata Hierarchy

Anchor
_19143892-2bc9-440f-b711-033f805f1715
_19143892-2bc9-440f-b711-033f805f1715
Descriptor template

The tables below show the descriptors that define the structure of the

scg-expression
Concept
ShowParts
t
id+term
900000000000516008|Annotation
type
reference
set|
pattern and examples of the descriptors for specific
Gloss
treference sets
that follow this pattern.

...

Table 47. Descriptor Template for Annotation Reference Sets
_19143892-2bc9-440f-b711-033f805f1715__c_19143892-2bc9-440f-b711-033f805f1715__c

 

 

 

 

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

 

scg-expression

Concept
ShowParts
t
id+term
900000000000456007|Reference
set
descriptor|
scg-expression

Concept
ShowParts
t
id+term
900000000000516008|Annotation
type|
Scg expressionShowPartsid+term

Concept
t900000000000518009|Annotated
component|
Scg expressionShowParts

Concept
t
id+term
900000000000461009|Concept
type
component|

0

  Scg expressionShowPartsid+term

Concept
t900000000000456007|Reference
set
descriptor|

scg-expression

Concept
ShowParts
t
id+term
900000000000516008|Annotation
type|
Scg expressionShowPartsid+term

Concept
t900000000000519001|Annotation|

scg-expression

Concept
ShowParts
t
id+term
900000000000465000|String|

1

 

The attributeType (field) for the Annotation field can be any

Gloss
tdescendant
of the " string "
Gloss
tconcept
in the metadata
Gloss
thierarchy
. This
Gloss
thierarchy
is described in more detail under the "
Gloss
tReference set
descriptor" section.

The table below holds the Descriptor for the "Associated image" annotation (field)

Gloss
treference set
, which allows URLs to be associated with :
Gloss
tconcepts
:

Table 48. Descriptor for
Anchor
_19143892-2bc9-440f-b711-033f805f1715__6_19143892-2bc9-440f-b711-033f805f1715__6
Scg expression
ShowPartsid+term
900000000000517004|Associated image reference set|

 

 

 

 

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

scg-expression

Concept
ShowParts
t
id+term
900000000000456007|Reference
set
descriptor|
scg-expression

Concept
ShowParts
t
id+term
900000000000517004|Associated
image|

scg-expression

Concept
ShowParts
t
term
900000000000518009|Annotated
component|
Scg expressionShowPartsid+term

Concept
t900000000000461009|Concept
type
component|

0scg-expression

Concept
ShowParts
t
id+term
900000000000456007|Reference
set
descriptor|

scg-expression

Concept
ShowParts
t
id+term
900000000000517004|Associated
image|
scg-expression

Concept
ShowParts
t
term
900000000000520007|Image|
Scg expressionShowPartsid+term

Concept
t900000000000469006|URL|

1

Note that in the table above, the

term
Scg expression
ShowParts
Concept
t900000000000469006|URL|
ShowFormatinline
Gloss
tconcept
is a
Gloss
tdescendant
of | string |
Gloss
tconcept
in the metadata.

Note: The tables above omit 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 tables above also show the

Gloss
tterm
from one of the
Gloss
tdescriptions
associated with each of the identified
Gloss
tconcept
. The release file only contains the
Gloss
tidentifier
.

Anchor
_619af0e2-cfc0-4eec-882b-3d4702ff543f
_619af0e2-cfc0-4eec-882b-3d4702ff543f
Annotation reference set example

As no annotation reference sets are included in the International Release, these sample rows are for illustration only.

Table 49. Example of "Associated image" Annotation Reference Set
Anchor
_619af0e2-cfc0-4eec-882b-3d4702ff543f__8_619af0e2-cfc0-4eec-882b-3d4702ff543f__8

 

 

refsetId

referencedComponentId

Annotation

scg-expression

Concept
ShowParts
t
id+term
900000000000517004|Associated
image|
scg-expression

Concept
ShowParts
t
id+term
80891009|Heart
structure|

http://en.wikipedia.org/wiki/Heart#mediaviewer/File:Wiki_Heart_Antomy_Ties_van_Brussel.jpg

scg-expression

Concept
ShowParts
t
id+term
900000000000517004|Associated
image|
scg-expression

Concept
ShowParts
t
id+term
86174004|Laparoscope|

http://www.educationaldimensions.com/eLearn/endoscope/bigScope.html

In the above example, the two URLs have been used to annotate two

Gloss
tSNOMED CT concepts
with images on the web. It is not recommended that this mechanism be used to annotate
Gloss
tconcepts
with text that may require translation to other
Gloss
tlanguages
. Instead, such text should be included under an appropriate
Gloss
tdescription
type within the Description file .

Note: The tables above omit 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 tables above also show the

Gloss
tterm
from one of the
Gloss
tdescriptions
associated with each of the identified
Gloss
tconcept
. The release file only contains the
Gloss
tidentifier
.