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
_c9862d6e-865f-42ec-b039-1faedd870fb5
_c9862d6e-865f-42ec-b039-1faedd870fb5
Purpose

A

id+term
Scg expression
ShowParts
Concept
t900000000000512005|Query
specification
type
reference
set|
allows a serialised query to represent the membership of a subset of
Gloss
tSNOMED CT components
. A query contained in the
Gloss
treference set
is run against the content of
Gloss
tSNOMED CT
to produce a subset of
Gloss
tconcepts
,
Gloss
tdescriptions
or
Gloss
trelationships
. The query is referred to an intensional definition of the subset. It can be run against future releases of
Gloss
tSNOMED CT
to generate an updated set of subset members.

The members of the resulting subset may also be represented in an enumerated form as a

Gloss
tSimple reference set
. An enumerated representation of a subset is referred to as an extensional definition.

Anchor
_944c2242-eb5c-4dcd-8c98-83134a1869f0
_944c2242-eb5c-4dcd-8c98-83134a1869f0
Data structure

A

Gloss
tQuery specification reference set
is a String (data type)
Gloss
treference set
containing query (field) that represent intensional definitions of subsets of
Gloss
tcomponents
. The result of running the query is an extensional representation of the subset of
Gloss
tcomponents
which can be represented as a
Gloss
tSimple reference set
. 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
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 id+term
Scg expression
ShowParts
Concept
t900000000000443000|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 a subtype of

id+term
Scg expression
ShowParts
Concept
t900000000000512005|Query
specification
type|

referencedComponentId (field)

SCTID (data type)

The identifier ( refsetId (field)) of the

Gloss
treference set
for which members are to be generated.

query

String (data type)

The serialised query that can be used to (re-)generate the

Gloss
treference set
members.

A standard syntax for use in these queries is currently under development and is due for publication in late 2014.

...

The following metadata in the "Foundation metadata

Gloss
tconcept
"
Gloss
thierarchy
supports this
Gloss
treference set
:

  • Anchor
    _244489f5-8635-41de-9ee6-7763c3ecbd79__5
    _244489f5-8635-41de-9ee6-7763c3ecbd79__5
    Scg expressionShowPartsid+term
    Concept
    t900000000000454005|Foundation
    metadata
    concept|
    Anchor
    _244489f5-8635-41de-9ee6-7763c3ecbd79__a
    _244489f5-8635-41de-9ee6-7763c3ecbd79__a
    • Concept
      t
      Scg expressionShowPartsid+term
      900000000000455006|Reference
      set|
      Anchor
      _244489f5-8635-41de-9ee6-7763c3ecbd79__d
      _244489f5-8635-41de-9ee6-7763c3ecbd79__d
      • Concept
        t
        Scg expressionShowPartsid+term
        900000000000512005|Query
        specification
        type|
        Anchor
        _244489f5-8635-41de-9ee6-7763c3ecbd79__7
        _244489f5-8635-41de-9ee6-7763c3ecbd79__7
        • scg-expression
          Concept
          ShowParts
          t
          id+term
          900000000000513000|Simple
          query
          specification|

...

Anchor
_451cc169-c8f1-4b1e-93d8-7ae10bd70fe7
_451cc169-c8f1-4b1e-93d8-7ae10bd70fe7
Descriptor template

The table below shows the descriptor that defines the structure of the

id+term
Scg expression
ShowParts
Concept
t900000000000512005|Query
specification
type
reference
set|
pattern.

...

.

...

 

...

 

...

id+term

 

refsetId

referencedComponentId

attributeDescription

attributeType

attributeOrder

 

Concept
t
Scg expression
ShowParts
900000000000456007|Reference
set
descriptor|
Scg expressionShowPartsid+term

Concept
t900000000000512005|Query
specification
type
reference
set|
Scg expressionShowParts

Concept
t
id+term
900000000000514006|Generated
reference
set|

scg-expression

Concept
ShowParts
t
id+term
900000000000461009|Concept
type
component|

0

 scg-expression

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

Concept
t900000000000512005|Query
specification
type
reference
set|
Scg expressionShowParts

Concept
t
id+term
900000000000515007|Query|

scg-expression

Concept
ShowParts
t
id+term
900000000000465000|String|

1

 

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
_270fa207-4075-47c9-92bf-de81d7ba4efd
_270fa207-4075-47c9-92bf-de81d7ba4efd
Example usage

In the example below, "serialised query 1" is a text string that can be used to generate members for

Gloss
tReference set
1, which is a simple member
Gloss
treference set
(without any additional fields within its member records).

...

.

...

 

...

term

refsetId

referencedComponentId

query

Concept
t
Scg expression
ShowParts
900000000000513000|Simple
query
specification|
Scg expressionShowPartsterm

Concept
t|Target
reference
set|

Serialized text of the query ...

...

The specification of the query

Gloss
tlanguage
has yet to be defined / selected, but it should be capable of:

  • Selecting
    Gloss
    tconcepts
    using primary fields, subsumption testing,
    Gloss
    trelationships
    , relationshipGroup (field), set operators (
    Gloss
    tunion
    ,
    Gloss
    tintersection
    , excludes), and lexical query ;
  • Selecting
    Gloss
    tdescriptions
    ,
    Gloss
    trelationships
    and
    Gloss
    treference sets
    using similar mechanisms;
  • Calculation of values for the
    Gloss
    treference set
    's extended fields. Identifying the version of the syntax and any
    Gloss
    tlanguage
    syntax variations.
  • Queries that support definitions for terminologies other than
    Gloss
    tSNOMED CT
    should also be supported. For example, queries to link or include codes in ICD-10, ICD-11, ICPC and
    Gloss
    tLOINC
    .

Note: During D uring 2014 work is underway to develop and pilot a standard approach to representation of queries including queries for generation of subset of

Gloss
tSNOMED CT concepts
.