This wiki has undergone a migration to Confluence found Here

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

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

Latest revision as of 00:44, 18 December 2015



codesystem

codesystem
Relative Path OP Model Method Return Type Parameters
codesystem/{codesystemid} PUT CodeSystemCatalogMaintenanceService:createCodeSystem codeSystem:CodeSystemCatalogEntry
  • codesystemid -
  • changeseturi - ChangeSetURI
  • uri - ExternalURI
  • name - CodeSystem:codeSystemName
codesystem/{codesystemid} DELETE CodeSystemCatalogMaintenanceService:deleteChangeable
  • codesystemid -
  • changeseturi -
codesystem/{codesystemid} POST CodeSystemCatalogMaintenanceService:updateCodeSystem
  • codesystemid -
  • changeseturi - ChangeSetURI
  • (POST) - codeSystemService:UpdateCodeSystemRequest
codesystem/{codesystemid} HEAD CodeSystemCatalogReadService:exists
  • codesystemid -
codesystem/{codesystemid} GET CodeSystemCatalogReadService:read codeSystem:CodeSystemCatalogEntryMsg
  • codesystemid -
  • 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
codesystem/{codesystemid}/changehistory GET CodeSystemCatalogHistoryService:getChangeHistoryFor codeSystem:CodeSystemCatalogEntryList
  • fromDate - DateAndTime
  • toDate - DateAndTime
codesystem/{codesystemid}/earliestchange GET CodeSystemCatalogHistoryService:getEarliestChangeFor codeSystem:CodeSystemCatalogEntryMsg
codesystem/{codesystemid}/latestchange GET CodeSystemCatalogHistoryService:getLatestChangeFor codeSystem:CodeSystemCatalogEntryMsg
codesystem/{codesystemid}/version/{codesystemversionid} DELETE CodeSystemVersionCatalogMaintenanceService:deleteChangeable
  • codesystemversionid -
  • changeseturi -
codesystem/{codesystemid}/version/{codesystemversionid} POST CodeSystemVersionCatalogMaintenanceService:updateCodeSystemVersion
  • codesystemversionid -
  • changeseturi - ChangeSetURI
  • (POST) - codeSystemService:UpdateCodeSystemVersionRequest
codesystem/{codesystemid}/version/{codesystemversionid} HEAD CodeSystemVersionCatalogReadService:exists
  • codesystemversionid -
codesystem/{codesystemid}/version/{codesystemversionid} GET CodeSystemVersionCatalogReadService:read codeSystemVersion:CodeSystemVersionCatalogEntryMsg
  • codesystemversionid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
codesystem/{codesystemid}/version/{codesystemversionid} POST EntityDescriptionMaintenanceService:createAnonymousIndividual entity:AnonymousIndividualDescription
  • codesystemversionid -
  • changeseturi - ChangeSetURI
codesystem/{codesystemid}/version/{codesystemversionid}/association/{associationid} DELETE AssociationMaintenanceService:deleteChangeable
  • associationid -
  • changeseturi -
codesystem/{codesystemid}/version/{codesystemversionid}/association/{associationid} POST AssociationMaintenanceService:updateAssociation association:Association
  • associationid -
  • changeseturi - ChangeSetURI
  • (POST) - associationService:UpdateAssociationRequest
codesystem/{codesystemid}/version/{codesystemversionid}/association/{associationid} HEAD AssociationReadService:exists
  • associationid -
codesystem/{codesystemid}/version/{codesystemversionid}/association/{associationid} GET AssociationReadService:read association:AssociationMsg
  • associationid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
codesystem/{codesystemid}/version/{codesystemversionid}/associations POST AssociationMaintenanceService:createAssociation association:Association
  • changeseturi - ChangeSetURI
  • subject - EntityNameOrURI
  • predicate - EntityNameOrURI
  • externalstatementid - String
  • (POST) - core:StatementTarget
codesystem/{codesystemid}/version/{codesystemversionid}/associations POST AssociationMaintenanceService:createAssociationFromExpression association:Association
  • changeseturi - ChangeSetURI
  • subject - EntityNameOrURI
  • predicate - EntityNameOrURI
  • externalstatementid - String
  • (POST) - association:AssociationRendering
