NIH | National Cancer Institute | NCI Wiki  

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

Note 3:  The codeSystemVersionUri value is determined through a special LexEVS URI handler that is responsible for constructing URIs that represent versions from LexEVS resources.

 

 

 

CodeSystemVersionRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.codesystemversion.CodeSystemVersionReadService

...

Note 2:  The CTS2 'codeSystemVersionName' is the only non 1-1 mapping. In CTS2, a version name is meant to be unique (even across versions) - so the LexEVS CodingSchemeName is concatenated with the LexEVS Version to get a unique name.

 

 

EntityDescriptionQuery

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.entitydescription.EntityDescriptionQueryService

...

Note 5:  Not supported at this time and throws an UnsupportedOperationException.

 

Transformation Table: 

...

CTS2 EntityDirectoryEntry ⇔ LexEVS ResolvedConceptReference

CTS2 EntityDirectoryEntryLexEVS ResolvedConceptReference
aboutentityUri    (Refer to Note 1 below table)
knownEntityDescription.describingCodeSystemVersion.codeSystem codingSchemeName
knownEntityDescription.describingCodeSystemVersion.content codingSchemeName + '-' + codingSchemeVersion
knownEntityDescription.designation  entityDescription.content
knownEntityDescription.  

Note 1:   The LexEVS entityUri value is determined through a special LexEVS URI handler that is responsible for constructing URIs from the LexEVS resource.

 

EntityDescriptionRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.entitydescription.EntityDescriptionReadService

 

EntityDescriptionRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.entitydescription.EntityDescriptionReadService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.entity.LexEvsEntityReadService 

...

