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.

...

Purpose

A

scg-expression
Concept
ShowParts
t
id+term
900000000000506000|Language
type
reference
set|
supports the representation of
Gloss
PreSpacefalse
tlanguage
and
Gloss
PreSpacefalse
tdialects
preferences for the use of particular
Gloss
PreSpacefalse
tdescriptions
. The most common use case for this type of
Gloss
PreSpacefalse
treference set
is to specify the acceptable and preferred terms for use within a particular country or region. However, the same type of
Gloss
PreSpacefalse
treference set
can also be used to represent preferences for use of
Gloss
PreSpacefalse
tdescriptions
in a more specific context such as a clinical specialty, organization or department.

...

Data structure

A

Gloss
PreSpacefalse
tLanguage reference set
is a
Gloss
PreSpacefalse
tComponent
 
Gloss
PreSpacefalse
treference set

...

A is a that is used to indicate which

Gloss
PreSpacefalse
tdescriptions
contain
Gloss
PreSpacefalse
tterms
that are acceptable or preferred in a particular
Gloss
PreSpacefalse
tlanguage
or
Gloss
PreSpacefalse
tdialect
. Its structure is shown in the following table.

...

 

...

 

...

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, a of

Scg expression
ShowPartsid+term
900000000000506000|Language type reference set|
.

...

referencedComponentId (field)

...

SCTID (data type)

...

The identifier of a included in the .

...

acceptabilityId (field)

...

SCTID (data type)

...

A of

Scg expression
ShowPartsid+term
900000000000511003|Acceptability|
indicating whether the is acceptable or preferred for use in the specified or .


Caption label
CapIdlanguage-reference-set-data-structure
CapTypeTable
Language reference set - Data structure


Refset spec table
Sizefs7
RefsetTypeLanguage Reference Set
Language Reference Rules and Guidance
In a 
 Gloss
PreSpacefalse
tLanguage reference set
:
  • No more than one 
     Gloss
    PreSpacefalse
    tdescription
     of a specific 
     Gloss
    PreSpacefalse
    tdescription type
     associated with a single 
     Gloss
    PreSpacefalse
    tconcept
     may have the 
     Specref
    RefType(field)
    tacceptabilityId
     value 
     Concept
    t900000000000548007|Preferred|
    .
  • Every active concept should have one preferred synonym in each language. 
    • This means that a language reference set should assign the acceptabilityId  
       Concept
      t900000000000548007|Preferred|
        to one  
       Gloss
      PreSpacefalse
      tsynonym
       (a  
       Gloss
      PreSpacefalse
      tdescription
       with  
       Specref
      ttypeId
       value 
       Concept
      t900000000000013009 | synonym |
      ) associated with each 
       Gloss
      PreSpacefalse
      tconcept
       .
    • This description is the 
       Gloss
      PreSpacefalse
      tpreferred term
       for that 
       Gloss
      PreSpacefalse
      tconcept
       in the specified 
       Gloss
      PreSpacefalse
      tlanguage
       or 
       Gloss
      PreSpacefalse
      tdialect
      .
  • Any  
     Gloss
    PreSpacefalse
    tdescription
     which is not referenced by an active row in the  
     Gloss
    PreSpacefalse
    treference set
     is regarded as unacceptable (i.e. not a valid 
     Gloss
    PreSpacefalse
    tsynonym
     in the language or 
     Gloss
    PreSpacefalse
    tdialect
     ).
    • If a description becomes unacceptable, the relevant language reference set member is inactivated by adding a new row with the same id, the effectiveTime of the the change and the value active=0. 
    • For this reason there is no requirement for an "unacceptable" value. 
Metadata
The following metadata supports this 
 Gloss
PreSpacefalse
treference set
 :

 Caption label
CapIdlanguage-references-sets-in-the-metadata-hierarchy
CapTypeTable
Language References Sets in the Metadata Hierarchy

 Scg expression
Borderridge

  900000000000454005 |Foundation metadata concept|
		900000000000506000 |Language type|
				900000000000507009 |English|
						900000000000508004 |GB English|
						900000000000509007 |US English|


