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.
Comment: Migration of unmigrated content due to installation of a new plugin

Anchor
_848bae5e-6edd-43f2-aaa0-f9ea40714de6
_848bae5e-6edd-43f2-aaa0-f9ea40714de6
Purpose

The

id+term
Scg expression
ShowParts
Concept
t900000000000456007|Reference
set
descriptor|
is a
Gloss
treference set
that is used to specify the format of all
Gloss
treference sets
included in a release. The data type and meaning of the referenced component and each additional field within each
Gloss
treference set
is described by this
Gloss
treference set
.

Gloss
tReference set
descriptor can be used to define

  • The order of appearance of additional attributes (other than those mandatory for all
    Gloss
    treference sets
    );
  • The name and purpose of the additional attributes;
  • The data types for the additional attributes.

This allows for a

Gloss
treference set
to be validated using the metadata embedded within the
Gloss
treference set
descriptor in the following ways:

  • the data type of its attributes may be validated against the data type declared in the
    Gloss
    treference set
    descriptor;
  • the column order can be checked against the
    Gloss
    treference set
    descriptor.

Anchor
_5c7e8c94-101c-450c-827d-573470153540
_5c7e8c94-101c-450c-827d-573470153540
Data structure

The is a - - Integer that specifies the structure of reference sets. Its structure is shown in the following table.

...

Gloss
tReference set descriptor reference set

...

 

...

 

...

Field

...

Data type

...

Purpose

...

id (field)

...

UUID (data type)

...

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

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

The current version of this 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 as at the specified effectiveTime (field) .

If active (field) = 1 (true) the is part of the current version of the set, if active (field) = 0 (false) the is not part of the current version of the set.

...

moduleId (field)

...

SCTID (data type)

...

Identifies the that contains this as at the specified effectiveTime (field) .

The value must be a of

Scg expression
ShowPartsid+term
900000000000443000|Module (core metadata concept)|
within the metadata .

...

refsetId (field)

...

SCTID (data type)

...

Identifies the to which this belongs.

In this case, set to

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

...

referencedComponentId (field)

...

SCTID (data type)

...

Identifies the (or type of ) that is specified by this descriptor.

Set to a of

Scg expression
ShowPartsid+term
900000000000455006|reference set (foundation metadata concept)|
in the metadata .

...

attributeDescription (field)

...

SCTID (data type)

...

Specifies the name of an attribute that is used in the to which this descriptor applies.

Set to a of

Scg expression
ShowPartsid+term
900000000000457003|Reference set attribute (foundation metadata concept)|
in the metadata , that describes the additional attribute extending the .

...

attributeType (field)

...

SCTID (data type)

...

Specifies the data type of this attribute in the to which this descriptor applies.

Set to a of

Scg expression
ShowPartsid+term
900000000000459000|attribute type (foundation metadata concept)|
in the metadata , that describes the type of the additional attribute extending the .

...

attributeOrder (field)

...

Integer

...

Specifies the position of this attribute in the to which this descriptor applies. A zero value identifies the referencedComponentId (field) within the . Other values specify an additional attributes by its position relative to the referencedComponentId (field). Within a particular descriptor, attributeOrder (field) values for a particular referencedComponentId (field) must be contiguous.

An unsigned Integer (data type), providing an ordering for the additional attributes extending the .

is a
Gloss
tComponent
-
Gloss
tComponent
- Integer
Gloss
treference set
that specifies the structure of reference sets. Its structure is shown in the following table.



Refset spec table
Sizefs7
RefsetTypeReference Set Descriptor Reference Set

At least one row must exist for each 
 Gloss
treference set
 included in a release. This row must have an attributeOrder 
 Specref
RefType(field)
tattributeOrder
 value of '0' and an attributeType 
 Specref
RefType(field)
tattributeType
 of ' 
 Gloss
tcomponent
 type' (or one of its 
 Gloss
tdescendants
). The referencedComponentId 
 Specref
RefType(field)
treferencedComponentId
 identifies the 
 Gloss
