Release File Specification

Search

 This Document

Search

 All Library Documents

Search

---

---

 Other Documents

SNOMED CT Document Library

Loading...

Browse pages

ConfigureSpace tools

• View Page
• • Remove Read Confirmation

  • Attachments (0)
  • Scaffolding History
  • Page History

  • Page Information
  • View in Hierarchy
  • View Source
  • View Scaffolding XML
  • Export to PDF
  • Export to Word
  • Export to PDF

  • Hide Inline Comments
  • Copy with Scaffolding XML

Page History

Versions Compared

Old Version 7

changes.mady.by.user Linda Bird

Saved on 2017-Feb-22

compared with

New Version Current

changes.mady.by.user Jon Zammit

Saved on 2024-May-28

• Previous Change: Difference between versions 6 and 7
• View Page History

Key

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

The effectiveTime

Specref
RefType (field)

andfields in theenable

t effectiveTime

and

Gloss
PreSpace false t active

fields in the

Gloss
PreSpace false t release file

enable the use of a "log style" append-only data model to track all changes to each

Gloss
PreSpace false t component

, providing full traceability. Once released, a row in any of these files will always remain unchanged. Historic data is supplied in thedating the

Gloss
PreSpace false t RF2

Gloss
PreSpace false t release files,

dating back to the first release informat in

Gloss
PreSpace false t RF1

format in 2002.

In order to change the properties of a current (and, therefore, to create a new version of it), a new row is added to the applicable file, containing the updated fields, with thefield

Gloss
PreSpace false t component

 a new version of that component is created with the same identifier. This done by adding a new row to the relevant release file, with the column values updated to represent the changes. The

Gloss
PreSpace false t active

field must be set to true and the timestamp in the effectiveTime

Specref
RefType (field) t effectiveTime

field indicating the nominal date on which the new version was released. Note that the existing row is not changed in any way.

To inactivate aa a

Gloss
PreSpace false t component,

a new row is added, containing the same data as the final valid version of thebut with thefield the

Gloss
PreSpace false t component,

but with the

Gloss
PreSpace false t active

field set to false and the timestamp in the effectiveTime

Specref
RefType (field)

field

t effectiveTime

fi eld indicating the nominal date of the release in which the final version ceased being valid. Note again that the existing row is not changed in any way.

Where editorial policy does not allow a particular property of ato a

Gloss
PreSpace false t component

to be changed whilst keeping the sametheas the same

Gloss
PreSpace false t Identifier,

the

Gloss
PreSpace false t component

as a whole is inactivated (as described above), and a new row added with a new id, the effectiveTime

Specref
RefType (field) t effectiveTime

set to the nominal date of the release in which this version of thebecame the

Gloss
PreSpace false t component

became valid, and thefield the

Gloss
PreSpace false t active

field set to true.

It is thus possible to see both the current values and any historical values of aat a

Gloss
PreSpace false t component

at any point in time.

New content, changes and inactivations must have the

Specref
RefType (field) t effectiveTime

 for Content will not be future dated with respect to the release that it appears in, although a release itself may be released a few days before its nominal release date. . Pre-releases for testing may set the effectiveTime as the date of the future scheduled release but in general the effectiveTime must not be later that the scheduled release data,  Where there is a business requirement for specifying a future activation date for somethis some

Gloss
PreSpace false t components,

this may be modeled represented using

Gloss
PreSpace false t reference sets.

The following example demonstrates how the history mechanism works on the Concept file

Specref
RefType file t Concept

, but the same rules apply equally well to theandmember the

Gloss
PreSpace false t Description,

Gloss
PreSpace false t Relationship

and

Gloss
PreSpace false t Reference set

member files. In this example, theassociated with the moduleId the

Gloss
PreSpace false t descriptions

associated with the

Specref
RefType (field)

and definitionStatusId

t moduleId

and

Specref
RefType (field) t definitionStatusId

have been shown in place of their SCTID

Specref
RefType (data type) t SCTID

values.

A new

Gloss
PreSpace false t concept

 (101291009) is added ad ded on the 1st July 2007:

Caption label
CapId -history-example-concept-added CapType Table
History Example - Concept Added

term

Id	Specref RefType (field) t effectiveTime	Gloss PreSpace false t active	Specref RefType (field)    t moduleId	Specref RefType (field) t definitionStatusId (field)
101291009	20070701	1	Concept t
Scg expression
ShowParts

|Module

1|

scg-expression

Concept

ShowParts

t

id+term

900000000000074008|Primitive|

