Implemented CTS2 Interfaces
CodeSystemVersionQuery
CTS2 Interface: edu.mayo.cts2.framework.service.profile.codesystemversion.CodeSystemVersionQueryService
Implementation: edu.mayo.cts2.framework.plugin.service.lexevs.service.codesystemversion.LexEvsCodeSystemVersionQueryService
Service Method Mappings Table
CTS2 CodeSystemVersionQueryService methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
int count(CodeSystemVersionQuery query) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingSchemeRenderingList getSupportedCodingSchemes() |
boolean exists(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
Set<PredicateReference> getKnownProperties() | Refer to Note 2 below table | Not Applicable |
DirectoryResult<CodeSystemVersionCatalogEntry> getResourceList(CodeSystemVersionQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingSchemeRenderingList getSupportedCodingSchemes() |
DirectoryResult<CodeSystemVersionCatalogEntrySummary> getResourceSummaries(CodeSystemVersionQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingSchemeRenderingList getSupportedCodingSchemes() |
Set<? extends MatchAlgorithmReference> getSupportedMatchAlgorithms() | Refer to Note 3 below table | Not Applicable |
Set<? extends PropertyReference> getSupportedSearchReferences() | Refer to Note 4 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 CodeSystemVersionCatalogEntrySummary ⇔ LexEVS CodingSchemeRendering
CTS2 CodeSystemVersionCatalogEntrySummary | LexEVS CodingSchemeRendering |
---|---|
about | codingSchemeURI (Refer to Note 1 below table) |
codeSystemVersionName | localName + '-' + representsVersion (Refer to Note 2 below table) |
documentURI | codeSystemVersionURI (Refer to Note 3 below table) |
formalName | formalName |
resourceSynopsis | content value of codingSchemeSummary's codingSchemeDescription |
Note 1: The LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resources.
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 LocalName is concatenated with the LexEVS Version to get a unique name.
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
Implementation: edu.mayo.cts2.framework.plugin.service.lexevs.service.codesystemversion.LexEvsCodeSystemVersionReadService
Service Method Mappings Table
CTS2 CodeSystemVersionReadService methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
boolean exists(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
boolean existsByTag(NameOrURI parentIdentifier, VersionTagReference tag, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
boolean existsVersionId(NameOrURI codeSystem, String officialResourceVersionId) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
CodeSystemVersionCatalogEntry getCodeSystemByVersionId(NameOrURI codeSystem, String officialResourceVersionId, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
List<VersionTagReference> getSupportedTags() | Refer to Note 2 below table | Not Applicable |
CodeSystemVersionCatalogEntry read(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
CodeSystemVersionCatalogEntry readByTag(NameOrURI codeSystem, VersionTagReference tag, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme 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 CodeSystemVersionCatalogEntry ⇔ LexEVS CodingScheme
CTS2 CodeSystemVersionCatalogEntry | LexEVS CodingScheme |
---|---|
about | codingSchemeURI (Refer to Note 1 below table) |
codeSystemVersionName | codingSchemeName + '-' + representsVersion (Refer to Note 2 below table) |
formalName | formalName |
keywordList | values from the collection set of localName |
properties | properties |
resourceSynopsis | codingScheme.entityDescription.content.value |
sourceAndNotation.description | string value "LexEVS" |
versionOf.content | codingSchemeName |
versionOf.uri | codingSchemeURI (Refer to Note 1 below table) |
Note 1: The LexEVS codingSchemeURI value is determined through a special LexEVS URI handler that is responsible for constructing URIs from LexEVS resources.
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
Implementation: edu.mayo.cts2.framework.plugin.service.lexevs.service.entitydescription.LexEvsEntityQueryService
Service Method Mappings Table
CTS2 EntityDescriptionQueryService methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
int count(EntityDescriptionQuery query) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
Set<PredicateReference> getKnownProperties() | Refer to Note 2 below table | Not Applicable |
DirectoryResult<EntityDescription> getResourceList(EntityDescriptionQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
DirectoryResult<EntityDirectoryEntry> getResourceSummaries(EntityDescriptionQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
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> getSupportedTags() | Refer to Note 2 below table | Not Applicable |
EntityNameOrURIList intersectEntityList(Set<EntityNameOrURI> entities, EntityDescriptionQuery restrictions, ResolvedReadContext readContext) | Refer to Note 5 below table | Not Applicable |
boolean isEntityInSet(EntityNameOrURI nameOrUri, EntityDescriptionQuery query, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
EntityReferenceList resolveAsEntityReferenceList(EntityDescriptionQuery arg0, ResolvedReadContext arg1) | Refer to Note 5 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".
Note 5: Not supported at this time and throws an UnsupportedOperationException.
EntityDescriptionRead
CTS2 Interface: edu.mayo.cts2.framework.service.profile.entitydescription.EntityDescriptionReadService
Implementation: edu.mayo.cts2.framework.plugin.service.lexevs.service.entity.LexEvsEntityReadService
Service Method Mappings Table
CTS2 EntityDescriptionReadService methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
EntityReference availableDescriptions(EntityNameOrURI entityId, ResolvedReadContext readContext) | Refer to Note 1 below table | Not Applicable |
boolean exists(EntityDescriptionReadId identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodedNodeSet getNodeSet(String codingScheme, CodingSchemeVersionOrTag versionOrTag, LocalNameList entityTypes) |
List<CodeSystemReference> getKnownCodeSystems() | Refer to Note 2 below table | Not Applicable |
List<CodeSystemVersionReference> getKnownCodeSystemVersions() | Refer to Note 2 below table | Not Applicable |
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 2 below table | Not Applicable |
List<VersionTagReference> getSupportedVersionTags() | Refer to Note 2 below table | Not Applicable |
EntityDescription read(EntityDescriptionReadId identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
List<EntityListEntry> readEntityDescriptions(EntityNameOrURI entityId, ResolvedReadContext readContext) | Refer to Note 1 below table | Not Applicable |
DirectoryResult<EntityListEntry> readEntityDescriptions(EntityNameOrURI entityId, SortCriteria sortCriteria, ResolvedReadContext readContext, Page page) | Refer to Note 1 below table | Not Applicable |
Note 1: Not supported at this time and throws an UnsupportedOperationException.
Note 2: Not supported at this time and returns an empty List.
Transformation Table: CTS2 EntityDescription ⇔ LexEVS ResolvedConceptReference
CTS2 EntityDescription | LexEVS ResolvedConceptReference |
---|---|
namedEntityDescription.about | entityUri (Refer to Note 1 below table) |
namedEntityDescription.designation.designationRole | getEntity().getPresentation().isIsPreferred() (Refer to Note 2 below table) |
namedEntityDescription.designation.value | getEntity().getPresentation().getValue().getContent() |
namedEntityDescription.describingCodeSystemVersion | |
namedEntityDescription.entityID.name | getEntity().getEntityCode() |
namedEntityDescription.entityID.nameSpace | getEntity().getEntityCodeNamespace() |
namedEntityDescription.parent |
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.
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 methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
int count(MapQuery query) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
Set<PredicateReference> getKnownProperties() | Refer to Note 2 below table | Not Applicable |
DirectoryResult<MapCatalogEntry> getResourceList(MapQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
DirectoryResult<MapCatalogEntrySummary> getResourceSummaries(MapQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
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 MapCatalogEntrySummary ⇔ LexEVS CodingScheme
CTS2 MapCatalogEntrySummary | LexEVS CodingScheme |
---|---|
about | codingSchemeURI (Refer to Note 1 below table) |
formalName | formalName |
fromCodeSystem | codingScheme.getRelations(0).getSourceCodingScheme() |
mapName | codingSchemeName |
resourceSynopsis | content value of codingSchemeSummary's codingSchemeDescription |
toCodeSystem | codingScheme.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 methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
boolean exists(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
MapVersion read(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
Note 1: Not supported at this time and returns an empty List.
Transformation Table: CTS2 MapCatalogEntry ⇔ LexEVS CodingScheme
CTS2 MapCatalogEntry | LexEVS CodingScheme |
---|---|
about | codingSchemeURI (Refer to Note 1 below table) |
formalName | formalName |
fromCodeSystem | codingScheme.getRelations(0).getSourceCodingScheme() |
keywordList | values from the collection set of localName |
mapName | codingSchemeName |
properties | properties |
resourceSynopsis | codingScheme.entityDescription.content.value |
toCodeSystem | codingScheme.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
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 methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
boolean exists(MapEntryReadId identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
MapEntry read(MapEntryReadId, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
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
CTS2 MapVersionQueryService methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
int count(MapVersionQuery query) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
Set<PredicateReference> getKnownProperties() | Refer to Note 2 below table | Not Applicable |
DirectoryResult<MapVersion> getResourceList(MapVersionQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
DirectoryResult<MapVersionDirectoryEntry> getResourceSummaries(MapVersionQuery query, SortCriteria sortCriteria, Page page) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl |
|
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 |
DirectoryResult<EntityDirectoryEntry> mapVersionEntities(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page) | Refer to Note 5 below table | Not Applicable |
DirectoryResult<EntityDescription> mapVersionEntityList(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page) | Refer to Note 5 below table | Not Applicable |
EntityReferenceList mapVersionEntityReferences(NameOrURI mapVersion, MapRole mapRole, MapStatus mapStatus, EntityDescriptionQuery query, SortCriteria sortCriteria, Page page) | Refer to Note 5 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".
Note 5: Not supported at this time and throws an UnsupportedOperationException.
Transformation Table: CTS2 MapVersionDirectoryEntry ⇔ LexEVS CodingSchemeRendering
CTS2 MapVersionDirectoryEntry | LexEVS CodingSchemeRendering |
---|---|
about | codingSchemeURI |
mapVersionName | localName + '-' + representsVersion (Refer to Note 1 below table) |
documentURI | codingSchemeURI |
formalName | formalName |
resourceSynopsis | content value of codingSchemeSummary's codingSchemeDescription |
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 LocalName is concatenated with the LexEVS Version to get a unique name.
MapVersionRead
CTS2 Interface: edu.mayo.cts2.framework.service.profile.mapversion.MapVersionReadService
Implementation: edu.mayo.cts2.framework.plugin.service.lexevs.service.mapversion.LexEvsMapVersionReadService
Service Method Mappings Table
CTS2 MapVersionReadService methods | LexEVS Service Implementation | LexEVS Service methods used |
---|---|---|
boolean exists(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
boolean existsByTag(NameOrURI parentIdentifier, VersionTagReference tag, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
List<DocumentedNamespaceReference> getKnownNamespaceList() | Refer to Note 1 below table | Not Applicable |
List<VersionTagReference> getSupportedTags() | Refer to Note 2 below table | Not Applicable |
MapVersion read(NameOrURI identifier, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme resolveCodingScheme(String codingScheme, CodingSchemeVersionOrTag versionOrTag) |
MapVersion readByTag(NameOrURI codeSystem, VersionTagReference tag, ResolvedReadContext readContext) | org.LexGrid.LexBIG.Impl.LexBIGServiceImpl | CodingScheme 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 MapVersion | LexEVS CodingScheme |
---|---|
about | codingSchemeURI |
formalName | formalName |
keywordList | values from the collection set of localName |
mapVersionName | codingSchemeName + '-' + representsVersion (Refer to Note 1 below table) |
properties | properties |
resourceSynopsis | codingScheme.entityDescription.content.value |
sourceAndNotation.description | string value "LexEVS" |
versionOf.content | codingSchemeName |
versionOf.uri | codingSchemeURI |
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.