OMG Issue 18532: URIAndEntityName references should all be changed to EntitySynopsis, allowing an optional description

[hsolbrig]

Issues #141 and #122 add an optional description to valueSetEntry, mapFrom and mapTo. It appears that, with the exception of EntityType and ResourceType, the remainder of the URIAndEntityName references should all be changed to EntitySynopsis, allowing an optional description. Would propose removing EntitySynopsis completely from the model and moving its description property to URIAndEntityName.

http://www.omg.org/issues/cts2-rtf#Issue18532

[cendle]

Reason For Change

This issue encapsulates OMG Issue 18532 (#143), OMG Issue 18470 (#141), and OMG Issue 18486 (#122).

OMG Issue 18532 (#143):

OMG Issue 18470 (#141) and OMG Issue 18486 (#122) add an optional description to valueSetEntry, mapFrom and mapTo. It appears that, with the exception of EntityType and ResourceType, the remainder of the URIAndEntityName references should all be changed to EntitySynopsis, allowing an optional description. Would propose removing EntitySynopsis completely from the model and moving its description property to URIAndEntityName.

http://www.omg.org/issues/cts2-rtf#Issue18532

---

OMG Issue 18470 (#141):

AssociatedEntitiesReference.referencedEntity and SpecificEntityList.referencedEntity are currently of type URIAndEntityName. This does not provide any place to include a designation or description of the entity. The type should be changed to EntitySynopsis.

http://www.omg.org/issues/cts2-rtf#Issue18470

---

OMG Issue 18486 (#122):

The mapFrom and mapTo elements in Map Entry are currently of type URIAndEntityName, which doesn't allow an explanatory designation to be provided, meaning that it may be necessary to resolve the returned types against a code system. This type should be changed to EntitySynopsis.

http://www.omg.org/issues/cts2-rtf#Issue18486

Severity: Minor

Proposed Resolution (PIM)

* Change Location 1 - OMG Issue 18470 (#141)

 Document "CTS2 - Entity Description Services, v1.0"
 Section 4.2 
 Page 47
 Figure 4.2  

* Change Description 1 - OMG Issue 18470 (#141)

 Updated diagram in Figure 4.2
 Old Diagram:

 New Diagram:
 Update diagram to indicate that nodeEntity is "nodeEntity :URIAndEntityName". 

* Change Location 2 - OMG Issue 18470 (#141)

 Document "CTS2 - Entity Description Services, v1.0"
 Section 4.2 
 Page 47, Paragraph 2 

* Change Description 2 - OMG Issue 18470 (#141)

Old Text:

For this reason, the CTS2 model defines a flattened representation of the corresponding graph that is designed for manipulation and reassembly. To accomplish this, every EntitySynopsis that occurs in the set of associations is assigned a unique number. These numbers are assigned in depth first order and, when both forward and reverse association traversal is supported, in the order of forward first followed by reverse.

New Text:

For this reason, the CTS2 model defines a flattened representation of the corresponding graph that is designed for manipulation and reassembly. To accomplish this, every URIAndEntityName that occurs in the set of associations is assigned a unique number. These numbers are assigned in depth first order and, when both forward and reverse association traversal is supported, in the order of forward first followed by reverse.

* Change Location 3 - OMG Issue 18470 (#141)

 Document "CTS2 - Core Model Elements, v1.0"
 Section 2.2.3 
 Page 14
 Figure 2.7  

* Change Description 3 - OMG Issue 18470 (#141)

 Updated diagram in Figure 2.7
 Old Diagram:

 New Diagram:
 Update diagram - remove the EntitySynopsis class.

* Change Location 4 - OMG Issue 18470 (#141)

 Document "CTS2 - Core Model Elements, v1.0"
 Section 2.2.3.6
 Page 16

* Change Description 4 - OMG Issue 18470 (#141)

 Remove section 2.2.3.6 Class EntitySynopsis.

* Change Location 5 - OMG Issue 18470 (#141)

 Document "CTS2 - Core Model Elements, v1.0"
 Section 2.2.3.9
 Page 17    

* Change Description 5 - OMG Issue 18470 (#141)

 Old Text:

The combination of a URI and/or and ScopedEntityName.

 New Text:

The combination of a URI and an optional ScopedEntityName and an optional designation for a resource.

* Change Location 6 - OMG Issue 18470 (#141)

 Document "CTS2 - Core Model Elements, v1.0"
 Section 2.2.3
 Page 14
 Figure 2.7

* Change Description 6 - OMG Issue 18470 (#141)

 Updated diagram in Figure 2.7
 Old Diagram:

 New Diagram:
 Update diagram to show that URIAndEntityName has a new element "designation :String".

* Change Location 7 - OMG Issue 18470 (#141)

 Document "CTS2 - Core Model Elements, v1.0"
 Section 2.2.3.9
 Page 17    

* Change Description 7 - OMG Issue 18470 (#141)

Add new attriubute to attribute section of class URIAndEntityName.     

designation - a designation considered appropriate for the entity in the specific context of use.

* Change Location 8 - OMG Issue 18470 (#141)

 Document "CTS2 - Value Set Services, v1.0"
 Section 4.4
 Page 27
 Figure 4.4

* Change Description 8 - OMG Issue 18470 (#141)

 Updated diagram in Figure 4.4
 Old Diagram:

 New Diagram:

For both the ResolvedValueSet and IterableResolvedValueSet, update diagram to indicate that member is "member :URIAndEntityName".

* Change Location 9 - OMG Issue 18532 (#143)

 Document "CTS2 - Core Model Elements, v1.0"
 Section 2.2.3
 Page 14
 Figure 2.7

* Change Description 9 - OMG Issue 18532 (#143)

 Updated diagram in Figure 2.7
 Old Diagram:

 New Diagram:

Update diagram: change "name :ScopedEntityName [0..1]" to "name :ScopedEntityName [0..]"
Add to diagram: "designation :ScopedEntityName [0..]"

Proposed Resolution (PSM)

* Change Location 1 - OMG Issue 18470 (#141)

Association.xsd
Core.xsd
ValueSetDefinition.xsd

* Change Description 1 - OMG Issue 18470 (#141)

View Changes: c0b1523

Due to number of changes, please review the PDF.
http://informatics.mayo.edu/svn/trunk/cts2/spec/submission/RTF_1.1/RTF_Issues/CTS2_RTF_1.1_18470.pdf

* Change Location 2 - OMG Issue 18532 (#143)

Core.xsd

* Change Description 2 - OMG Issue 18532 (#143)

View Changes: 5be0ba9

Proposed Revised Text

NA