Page History
Anchor | ||||
---|---|---|---|---|
|
The 900000000000456007 $$ Reference set descriptor $$ is a reference set
Scg expression | ||
---|---|---|
| ||
900000000000456007|Reference set descriptor| |
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 | ||||
---|---|---|---|---|
|
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.
|
|
| |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Field | Data type | Purpose | |||||||||||
A 128 bit unsigned | integerInteger (data type), uniquely identifying this | reference set member . Different versions of a reference set member share the same id (field) but have different | effectiveTimeseffectiveTime (field). This allows a reference set member to be modified or made | inactive active (field) (i.e. removed from the active set) at a specified time. | |||||||||
The inclusive date or time at which this version of the identified | reference set member became the current version. The current version of this | reference set member at time T is the version with the most recent effectiveTime (field) prior to or equal to time T . | |||||||||||
The state of the identified | reference set member as at the specified effectiveTime (field) . If active (field) = 1 (true) the | reference set member is part of the current version of the set, if active (field) = 0 (false) the | reference set member is not part of the current version of the set. | ||||||||||
Identifies the | SNOMED CT module that contains this | reference set member as at the specified effectiveTime (field) . The value must be a | subtype of 900000000000443000 $$ Module (core metadata concept) $$ of
| hierarchy . | |||||||||
Identifies the | reference set to which this | reference set member belongs. In this case, set to | 900000000000456007 $$ Reference set descriptor $$
| ||||||||||
Identifies the | Identifies the reference set | (or type of | reference set ) that is specified by this descriptor. Set to a | descendant of 900000000000455006 $$ reference set (foundation metadata concept) $$ of
| hierarchy . | ||||||||
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) $$ of
| hierarchy, that describes the additional attribute extending the | reference set . | |||||||||
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) $$ of
| hierarchy, that describes the type of the additional attribute extending the | reference set . | |||||||||
Specifies the position of this attribute in the | reference set to which this descriptor applies. A zero value identifies the referencedComponentId (field) within the | reference set. 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 | integerInteger (data type), providing an ordering for the additional attributes extending the | reference set . |
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 | ||||
---|---|---|---|---|
|
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 | ||
---|---|---|
| ||
900000000000456007|Reference set descriptor| |
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__d _d3887261-8892-4cad-a1c5-fd2ec50eb656__d
900000000000441003 $$ SNOMED CT Model Component $$Scg expression ShowParts id+term 900000000000441003|SNOMED CT Model Component|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__8 _d3887261-8892-4cad-a1c5-fd2ec50eb656__8
900000000000454005 $$ Foundation metadata concept $$Scg expression ShowParts id+term 900000000000454005|Foundation metadata concept|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__2 _d3887261-8892-4cad-a1c5-fd2ec50eb656__2 Scg expression ShowParts id+term 900000000000455006|Reference set|
Scg expression ShowParts id+term 900000000000456007|Reference set descriptor|
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 ShowParts id+term 900000000000454005
concept $$|Foundation metadata
concept|
$$Scg expression ShowParts id+term 900000000000457003
$$|Reference set attribute
|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__f _d3887261-8892-4cad-a1c5-fd2ec50eb656__f Scg expression - 900000000000458008 $$ Attribute description $$
ShowParts id+term 900000000000458008|Attribute description|
900000000000459000 $$ Attribute type $$Scg expression ShowParts id+term 900000000000459000|Attribute type|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__b _d3887261-8892-4cad-a1c5-fd2ec50eb656__b
$$Scg expression ShowParts id+term 900000000000460005
type $$|Component
type|
$$Scg expression ShowParts id+term 900000000000461009
component $$|Concept type
component|
$$Scg expression ShowParts id+term 900000000000462002
component $$|Description type
component|
$$Scg expression ShowParts id+term 900000000000463007
component $$|Relationship type
component|
$$Scg expression ShowParts id+term 900000000000464001
component $$|Reference set member type
component|
$$Scg expression ShowParts id+term 900000000000465000
$$|String
|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__a _d3887261-8892-4cad-a1c5-fd2ec50eb656__a
$$Scg expression ShowParts id+term 900000000000466004
$$|Text
|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__7 _d3887261-8892-4cad-a1c5-fd2ec50eb656__7
$$Scg expression ShowParts id+term 900000000000467008
character $$|Single
character|
$$Scg expression ShowParts id+term 900000000000468003
bytes $$|Text < 256
bytes|
$$Scg expression ShowParts id+term 900000000000469006
$$|URL
|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__0 _d3887261-8892-4cad-a1c5-fd2ec50eb656__0
$$Scg expression ShowParts id+term 900000000000470007
reference $$|HTML
reference|
$$Scg expression ShowParts id+term 900000000000471006
$$|Image reference
...|
- 900000000000474003 $$ UUID $$
- 900000000000475002 $$ Time $$
Scg expression ShowParts id+term 900000000000474003|UUID|
Scg expression ShowParts id+term 900000000000475002|Time|
900000000000476001 $$ Integer $$Scg expression ShowParts id+term 900000000000476001|Integer|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__c _d3887261-8892-4cad-a1c5-fd2ec50eb656__c Scg expression - 900000000000477005 $$ Signed integer $$
ShowParts id+term 900000000000477005|Signed integer|
900000000000478000 $$ Unsigned integer $$Scg expression ShowParts id+term 900000000000478000|Unsigned integer|
Anchor _d3887261-8892-4cad-a1c5-fd2ec50eb656__4 _d3887261-8892-4cad-a1c5-fd2ec50eb656__4
$$Scg expression ShowParts id+term 900000000000460005
$$|Component type
...|
900000000000465000 $$ String $$Scg expression
...ShowParts id+term 900000000000465000|String|
$$Scg expression ShowParts id+term 900000000000476001
$$|Integer
...|
$$Scg expression ShowParts id+term 900000000000479008
order $$|Attribute
order|
$$Scg expression ShowParts id+term 900000000000491004
$$|Attribute value
...|
Figure 7. Reference Set Attribute Metadata Hierarchy
Anchor | ||||
---|---|---|---|---|
|
The table below shows the descriptor that defines the structure of the 900000000000456007 $$ Reference set descriptor $$
Scg expression | ||
---|---|---|
| ||
900000000000456007|Reference set descriptor| |
| 900000000000456007 $$ Reference set descriptor $$
|
|
|
|
| |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
refsetId | referencedComponentId (Referenced component) | attributeDescription (Attribute description) | attributeType (Attribute type) | attributeOrder (Attribute order) |
| |||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||
0 |
| |||||||||||||||||||||||||||||
1 |
| |||||||||||||||||||||||||||||
2 |
| |||||||||||||||||||||||||||||
|
|
|
| 0 |
| |||||||||||||||||||||||||
|
|
|
| 1 |
| |||||||||||||||||||||||||
|
|
|
| 2 |
| |||||||||||||||||||||||||
|
|
|
| 900000000000478000 $$ Unsigned integer $$ | 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 .