treference set
 defined by the descriptor.
There is one additional row for each additional column present in the specified 
 Gloss
treference set
 .
Creation of 
 Gloss
tReference set
 descriptor data is mandatory when creating a new 
 Gloss
treference set
 in the 
 Gloss
tInternational Release
 or in a 
 Gloss
tNational Extension
 .
Creation of a 
 Gloss
tReference set
 descriptor is optional when creating a 
 Gloss
treference set
 in another 
 Gloss
tExtension
. If a descriptor is not created, the descriptor of the closest 
 Gloss
tancestor
 of the 
 Gloss
treference set
 is used when validating 
 Gloss
treference set
 member records.
...
Metadata
The following metadata in the |Foundation metadata 
 Gloss
tconcept
 | 
 Gloss
thierarchy
 supports the 
 Gloss
treference set
 descriptor 
 Gloss
treference set
 .
The 
 Gloss
tReference Set
 Descriptor 
 Gloss
tReference Set
 is specified by the scg-expression
 Concept
ShowParts
t
id+term
900000000000456007|Reference 
 
 set 
 
 descriptor|
ShowFormatinline
 Gloss
tconcept
 in the metadata hierarchy.
  •  Anchor
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__d
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__d
     Scg expressionShowPartsid+term
     Concept
    t900000000000441003|SNOMED 
     
     CT 
     
     Model 
     
     Component|
     Anchor
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__8
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__8
    • scg-expression
       Concept
      ShowParts
      t
      id+term
      900000000000454005|Foundation 
       
       metadata 
       
       concept|
       Anchor
      _d3887261-8892-4cad-a1c5-fd2ec50eb656__2
      _d3887261-8892-4cad-a1c5-fd2ec50eb656__2
      •  Concept
        t
         Scg expressionShowPartsid+term
        900000000000455006|Reference 
         
         set|
        ShowFormat
        scg-expression
        inline
        • ShowParts
           Concept
          id+term
          t900000000000456007|Reference 
           
           set 
           
           descriptor|
Figure 6. Reference Set Descriptor Concept in the Metadata Hierarchy 


Values in the 
 Gloss
