This wiki has undergone a migration to Confluence found Here

Difference between revisions of "CTS2/doc/Rest map"

From HL7Wiki
Jump to navigation Jump to search
m (1 revision: Re-import CTS2 documentation pages with appropriate links)
 
 
Line 401: Line 401:
  
 
{{method_table_end}}
 
{{method_table_end}}
 +
 +
{{ CTS2-Navbox }}

Latest revision as of 00:39, 18 December 2015



map

map
Relative Path OP Model Method Return Type Parameters
map/{mapid} PUT MapCatalogMaintenanceService:createMapCatalogEntry map:MapCatalogEntry
  • mapid -
  • changeseturi - ChangeSetURI
  • mapcatalogentryname -
  • fromcodesystem -
  • fromvalueset -
  • tocodesystem -
  • tovalueset -
map/{mapid} PUT MapCatalogMaintenanceService:createMapCatalogEntry coreService:ChangeSetIsNotOpen
  • mapid -
  • changeseturi - ChangeSetURI
  • mapcatalogentryname -
  • fromcodesystem -
  • fromvalueset -
  • tocodesystem -
  • tovalueset -
map/{mapid} PUT MapCatalogMaintenanceService:createMapCatalogEntry coreService:MapCatalogFromReferenceException
  • mapid -
  • changeseturi - ChangeSetURI
  • mapcatalogentryname -
  • fromcodesystem -
  • fromvalueset -
  • tocodesystem -
  • tovalueset -
map/{mapid} PUT MapCatalogMaintenanceService:createMapCatalogEntry coreService:DuplicateMapName
  • mapid -
  • changeseturi - ChangeSetURI
  • mapcatalogentryname -
  • fromcodesystem -
  • fromvalueset -
  • tocodesystem -
  • tovalueset -
map/{mapid} PUT MapCatalogMaintenanceService:createMapCatalogEntry coreService:MapCatalogToReferenceException
  • mapid -
  • changeseturi - ChangeSetURI
  • mapcatalogentryname -
  • fromcodesystem -
  • fromvalueset -
  • tocodesystem -
  • tovalueset -
map/{mapid} PUT MapCatalogMaintenanceService:createMapCatalogEntry coreService:UnknownChangeSet
  • mapid -
  • changeseturi - ChangeSetURI
  • mapcatalogentryname -
  • fromcodesystem -
  • fromvalueset -
  • tocodesystem -
  • tovalueset -
map/{mapid} DELETE MapCatalogMaintenanceService:deleteChangeable
  • mapid -
  • changeseturi -
map/{mapid} POST MapCatalogMaintenanceService:updateMap map:MapCatalogEntry
  • mapid -
  • changeseturi - ChangeSetURI
  • (POST) - mapService:UpdateMapCatalogRequest
map/{mapid} POST MapCatalogMaintenanceService:updateMap coreService:UnknownMap
  • mapid -
  • changeseturi - ChangeSetURI
  • (POST) - mapService:UpdateMapCatalogRequest
map/{mapid} POST MapCatalogMaintenanceService:updateMap coreService:UnknownChangeSet
  • mapid -
  • changeseturi - ChangeSetURI
  • (POST) - mapService:UpdateMapCatalogRequest
map/{mapid} POST MapCatalogMaintenanceService:updateMap coreService:ChangeSetIsNotOpen
  • mapid -
  • changeseturi - ChangeSetURI
  • (POST) - mapService:UpdateMapCatalogRequest
map/{mapid} POST MapCatalogMaintenanceService:updateMap coreService:ResourceDescriptionUpdateExceptions
  • mapid -
  • changeseturi - ChangeSetURI
  • (POST) - mapService:UpdateMapCatalogRequest
map/{mapid} HEAD MapCatalogReadService:exists
  • mapid -
map/{mapid} GET MapCatalogReadService:read map:MapCatalogEntryMsg
  • mapid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • filtercomponent - FilterComponent:filterComponent
  • matchalgorithm - FilterComponent:matchAlgorithm
  • matchvalue - FilterComponent:matchValue
map/{mapid}/changehistory GET MapCatalogHistoryService:getChangeHistoryFor map:MapCatalogEntryList
  • fromDate - DateAndTime
  • toDate - DateAndTime
map/{mapid}/earliestchange GET MapCatalogHistoryService:getEarliestChangeFor map:MapCatalogEntryMsg
map/{mapid}/latestchange GET MapCatalogHistoryService:getLatestChangeFor map:mapCatalogEntryMsg
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion mapVersion:MapVersion
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:UnsupportedNamespaceName
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:MapVersionToReferenceException
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:DuplicateMapVersionName
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:UnknownValueSetDefinition
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:MapVersionFromReferenceException
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:ResourceCreationExceptions
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} PUT MapVersionMaintenanceService:createMapVersion coreService:UnknownCodeSystemVersion
  • mapversionid -
  • changeseturi - ChangeSetURI
map/{mapid}/mapversion/{mapversionid} DELETE MapVersionMaintenanceService:deleteChangeable
  • mapversionid -
  • changeseturi -
map/{mapid}/mapversion/{mapversionid} HEAD MapVersionReadService:exists
  • mapversionid -
map/{mapid}/mapversion/{mapversionid} GET MapVersionReadService:read mapVersion:MapVersionMsg
  • mapversionid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
map/{mapid}/mapversion/{mapversionid}/changehistory GET MapVersionHistoryService:getChangeHistoryFor mapVersion:MapVersionList
  • fromDate - DateAndTime
  • toDate - DateAndTime
