CTS2 OMG© REST Platform Specific Model

This document contains Representational State Transfer (REST) Bindings to the CTS2 OMG Specification. Certain patterns are used throughout the document:



For more information about CTS2, visit the CTS2 Site

NOTE: Each 'by URI' request must accept any parameters that are allowed by the 'read by name' requests. For example, '/codesystembyuri?uri=http://some/cs' must accept the same parameters as the equivalent 'read by name' request, such as '/codesystem/CS'.

Resources

/

Methods

//service

Methods

GET

available response representations:

//service/advancedassociationquery

Methods

GET

available response representations:

//service/associationmaintenance

Methods

GET

available response representations:

//service/associationquery

Methods

GET

available response representations:

//service/associationread

Methods

GET

available response representations:

//service/associationtransform

Methods

GET

available response representations:

//service/associationtransform/entityexpression

Methods

POST

Return an expression that represents associationList in the named languageAndSyntax.

request query parameters
parametervaluedescription

languageAndSyntax

string

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

//service/reasoning

Methods

GET

available response representations:

//service/codesystemmaintenance

Methods

GET

available response representations:

//service/codesystemquery

Methods

GET

available response representations:

//service/codesystemread

Methods

GET

available response representations:

//service/codesystemhistory

Methods

GET

available response representations:

//service/codesystemversionmaintenance

Methods

//service/codesystemversionread

Methods

GET

available response representations:

//service/codesystemversionquery

Methods

GET

available response representations:

//service/codesystemversionhistory

Methods

//service/conceptdomainmaintenance

Methods

GET

available response representations:

//service/conceptdomainread

Methods

GET

available response representations:

//service/conceptdomainquery

Methods

GET

available response representations:

//service/conceptdomainhistory

Methods

GET

available response representations:

//service/conceptdomainbindingmaintenance

Methods

//service/conceptdomainbindingread

Methods

//service/conceptdomainbindingquery

Methods

//service/entitydescriptionmaintenance

Methods

GET

available response representations:

//service/entitydescriptionread

Methods

GET

available response representations:

//service/entitydescriptionquery

Methods

GET

available response representations:

//service/entitydescriptionhistory

Methods

GET

available response representations:

//service/entitydescriptiontransform

Methods

GET

available response representations:

//service/entitydescriptiontransform/entityexpression

Methods

POST

Transform the list of entity descriptions in entityList into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

languageandsyntax

string

The language and syntax of an expression in an ontology. Language identifies the expression semantics (e.g. OWL 2.0, RDF, SNOMED Compositional Expression, etc) and syntax identifies how it is represnted (e.g. XML, text/plain, xml/rdf, manchester syntax, etc)

acceptable request representations:

available response representations:

available response representations:

available response representations:

//service/entitydescriptiontransform/entitylist

Methods

POST

Transform entityExpression into a list of one or more EntityDescriptions in the context of the supplied codeSystemVersion.

request query parameters
parametervaluedescription

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

//service/mapcatalogmaintenance

Methods

GET

available response representations:

//service/mapcatalogread

Methods

GET

available response representations:

//service/mapcatalogquery

Methods

GET

available response representations:

//service/mapcataloghistory

Methods

GET

available response representations:

//service/mapversionmaintenance

Methods

GET

available response representations:

//service/mapversionread

Methods

GET

available response representations:

//service/mapversionquery

Methods

GET

available response representations:

//service/mapversionhistory

Methods

GET

available response representations:

//service/mapentrymaintenance

Methods

GET

available response representations:

//service/mapentryread

Methods

GET

available response representations:

//service/mapentryquery

Methods

GET

available response representations:

//service/mapentryhistory

Methods

GET

available response representations:

//service/mapresolution

Methods

GET

available response representations:

//service/statementmaintenance

Methods

GET

available response representations:

//service/statementread

Methods

GET

available response representations:

//service/statementquery

Methods

GET

available response representations:

//service/statementhistory

Methods

GET

available response representations:

//service/valuesetmaintenance

Methods

GET

available response representations:

//service/valuesetread

Methods

GET

available response representations:

//service/valuesetquery

Methods

GET

available response representations:

//service/valuesethistory

Methods

GET

available response representations:

//service/valuesetdefinitionmaintenance

Methods

//service/valuesetdefinitionread

Methods

//service/valuesetdefinitionquery

Methods