In the next following release (on 1st January 2008), theis the

Gloss
PreSpace false t concept

is moved from |Module 1| to |Module 2|. Because the moduleId field is not immutable, themay the

Gloss
PreSpace false t concept

may be updated simply by adding a new record with the same Id.

Caption label
CapId history-example-module-change CapType Table
History Example - Module Change

Id	Specref RefType (field) t effectiveTime	Gloss PreSpace false t active	Specref RefType (field)    t moduleId	Specref RefType (field) t definitionStatusId (field)
101291009	20070701	1	scg-expression Concept ShowParts t	term

|Module

1|

scg-expression

Concept

ShowParts

t

id+term

900000000000074008|Primitive|

101291009

20080101

1

Concept
t

Scg expressionShowPartsterm

|Module

2|

Scg expressionShowPartsid+term

Concept
t 900000000000074008|Primitive|

In the next following release (on 1st July 2008), theis changed from beingto beingthe

Gloss
PreSpace false t concept

is changed from being

Gloss
PreSpace false t Primitive

to being

Gloss
PreSpace false t Fully defined.

Caption label
CapId history-example-definition-status-changed CapType Table
History Example - Definition Status Changed

term

Id	Specref RefType (field) t effectiveTime	Gloss PreSpace false t active	Id	effectiveTime Specref RefType (field)    t moduleId	Specref RefType (field) t definitionStatusId (field)
101291009	20070701	1	Concept t
Scg expression
ShowParts

|Module

1|

scg-expression

Concept
t 900000000000074008|Primitive|

101291009

20080101

1

Concept
t

Scg expressionShowPartsterm

|Module

2|

Scg expressionShowPartsid+term

Concept
t 900000000000074008|Primitive|

101291009

20080701

1

scg-expression

Concept

ShowParts

t

term

|Module

2|

Scg expressionShowPartsid+term

Concept
t 900000000000073002|Defined|

In the next following release (on 1st January 2009), theis deactivated:the

Gloss
PreSpace false t concept

is deactivated:

Caption label
CapId history-example-concept-made-inactive- CapType Table
History Example - Concept Made Inactive

term

Id	Specref RefType (field) t effectiveTime	Gloss PreSpace false t active	Id	effectiveTime Specref RefType (field)    t moduleId	Specref RefType (field) t definitionStatusId (field)
101291009	20070701	1	Concept t
Scg expression
ShowParts

|Module

1|

Scg expressionShowPartsid+term

Concept
t 900000000000074008|Primitive|

101291009

20080101

1

Concept
t

Scg expressionShowPartsterm

|Module

2|

Scg expressionShowPartsid+term

Concept
t 900000000000074008|Primitive|

101291009

20080701

1

Concept
t

Scg expressionShowPartsterm

|Module

2|

Scg expressionShowPartsid+term

Concept
t 900000000000073002|Defined|

101291009

20090101

0

scg-expression

Concept

ShowParts

t

term

|Module

2|

Scg expressionShowPartsid+term

Concept
t 900000000000074008|Primitive|

Notes

1. At no stage in this process are previously written records ever amended. Once a record has been released in ait a

   Gloss
   PreSpace false t release file,

   it will continue to be released in exactly the same form in future

   Gloss
   PreSpace false t release files.

2. Changes are only recorded at the point of release in theIf arecord the

   Gloss
   PreSpace false t RF2

   Gloss
   PreSpace false t release files.

   If a

   Gloss
   PreSpace false t component

   record is changed a number of times between releases (during an edit and review process), only the most recently amended record will be appended to thenot the

   Gloss
   PreSpace false t release file,

   not individual records showing each separate edit to the released

   Gloss
   PreSpace false t component.

3. In the last example, as well as inactivating the concept (active=0), the definitionStatusId

   Specref
   RefType (field) t definitionStatusId

   is changed from id+term

   Scg expression
   ShowParts

   Concept
   t 900000000000073002|Defined| ShowFormat

   to

   inline

   scg-expression to ShowFormat

   Concept

   nospace

   t 900000000000074008|Primitive|

   . In practice this change is not essential since the value of data columns is ignored when ais a

   Gloss
   PreSpace false t component

   is inactive. Although the change is unnecessary and insignificant, it typically occurs since all the relationships of an inactive concept must also be inactive, and as a result, from the perspective of the authoring environment the concept cannot be regarded as scg-expression

   Concept

   ShowFormat

   t

   nospace

   900000000000073002|Defined|

   .

Related Links

...

1. .

...