map/{mapid}/mapversion/{mapversionid}/earliestchange GET MapVersionHistoryService:getEarliestChangeFor mapVersion:MapVersionMsg
map/{mapid}/mapversion/{mapversionid}/entities HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
map/{mapid}/mapversion/{mapversionid}/entities POST MapVersionQueryService:mapVersionEntities entity:EntityDirectory
  • context - MapStatus
  • maprole - MapRole
  • mapstatus - MapStatus
  • list -
  • (POST) - coreService:Query
map/{mapid}/mapversion/{mapversionid}/entities POST MapVersionQueryService:mapVersionEntities entity:EntityDirectoryList
  • context - MapStatus
  • maprole - MapRole
  • mapstatus - MapStatus
  • list -
  • (POST) - coreService:Query
map/{mapid}/mapversion/{mapversionid}/entries HEAD MapEntryQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • timelimit - QueryControl:timeLimit
  • filtercomponent - FilterComponent:filterComponent
  • matchalgorithm - FilterComponent:matchAlgorithm
  • matchvalue - FilterComponent:matchValue
  • targetentity - EntityNameOrURIList
  • restrictiontype - AllOrSome
map/{mapid}/mapversion/{mapversionid}/entries GET MapEntryQueryService:resolve mapVersion:MapEntryDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • filtercomponent - FilterComponent:filterComponent
  • matchalgorithm - FilterComponent:matchAlgorithm
  • matchvalue - FilterComponent:matchValue
  • list -
  • targetentity - EntityNameOrURIList
  • restrictiontype - AllOrSome
map/{mapid}/mapversion/{mapversionid}/entries GET MapEntryQueryService:resolve mapVersion:MapEntryList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • filtercomponent - FilterComponent:filterComponent
  • matchalgorithm - FilterComponent:matchAlgorithm
  • matchvalue - FilterComponent:matchValue
  • list -
  • targetentity - EntityNameOrURIList
  • restrictiontype - AllOrSome
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom} PUT MapEntryMaintenanceService:createMapEntry
  • mapFrom -
  • changeseturi - ChangeSetURI
  • processingrule - MapProcessingRule
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom} POST MapEntryMaintenanceService:updateMapEntry
  • mapFrom -
  • changeseturi - ChangeSetURI
  • (POST) - mapEntryService:UpdateMapEntryRequest
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom} HEAD MapEntryReadService:exists
  • mapFrom -
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom} GET MapEntryReadService:read
  • mapFrom -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom}/changehistory GET MapEntryHistoryService:getChangeHistoryFor mapVersion:MapEntryList
  • fromDate - DateAndTime
  • toDate - DateAndTime
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom}/mapset/{setnumber} PUT MapEntryMaintenanceService:addMapSet
  • changeseturi -
  • processingrule -
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom}/mapset/{setnumber} DELETE MapEntryMaintenanceService:removeMapSet
  • changeseturi -
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom}/mapset/{setnumber}/target/{targetslot} PUT MapEntryMaintenanceService:addMapTarget
  • changeseturi -
  • (POST) - mapEntryService:MapTargetRequest
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom}/mapset/{setnumber}/target/{targetslot} DELETE MapEntryMaintenanceService:removeMapTarget
  • changeseturi -
map/{mapid}/mapversion/{mapversionid}/entry/{mapFrom}/mapset/{setnumber}/target/{targetslot} POST MapEntryMaintenanceService:updateMapTarget
  • changeseturi -
  • (POST) - mapEntryService:MapTargetRequest
map/{mapid}/mapversion/{mapversionid}/latestchange GET MapVersionHistoryService:getLatestChangeFor mapVersion:mapVersionMsg
map/{mapid}/mapversion/{mapversionid}/resolution GET MapResolutionService:resolve mapEntryService:MapTargetList
  • entity - EntityNameOrURI
map/{mapid}/mapversion/{mapversionid}/resolutionlist GET MapResolutionService:resolveEntityList mapEntryService:MapTargetListList
  • entity - EntityNameOrURIList
map/{mapid}/mapversions HEAD MapVersionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • timelimit - QueryControl:timeLimit
  • codesystem - NameOrURIList
  • valueset - NameOrURIList
  • maprole - MapRole
  • entity - EntityNameOrURIList
  • mapstatus - MapRole
  • restrictiontype - RestrictionType
  • maprole - MapRole
map/{mapid}/mapversions GET MapVersionQueryService:resolve mapVersion:MapVersionDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • codesystem - NameOrURIList
  • valueset - NameOrURIList
  • maprole - MapRole
  • entity - EntityNameOrURIList
  • mapstatus - MapRole
  • restrictiontype - RestrictionType
  • maprole - MapRole
map/{mapid}/mapversions GET MapVersionQueryService:resolve mapVersion:MapVersionList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • codesystem - NameOrURIList
  • valueset - NameOrURIList
  • maprole - MapRole
  • entity - EntityNameOrURIList
  • mapstatus - MapRole
  • restrictiontype - RestrictionType
  • maprole - MapRole
map/{mapid}/mapversions POST MapVersionQueryService:resolve mapVersion:MapVersionDirectory
  • list -
  • (POST) - coreService:Query
map/{mapid}/mapversions POST MapVersionQueryService:resolve mapVersion:MapVersionList
  • list -
  • (POST) - coreService:Query

Navigation – Common Terminology Services (CTS2)

   Home
About CTS2
   Purpose
   CTS2 History
   Business Case
How it works
   Federation
   Functionality
Implementing CTS2
   Architecture
   Development
Resources
   Purpose
   FAQ
   Business Case
   Glossary of Terms
Specification
   REST
   SOAP
   HL7 SFM
Development
   CTS2 Development Framework
   Implementations
  Github Page
Community
   Who is Using CTS2?
   Get Help
   Links