This wiki has undergone a migration to Confluence found Here

CTS2/doc/Rest valueset

From HL7Wiki
Jump to navigation Jump to search



valueset

valueset
Relative Path OP Model Method Return Type Parameters
valueset/{valuesetid} PUT ValueSetCatalogMaintenanceService:createValueSet valueSet:ValueSetCatalogEntry
  • valuesetid -
  • changeseturi - ChangeSetURI
valueset/{valuesetid} PUT ValueSetCatalogMaintenanceService:createValueSet coreService:ChangeSetIsNotOpen
  • valuesetid -
  • changeseturi - ChangeSetURI
valueset/{valuesetid} PUT ValueSetCatalogMaintenanceService:createValueSet coreService:DuplicateValueSetURI
  • valuesetid -
  • changeseturi - ChangeSetURI
valueset/{valuesetid} PUT ValueSetCatalogMaintenanceService:createValueSet coreService:DuplicateValueSetName
  • valuesetid -
  • changeseturi - ChangeSetURI
valueset/{valuesetid} DELETE ValueSetCatalogMaintenanceService:deleteChangeable
  • valuesetid -
  • changeseturi -
valueset/{valuesetid} POST ValueSetCatalogMaintenanceService:updateValueSet valueSet:ValueSetCatalogEntry
  • valuesetid -
  • changeseturi - ChangeSetURI
  • (POST) - valueSetService:UpdateValueSetRequest
valueset/{valuesetid} POST ValueSetCatalogMaintenanceService:updateValueSet coreService:ChangeSetIsNotOpen
  • valuesetid -
  • changeseturi - ChangeSetURI
  • (POST) - valueSetService:UpdateValueSetRequest
valueset/{valuesetid} POST ValueSetCatalogMaintenanceService:updateValueSet coreService:ResourceDescriptionUpdateExceptions
  • valuesetid -
  • changeseturi - ChangeSetURI
  • (POST) - valueSetService:UpdateValueSetRequest
valueset/{valuesetid} HEAD ValueSetCatalogReadService:exists
  • valuesetid -
valueset/{valuesetid} GET ValueSetCatalogReadService:read valueSet:ValueSetCatalogEntryMsg
  • valuesetid -
  • 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
valueset/{valuesetid}/changehistory GET ValueSetCatalogHistoryService:getChangeHistoryFor valueSet:ValueSetCatalogList
  • fromDate - DateAndTime
  • toDate - DateAndTime
valueset/{valuesetid}/earliestchange GET ValueSetCatalogHistoryService:getEarliestChangeFor valueSet:ValueSetCatalogEntryMsg
valueset/{valuesetid}/latestchange GET ValueSetCatalogHistoryService:getLatestChangeFor valueSet:ValueSetCatalogEntryMsg
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid} DELETE ValueSetDefinitionHistoryService:deleteChangeable
  • valuesetdefinitionid -
  • changeseturi -
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid} HEAD ValueSetDefinitionReadService:exists
  • valuesetdefinitionid -
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid} GET ValueSetDefinitionReadService:read valueSetDefinition:ValueSetDefinitionMsg
  • valuesetdefinitionid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/changehistory GET ValueSetCatalogHistoryService:getChangeHistoryFor valueSetDefinition:ValueSetDefinitionList
  • fromDate - DateAndTime
  • toDate - DateAndTime
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/earliestchange GET ValueSetDefinitionHistoryService:getEarliestChangeFor valueSetDefinition:ValueSetDefinitionMsg
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/entries POST valueSetDefinition:ValueSetDefinition
  • definitionentry -
  • changeseturi - ChangeSetURI
  • (POST) - valueSetDefinition:ValueSetDefinitionEntry
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/entry/{definitionentry} DELETE ValueSetDefinitionMaintenanceService:removeDefinitionEntry
  • definitionentry -
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/latestchange GET ValueSetDefinitionHistoryService:getLatestChangeFor valueSetDefinition:ValueSetDefinitionMsg
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/resolution HEAD ValueSetDefinitionResolution:contains
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystemversion - NameOrURI
  • tag - VersionTagReference
  • entity - EntityNameOrURI
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/resolution GET ValueSetDefinitionResolution:resolve valueSetDefinition:ResolvedValueSetDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • codesystemversion - NameOrURI
  • tag - VersionTagReference
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/resolution/completeset GET ValueSetDefinitionResolution:resolveAsCompleteSet valueSet:ResolvedValueSet
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • codesystemversion - NameOrURI
  • tag - VersionTagReference
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/resolution/entitydirectory HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/resolution/entitydirectory GET ValueSetDefinitionResolution:resolveAsEntityDirectory entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • codesystemversion - NameOrURI
  • tag - VersionTagReference
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
  • (POST) - coreService:Query
valueset/{valuesetid}/valuesetdefinition/{valuesetdefinitionid}/resolution/entitydirectory GET ValueSetDefinitionResolution:resolveAsEntityDirectory entity:EntityList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • codesystemversion - NameOrURI
  • tag - VersionTagReference
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
  • (POST) - coreService:Query
valueset/{valuesetid}/valuesetdefinitions HEAD ValueSetDefinitionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • timelimit - QueryControl:timeLimit
  • entityreference - EntityReferenceList
valueset/{valuesetid}/valuesetdefinitions GET ValueSetDefinitionQueryService:resolve valueSetDefinition:ValueSetDefinitionDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • entityreference - EntityReferenceList
valueset/{valuesetid}/valuesetdefinitions GET ValueSetDefinitionQueryService:resolve valueSetDefinition:ValueSetDefinitionList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • entityreference - EntityReferenceList
valueset/{valuesetid}/valuesetdefinitions POST ValueSetDefinitionQueryService:resolve valueSetDefinition:ValueSetDefinitionDirectory
  • list -
  • (POST) - coreService:Query
valueset/{valuesetid}/valuesetdefinitions POST ValueSetDefinitionQueryService:resolve valueSetDefinition:ValueSetDefinitionList
  • 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