Search

 This Document

 All Library Documents



 Other Documents
Skip to end of metadata
Go to start of metadata

Purpose

The 900000000000456007 |Reference set descriptor| is a reference set that is 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.

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.

Table 5.2.11-4: Reference set descriptor reference set - Data structure

Field

Data type

Purpose

Part of Primary Key

id

A 128 bit unsigned Integer, uniquely identifying this reference set member.

Different versions of a reference set member share the same id but have different effectiveTime. This allows a reference set member to be modified or made inactive (i.e. removed from the active set) at a specified time.

NOYES (Full /Snapshot)

The inclusive date or time at which this version of the identified reference set member became the current version.

Note: In distribution files the effectiveTime should follow the short ISO date format (YYYYMMDD) and should not include the hours, minutes, seconds or timezone indicator.

The current version of this reference set member at time T is the version with the most recent effectiveTime prior to or equal to time T .

YES

YES (Full)

Optional (Snapshot) 

The state of the identified reference set member as at the specified effectiveTime .

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

YESNO

Identifies the SNOMED CT module that contains this reference set member as at the specified effectiveTime .

The value must be a subtype of 900000000000443000 |Module (core metadata concept)|within the metadata hierarchy.

YESNO

Identifies the reference set to which this reference set member belongs.

In this case, the refsetId is always 900000000000456007 |Reference set descriptor| as there is only one reference set of this type.

NONO

A reference to the SNOMED CT component to be included in the reference set.

Refers to the concept that identifies the reference set (or reference set type) defined by this descriptor.

NONO

attributeDescription

SCTID

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

Set to a descendant of 900000000000457003 |Reference set attribute (foundation metadata concept)| in the metadata hierarchy, that describes the additional attribute extending the reference set .

NONO

attributeType

SCTID

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

Set to a descendant of 900000000000459000 |attribute type (foundation metadata concept)| in the metadata hierarchy, that describes the type of the additional attribute extending the reference set .

NONO

attributeOrder

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

An unsigned Integer, providing an ordering for the additional attributes extending the reference set .

NONO


At least one row must exist for each reference set included in a release. This row must have an attributeOrder value of '0' and an attributeType of ' component type' (or one of its descendants). The referencedComponentId 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.

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 in the metadata hierarchy.

Table 5.2.11-4: Reference Set Descriptor Concept in the Metadata Hierarchy

Values in the Reference Set are populated from:

Table 5.2.11-4: Reference Set Attribute Metadata Hierarchy

Reference Set Descriptor and Example Data

Notes on the tables used to show descriptors and examples

The reference set example tables on this page have been revised as follows to aid clarity and understanding:

  • The first four columns which are present in all release files are not shown. The omitted columns (ideffectiveTimeactivemoduleId) are used in the same way in all referenced sets to support identification, versioning and packaging. They do not directly affect the specific features of a particular reference set or reference set type.
  • Reference set columns that contain SNOMED CT identifiers are expanded to show details of the concept or description referenced by that identifier. In some cases, the term is shown in the same column using the expression syntax, in other cases an additional column with a name suffix '_term' has been added. In the standard reference set files only the identifier is present in the column and there is no added column for the term. When using reference sets, the term and other details of the component are looked up from the relevant component release files.

Descriptor Template

The table below shows the descriptor that defines the structure of the 900000000000456007 |Reference set descriptor|. Note that this descriptor is itself part of the  900000000000456007 |Reference set descriptor| that it describes!

Table 5.2.11-4: Refset Descriptor rows for


Feedback