Main Page

From CTS2

Jump to: navigation, search


This site is being used to create, assemble and (hopefully) gather input on the combined Mayo/II4SM CTS2 submission to the OMG.
Questions, comments and suggestions are welcomed. Please direct any input to solbrig <dot>harold<at>mayo.edu


Status:
The "final" specification was submitted to the OMG on May 23 to meet the four week rule requirements for the June 20 OMG meeting.


The "final" specification has been submitted to the OMG. Final is in quotes because there is still a significant amount of work that needs to be done before this can be called complete - details of which can be found below.

The specification, as submitted, consists of the following components:

While the contents of the above submission is reasonably solid, there is still considerable room for improvement - especially in the area of document and testing. In particular, the following tasks are still outstanding:

  • CTS2 Primer - we still need to produce an overview document that describes the various components, provides examples, etc.
  • Z Behavioral Specification - Some of the components of the submission have been formally specified in Z. This task, however, is still not complete and will continue to be added. We view the Z as a component of the OMG's "Finalization Task Force (FTF)", whose job it is to correct and solidify the specification as submitted.
  • Canonical RDF Specification - An additional PSM for the information model that describes a "canonical" RDF rendering - establishing the tags and structure to represent the various CTS2 resources in RDF format
  • ISO 21090 PSM - Portions of the CTS2 model (concept domains and value set resolution) should be representable using the ISO 21090 Healthcare Datatypes. This portion of the modeling still needs to be completed.
  • Proof reading, testing and additional documentation - it will quickly become obvious that there is still a great deal of work that could (and should) be done on the submission. This will be an ongoing task for the Finalization Task Force.


The following changes have been applied to the working copy subsequent to its submission to the OMG:

Package Source Change Status
UML EntityDescription equivalentEntities changed to equivalentEntity and documentation updated accordingly Fixed in UML
UML EntityDescription entityType. parent and equivalentEntity is type URIAndEntityName instead of EntityReference Fixed in UML, documentation not updated
REST Entity.xsd EntityDescriptionMsg contains EntityDescription rather than anonymous choice Submitted Entity.xsd
UML ResourceDescription resourceType should be URIAndEntityName instead of EntityReference Fixed in UML, documentation not updated
REST Core.xsd ResourceDescription - changed resourceType from EntityReference to URIAndEntityName Submitted Core.xsd
UML ValueSetCatalogEntry changed "definition" to "definitions" and cardinality to 0..1 Fixed in UML, documentation not updated
REST ValueSet.xsd ValueSetCatalogEntry - added definitions node - it got omitted Submitted ValueSet.xsd
UML Note assertedInCodeSystemVersion text - changed "not" to "note" Fixed in UML. Documentation not updated
UML Designation added assertedInCodeSystemVersion Fixed in UML. Documentation not updated.
REST Entity.xsd Designation - added assertedInCodeSystemVersion Submitted Entity.xsd
REST Core.xsd ResourceDescriptionDirectoryEntry - pulled resourceID as it is named explicitly (e.g. codeSystemName, ...) Submitted Core.xsd
REST Association.xsd Association - changed cardinality of target from 1:1 to 1:n (model translation error) Submitted Association.xsd
UML Reference Removed ConceptDomainBindingReference as bindings are now contained in the domains Submitted Core.xsd
UML Reference Added AssociationReference, OntologyEngineeringToolReference, OntologyEngineeringMethodologyReference, StatementReference Submitted Core.xsd
UML Reference Removed ResolutionRuleReference Submitted Core.xsd
UML Reference Added FormalityLevelReference Submitted Core.xsd
UML CodeSystemCatalogEntry Added usedOntologyEngineeringTool, usedOntologyEngineeringMethodology, hasFormalityLevel Submitted Core.xsd
UML Reference Renamed MapCatalogReference to MapReference (catalogs reference maps) Submitted Core.xsd and MapVersion.xsd
UML Directory Made sortCriteria optional
UML FiltersAndSorting Changed NameAndMeaningReference to URIAndEntityName
UML ImportExportBase Added the following exceptions:
  • MetadataDocumentRequired
  • MetadataError
  • ResourceAlreadyExists
  • ResourceWriteError
  • UnableToOpenDocument
  • UnableToOpenMetadataDocument
  • UnableToOpenOrCreateTargetDirectory
  • UnknownProcessId
  • UnsupportedResourceType

