Search



Versions Compared

Key

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

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

The 900000000000456007 $$ Reference set descriptor $$ is a reference set

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

descriptor can be used to define

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

This allows for a reference set to be validated using the metadata embedded within the reference set descriptor in the following ways:

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

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

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

integer reference set member effectiveTimes inactive reference set member reference set member reference set member reference set member reference set member SNOMED CT module reference set member subtype of 900000000000443000 $$ Module (core metadata concept) $$ hierarchy reference set reference set member 900000000000456007 $$ Reference set descriptor $$ Identifies the reference set reference set descendant of 900000000000455006 $$ reference set (foundation metadata concept) $$ hierarchy reference set descendant of 900000000000457003 $$ Reference set attribute (foundation metadata concept) $$ hierarchy reference set reference set descendant of 900000000000459000 $$ attribute type (foundation metadata concept) $$ hierarchy reference set reference set reference set integer reference set

Anchor
_5c7e8c94-101c-450c-827d-573470153540__4
_5c7e8c94-101c-450c-827d-573470153540__4
Table 17. Reference set descriptor reference set - Data structure

 

 

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

referencedComponentId

SCTID

(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

.

At least one row must exist for each reference set included in a release. This row must have an attributeOrder (field) value of '0' and an attributeType (field) of ' component type' (or one of its descendants ). The referencedComponentId (field) identifies the reference set defined by the descriptor.

There is one additional row for each additional column present in the specified reference set .

Creation of Reference set descriptor data is mandatory when creating a new reference set in the International Release or in a National Extension .

Creation of a Reference set descriptor is optional when creating a reference set in another Extension . If a descriptor is not created, the descriptor of the closest ancestor of the reference set is used when validating reference set member records.

Anchor
_d3887261-8892-4cad-a1c5-fd2ec50eb656
_d3887261-8892-4cad-a1c5-fd2ec50eb656
Metadata

The following metadata in the |Foundation metadata concept | hierarchy supports the reference set descriptor reference set .

The Reference Set Descriptor Reference Set is specified by the 900000000000456007 $$ Reference set descriptor $$ concept

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
in the metadata hierarchy.

Figure 6. Reference Set Descriptor Concept in the Metadata Hierarchy

Values in the Reference Set are populated from:

  • Anchor
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__e
    _d3887261-8892-4cad-a1c5-fd2ec50eb656__e
    Scg expression
    ShowPartsid+term
    900000000000454005
    $$
    |Foundation metadata
    concept $$
     concept|
    • Scg expression
      ShowPartsid+term
      900000000000457003
      $$
      |Reference set attribute
      $$
      |
      Anchor
      _d3887261-8892-4cad-a1c5-fd2ec50eb656__f
      _d3887261-8892-4cad-a1c5-fd2ec50eb656__f
      • Scg expression
      • 900000000000458008 $$ Attribute description $$
      • ShowPartsid+term
        900000000000458008|Attribute description|
      • Scg expression
        ShowPartsid+term
        900000000000459000|Attribute type|
        900000000000459000 $$ Attribute type $$
        Anchor
        _d3887261-8892-4cad-a1c5-fd2ec50eb656__b
        _d3887261-8892-4cad-a1c5-fd2ec50eb656__b
        • Scg expression
          ShowPartsid+term
          900000000000460005
          $$
          |Component
          type $$
           type|
          • Scg expression
            ShowPartsid+term
            900000000000461009
            $$
            |Concept type
            component $$
             component|
          • Scg expression
            ShowPartsid+term
            900000000000462002
            $$
            |Description type
            component $$
             component|
          • Scg expression
            ShowPartsid+term
            900000000000463007
            $$
            |Relationship type
            component $$
             component|
          • Scg expression
            ShowPartsid+term
            900000000000464001
            $$
            |Reference set member type
            component $$
             component|
        • Scg expression
          ShowPartsid+term
          900000000000465000
          $$
          |String
          $$
          |
          Anchor
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__a
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__a
          • Scg expression
            ShowPartsid+term
            900000000000466004
            $$
            |Text
            $$
            |
            Anchor
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__7
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__7
            • Scg expression
              ShowPartsid+term
              900000000000467008
              $$
              |Single
              character $$
               character|
            • Scg expression
              ShowPartsid+term
              900000000000468003
              $$
              |Text < 256
              bytes $$
               bytes|
          • Scg expression
            ShowPartsid+term
            900000000000469006
            $$
            |URL
            $$
            |
            Anchor
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__0
            _d3887261-8892-4cad-a1c5-fd2ec50eb656__0
            • Scg expression
              ShowPartsid+term
              900000000000470007
              $$
              |HTML
              reference $$
               reference|
            • Scg expression
              ShowPartsid+term
              900000000000471006
              $$
              |Image reference
              $$
              |
              ...
          • 900000000000474003 $$ UUID $$
          • 900000000000475002 $$ Time $$
          • Scg expression
            ShowPartsid+term
            900000000000474003|UUID|
          • Scg expression
            ShowPartsid+term
            900000000000475002|Time|
        • Scg expression
          ShowPartsid+term
          900000000000476001|Integer|
          900000000000476001 $$ Integer $$
          Anchor
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__c
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__c
        • Anchor
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__4
          _d3887261-8892-4cad-a1c5-fd2ec50eb656__4
          Scg expression
          ShowPartsid+term
          900000000000460005
          $$
          |Component type
          $$
          |
          ...
        • Scg expression
          900000000000465000 $$ String $$
          ShowPartsid+term
          900000000000465000|String|
          ...
        • Scg expression
          ShowPartsid+term
          900000000000476001
          $$
          |Integer
          $$
          |
          ...
      • Scg expression
        ShowPartsid+term
        900000000000479008
        $$
        |Attribute
        order $$
         order|
      • Scg expression
        ShowPartsid+term
        900000000000491004
        $$
        |Attribute value
        $$
        |
        ...

Figure 7. Reference Set Attribute Metadata Hierarchy

Anchor
_62fc1dda-d145-48be-ab58-cc5c1920e9e8
_62fc1dda-d145-48be-ab58-cc5c1920e9e8
Descriptor

The table below shows the descriptor that defines the structure of the 900000000000456007 $$ Reference set descriptor $$

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
.

900000000000456007 $$ Reference set descriptor $$ 900000000000478000 $$ Unsigned integer $$

Anchor
_62fc1dda-d145-48be-ab58-cc5c1920e9e8__0
_62fc1dda-d145-48be-ab58-cc5c1920e9e8__0
Table 18. Refset Descriptor rows for

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
.

 

 

 

 

refsetId

referencedComponentId (Referenced component)

attributeDescription (Attribute description)

attributeType (Attribute type)

attributeOrder (Attribute order)

 

Scg expression

900000000000456007 $$ Reference set descriptor $$

900000000000456007 $$ Reference set descriptor $$

449608002 $$ Referenced component $$

900000000000461009 $$ Concept type component $$

0

 

900000000000456007 $$ Reference set descriptor $$

900000000000456007 $$ Reference set descriptor $$

900000000000458008 $$ Attribute description $$

900000000000461009 $$ Concept type component $$

1

 

900000000000456007 $$ Reference set descriptor $$

900000000000456007 $$ Reference set descriptor $$

900000000000459000 $$ Attribute type $$

900000000000461009 $$ Concept type component $$

2

 

ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

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
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000458008|Attribute description|

Scg expression
ShowPartsid+term
900000000000461009|Concept type component|

1

 

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000459000|Attribute type|

Scg expression
ShowPartsid+term
900000000000461009|Concept type component|

2

 

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|

Scg expression
ShowPartsid+term
900000000000479008|Attribute order|

Scg expression
ShowPartsid+term
900000000000478000|Unsigned integer|

900000000000456007 $$ Reference set descriptor $$

900000000000456007 $$ Reference set descriptor $$

900000000000479008 $$ Attribute order $$

3

 

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 , moduleId(field), active (field). Additionally, to aid understanding, the table above also includes the term from one of the descriptions associated with each of the identified concept . The release file only contains the identifier .