CTS2 EntityDescriptionReadService methodsLexEVS Service ImplementationLexEVS Service methods used
EntityReference availableDescriptions(EntityNameOrURI entityId, ResolvedReadContext readContext)Refer to Note 1 below tableNot Applicable
boolean exists(EntityDescriptionReadId identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodedNodeSet getNodeSet(String codingScheme, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes)
List<CodeSystemReference> getKnownCodeSystems()Refer to Note 2 below tableNot Applicable
List<CodeSystemVersionReference> getKnownCodeSystemVersions()Refer to Note 2 below tableNot Applicable
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 2 below tableNot Applicable
List<VersionTagReference> getSupportedVersionTags()Refer to Note 2 below tableNot Applicable
EntityDescription read(EntityDescriptionReadId identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodedNodeSet getNodeSet(String codingScheme, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes)
  • LexBIGServiceConvenienceMethods getGenericExtension("LexBIGServiceConvenienceMethods")
List<EntityListEntry> readEntityDescriptions(EntityNameOrURI entityId, ResolvedReadContext readContext)Refer to Note 1 below tableNot Applicable
DirectoryResult<EntityListEntry> readEntityDescriptions(EntityNameOrURI entityId, SortCriteria sortCriteria, ResolvedReadContext readContext, Page page)Refer to Note 1 below tableNot Applicable

...

Transformation Table:  CTS2 EntityDescription ⇔ LexEVS ResolvedConceptReference

...

CTS2 EntityDescription

 

 

 

MapQuery

LexEVS ResolvedConceptReference
namedEntityDescription.aboutentityUri    (Refer to Note 1 below table)
namedEntityDescription.designation.designationRolegetEntity().getPresentation().isIsPreferred()    (Refer to Note 2 below table)
namedEntityDescription.designation.valuegetEntity().getPresentation().getValue().getContent()
namedEntityDescription.describingCodeSystemVersion - CodeSystemVersionReference.codeSystemcodingSchemeName 
namedEntityDescription.describingCodeSystemVersion - CodeSystemVersionReference.

nameAndMeaningReference.content 

codingSchemeName + '-' + codingSchemeVersion 

namedEntityDescription.entityID.namegetEntity().getEntityCode()
namedEntityDescription.entityID.nameSpacegetEntity().getEntityCodeNamespace()
namedEntityDescription.parent - URIAndEntityName.nameper Association, the Association's AssociatedConcept.code 
namedEntityDescription.parent - URIAndEntityName.nameSpace per Association, the Association's AssociatedConcept.codeNameSpace 
namedEntityDescription.parent - URIAndEntityName.uri entityUri   (Refer to Note 3 below table) 

Note 1:   The LexEVS entityUri value is determined through a special LexEVS URI handler that is responsible for constructing URIs from the LexEVS resource.

Note 2:  The CTS2 designationRole value is determined on the LexEVS Presentation object(s) of the LexEVS Entity associated with the LexEVS ResolvedConceptReference. If the given LexEVS Presentation object is preferred then the corresponding CTS2 designationRole is set to the CTS2 DesignationRole.PREFERRED value, else it is set to the CTS2 DesignationRole.ALTERNATIVE value.

Note 3:  The LexEVS entityUri value is determined through a special LexEVS URI handler that is responsible for constructing URIs from the LexEVS resource.  In this case the LexEVS resource is the ResolvedConceptReference (AssociatedConcept) for a particular resolved LexEVS Association.

 

MapQuery

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.map.MapQueryService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.map.LexEvsMapQueryService

Service Method Mappings Table

CTS2 MapQueryService methodsLexEVS Service ImplementationLexEVS Service methods used
int count(MapQuery query)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
  • resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
Set<PredicateReference> getKnownProperties()Refer to Note 2 below tableNot Applicable
DirectoryResult<MapCatalogEntry> getResourceList(MapQuery query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
  • resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
DirectoryResult<MapCatalogEntrySummary> getResourceSummaries(MapQuery query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
  • resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
Set<? extends MatchAlgorithmReference> getSupportedMatchAlgorithms()Refer to Note 3 below tableNot Applicable
Set<? extends PropertyReference> getSupportedSearchReferences()Refer to Note 4 below tableNot Applicable
Set<? extends PropertyReference> getSupportedSortReferences()Refer to Note 2 below tableNot Applicable

Note 1:  Not supported at this time and returns an empty List.

Note 2:  Not supported at this time and returns an empty Set.

Note 3:  Returned Set contains 3 MatchAlgorithmReference objects supporting "exactMatch", "contains" and "startsWith".

Note 4:  Returned Set contains 3 PropertyReference objects supporting attributes "about", "resourceName" and "resourceSynopsis".

 

Transformation Table:  CTS2 MapCatalogEntrySummary ⇔ LexEVS CodingScheme

CTS2 MapCatalogEntrySummaryLexEVS CodingScheme
aboutcodingSchemeURI    (Refer to Note 1 below table)
formalNameformalName
fromCodeSystemcodingScheme.getRelations(0).getSourceCodingScheme()
mapNamecodingSchemeName
resourceSynopsiscontent value of codingSchemeSummary's codingSchemeDescription
toCodeSystemcodingScheme.getRelations(0).getTargetCodingScheme()

 Note 1:  The LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resources.

 

MapRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.map.MapReadService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.map.LexEvsMapReadService

Service Method Mappings Table

CTS2 MapReadService methodsLexEVS Service ImplementationLexEVS Service methods used
boolean exists(NameOrURI identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
MapVersion read(NameOrURI identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)

Note 1:  Not supported at this time and returns an empty List.

 

Transformation Table:  CTS2 MapCatalogEntry ⇔ LexEVS CodingScheme

CTS2 MapCatalogEntryLexEVS CodingScheme
aboutcodingSchemeURI    (Refer to Note 1 below table)
formalNameformalName
fromCodeSystemcodingScheme.getRelations(0).getSourceCodingScheme()
keywordListvalues from the collection set of localName
mapNamecodingSchemeName
propertiesproperties
resourceSynopsiscodingScheme.entityDescription.content.value
toCodeSystemcodingScheme.getRelations(0).getTargetCodingScheme()

Note 1:  The LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resources.

 

MapEntryQuery

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.mapentry.MapEntryQueryService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.mapentry.LexEvsMapEntryQueryService

Service Method Mappings Table

CTS2 MapEntryQueryService methodsLexEVS Service ImplementationLexEVS Service methods used
 int count(MapEntryQuery query)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)

List<DocumentedNamespaceReference> getKnownNamespaceList()

Refer to Note 1 below table Not Applicable

Set<PredicateReference> getKnownProperties()

Refer to Note 2 below table Not Applicable

DirectoryResult<MapEntry> getResourceList(MapEntryQuery query, SortCriteria sortCriteria, Page page)

org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag) 

DirectoryResult<MapEntryDirectoryEntry> getResourceSummaries(MapEntryQuery query, SortCriteria sortCriteria, Page page)

org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
 Set<? extends  MatchAlgorithmReference> getSupportedMatchAlgorithms() Refer to Note 3 below table Not Applicable
 Set<? extends  PropertyReference> getSupportedSearchReferences() Refer to Note 4 below table Not Applicable
 Set<? extends  PropertyReference> getSupportedSortReferences() Refer to Note 2 below table  Not Applicable

Note 1:  Not supported at this time and returns an empty List.

Note 2:  Not supported at this time and returns an empty Set.

Note 3:  Returned Set contains 3 MatchAlgorithmReference objects supporting "exactMatch", "contains" and "startsWith".

Note 4:  Returned Set contains 3 PropertyReference objects supporting attributes "about", "resourceName" and "resourceSynopsis".

 

Transformation Table:  CTS2 MapEntryDirectoryEntry ⇔ LexEVS ResolvedConceptReference

CTS2 MapEntryDirectoryEntryLexEVS ResolvedConceptReference
hrefRefer to Note 1 below table  
mapFrom Refer to Note 2 below table 
resourceNameRefer to Note 3 below table 

Note 1:  the href attribute represents a MapEntry URLvalue as a String in the format: mapName/version/mapVersionName/entry/mapEntryName where mapName is the LexEVS ResolvedConceptReference.getCodingSchemeName() value, mapVersionName represents the String value concatentation of 'ResolvedConceptReference.getCodingSchemeName() + "-" + ResolvedConceptReference.getCodingSchemeVersion()', and mapEntryName is the encoded value of CTS2 MapEntryDirectoryEntry.mapFrom attribute.

Note 2:  the MapEntryDirectoryEntry.mapFrom attribute represents a CTS2 UriAndEntityName object where the UriAndEntityName.name value is the LexEVS ResolvedConceptReference.getCode() value, the UriAndEntityName.nameSpace value is the LexEVS ResolvedConceptReference.getCodeNameSpace() value, and the the UriAndEntityName.uri value is determined through a special LexEVS URI handler that is responsible for constructing URIs from the LexEVS resource.

Note 3:  the resourceName value is the encoded value of the CTS2 MapEntryDirectoryEntry.mapFrom attribute. 

 

MapEntryRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.mapentry.MapEntryReadService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.mapentry.LexEvsMapEntryReadService

Service Method Mappings Table

CTS2 MapEntryReadService methodsLexEVS Service ImplementationLexEVS Service methods used
boolean exists(MapEntryReadId identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • MappingExtension getGenericExtension("MappingExtension")
  • Mapping MappingExtension.getMapping(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag, String relationsContainerName)
  • Mapping restrictToCodes(ConceptReferenceList codeList, SearchContext searchContext)
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
MapEntry read(MapEntryReadId, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • MappingExtension getGenericExtension("MappingExtension")
  • Mapping MappingExtension.getMapping(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag, String relationsContainerName)
  • Mapping restrictToCodes(ConceptReferenceList codeList, SearchContext searchContext)

Note 1:  Not supported at this time and returns an empty List.

 

Transformation Table:  CTS2 MapEntry ⇔ LexEVS ResolvedConceptReference

CTS2 MapEntryLexEVS ResolvedConceptReference
assertedBycodingSchemeName, codingSchemeVersion, codingSchemeURI    (Refer to Note 1 below table)
mapFromRefer to Note 1 below table
mapSetRefer to Note 2 below table 
mapSet.entryOrderis always set to value 1
mapSet.mapTarget.entryOrderset according to the number of CTS2 MapTarget objects added to the CTS2 MapSet object
mapSet.mapTarget.mapToRefer to Note 3 below table 
mapSet.processingRuleis always set to the CTS2 value MapProcessingRule.ALL_MATCHES
processingRuleis always set to the CTS2 value MapProcessingRule.ALL_MATCHES

Note 1:  the MapEntry.mapFrom attribute represents a CTS2 UriAndEntityName object where the UriAndEntityName.name value is the LexEVS ResolvedConceptReference.getCode() value, the UriAndEntityName.nameSpace value is the LexEVS ResolvedConceptReference.getCodeNameSpace() value, and the the UriAndEntityName.uri value is determined through a special LexEVS URI handler that is responsible for constructing URIs from the LexEVS resource.

Note 2:  the CTS2 MapEntry is always set to have only one CTS2 MapSet object.

Note 3:  the CTS2 MapTarget.mapTo attribute represents a CTS2 UriAndEntityName object where the UriAndEntityName.name value is the LexEVS AssociatedConcept.getCode() value, the UriAndEntityName.nameSpace value is the LexEVS AssociatedConcept.getCodeNameSpace() value, and the the UriAndEntityName.uri value is determined through a special LexEVS URI handler that is responsible for constructing URIs from the LexEVS resource.  

 

MapVersionQuery

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.mapversion.MapVersionQueryService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.mapversion.LexEvsMapVersionQueryService

Service Method Mappings Table

CTS2 MapVersionQueryService methodsLexEVS Service ImplementationLexEVS Service methods used
int count(MapVersionQuery query)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
Set<PredicateReference> getKnownProperties()Refer to Note 2 below tableNot Applicable
DirectoryResult<MapVersion> getResourceList(MapVersionQuery query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
DirectoryResult<MapVersionDirectoryEntry> getResourceSummaries(MapVersionQuery

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.map.MapQueryService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.map.LexEvsMapQueryService

Service Method Mappings Table

CTS2 MapQueryService methodsLexEVS Service ImplementationLexEVS Service methods usedint count(MapQuery query)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
  • resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot ApplicableSet<PredicateReference> getKnownProperties()Refer to Note 2 below tableNot ApplicableDirectoryResult<MapCatalogEntry> getResourceList(MapQuery query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
  • resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
DirectoryResult<MapCatalogEntrySummary> getResourceSummaries(MapQuery
query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • CodingSchemeRenderingList getSupportedCodingSchemes()
  • getGenericExtension("MappingExtension")
  • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
Set<? extends MatchAlgorithmReference> getSupportedMatchAlgorithms()Refer to Note 3 below tableNot Applicable
Set<? extends
MatchAlgorithmReference> getSupportedMatchAlgorithms
PropertyReference> getSupportedSearchReferences()Refer to Note
3
4 below tableNot Applicable
Set<? extends
PropertyReference> getSupportedSearchReferences(
PropertyReference> getSupportedSortReferences()Refer to Note 2 below tableNot Applicable
DirectoryResult<EntityDirectoryEntry> mapVersionEntities(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page)Refer to Note 5 below tableNot Applicable
DirectoryResult<EntityDescription> mapVersionEntityList(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page)Refer to Note
4
5 below tableNot Applicable
Set<? extends PropertyReference> getSupportedSortReferences(
EntityReferenceList mapVersionEntityReferences(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page)Refer to Note
2
5 below tableNot Applicable

Note 1:  Not supported at this time and returns an empty List.

Note 2:  Not supported at this time and returns an empty Set.

Note 3:  Returned Set contains 3 MatchAlgorithmReference objects supporting "exactMatch", "contains" and "startsWith".

Note 4:  Returned Set contains 3 PropertyReference objects supporting attributes "about", "resourceName" and "resourceSynopsis".

Note 5:  Not supported at this time and throws an UnsupportedOperationException.

 

Transformation Table:

  CTS2 MapCatalogEntrySummary

  CTS2 MapVersionDirectoryEntry ⇔ LexEVS

CodingScheme

CodingSchemeRendering

CTS2
MapCatalogEntrySummary
MapVersionDirectoryEntryLexEVS
CodingScheme
CodingSchemeRendering
about
codingSchemeURI   
codingSchemeURI
mapVersionNamelocalName + '-' + representsVersion    (Refer to Note 1 below table)
documentURIcodingSchemeURI
formalNameformalName
fromCodeSystem
codingScheme.getRelations(0).getSourceCodingScheme()mapNamecodingSchemeName
resourceSynopsiscontent value of codingSchemeSummary's codingSchemeDescription
toCodeSystemcodingScheme.getRelations(0).getTargetCodingScheme()
 

Note 1:  The

LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resources

CTS2 'mapVersionName' is the only non 1-1 mapping. In CTS2, a version name is meant to be unique (even across versions) - so the LexEVS LocalName is concatenated with the LexEVS Version to get a unique name.

 

MapRead

MapVersionRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.

map

mapversion.

MapReadService

MapVersionReadService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.

map

mapversion.

LexEvsMapReadService

LexEvsMapVersionReadService  

Service Method Mappings Table

CTS2
MapReadService
MapVersionReadService methods
LexEVS Service ImplementationLexEVS Service methods used
boolean exists(NameOrURI identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
boolean existsByTag(NameOrURI parentIdentifier, VersionTagReference tag
LexEVS Service ImplementationLexEVS Service methods usedboolean exists(NameOrURI identifier
, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
List<VersionTagReference> getSupportedTags()Refer to Note 2 below tableNot Applicable
MapVersion read(
)
NameOrURI identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
MapVersion readByTag(NameOrURI codeSystem, VersionTagReference tag
Refer to Note 1 below tableNot ApplicableMapVersion read(NameOrURI identifier
, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)

Note 1:

 Not

  Not supported at this time and returns an empty List.

Note 2:  Only the default of current tag is supported at this time.

 

Transformation Table:

  CTS2 MapCatalogEntry

  CTS2 MapVersion ⇔ LexEVS CodingScheme

CTS2
MapCatalogEntry
MapVersionLexEVS CodingScheme
about
codingSchemeURI    (Refer to Note 1 below table)
codingSchemeURI
formalNameformalName
fromCodeSystemcodingScheme.getRelations(0).getSourceCodingScheme()
keywordListvalues from the collection set of localName
mapName
mapVersionNamecodingSchemeName + '-' + representsVersion    (Refer to Note 1 below table)
propertiesproperties
resourceSynopsiscodingScheme.entityDescription.content.value
toCodeSystemcodingScheme.getRelations(0).getTargetCodingScheme()
sourceAndNotation.descriptionstring value "LexEVS"
versionOf.contentcodingSchemeName
versionOf.uricodingSchemeURI

 Note 1:  The

LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resourcesMapEntryRead

CTS2 'mapVersionName' is the only non 1-1 mapping. In CTS2, a version name is meant to be unique (even across versions) - so the LexEVS CodingSchemeName is concatenated with the LexEVS Version to get a unique name.

 

 

 

MapEntryQuery

 

 

ValueSetDefinitionRead

CTS2 Interface:  edu.mayo.cts2.framework.service.profile.

mapentry

valuesetdefinition.

MapEntryReadService

ValueSetDefinitionReadService

Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.

mapentry

mapversion.

LexEvsMapEntryReadService

LexEvsValueSetDefinitionReadService

Service Method Mappings Table

CTS2 MapEntryReadService MapVersionReadService methodsLexEVS Service ImplementationLexEVS Service methods used
boolean exists(MapEntryReadId ValueSetDefinitionReadId identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImpllexgrid.valuesets.LexEVSValueSetDefinitionServicesValueSetDefinition getValueSetDefinition(String uri, String revision)
boolean existsByTag(NameOrURI parentIdentifier, VersionTagReference tag, ResolvedReadContext readContext)Not ApplicableNot Applicable
  • MappingExtension getGenericExtension("MappingExtension")
  • Mapping MappingExtension.getMapping(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag, String relationsContainerName)
  • Mapping restrictToCodes(ConceptReferenceList codeList, SearchContext searchContext)
    List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
    List<VersionTagReference> getSupportedTags()Refer to Note 2 below tableNot Applicable
    ValueSetDefinition read(ValueSetDefinitionReadId identifier, ResolvedReadContext readContext)org.lexgrid.valuesets.LexEVSValueSetDefinitionServicesValueSetDefinition getValueSetDefinition(String uri, String revision)
    ValueSetDefinition readByTag(ValueSetDefinitionReadId valueSet, VersionTagReference tag, ResolvedReadContext readContext)Not ApplicableNot ApplicableMapEntry read(MapEntryReadId, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
  • MappingExtension getGenericExtension("MappingExtension")
  • Mapping MappingExtension.getMapping(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag, String relationsContainerName)
  • Mapping restrictToCodes(ConceptReferenceList codeList, SearchContext searchContext)

    Note 1:  Not supported at this time and returns an empty List.

     

     

    MapVersionQuery

    CTS2 Interface:  edu.mayo.cts2.framework.service.profile.mapversion.MapVersionQueryService

    Implementation:  edu.mayo.cts2.framework.plugin.service.lexevs.service.mapversion.LexEvsMapVersionQueryService

    Service Method Mappings Table

    empty List.

    Note 2:  Only the default of current tag is supported at this time.

     

    Transformation Table:  CTS2 ValueSetDefinition ⇔ LexEVS ValueSetDefinition

    CTS2 ValueSetDefinitionLexEVS ValueSetDefinition
    aboutvalueSetDefinitionURI
    documentURIvalueSetDefinitionURI
    formalNamevalueSetDefinitionURI
    CompleteCodeSystemReferenceCodingSchemeReference

    AssociatedEntitiesReference
    OR

    SpecificEntityList

    EntityReference
    PropertyQueryReferencePropertyReference
    CompleteValueSetReferenceValueSetDefinitionReference

     

    ResolvedValueSetQueryService

    CTS2 Interface:  edu.mayo.cts2.framework.service.profile.resolvedvalueset.ResolvedValueSetQueryService

    Implementation: 

    edu.mayo.cts2.framework.plugin.service.lexevs.service.resolvedvalueset.LexEvsResolvedValueSetQueryService

    Service Method Mappings Table

    org.lexgrid.resolvedvalueset

    CTS2 ResolvedValueSetQueryService methodsLexEVS Service ImplementationLexEVS Service methods used
    int count(EntityDescriptionQuery query)

    org.lexgrid.resolvedvalueset.LexEVSResolvedValueSetService

    • listAllResolvedValueSets()

    List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
    Set<PredicateReference> getKnownProperties
    CTS2 MapVersionQueryService methodsLexEVS Service ImplementationLexEVS Service methods used
    int count(MapVersionQuery query)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
    • CodingSchemeRenderingList getSupportedCodingSchemes()
    • getGenericExtension("MappingExtension")
    • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
    List<DocumentedNamespaceReference> getKnownNamespaceList()Refer to Note 1 below tableNot Applicable
    Set<PredicateReference> getKnownProperties()Refer to Note 2 below tableNot Applicable
    DirectoryResult<MapVersion> getResourceList(MapVersionQuery query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
    • CodingSchemeRenderingList getSupportedCodingSchemes()
    • getGenericExtension("MappingExtension")
    • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
    DirectoryResult<MapVersionDirectoryEntry> getResourceSummaries(MapVersionQuery query, SortCriteria sortCriteria, Page page)org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
    • CodingSchemeRenderingList getSupportedCodingSchemes()
    • getGenericExtension("MappingExtension")
    • MappingExtension.isMappingCodingScheme(String codingScheme, CodingSchemeVersionOrTag codingSchemeVersionOrTag)
    Set<? extends MatchAlgorithmReference> getSupportedMatchAlgorithms()Refer to Note 3 below tableNot Applicable
    Set<? extends PropertyReference> getSupportedSearchReferences()Refer to Note 4 below tableNot Applicable
    Set<? extends PropertyReference> getSupportedSortReferences()Refer to Note 2 below tableNot Applicable

    DirectoryResult<ResolvedValueSetDirectoryEntry> getResourceSummaries(

       ResolvedValueSetQuery

    DirectoryResult<EntityDirectoryEntry> mapVersionEntities(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery

    query, SortCriteria

    sortCriteria

    sort, Page page)

    org.LexGrid.LexBIG.Impl.LexBIGServiceImpl
    • CodingSchemeRenderingList getSupportedCodingSchemes()
    • CodedNodeSet getNodeSet(String codingScheme, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes)
    Set<? extends MatchAlgorithmReference> getSupportedMatchAlgorithms(Refer to Note 5 below tableNot ApplicableDirectoryResult<EntityDescription> mapVersionEntityList(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page)Refer to Note 53 below tableNot Applicable
    EntityReferenceList mapVersionEntityReferences(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page pageSet<? extends PropertyReference> getSupportedSearchReferences()Refer to Note 54 below tableNot Applicable

    Note 1:  Not supported at this time and returns an empty List.

    Note 2:  Not supported at this time and returns an empty Set.

    Note 3:  Returned Set contains 3 MatchAlgorithmReference objects supporting "exactMatch", "contains" and "startsWith".

    Note 4:  Returned Set contains 3 PropertyReference objects supporting attributes "about", "resourceName" and "resourceSynopsis".

    Note 5:  Not supported at this time and throws an UnsupportedOperationException.

     

    Transformation Table:  CTS2

    MapVersionDirectoryEntry

    ResolvedValueSetDirectoryEntry ⇔ LexEVS

    CodingSchemeRendering

    CodingScheme

    CTS2 MapVersionDirectoryEntryResolvedValueSetDirectoryEntryLexEVS CodingSchemeRenderingCodingScheme
    aboutcodingSchemeURI

    setResolvedValueSetURI

    codingSchemeURI    (Refer to Note 1 below table)

    setResourceName

    codingSchemeName mapVersionNamelocalName + '-' + representsVersion    (Refer to Note 12 below table)
    documentURIcodingSchemeURI
    formalNameformalName
    resourceSynopsiscontent value of codingSchemeSummary's codingSchemeDescription

    ResolvedValueSetHeader

    property= codingScheme.propertyName[

    LexEVSValueSetDefinitionServices.RESOLVED_AGAINST_CODING_SCHEME_VERSION)

    ResolvedValueSetHeaderURI= property.getValue().getContent();

    ResolvedValueSetHeaderVersion=property.getPropertyQualifier().getValue().getContent();

    resourceSynopsiscodingScheme.entityDescription.content.value

    Note 1:  The LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resources.

    Note 2Note 1:  The CTS2 'mapVersionNamecodeSystemVersionName' is the only non 1-1 mapping. In CTS2, a version name is meant to be unique (even across versions) - so the LexEVS LocalName CodingSchemeName is concatenated with the LexEVS Version to get a unique name.

      

    ResolvedValueSetResolutionService

    MapVersionRead

    CTS2 Interface:    edu.mayo.cts2.framework.plugin.service.profilelexevs.service.mapversionresolvedvalueset.MapVersionReadServiceResolvedValueSetResolutionService

    Implementation:  edu.mayo.cts2.framework.plugin.service.lexevsprofile.serviceresolvedvalueset.mapversion.LexEvsMapVersionReadService  ResolvedValueSetResolutionService

    Service Method Mappings Table

    CTS2 MapVersionReadService ResolvedValueSetResolutionService methodsLexEVS Service ImplementationLexEVS Service methods used
    boolean exists(NameOrURI identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
    boolean existsByTag(NameOrURI parentIdentifier, VersionTagReference tag, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
    List<DocumentedNamespaceReference> getKnownNamespaceListSet<? extends MatchAlgorithmReference> getSupportedMatchAlgorithms()Refer to Note 13 below tableNot Applicable
    List<VersionTagReference> getSupportedTags

    Set<? extends PropertyReference> getSupportedSearchReferences()

    Refer to Note 2 below tableNot Applicable
    MapVersion read(NameOrURI identifier, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)
    MapVersion readByTag(NameOrURI codeSystem, VersionTagReference tag, ResolvedReadContext readContext)org.LexGrid.LexBIG.Impl.LexBIGServiceImplCodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag)

    Note 1:  Not supported at this time and returns an empty List.

    Note 2:  Only the default of current tag is supported at this time.

     

    Transformation Table:  CTS2 MapVersion ⇔ LexEVS CodingScheme

    CTS2 MapVersionLexEVS CodingScheme
    aboutcodingSchemeURI
    formalNameformalName
    keywordListvalues from the collection set of localName
    mapVersionNamecodingSchemeName + '-' + representsVersion    (Refer to Note 1 below table)
    propertiesproperties
    resourceSynopsiscodingScheme.entityDescription.content.value
    sourceAndNotation.descriptionstring value "LexEVS"
    versionOf.contentcodingSchemeName
    versionOf.uricodingSchemeURI

     Note 1:  The CTS2 'mapVersionName' is the only non 1-1 mapping. In CTS2, a version name is meant to be unique (even across versions) - so the LexEVS CodingSchemeName is concatenated with the LexEVS Version to get a unique name.

     

     

    4 below tableNot Applicable

    Set<? extends PropertyReference> getSupportedSortReferences()

    Refer to Note 2 below tableNot Applicable

    Set<PredicateReference> getKnownProperties()

    Refer to Note 2 below tableNot Applicable

    List<DocumentedNamespaceReference> getKnownNamespaceList() 

    Refer to Note 2 below table

    Not Applicable

    ResolvedValueSetResult<EntitySynopsis> getResolution(

       ResolvedValueSetReadId identifier,

       Set<ResolvedFilter> filterComponent, Page page)

    Uses CTS2's LexEvsEntityQueryService

    Not Applicable

    ResolvedValueSet getResolution(ResolvedValueSetReadId identifier)

    Refer to Note 1 below tableNot Applicable

    ResolvedValueSetResult<EntityDirectoryEntry> getEntities(

       ResolvedValueSetReadId identifier,

       ResolvedValueSetResolutionEntityQuery query,

       SortCriteria sortCriteria, Page page)

    Uses CTS2's LexEvsEntityQueryServiceNot Applicable

    DirectoryResult<EntityDescription> getEntityList(

       ResolvedValueSetReadId identifier,

       ResolvedValueSetResolutionEntityQuery query,

       SortCriteria sortCriteria, Page page)

    Uses CTS2's LexEvsEntityQueryServiceNot Applicable

    Note 1:  Not supported at this time and throws an UnsupportedOperationException.

    Note 2:  Not supported at this time and returns null.

    Note 3:  Returned Set contains 3 MatchAlgorithmReference objects supporting "exactMatch", "contains" and "startsWith".

    Note 4:  Returned Set contains 3 PropertyReference objects supporting attributes "about", "resourceName" and "resourceSynopsis".