And the following exception sets

  • ExportOutputExceptions
  • MetadataExceptions
Submitted to Exceptions.xsd
UML ImportExportBase interface Added UnknownProcessId exception to getLog and clearLog. Also added "delta" profile to clearLog
UML BaseImportService Added exceptions to getStatus and validate methods
UML BaseExportService Removed redundant clearLog and getLog. Added exceptions to getStatus and export
UML UpdateService
  1. changed the type of changeSet from ChangeSet to DocumentURI so that the resource could be retrieved from another service or off of a disk
  2. added parameter to validateChangeSet to say whether you wanted both errors and warnings or just errors
  3. added unsupportedResourceTypa and DirectoryURI exceptions
UML EntityDescriptionMaintenanceService Removed resourceType parameter from createAnnotationProperty, createDataTypeDescription, createDataPropertyDescription, createNamedIndividualDescription, createObjectPropertyDescription and createPredicateDescription as they default to owl:AnnotationProperty, owl:DataType, owl:DataProperty, owl:NamedIndividual, owl:ObjectProperty and rdf:Property respectively. Submitted EntityDescriptionMaintenanceService.wsdl and cts2.wadl
UML EntityDescriptionMaintenanceService Renamed the resourceType parameter in createClassDescription to entityType Submitted cts2.wadl and EntityDescriptionMaintenanceService .wsdl
UML EntityDescriptionMaintenanceService added entityType parameter
UML EntityDescriptionTransformationService changed the codeSystemVersion' parameter of toEntityDescription from NameAndURI to NameOrURI
UML Association removed AssociationRendering class from the model as it is no longer used, having been replaced by EntityExpression
UML AssociationReadService renamed entryID to associationID in read and exists function Submitted AssociationReadService.wsdl
UML AssociationQueryService removed supportedSourceAndNotation parameter as this functionality has been moved to the AssociationTransformService
UML AdvancedAssociationQueryService
  1. changed focus to graphFocus
  2. added focusEntity
  3. added a number of exceptions to the resolveGraph call
  4. added a new exception UnknownFocusEntity
  1. Submitted AdvancedAssociationQueryService.wsdl
  2. Submitted AdvancedAssociationQueryService.wsdl
  3. Will be generated into wsdl/wadl
  4. Submitted Exceptions.xsd
UML MapCatalog renamed "UnknownMapCatalog" exception to "UnknownMap" Submitted Exceptions.xsd
UML ValueSetDefinitionHistoryService changed the data type of all valueSetDefinitions from NameOrURI to DocumentURI, as definitions do not have names Submitted cts2.wadl and ValueSetDefinitionHistoryService .wsdl
UML ValueSetMaintenanceService changed VSD types from NameOrURI to DocumentURI Submitted cts2.wadl and ValueSetDefinitionMaintenanceService.wsdl
UML ValueSetMaintenanceService Redid the create and add operations for PropertyReference (in general maintenance needs to be double checked against the schema)
UML CodeSystemMaintenance Changed the type of name from CodeSystemVersionName to CodeSystemName Submitted CodeSystemCatalogMaintenanceService.wsdl
UML CodeSystemMaintenance changed types of the various parameters from (something)Reference to NameAndURI
UML EntityQueryService Changed entities in restrictToEntities from EntityReferenceList to EntityNameOrURIList
UML CodeSystemVersionMaintenanceService createCodeSystemVersion - changed the type of name from DocumentURI to CodeSystemVersionName Submitted CodeSystemVersionCatalogMaintenanceService.wsdl
UML CodeSystemVersionMaintenanceService added many exceptions (check the whole of CSV) Will be generated into wsdl/wadl
UML CodeSystemVersionCatalogEntry Removed the predecessor typed as CodeSystemVersionReference - it was more confusing than enligtening
UML MapCatlogHistoryService Changed return type or earliest and latest from MapCatalogEntrySummary to MapCatalogEntry
UML Statement and StatementService Added to model
UML URIResolutionService Removed from model
UML Core Changed OntologyEngineeringModel" to OntologyEngineeringModelReference"
XML Schema Core Removed StatementReference as it was never used
UML Statement Removed externalID from statement as it is a property of the target, not the subject.
UML Exceptions Added UnknownStatement as an UnknownResourceException
UML EntityDescriptionMaintenance updateEntityDescription - changed type of EntityType from reference to EntityNameOrURI
Documentation Regenerated all document sets except Map and Code system catalog. All at 0.95 except those two
=====================
UML Updates Changed ChangeSet/Changeable containment from aggregate to composite. Added role label (containingSet) and cardinality of 0..1
UML Updates Changed ChangeDescription/Changeable containment from aggregate to compsite. Added role name (successor) and cardinality of 0..*
UML Updates Added label to Changeable/ChangeDescription (describedChange) and cardinality of 1
UML CodeSystemCatalog # Changed CodeSystemCatalog to CodeSystemCatalogEntryDirectory
  1. Changed CodeSystemCatalogListEntry to CodeSystemCatalogEntryListEntry
  2. added labels and cardinality on aggregate side of directory and list