codesystem/{codesystemid}/version/{codesystemversionid}/associations POST AssociationMaintenanceService:createAssociationsFromExpression association:AssociationList
  • changeseturi - ChangeSetURI
  • subject - EntityNameOrURI
  • (POST) - core:EntityExpression
codesystem/{codesystemid}/version/{codesystemversionid}/associations HEAD AssociationQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/associations GET AssociationQueryService:resolve association:AssociationDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/associations GET AssociationQueryService:resolve association:AssociationList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/associations POST AssociationQueryService:resolve association:AssociationDirectory
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations POST AssociationQueryService:resolve association:AssociationList
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/classify POST ReasoningService:classify association:AssociationList
codesystem/{codesystemid}/version/{codesystemversionid}/associations/classify POST ReasoningService:classify coreService:InferenceNotSupported
codesystem/{codesystemid}/version/{codesystemversionid}/associations/predicates GET AssociationQueryService:getPredicates entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/predicates GET AssociationQueryService:getPredicates entity:EntityList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/sourceanttargetentities GET AssociationQueryService:getAllSourceAndTargetEntities entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/sourceanttargetentities GET AssociationQueryService:getAllSourceAndTargetEntities entity:EntityList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/sourceentities GET AssociationQueryService:getSourceEntities entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/sourceentities GET AssociationQueryService:getSourceEntities entity:EntityList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/associations/targetentities GET AssociationQueryService:getTargetEntities entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/associations/targetentities GET AssociationQueryService:getTargetEntities entity:EntityList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/changehistory GET CodeSystemVersionCatalogHistoryService:getChangeHistoryFor codeSystemVersion:CodeSystemCatalogList
  • fromDate - DateAndTime
  • toDate - DateAndTime
codesystem/{codesystemid}/version/{codesystemversionid}/earliestchange GET CodeSystemVersionHistoryService:getEarliestChangeFor codeSystemVersion:CodeSystemVersionCatalogEntryMsg
codesystem/{codesystemid}/version/{codesystemversionid}/entities HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entities GET EntityDescriptionQueryService:resolve entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
codesystem/{codesystemid}/version/{codesystemversionid}/entities GET EntityDescriptionQueryService:resolve entity:EntityDirectoryList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
codesystem/{codesystemid}/version/{codesystemversionid}/entities POST EntityDescriptionQueryService:resolve entity:EntityDirectory
  • list -
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/entities POST EntityDescriptionQueryService:resolve entity:EntityDirectoryList
  • list -
  • (POST) - coreService:Query
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createAnnotationPropertyDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createAnonymousIndividualDescription entity:AnonymousIndividualDescription
  • entityid -
  • changeseturi - ChangeSetURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createClassDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • entitytype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createDataPropertyDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createDataTypeDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createNamedEntityDescription entity:EntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createNamedIndividualDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createObjectPropertyDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} PUT EntityDescriptionMaintenanceService:createPredicateDescription entity:NamedEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • resourcetype - EntityNameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} DELETE EntityDescriptionMaintenanceService:deleteChangeable
  • entityid -
  • changeseturi -
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} POST EntityDescriptionMaintenanceService:updateEntityDescription
  • entityid -
  • changeseturi - ChangeSetURI
  • (POST) - entityService:UpdateEntityDescriptionRequest
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} HEAD EntityDescriptionReadService:exists
  • entityid -
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} GET EntityDescriptionReadService:read entity:EntityDescriptionMsg
  • entityid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} GET EntityDescriptionReadService:read coreService:UnsupportedNamespaceName
  • entityid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid} GET EntityDescriptionReadService:read coreService:UnknownEntity
  • entityid -
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/ancestors HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/ancestors GET AssociationQueryService:resolve entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/ancestors GET AssociationQueryService:resolve entity:EntityDirectoryList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/changehistory GET EntityDescriptionHistoryService:getChangeHistoryFor entity:EntityDirectory
  • fromdate -
  • todate -
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/children HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/children GET AssociationQueryService:resolve entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/children GET AssociationQueryService:resolve entity:EntityDirectoryList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/decendents HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/decendents GET AssociationQueryService:resolve entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/decendents GET AssociationQueryService:resolve entity:EntityDirectoryList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/earliestchange GET EntityDescriptionHistoryService:getEarliestChangeFor entity:NamedEntityDescription
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/earliestservicechange GET EntityDescriptionHistoryService:getEarliestServiceChangeFor entity:NamedEntityDescription
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/latestchange GET EntityDescriptionHistoryService:getLatestChangeFor entity:NamedEntityDescription
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/latestservicechange GET EntityDescriptionHistoryService:getLatestServiceChangeFor entity:NamedEntityDescription
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/parents HEAD EntityDescriptionQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/parents GET AssociationQueryService:resolve entity:EntityDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/parents GET AssociationQueryService:resolve entity:EntityDirectoryList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystem - NameOrURI
  • tag - VersionTagReference
  • codesystemversion - NameOrURI
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/servicehistory GET EntityDescriptionHistoryService:getServiceHistoryFor entity:EntityList
  • fromdate -
  • todate -
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/sourceof HEAD AssociationQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/sourceof GET AssociationQueryService:resolve association:AssociationDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/sourceof GET AssociationQueryService:resolve association:AssociationList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/targetof HEAD AssociationQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/targetof GET AssociationQueryService:resolve association:AssociationDirectory
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/entity/{entityid}/targetof GET AssociationQueryService:resolve association:AssociationList
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • format - QueryControl:format
  • page -
  • maxtoreturn - QueryControl:maxToReturn
  • timelimit - QueryControl:timeLimit
  • list -
  • codesystemversion - NameOrURI
  • predicate - EntityNameOrURI
  • sourceentity - EntityNameOrURI
  • sourceortargetentity - EntityNameOrURI
  • targetentity - EntityNameOrURI
  • targetexpression - AssociationRendering
  • targetliteral - String
