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

The

Concept

t	900000000000456007\|Reference set descriptor\|

is a

Gloss

t	reference set

that used to specify the format of all

Gloss

t	reference sets

included in a release. The data type and meaning of the referenced component and each additional field within each

Gloss

t	reference set

is described by this

Gloss

t	reference set

.

Gloss

t	Reference set

descriptor can be used to define

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

This allows for a

Gloss

t	reference set

to be validated using the metadata embedded within the

Gloss

t	reference set

descriptor in the following ways:

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

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

The

Gloss

t	Reference set descriptor reference set

is a

Gloss

t	Component

-

Gloss

t	Component

- Integer

Gloss

t	reference set

that specifies the structure of reference sets. Its structure is shown in the following table.

Field

Data type

Purpose

Gloss

t	Mutable
LinkType	subtle

Part of Primary Key

id

Specref

RefType	(data type)
t	UUID

A 128 bit unsigned

Specref

RefType	(data type)
t	Integer

, uniquely identifying this

Gloss

t	reference set member

.

Different versions of a reference set member share the same

Specref

RefType	(field)
t	id

but have different

Specref

RefType	(field)
t	effectiveTime

. This allows a reference set member to be modified or made

Specref

RefType	(field)
t	active

(i.e. removed from the active set) at a specified time.

NO

YES (Full/ Snapshot)

Specref

RefType	(field)
t	effectiveTime

Specref

RefType	(data type)
t	Time

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

Gloss

Space	true
t	reference set member

became the current version.

The current version of this

Gloss

Space	true
t	reference set member

at time T is the version with the most recent

Specref

RefType	(field)
t	effectiveTime

prior to or equal to time T .

YES

YES (Full)

Optional (Snapshot)

Specref

RefType	(field)
t	active

Specref

RefType	(data type)
t	Boolean

The state of the identified

Gloss

Space	true
t	reference set member

as at the specified

Specref

RefType	(field)
t	effectiveTime

.

If

Specref

RefType	(field)
t	active

= 1 (true) the

Gloss

Space	true
t	reference set member

is part of the current version of the set, if

Specref

RefType	(field)
t	active

= 0 (false) the

Gloss

Space	true
t	reference set member

is not part of the current version of the set.

YES

NO

Specref

RefType	(field)
t	moduleId

Specref

RefType	(data type)
t	SCTID

Identifies the

Gloss

Space	true
t	SNOMED CT module

that contains this

Gloss

Space	true
t	reference set member

as at the specified

Specref

RefType	(field)
t	effectiveTime

.

The value must be a

Gloss

Space	true
t	subtype

of

Concept

t	900000000000443000\|Module (core metadata concept)\|
ShowFormat	inline

within the metadata

Gloss

t	hierarchy

.

YES

NO

Specref

RefType	(field)
t	refsetId

Specref

RefType	(data type)
t	SCTID

Identifies the

Gloss

Space	true
t	reference set

to which this

Gloss

Space	true
t	reference set member

belongs.

Note: In this case, the refsetId is always

Concept

t	900000000000456007\|Reference set descriptor\|

as there is only one reference set of this type.

NO

Specref

RefType	(field)
t	referencedComponentId

Specref

RefType	(data type)
t	SCTID

A reference to the

Gloss

Space	true
t	SNOMED CT component

to be included in the

Gloss

t	reference set

.

NO

Specref

RefType	(field)
t	attributeDescription

Specref

RefType	(data type)
t	SCTID

Specifies the name of an attribute that is used in the

Gloss

t	reference set

to which this descriptor applies.

Set to a

Gloss

t	descendant

of

Concept

t	900000000000457003\|Reference set attribute (foundation metadata concept)\|

in the metadata

Gloss

t	hierarchy

, that describes the additional attribute extending the

Gloss

t	reference set

.

NO

Specref

RefType	(field)
t	attributeType

Specref

RefType	(data type)
t	SCTID

Specifies the data type of this attribute in the

Gloss

t	reference set

to which this descriptor applies.

Set to a

Gloss

t	descendant

of

Concept

t	900000000000459000\|attribute type (foundation metadata concept)\|

