The services described in 3.7.1 Access Details of Terminology Changes get versioning data related to the addition, modification, or inactivation of individual terminology components. Many practical uses of this data require interpretation of the overall effect of a combination of changes to a concept. Therefore, it may be useful to integrate versioning data in ways that facilitate a review of the impact of these changes. A possible way to achieve this is illustrated by the data model in Figure 3.7.2-1.

A data structure of this type could be used to assist the identification of changes relevant to managing the impact of changes on EHR applications and Extensions in two ways:

By generating a human-readable version of the change data for use in manual review of existing data
As a computer processable resource from which queries can be generated to search records, user interface templates, reporting, and analytics queries and extensions for references for changed or inactivated concepts and descriptions.

Figure 3.7.2-1: Example Data Model for Integrated Versioning Data

Component Version Data

Each instance of the Component Version Data object represents the previous and new states of an identified concept, description¹, relationship or OWL axiom reference set member that has been added, changed, inactivated or reactivated between two specified versions of the same edition. Details of the data items in the example Component Version Data object are shown in Table 3.7.2-1.

Table 3.7.2-1: Component Version Data Object

Data Item	Notes
componentType	Indicates whether the component is a concept,description, relationship (part of the inferred view of the concept definition), or OWL axiom (part of the stated view of the concept definition).
action	Indicates the nature of the change: added : This component was not present in previous release changed : The active value is unchanged and change has been made to a data value² inactivated : The active value of the component has been changed from 1 to 0 reactivated : The active value of the component has been changed from 0 to 1
id	The identifier of the concept, description, relationship or OWL axiom reference set member.
newComponentData	The ComponentData for the identified component in the snapshot release of the later of the two versions being compared. ComponentData ComponentData refers to a representation of the data in the relevant release file row for the identified concept, description, relationship or OWL axiom. In the case of a description, the ComponentData should also include the acceptability values for that description in the language reference sets of that snapshot release. The data should be represented in a way that supports the data structure of the specified componentType. For example, the data could be represented as the string serialization of a JSON object.
previousComponentData	Represents the release file data for the identified component in the earlier of the two versions being compared. Empty if the component was not present in the earlier version of the release file.
reason	Only applicable to concepts and descriptions that are active in the previousComponentData view and inactive in the newComponentData view: In the case of a concept, the reason for inactivation as represented in the concept inactivation reference set. In the case of a description, the reason for inactivation as represented in the description inactivation reference set.
alternatives	Only applicable to concepts that inactive in the newComponentData view: An array of historically associated concepts derived by selecting active rows from most recent snapshot view the historical association reference sets with a referenceComponentId that matches the identifier of the concept. Each element of the array should include the refsetId, which indicates the type of association, and the targetComponentId, which refers to associated concept.
conceptId	The identifier of the concept with which this component is associated. This provides a link to the id of the relevant Complete Concept Version Data. In the case of a concept, this is the same as the id (i.e. same as the id data item above). In the case of a description, this is the conceptId. In the case of a relationship, this is the sourceId. In the case of an OWL axiom, this is the referencedComponentId.

Full Concept Version Data

There is an instance of the Full Concept Version Data object for each concept to which one or more of the following conditions applies:

The concept has been added, changed, inactivated or reactivated
OWL axioms or relationships that contribute to the stated and/or inferred definition of the concept have been added, changed, inactivated or reactivated
Descriptions associated with the concept have been added, changed, inactivated or reactivated
Language reference set rows that specify the acceptability of an associated description have been added, changed, inactivated or reactivated.

Each instance of the Full Concept Version Data object represents the previous and new state of a concept including all its active descriptions (with relevant language acceptability data), all its active relationships and all associated active OWL axioms. Details of the data items in this object are shown in Table 3.7.2-2.

Table 3.7.2-2: Full Concept Version Data Object

Data Item	Notes
id	The identifier of a concept that has been affected directly or indirectly by updates between two specified versions of the same edition.
newFullConceptData	A representation of the FullConceptData for the identified concept in the snapshot release of the later of the two versions being compared. FullConceptData FullConceptData refers to a representation of the data in the all the relevant active release file rows that describe and define an identified concept. This includes all the data in: the row of the concept snapshot release file with the relevant id value. all active rows of the description snapshot release file with a conceptId value matching the identifier of the concept and for each of these descriptions and all active rows of the language reference set snapshot release file with the a referencedComponentId value matching the identifier of that description all active rows of the relationship snapshot release file with a sourceId value matching the identifier of the concept. all active rows of the OWL reference set snapshot release file with refsetId 733073007 \| OWL axiom reference set\| and a referencedComponentId value matching the identifier of the concept. The data should be represented in a way that supports the data structures of all of the above data components. For example, the data could be represented as the string serialization of a JSON object combining representations of each of the different data items.
previousFullConceptData	A representation of the FullConceptData for the identified concept in the snapshot release of the earlier of the two versions being compared. Empty if this concept was not present in the earlier release.

Footnotes

1

To ensure that changes to the acceptability of a description in any language or dialect are captured, a description should also be included if any language reference set member that refers to it has been added, changed, inactivated or reactivated.

2

If the active value has changed, the action is either inactivated or reactivated, even if a data value has also changed.

Search

3.7.2 Integrate and Interpret Versioning Data

Component Version Data

Full Concept Version Data

Footnotes