//service/valuesetdefinitionhistory

Methods

//service/valuesetdefinitionresolution

Methods

GET

available response representations:

//service/importer

Methods

GET

available response representations:

POST

Load structured content from a specified source and return a URI that references the "process" that performed or is performing the import

request query parameters
parametervaluedescription

languageandsyntax

string (required)

The language and syntax of an expression in an ontology. Language identifies the expression semantics (e.g. OWL 2.0, RDF, SNOMED Compositional Expression, etc) and syntax identifies how it is represnted (e.g. XML, text/plain, xml/rdf, manchester syntax, etc)

source

string (required)

a Universal Resource Identifier (URI) as defined in IETF RFC 3986. CTS2 implementations are encouraged to consider implementing this data type using the IRI (RFC3987) specification.

metadata

string (required)

a Universal Resource Identifier (URI) as defined in IETF RFC 3986. CTS2 implementations are encouraged to consider implementing this data type using the IRI (RFC3987) specification.

errorresponse

string (required)

An indicator that determines the server's response to encountering warnings or errors.

synchronicity

string (required)

An indicator that determines whether an import, export or other potentially lengthy request occurs in the foreground or returns control to the user.

//service/importer/validator

Methods

GET

Determine whether the source document would import successfully if it were imported

request query parameters
parametervaluedescription

languageandsyntax

string (required)

The language and syntax of an expression in an ontology. Language identifies the expression semantics (e.g. OWL 2.0, RDF, SNOMED Compositional Expression, etc) and syntax identifies how it is represnted (e.g. XML, text/plain, xml/rdf, manchester syntax, etc)

source

string (required)

a Universal Resource Identifier (URI) as defined in IETF RFC 3986. CTS2 implementations are encouraged to consider implementing this data type using the IRI (RFC3987) specification.

metadata

string (required)

a Universal Resource Identifier (URI) as defined in IETF RFC 3986. CTS2 implementations are encouraged to consider implementing this data type using the IRI (RFC3987) specification.

validationlevel

string (required)

An indicator that determines the detail level of a validation request.

available response representations:

//service/importer/process/{processid}

resource-wide template parameters
parametervaluedescription

processid

string

Methods

GET

Return the import status for the supplied process identifier

available response representations:

//service/importer/process/{processid}/log

resource-wide template parameters
parametervaluedescription

processid

string

Methods

GET

request query parameters
parametervaluedescription

logginglevel

string (required)

The LoggingLevel entries are modeled after the corresponding levels in the Apache log4j package. As with the log4j package, each level includes the entries in the lower level. In particular, levels are ordered. For the standard levels, we have DEBUG < INFO < WARN < ERROR < FATAL.

available response representations:

DELETE

//service/exporter

Methods

GET

available response representations:

POST

Export structured content to a specified location with a specified format and return a URI that represents the (results of) the process that did the exporting

request query parameters
parametervaluedescription

languageandsyntax

string (required)

The language and syntax of an expression in an ontology. Language identifies the expression semantics (e.g. OWL 2.0, RDF, SNOMED Compositional Expression, etc) and syntax identifies how it is represnted (e.g. XML, text/plain, xml/rdf, manchester syntax, etc)

resourcedirectory

string (required)

the unique name of a query that, when executed results in a list of resources that, in the context of a given service, satisfy the query.

destination

string (required)

a Universal Resource Identifier (URI) as defined in IETF RFC 3986. CTS2 implementations are encouraged to consider implementing this data type using the IRI (RFC3987) specification.

overwrite

string (required)

errorresponse

string (required)

An indicator that determines the server's response to encountering warnings or errors.

synchronicity

string (required)

An indicator that determines whether an import, export or other potentially lengthy request occurs in the foreground or returns control to the user.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//service/exporter/process/{processid}

resource-wide template parameters
parametervaluedescription

processid

string

Methods

GET

Obtain a current status of the export process.

available response representations:

available response representations:

//service/exporter/process/{processid}/log

resource-wide template parameters
parametervaluedescription

processid

string

Methods

GET

request query parameters
parametervaluedescription

logginglevel

string (required)

The LoggingLevel entries are modeled after the corresponding levels in the Apache log4j package. As with the log4j package, each level includes the entries in the lower level. In particular, levels are ordered. For the standard levels, we have DEBUG < INFO < WARN < ERROR < FATAL.

available response representations:

DELETE