in the metadata

Gloss

t	hierarchy

, that describes the type of the additional attribute extending the

Gloss

t	reference set

.

NO

Specref

RefType	(field)
t	attributeOrder

Integer

Specifies the position of this attribute in the

Gloss

t	reference set

to which this descriptor applies. A zero value identifies the

Specref

RefType	(field)
t	referencedComponentId

within the

Gloss

t	reference set

. Other values specify an additional attributes by its position relative to the

Specref

RefType	(field)
t	referencedComponentId

. Within a particular descriptor,

Specref

RefType	(field)
t	attributeOrder

values for a particular

Specref

RefType	(field)
t	referencedComponentId

must be contiguous.

An unsigned

Specref

RefType	(data type)
t	Integer

, providing an ordering for the additional attributes extending the

Gloss

t	reference set

.

NO

At least one row must exist for each

Gloss

t	reference set

included in a release. This row must have an

Specref

RefType	(field)
t	attributeOrder

value of '0' and an

Specref

RefType	(field)
t	attributeType

of '

Gloss

t	component

type' (or one of its

Gloss

t	descendants

). The

Specref

RefType	(field)
t	referencedComponentId

identifies the

Gloss

t	reference set

defined by the descriptor.

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

Gloss

t	reference set

.

Creation of

Gloss

t	Reference set

descriptor data is mandatory when creating a new

Gloss

t	reference set

in the

Gloss

t	International Release

or in a

Gloss

t	National Extension

.

Creation of a

Gloss

t	Reference set

descriptor is optional when creating a

Gloss

t	reference set

in another

Gloss

t	Extension

. If a descriptor is not created, the descriptor of the closest

Gloss

t	ancestor

of the

Gloss

t	reference set

is used when validating

Gloss

t	reference set

member records.

Metadata

The following metadata in the |Foundation metadata

Gloss

t	concept

|

Gloss

t	hierarchy

supports the

Gloss

t	reference set

descriptor

Gloss

t	reference set

.

The

Gloss

t	Reference Set

Descriptor

Gloss

t	Reference Set

is specified by the

Concept

t	900000000000456007\|Reference set descriptor\|
ShowFormat	inline

Gloss

t	concept

in the metadata hierarchy.

Anchor
_d3887261-8892-4cad-a1c5-fd2ec50eb656__d
_d3887261-8892-4cad-a1c5-fd2ec50eb656__d
Concept
t 900000000000441003|SNOMED CT Model Component|
Anchor
_d3887261-8892-4cad-a1c5-fd2ec50eb656__8
_d3887261-8892-4cad-a1c5-fd2ec50eb656__8
- Concept
  t 900000000000454005|Foundation metadata concept|
  Anchor
  _d3887261-8892-4cad-a1c5-fd2ec50eb656__2
  _d3887261-8892-4cad-a1c5-fd2ec50eb656__2
  - Concept
    t 900000000000455006|Reference set|
    ShowFormat inline
    - Concept
      t 900000000000456007|Reference set descriptor|

Values in the

Gloss

t	Reference Set

are populated from:

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

Excerpt Include

	REUSE:Notes on Reference Set Example Tables
	REUSE:Notes on Reference Set Example Tables
nopanel	true

Descriptor Template

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

Concept

t	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)

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	449608002\|Referenced component\|

Concept

t	900000000000461009\|Concept type component\|

0

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000458008\|Attribute description\|

Concept

t	900000000000461009\|Concept type component\|

1

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000459000\|Attribute type\|

Concept

t	900000000000461009\|Concept type component\|

2

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000456007\|Reference set descriptor\|

Concept

t	900000000000479008\|Attribute order\|

Concept

t	900000000000478000\|Unsigned integer\|

3

Search

Versions Compared

Old Version 5

New Version 6

Key

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

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

Metadata

Descriptor Template

Search

Page History

Versions Compared

Old Version 5

New Version 6

Key

Anchor_848bae5e-6edd-43f2-aaa0-f9ea40714de6_848bae5e-6edd-43f2-aaa0-f9ea40714de6Purpose

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

Metadata

Descriptor Template

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

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