UML CodeSystemVersionCatalog # Changed CodeSystemVersionCatalog to CodeSystemVersionCatalogEntryDirectory
  1. Changed CodeSystemVersionCatalogList to CodeSystemVersionCatalogEntryList
  2. Changed CodeSystemVersionListCatalogEntry to CodeSystemVersionCatalogEntryListEntry
  3. added labels and cardinality on aggregate side of directory and list
UML MapCatalog # Changed MapCatalog to MapCatalogEntryDirectory
  1. Changed MapCatalogList to MapCatalogEntryList
  2. Changed MapCatalogListEntry to MapCatalogEntryListEntry
  3. added labels and cardinality on aggregate side of directory and list
  1. Submitted Map.xsd, MapCatalogQueryService.wsdl, cts2.wadl
  2. Submitted Map.xsd, MapCatalogQueryService.wsdl, cts2.wadl
UML ValueSetCatalog # Changed ValueSetCatalog to ValuSetCatalogEntryDirectory
  1. Changed ValueSetCatalogList to ValueSetCatalogEntryList
  2. Changed ValueSetCatalogListEntry to ValueSetCatalogEntryListEntry
  3. added labels and cardinality on aggregate side of directory and list
UML ConceptDomainCatalog # Changed ConceptDomainCatalog to ConceptDomainCatalogEntryDirectory
  1. Changed ConceptDomainCatalogList to ConceptDomainCatalogEntryList
  2. Changed ConceptDomaintCatalogListEntry to ConceptDomainCatalogEntryListEntry
  3. added labels and cardinality on aggregate side of directory and list
  1. Submitted ConceptDomain.xsd, ConceptDomainCatalogQueryService.wsdl, cts2.wadl
  2. Submitted ConceptDomain..xsd, ConceptDomainCatalogQueryService.wsdl, cts2.wadl
UML DirectoryTypes # Changed CodeSystemCatalogURI to CodeSystemCatalogEntryDirectoryURI
  1. Changed ConceptDomainCatalogURI to ConceptDomainCatalogEntryDirectoryURI
  2. Changed CodeSystemVersionCatalogURI to CodeSystemVersionCatalogEntryDirectoryURI
  3. Changed MapCatalogURI to MapCatalogEntryDirectoryURI
  4. Changed ValueSetCatalogURI to ValueSetCatalogEntryDirectoryURI
  1. Submitted Core.xsd, cts2.wadl, ConceptDomainCatalogQueryService.wsdl
  2. Submitted Core.xsd, cts2.wadl, CodeSystemVersionCatalogQueryService.wsdl
  3. Submitted Core.xsd, cts2.wadl, MapCatalogQueryService.wsdl
  4. Submitted Core.xsd, cts2.wadl, ValueSetCatalogQueryService.wsdl
UML DataTypes Removed Enumeration data type

We are in the process of finalizing the documentation, filling in the blanks, filling out some of the more egregious errors, etc. The updated documents are:


Post OMG Submission Questions and answers

Clonation

Q: In the pim there are some hints about a 'clonation' system as the CLONED value of the ChangeType enum and the ChangeDescription.clonedResource field suggest. But in no service there is reference to cloning, so how could we get a clone of a Changeable resource?

Answer

EntityDescriptionReadService

Q: How can there be multiple entity descriptions when the entityID uniquely identifies the EntityDescription

Answer

CodeSystemVersionReadService

Q: How does the service set the codeSystemVersionTag?

Answer

EntityResourceType

Q: What goes in the CTS2ResourceType for EntityDirectory

Answer


FilterComponents

Q: Can secondary properties (propertyQualifier, correspondingStatement, etc) be used as filter and sort components?

Answer


Personal tools
Toolbox