//entity

Methods

POST

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

//entitybyuri

Methods

GET

retrieve all of the EntityDescriptions for the supplied entityId. This function will return the current EntityDescription for every describing code system version that makes non-semantic assertions about the referenced entity.

Return the available EntityDescriptions for the referenced entity. This returns a list of the latest versions of all of the code systems that make assertions about the referenced entity.

request query parameters
parametervaluedescription

uri

string

the URI of the requested resource

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//entity/{entityid}

resource-wide template parameters
parametervaluedescription

entityid

string

the Scoped Entity Name of the EntityDescription Resource. This identifier will be in the following format:

namespace:name

where 'namespace' is the scoping namespace and 'name' is the name of the EntityDescription in that context. 'Namespace' may be ommitted if the Entity is being accessed within the context of a CodeSystem. In this case, the name of the CodeSystem will be set as the 'namespace.'

For example, the following calls are functionally identical:

'/codesystem/CS/version/1/entity/CS:MyEntity'
'/codesystem/CS/version/1/entity/MyEntity'

Methods

GET

retrieve all of the EntityDescriptions for the supplied entityId. This function will return the current EntityDescription for every describing code system version that makes non-semantic assertions about the referenced entity.

Return the available EntityDescriptions for the referenced entity. This returns a list of the latest versions of all of the code systems that make assertions about the referenced entity.

request query parameters
parametervaluedescription

uri

string

the URI of the requested resource

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//entities

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

HEAD

Determine whether the supplied entity name or URI is in the set referenced by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

entityinset

string (required)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystemversion

Methods

POST

Create a new code system version catalog entry. Note that the versionOf parameter does not have to be validated as there is no service level requirement that code system catalogs be complete or even present.

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystemversionbyuri

Methods

GET

request query parameters
parametervaluedescription

uri

string (required)

the URI of the requested resource

tag

string

Default: CURRENT

//codesystemversions

This URL Path represents: a DirectoryURI that references a set of CodeSystemVersionCatalogEntries.

Methods

GET

Retrieve the specified code system version directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

entityreference

string (repeating)

A list (set) of zero or more entity references

activeorall

ActiveOrAll

an indicator that determines whether the given service access request applies only to elements that are currently marked as ACTIVE in the context of the particular query or to both ACTIVE and INACTIVE entries.

allorsome

RestrictionType

a parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Retrieve the specified code system version directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

entityreference

string (repeating)

A list (set) of zero or more entity references

activeorall

ActiveOrAll

an indicator that determines whether the given service access request applies only to elements that are currently marked as ACTIVE in the context of the particular query or to both ACTIVE and INACTIVE entries.

allorsome

RestrictionType

a parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

//valuesetdefinition

Methods

POST

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

//valuesetdefinitionbyuri

Methods

GET

request query parameters
parametervaluedescription

uri

string (required)

the URI of the requested resource

//valuesetdefinitions

This URL Path represents: a DirectoryURI that references a set of ValueSetDefinitions

Methods

GET

Resolve a ValueSetDefinitionDirectoryURI to a directory summarizing the referenced definitions.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

entityreference

string (repeating)

A list (set) of zero or more entity references

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

string

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Resolve a ValueSetDefinitionDirectoryURI to a directory summarizing the referenced definitions.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

entityreference

string (repeating)

A list (set) of zero or more entity references

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

string

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

//resolvedvalueset

Methods

POST

Load the resolved value set into the local resolution list and return a URI that references it.

acceptable request representations:

//resolvedvaluesetbyuri

Methods

GET

request query parameters
parametervaluedescription

uri

string (required)

the URI of the requested resource

//resolvedvaluesets

Methods

GET

Resolve the directory URI to the corresponding directory

request query parameters
parametervaluedescription

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

valueset

string (repeating)

A set of zero or more NameOrURI elements

definition

string (repeating)

codesystem

string (repeating)

A set of zero or more NameOrURI elements

codesystemversion

string (repeating)

A set of zero or more NameOrURI elements

entity

string (repeating)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

POST

Resolve the directory URI to the corresponding directory

request query parameters
parametervaluedescription

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

valueset

string (repeating)

A set of zero or more NameOrURI elements

definition

string (repeating)

codesystem

string (repeating)

A set of zero or more NameOrURI elements

codesystemversion

string (repeating)

A set of zero or more NameOrURI elements