tReference Set
Values in the are populated from:
  •  Anchor
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__e
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__e
     Scg expressionShowPartsid+term
     Concept
    t900000000000454005|Foundation 
     
     metadata 
     
     concept|
    ShowFormat
    scg-expression
    inline
    • ShowParts
       Concept
      id+term
      t900000000000457003|Reference 
       
       set 
       
       attribute|
       Anchor
      _d3887261-8892-4cad-a1c5-fd2ec50eb656__f
      _d3887261-8892-4cad-a1c5-fd2ec50eb656__f
      • scg-expression
         Concept
        ShowParts
        t
        id+term
        900000000000458008|Attribute 
         
         description|
         Scg expressionShowPartsid+term
      •  Concept
        t900000000000459000|Attribute 
         
         type|
         Anchor
        _d3887261-8892-4cad-a1c5-fd2ec50eb656__b
        _d3887261-8892-4cad-a1c5-fd2ec50eb656__b
        •  Concept
          t
           Scg expressionShowPartsid+term
          900000000000460005|Component 
           
           type|
          ShowFormat
          scg-expression
          inline
          • ShowParts
             Concept
            id+term
            t900000000000461009|Concept 
             
             type 
             
             component|
             Scg expressionShowPartsid+term
          •  Concept
            t900000000000462002|Description 
             
             type 
             
             component|
             Scg expressionShowParts
          •  Concept
            t
            id+term
            900000000000463007|Relationship 
             
             type 
             
             component|
             Scg expressionShowPartsid+term
          •  Concept
            t900000000000464001|Reference 
             
             set 
             
             member 
             
             type 
             
             component|
           Scg expressionShowPartsid+term
        •  Concept
          t900000000000465000|String|
           Anchor
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__a
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__a
          • scg-expression
             Concept
            ShowParts
            t
            id+term
            900000000000466004|Text|
             Anchor
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__7
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__7
            •  Concept
              t
               Scg expressionShowPartsid+term
              900000000000467008|Single 
               
               character|
               Scg expressionShowPartsid+term
            •  Concept
              t900000000000468003|Text 
               
               < 
               
               256 
               
               bytes|
             Scg expressionShowPartsid+term
          •  Concept
            t900000000000469006|URL|
             Anchor
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__0
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__0
            • scg-expression
               Concept
              ShowParts
              t
              id+term
              900000000000470007|HTML 
               
               reference|
               Scg expressionShowPartsid+term
            •  Concept
              t900000000000471006|Image 
               
               reference|
               ...
            scg-expression
          •  Concept
            ShowParts
            t
            id+term
            900000000000474003|UUID|
             Scg expressionShowPartsid+term
          •  Concept
            t900000000000475002|Time|
          scg-expression
        •  Concept
          ShowParts
          t
          id+term
          900000000000476001|Integer|
           Anchor
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__c
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__c
          • scg-expression
             Concept
            ShowParts
            t
            id+term
            900000000000477005|Signed 
             
             integer|
            scg-expression
          •  Concept
            ShowParts
            t
            id+term
            900000000000478000|Unsigned 
             
             integer|
        •  Anchor
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__4
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__4
          scg-expression
           Concept
          ShowParts
          t
          id+term
          900000000000460005|Component 
           
           type|
           ... Scg expressionShowPartsid+term
        •  Concept
          t900000000000465000|String|
           ... Scg expressionShowParts
        •  Concept
          t
          id+term
          900000000000476001|Integer|
           ...
         Scg expressionShowPartsid+term
      •  Concept
        t900000000000479008|Attribute 
         
         order|
         Scg expressionShowParts
      •  Concept
        t
        id+term
        900000000000491004|Attribute 
         
         value|
         ...
Figure 7. Reference Set Attribute Metadata Hierarchy 
...


 Excerpt Include
REUSE:Notes on Reference Set Example Tables
REUSE:Notes on Reference Set Example Tables
nopaneltrue
Descriptor Template
...
The table below shows the descriptor that defines the structure of the 
scg-expression
 Concept
ShowParts
t
id+term
900000000000456007|Reference 
 
 set 
 
 descriptor|
. 
...
Note that this descriptor is itself part of the 
 Concept
t
...
900000000000456007|Reference 
...
 set 
...
 descriptor|
 that it describes!

 . 
 
 
 
 
      
refsetId
referencedComponentId (Referenced component)
attributeDescription (Attribute description)
attributeType (Attribute type)
attributeOrder (Attribute order)
 
 Scg expressionShowPartsid+term
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
scg-expression
 Concept
ShowParts
t
id+term
900000000000456007|Reference 
 
 set 
 
 descriptor|
scg-expression
 Concept
ShowParts
t
id+term
449608002|Referenced 
 
 component|
scg-expression
 Concept
ShowParts
t
id+term
900000000000461009|Concept 
 
 type 
 
 component|
0
 
 Scg expressionShowPartsid+term
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expressionShowPartsid+term
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expression
 Concept
t
ShowPartsid+term
900000000000458008|Attribute 
 
 description|
 Scg expressionShowPartsid+term
 Concept
t900000000000461009|Concept 
 
 type 
 
 component|
1
 
 Concept
 Scg expression
ShowPartsid+term
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expressionShowPartsid+term
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
scg-expression
 Concept
ShowParts
t
id+term
900000000000459000|Attribute 
 
 type|
 Scg expressionShowPartsid+term
 Concept
t900000000000461009|Concept 
 
 type 
 
 component|
2
 
 Concept
 Scg expression
ShowPartsid+term
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expressionShowPartsid+term
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expression
 Concept
t
ShowPartsid+term
900000000000479008|Attribute 
 
 order|
scg-expression
 Concept
ShowParts
t
id+term
900000000000478000|Unsigned 
 
 integer|
3
 
...