The immediate 
 Gloss
PreSpacefalse
tchildren
 of 
 Concept
ShowPartsterm
t900000000000506000 |Language type|
 will represent languages
In a : 
...
 Scg expression
ShowPartsid+term
900000000000548007|Preferred|
...
 Scg expression
ShowPartsid+term
900000000000548007|Preferred|
...
The following metadata supports this : 
...
 Scg expression
ShowPartsid+term
900000000000454005|Foundation metadata concept|
...
 Scg expression
ShowPartsid+term
900000000000455006|Reference set|
...
 Scg expression
ShowPartsid+term
900000000000456007|Reference set descriptor|
...
 Scg expression
ShowPartsid+term
900000000000480006|Attribute value type|
...
 Scg expression
ShowPartsid+term
900000000000496009|Simple map|
...
 Scg expression
ShowPartsid+term
900000000000506000|Language type|
...
 Scg expression
ShowPartsid+term
900000000000507009|English|
...
  •  Scg expression
    ShowPartsid+term
    900000000000508004|GB English|
  •  Scg expression
    ShowPartsid+term
    900000000000509007|US English|
Figure 13. Language References Sets in the Metadata Hierarchy 
The immediate of | type| will be . This level may be used to represent the "correct" formal approved" 
 Gloss
PreSpacefalse
tlanguage
, where a authority existslanguage authority is formally recognized. In most cases, however, this level is likely to be empty. 
...
will not identify a specific reference set. Subtype of the language level are used to represent different dialects, national or regional variants.
 Excerpt Include
REUSE:Notes on Reference Set Example Tables
REUSE:Notes on Reference Set Example Tables
nopaneltrue
Language Reference Descriptor
...
The table below shows an example of the descriptor for a specific 
 Gloss
PreSpacefalse
treference sets
 that follows the scg-expression
 Concept
ShowParts
t
id+term
900000000000506000|Language 
 
 type 
 
 reference 
 
 set|
 pattern.

 Caption label
...
CapId
...
refset-
...
descriptor-
...
rows-
...
for-a-language-reference-set
CapTypeTable
Refset Descriptor rows for a language reference set
...
 Scg expression
ShowPartsid+term
900000000000508004|GB English|
...
 
...
 
...
 
...

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
900000000000508004|GB 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
900000000000510002|Description 
 
 in 
 
 dialect|
scg-expression
 Concept
ShowParts
t
id+term
900000000000462002|Description 
 
 type 
 
 component|
0
 
 Scg expression
ShowPartsid+term
 Concept
t900000000000456007|Reference 
 
 set 
 
 descriptor|
 Scg expressionShowPartsid+term
 Concept
t900000000000508004|GB 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
900000000000511003|Acceptability|
scg-expression
 Concept
ShowParts
t
id+term
900000000000461009|Concept 
 
 type 
 
 component|
1
 
Note: The tables above omit the initial four columns of data present in the release file. These follow the standards versioning pattern id (field), effectiveTime (field), active (field), active (field). Additionally, to aid understanding, the tables above also show the from one of the associated with each of the identified . The release file only contains the . 
...
Language Reference Set Examples

 Caption label
CapIdsample-content-from-the-us-english-language-reference-set
CapTypeTable
Sample content from the US English language reference set

refsetId
referencedComponentId (Description)
acceptabilityId (Acceptability in dialect)
 Concept
t900000000000509007|US English|
 Concept
t42969009|Cauterization of skin 
 Anchor_48313b33-6c47-4357-8b68-88e8ae5b4745__1_48313b33-6c47-4357-8b68-88e8ae5b4745__1Table 41. Sample content from 
 Scg expression
ShowPartsid+term
900000000000509007|US English|
 . 
 
 
refsetId
referencedComponentId (Description in dialect)
acceptabilityId (Acceptability)
 Scg expression
ShowPartsid+term
900000000000509007|US English|
 Scg expression