entity

string (repeating)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

acceptable request representations:

available response representations:

available response representations:

available response representations:

//mapversion

Methods

POST

Create a new map version entry.

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

//mapversions

This URL Path represents: a DirectoryURI that references a set of MapVersions

Methods

GET

Resolve a MapVersionDirectoryURI returning a directory of the map versions that it references.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

codesystem

string (repeating)

A set of zero or more NameOrURI elements

valueset

string (repeating)

A set of zero or more NameOrURI elements

maprole

string

An indicator that determines whether the "from", the "to" or both components of a Map or MapVersion are being queried.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

mapstatus

string

An indicator that determines whether the "from", the "to" or both components of a Map or MapVersion are being queried.

restrictiontype

string

a parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite

maprole

string

An indicator that determines whether the "from", the "to" or both components of a Map or MapVersion are being queried.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Resolve a MapVersionDirectoryURI returning a directory of the map versions that it references.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

codesystem

string (repeating)

A set of zero or more NameOrURI elements

valueset

string (repeating)

A set of zero or more NameOrURI elements

maprole

string

An indicator that determines whether the "from", the "to" or both components of a Map or MapVersion are being queried.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

mapstatus

string

An indicator that determines whether the "from", the "to" or both components of a Map or MapVersion are being queried.

restrictiontype

string

a parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite

maprole

string

An indicator that determines whether the "from", the "to" or both components of a Map or MapVersion are being queried.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

//association

Methods

POST

Create a new Association

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//associations

This URL Path represents: a DirectoryURI that references a set of Associations.

Methods

GET

Return a directory that summarizes the resolution of the supplied association directory URI.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

string

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return a directory that summarizes the resolution of the supplied association directory URI.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

//associations/sourceandtargetentities

A Directory of Entity Descriptions that include all entities in the given Association Directory that participate in either the 'source' or 'target' of the association.

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

HEAD

Determine whether the supplied entity name or URI is in the set referenced by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

entityinset

string (required)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//associations/predicates

A Directory of Entity Descriptions that include all entities in the given Association Directory that participate in the 'predicate' of the association.

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

HEAD

Determine whether the supplied entity name or URI is in the set referenced by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

entityinset

string (required)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//associations/sourceentities

A Directory of Entity Descriptions that include all entities in the given Association Directory that participate in the 'source' or 'subject' of the association.

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

HEAD

Determine whether the supplied entity name or URI is in the set referenced by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

entityinset

string (required)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//associations/targetentities

A Directory of Entity Descriptions that include all entities in the given Association Directory that participate in the 'target' or 'object' of the association.

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

HEAD

Determine whether the supplied entity name or URI is in the set referenced by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

entityinset

string (required)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//graph

This URL Path represents: An augmented rendering of a set of Associations where the linkage between subject and target nodes has been normalized for easier traversal.

Methods

GET

Resolve the set of associations referenced by associationDirectory as a graph.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

focus

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

graphfocus

string

Identifies the root of an association graph

focusentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

resolvedirection

string

An indicator that states whether the graph represents a graph at which the focus is in the subject role, the target role or both.

resolvedepth

integer

a non-negative integer ($\nat$). NaturalNumber is used exclusively for representing quantities in this specification.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Resolve the set of associations referenced by associationDirectory as a graph.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

focus

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

graphfocus

string

Identifies the root of an association graph

focusentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

resolvedirection

string

An indicator that states whether the graph represents a graph at which the focus is in the subject role, the target role or both.

resolvedepth

integer

a non-negative integer ($\nat$). NaturalNumber is used exclusively for representing quantities in this specification.

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystems

This URL Path represents: a DirectoryURI that references a set of CodeSystemCatalogEntries.

Methods

GET

Resolve a DirectoryURI that references a set of code system catalog entries and return a summary of the references.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

POST

Resolve a DirectoryURI that references a set of code system catalog entries and return a summary of the references.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystem

Methods

POST

Create a new entry in the code system catalog

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystembyuri

Methods

GET

request query parameters
parametervaluedescription

uri

string (required)

the URI of the requested resource

//codesystem/{codesystemid}

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

Methods

HEAD

Determine whether a catalog entry exists that has an about or alternateId that matches the supplied URI or that has a codeSystemName that matches the supplied name that is (was) applicable in the supplied context.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

available response representations:

available response representations:

available response representations:

available response representations:

PUT

Update the contents of an existing catalog entry.

acceptable request representations:

GET

Retrieve the specified code system version details for the specified code system from the service.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

tag

string (required)

Default: CURRENT

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Determine if the specified version of the code system exists for the specified code system on the service.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

tag

string (required)

Default: CURRENT

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return the catalog entry that has an about or alternateId that matches the supplied URI or that has a codeSystemName that matches the supplied name that is (was) applicable in the supplied context.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

DELETE

request query parameters
parametervaluedescription

changeseturi

string (required)

//codesystem/{codesystemid}/changehistory

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

Methods

GET

Return a list of records that reflects the change in the catalog entry over the specified time span. Records will be sorted from earliest to latest if (a) fromDate is omitted or (b) toDate is omitted, or (c) fromDate is earlier than toDate. In all other cases, records will be sorted from latest to earliest.

request query parameters
parametervaluedescription

fromDate

dateAndTime

represents an ``Instant" as defined in the OWL Time Specification. CTS2 implementations must be able to support temporal units of second, minute, hour, day, month, and year, and be able to represent and compare instances represented in any of these units. DateAndTime can only provide a partial ordering and, as a consequence, is never used as an index, unique identifier or to sequence data or events.

toDate

dateAndTime

represents an ``Instant" as defined in the OWL Time Specification. CTS2 implementations must be able to support temporal units of second, minute, hour, day, month, and year, and be able to represent and compare instances represented in any of these units. DateAndTime can only provide a partial ordering and, as a consequence, is never used as an index, unique identifier or to sequence data or events.

available response representations:

available response representations:

//codesystem/{codesystemid}/earliestchange

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

Methods

GET

Return an catalog entry that reflects the state of the entry when it first appeared in the service.

available response representations:

available response representations:

//codesystem/{codesystemid}/latestchange

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

Methods

GET

available response representations:

//codesystem/{codesystemid}/versions

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

Methods

GET

Retrieve the specified code system version directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

entityreference

string (repeating)

A list (set) of zero or more entity references

activeorall

ActiveOrAll

an indicator that determines whether the given service access request applies only to elements that are currently marked as ACTIVE in the context of the particular query or to both ACTIVE and INACTIVE entries.

allorsome

RestrictionType

a parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Retrieve the specified code system version directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

entityreference

string (repeating)

A list (set) of zero or more entity references

activeorall

ActiveOrAll

an indicator that determines whether the given service access request applies only to elements that are currently marked as ACTIVE in the context of the particular query or to both ACTIVE and INACTIVE entries.

allorsome

RestrictionType

a parameter used in queries where multiple elements are provided. It determines whether a candidate element must satisfy all restrictions or just one or more restriction in order to be considered as satisfying the restriction composite

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

//codesystem/{codesystemid}/version/{codesystemversionid}

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

codesystemversionid

string

the Name of the Code System Version

Methods

GET

Retrieve the specified code system version details from the service.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

PUT

Update an existing code system version catalog entry.

request query parameters
parametervaluedescription

changeseturi

string (required)

the unique identifier of a set of change instructions that can potentially transform the contents of CTS2 service instance from one state to another.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return TRUE if the a CodeSystemVersion is known to the service with a matching name or URI.

available response representations:

available response representations:

available response representations:

available response representations:

DELETE

request query parameters
parametervaluedescription

changeseturi

string (required)

//codesystem/{codesystemid}/version/{codesystemversionid}/entities

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

codesystemversionid

string

the Name of the Code System Version

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

HEAD

Determine whether the supplied entity name or URI is in the set referenced by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

entityinset

string (required)

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystem/{codesystemid}/version/{codesystemversionid}/transformer/associationlist

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

codesystemversionid

string

the Name of the Code System Version

Methods

POST

Transform entityExpression into a lot of one or more Associations in the context of the supplied codeSystemVersion.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystem/{codesystemid}/version/{codesystemversionid}/classifications

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

codesystemversionid

string

the Name of the Code System Version

Methods

POST

The set of new assertions that can be inferred from the combination of the assertions in associationList and the set that are assertedBy codeSystemVersion.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

//codesystem/{codesystemid}/version/{codesystemversionid}/associations

This URL Path represents: a DirectoryURI that references a set of Associations.

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

codesystemversionid

string

the Name of the Code System Version

Methods

GET