codesystem/{codesystemid}/version/{codesystemversionid}/latestchange GET CodeSystemCatalogHistoryService:getLatestChangeFor codeSystemVersion:CodeSystemVersionCatalogEntryMsg
codesystem/{codesystemid}/versions POST CodeSystemVersionCatalogMaintenanceService:createCodeSystemVersion codeSystemVersion:CodeSystemVersionCatalogEntry
  • changeseturi - ChangeSetURI
  • uri - DocumentURI
  • name - CodeSystemVersion:codeSystemVersionName
  • (POST) - core:SourceAndNotation
codesystem/{codesystemid}/versions POST CodeSystemVersionCatalogMaintenanceService:createCodeSystemVersion coreService:DuplicateCodeSystemVersionName
  • changeseturi - ChangeSetURI
  • uri - DocumentURI
  • name - CodeSystemVersion:codeSystemVersionName
  • (POST) - core:SourceAndNotation
codesystem/{codesystemid}/versions POST CodeSystemVersionCatalogMaintenanceService:createCodeSystemVersion coreService:DuplicateCodeSystemVersionURI
  • changeseturi - ChangeSetURI
  • uri - DocumentURI
  • name - CodeSystemVersion:codeSystemVersionName
  • (POST) - core:SourceAndNotation
codesystem/{codesystemid}/versions HEAD CodeSystemVersionCatalogQueryService:count core:NaturalNumber
  • active - ReadContext:active
  • changesetcontext - ReadContext:changeSetContext
  • referencelanguage - ReadContext:referenceLanguage
  • referencetime - ReadContext:referenceTime
  • timelimit - QueryControl:timeLimit
  • entityreference - EntityReferenceList
  • activeorall - ActiveOrAll
  • allorsome - RestrictionType
codesystem/{codesystemid}/versions GET CodeSystemVersionCatalogQueryService:resolve codeSystemVersion:CodeSystemVersionCatalogEntryDirectory
  • 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
  • activeorall - ActiveOrAll
  • allorsome - RestrictionType
codesystem/{codesystemid}/versions GET CodeSystemVersionCatalogQueryService:resolve codeSystemVersion:CodeSystemVersionCatalogEntryList
  • 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
  • activeorall - ActiveOrAll
  • allorsome - RestrictionType
codesystem/{codesystemid}/versions POST CodeSystemVersionCatalogQueryService:resolve codeSystemVersion:CodeSystemVersionCatalogEntryDirectory
  • list -
  • (POST) - coreService:Query
codesystem/{codesystemid}/versions POST CodeSystemVersionCatalogQueryService:resolve codeSystemVersion:CodeSystemVersionCatalogEntryList
  • 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