ShowPartsid+term
42969009|Cauterization of skin 
 {id:71693012}|
 Scg expressionShowPartsid+term
 Concept
t900000000000548007|Preferred|
scg-expression
 Concept
ShowParts
t
id+term
900000000000509007|US 
 
 English|
 Scg expression
 Concept
t
ShowPartsid+term
42969009|Fulguration 
 
 of 
 
 subcutaneous 
 
 tissue 
 
 {id:71695017}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000549004|Acceptable|
scg-expression
 Concept
ShowParts
t
id+term
900000000000509007|US 
 
 English|
 Scg expression
 Concept
t
ShowPartsid+term
80146002|Appendectomy 
 
 {id:132967011}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000548007|Preferred|
scg-expression
 Concept
ShowParts
t
id+term
900000000000509007|US 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
80146002|Excision 
 
 of 
 
 appendix 
 
 {id:132972019}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000549004|Acceptable|
 Scg expressionShowPartsid+term
 Concept
t900000000000509007|US 
 
 English|
 Scg expression
 Concept
t
ShowPartsid+term
271737000|Anemia 
 
 {id:406636013}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000548007|Preferred|
scg-expression
 Concept
ShowParts
t
id+term
900000000000509007|US 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
271737000|Absolute 
 
 anemia 
 
 {id:406640016}|
 Scg expressionShowPartsid+term
 Concept
t900000000000549004|Acceptable|
 Anchor_48313b33-6c47-4357-8b68-88e8ae5b4745__d_48313b33-6c47-4357-8b68-88e8ae5b4745__d

 Caption label
CapIdsample-content-from-the-gb-english-language-reference-set
CapTypeTable
Sample content from the GB English language reference set

Table 42. Sample content from 
 Scg expression
ShowPartsid+term
900000000000508004|GB English|
 . 
 
 
refsetId
referencedComponentId (Description
 in dialect
)
acceptabilityId (Acceptability in dialect)
scg-expression
 Concept
ShowParts
t
id+term
900000000000508004|GB 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
42969009|Cauterisation 
 
 of 
 
 skin 
 
 {id:493493018}|
 Scg expressionShowPartsid+term
 Concept
t900000000000548007|Preferred|
scg-expression
 Concept
ShowParts
t
id+term
900000000000508004|GB 
 
 English|
 Scg expression
 Concept
t
ShowPartsid+term
42969009|Fulguration 
 
 of 
 
 subcutaneous 
 
 tissue 
 
 {id:71695017}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000549004|Acceptable|
 Scg expressionShowPartsid+term
 Concept
t900000000000508004|GB 
 
 English|
 Scg expression
 Concept
t
ShowPartsid+term
80146002|Excision 
 
 of 
 
 appendix 
 
 {id:132972019}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000549004|Acceptable|
scg-expression
 Concept
ShowParts
t
id+term
900000000000508004|GB 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
80146002|Appendicectomy 
 
 {id:132973012}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000548007|Preferred|
 Scg expressionShowPartsid+term
 Concept
t900000000000508004|GB 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
271737000|Anaemia 
 
 {id:406638014}|
scg-expression
 Concept
ShowParts
t
id+term
900000000000548007|Preferred|
scg-expression
 Concept
ShowParts
t
id+term
900000000000508004|GB 
 
 English|
scg-expression
 Concept
ShowParts
t
id+term
271737000|Absolute 
 
 anaemia 
 
 {id:406641017}|
 Scg expressionShowPartsid+term
 Concept
t900000000000549004|Acceptable|
In the above examples, 
term
 Scg expression
ShowParts
 Concept
t80146002|Excision 
 
 of 
 
 appendix|
 is acceptable in both US and GB English. However, scg-expression
 Concept
ShowParts
t
term
80146002|Appendectomy|
 is preferred in US English and term
 Scg expression
ShowParts
 Concept
t80146002|Appendicectomy|
 is preferred in GB English. Note: Any which is not referenced by an active row in the relevant language is regarded as unacceptable (i.e. not a valid in the language or ).