Return a directory that summarizes the resolution of the supplied association directory URI.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

string

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

POST

Return a directory that summarizes the resolution of the supplied association directory URI.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

list

boolean

Default: false

whether to return the results in 'List' or 'Directory' format. 'true' indicates that results will be returned as a 'List.' 'false' indicates that results will be returned as a 'Directory'

acceptable request representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

HEAD

Return the number of elements currently represented by the supplied directory URI.

response header parameters
parametervaluedescription

count

NaturalNumber

//codesystem/{codesystemid}/version/{codesystemversionid}/associations/sourceandtargetentities

A Directory of Entity Descriptions that include all entities in the given Association Directory that participate in either the 'source' or 'target' of the association.

This URL Path represents: a DirectoryURI that references a set of EntityDescriptionDirectory

resource-wide template parameters
parametervaluedescription

codesystemid

string

the Name of the Code System

codesystemversionid

string

the Name of the Code System Version

Methods

GET

Transform the list of entity descriptions referenced in entityDirectory into the semantics and syntax specified in toLanguageAndSyntax.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

predicate

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

sourceortargetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetentity

string

A reference to a class, property or individual that is described in some Code System. EntityNameOrURI may either reference an entity that is known locally to the service or an entity that is described elsewhere. If the entity is known to the service, it is possible to use the entityName variant, but note that neither scopingNamespace nor the entityName are guaranteed to be the same in different CTS2 implementations. The entityName variant is intended for use in human/browser interactions and should not be hard-coded into data tables or applications.

targetexpression

string

targetliteral

string

a non-empty sequence of characters. As terminological resources are often multilingual, it is expected that most CTS2 Platform Specific Models (PSMs) will require that the String implementation support international character sets.

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

format

string

the local identifier or URI of the return format for query results. This parameter defaults to the defaultFormat in the BaseService interface if not supplied.

sort

string

the type and name of the attribute, property or special element to be sorted

sortdirection

string

the sort order

page

nonNegativeInteger

the 0-based page number used for paging result sets

maxtoreturn

string

the maximum number of entries that may be present in a return Directory. Note that a service may choose to return less than maxToReturn entries - this is simply an upper limit. If maxToReturn is not supplied, the service may use whatever return block size it determines to be most appropriate.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include "starts with", "regular expression match", "exists", "inRange", etc. NOTE: The CTS2 specification needs to establish a core set of match algorithms that all compliant implementations must support.

matchvalue

string

the value to be used in comparison. The structure and format of matchValue depends on the specific matchAlgorithm. As an example, a "startsWith" algorithm would be plain text, a "regularExpression" algorithm would have a regular expression while an "exists" algorithm would have nothing in the matchValue attribute.

codesystem

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

tag

string

a reference to a tag that can be assigned to versionable resources within the context of a service implementation

codesystemversion

string

Carries either a local identifier (name) or a URI (uri) that references a resource in the service. NameOrURI is only used as an input parameter and its type is always defined by the usage context. Note that service calls that use the name option may not be portable across implementations, as there is no guarantee that any two CTS2 service implementations will use the same local identifiers for the same resources.

entity

string (repeating)

A set of zero or more EntityNmeOrURI elements

languageandsyntax

string (required)

asexpressions

string (required)

Fixed: true

available response representations:

available response representations:

available response representations:

available response representations:

available response representations:

GET

Return an EntityDirectory that contains the set of EntityReferences identified by directory.

request query parameters
parametervaluedescription

active

string

determines whether the query only applies to only active or all entries.

changesetcontext

string

the URI of an open change set whose contents should be included in the results of the access request. changeSetContext is only applicable in services that support the Authoring profile. If omitted, no change set context is supplied in the service call.

referencelanguage

string

the spoken or written language that should be used for the results of the inquiry, where appropriate. Should default to the default reference language of the service if omitted.

referencetime

dateTime

the contextual date and time of the query. referenceTime is may only be present in services that support the Temporal profile. If omitted, referenceTime defaults to the current system date and time.

timelimit

positiveInteger

the maximum amount of time that may be taken to process a query before a time out exception occurs. If not present, the service determines the maximum query time out.

filtercomponent

string

the name or URI of the property or model element to be filtered. Properties are referenced by their predicate and model elements all have URI's that are established by this specification.

matchalgorithm

string

the algorithm to be used for testing the referenced component. Examples might include