DRAFT
| Table of Contents |
|---|
Overview
Identifiers in the URL are to be managed externally. As such, internal consistency will hold insofar as resources are consistently linked in external sources.
...
POST may still used for creation; the identifier for the POST is extracted from the input XML, and used to build the URL; this will ensure consistency with the URL used with PUT.
Concept Determination Methods
/config/v1/conceptdeterminationmethods
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml | conceptDeterminationMethods | 200 (OK) | Provides the list of supported ConceptDeterminationMethods. | |
POST | application/xml | conceptDeterminationMethod |
| Adds a new ConceptDeterminationMethod. Returns an error (status code 409) if the ConceptDeterminationMethod already exists. | |
PUT | application/xml | conceptDeterminationMethods | 204 (No Content) | Replaces the entire existing ConceptDeterminationMethod collection with the collection provided in the request. |
/config/v1/conceptdeterminationmethods/<cdmId>
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET |
| Configuration Front-End API (REST) Version 1.0cdmId | conceptDeterminationMethod | 200 (OK) | Provides the ConceptDeterminationMethod associated with the given CDMId, or an error if it is not found. |
PUT |
|
| Adds or Updates the ConceptDeterminationMethod associated with the provided CDMId. | ||
DELETE | Configuration Front-End API (REST) Version 1.0cdmId |
| Deletes the ConceptDeterminationMethod associated with the provided CDMId. Returns an error if it is not found. |
...
NQF^C45^1.0^C2511^1.0(this example contains no Code System)
Execution Engines
/config/v1/executionengines
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml | 200 (OK) | Provides the list of ExecutionEngine definitions associated with the service. | ||
POST | application/xml | executionEngine |
|
| Adds a new ExecutionEngine definition. Returns an error (status code 409) if the ExecutionEngine definition already exists. |
PUT | application/xml | executionEngines | 204 (No Content) | Replaces the entire existing ExecutionEngine collection with the collection provided in the request. |
/config/v1/executionengines/<executionEngineId>
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET |
| Configuration Front-End API (REST) Version 1.0executionEngineId |
|
| Provides the ExecutionEngine metadata associated with the provided ExecutionEngineId. |
PUT | application/xml |
|
|
| Adds or Updates the ExecutionEngine definition. |
DELETE |
| 204 (No Content) | Deletes an ExecutionEngine. |
...
org.opencds.service.drools.v55.DroolsAdapter
Knowledge Modules
/config/v1/knowledgemodules
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
| application/xml |
| Provides the list of configured KnowledgeModules. | ||
POST | application/xml | knowledgeModule |
|
| Adds a new KnowledgeModule. Returns an error (status code 409) if the KnowledgeModule already exists. |
PUT | application/xml | knowledgeModules | 204 (No Content) | Replaces the entire existing KnowledgeModule collection with the collection provided in the request. |
/config/v1/knowledgemodules/<kmId>
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml | Configuration Front-End API (REST) Version 1.0kmId |
| Provides the KnowledgeModule metadata, or returns an error if it does not exist. | |
PUT | application/xml |
|
| Adds or Updates the KnowledgeModule. | |
DELETE | Configuration Front-End API (REST) Version 1.0kmId |
|
| Delete the KnowledgeModule associated with the given KMId, along with its associated KnowledgePackage and SupportingData. Returns an error if not found. |
...
edu.utah^AHRQ_PSI_15^4.3.1- edu.utah^HEDIS_AMR^2014.0.0
Knowledge Package
/config/v1/knowledgemodules/<kmId>/package
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/octet-stream | Configuration Front-End API (REST) Version 1.0kmId | package content
|
| Returns the KnowledgePackage associated with the KnowledgeModule (KMId). Returns an error if the KnowledgePackage or the KnowledgeModule is not found. |
PUT | application/octet-stream |
|
|
| Adds or Updates the KnowledgePackage associated with the KnoweldgeModule (KMId). Returns an error if the KnowledgeModule is not found. |
DELETE | Configuration Front-End API (REST) Version 1.0kmId |
|
| Deletes the KnowledgePackage associated with the KnowledgeModule (KMId). Returns an error if the KnowledgePackage or KnowledgeModule is not found. |
Supporting Data
/config/v1/knowledgemodules/<kmId>/supportingdata
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml | Configuration Front-End API (REST) Version 1.0kmId |
| Returns the list of SupportingData (metadata) associated with the given KnowledgeModule (KMId), or an error if the KnowledgeModule is not found. | |
POST | application/xml |
| Creates the SupportingData metadata associated with the KnowledgeModule (KMId). Returns an error (status code 409) if the metadata already exists. Returns an error (status code 404) if the KnowledgeModule is not found. |
...
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml |
|
|
| Returns the SupportingData metadata associated with the given KnowledgeModule (KMId) and SupportingData (SupportingDataId). Returns an error (status code 404) if either the SupportingData or KnowledgeModule are not found. |
PUT | application/xml |
|
|
| Updates the SupportingData metadata associated with the given KnowledgeModule (KMId) and SupportingData (SupportingDataId). Returns an error (status code 404) if either the SupportingData or KnowledgeModule are not found. |
DELETE |
|
|
| Deletes the SupportingData metadata (and its package) associated with the givenKnowledgeModule (KMId) and SupportingData (SupportingDataId). Returns an error (status code 404) if either the SupportingData or KnowledgeModule are not found. |
| Anchor | ||||
|---|---|---|---|---|
|
supportingDataId is a unique identifier for each SupportingData, and can be any chosen identifier./config/v1/knowledgemodules/<kmId>/supportingdata/<supportingDataId>/package
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
| application/octet-stream |
|
|
| Returns the package associated with the given KnowledgeModule (KMId) and SupportingData (SupportingDataId). Returns an error if either the SupportingData or KnowledgeModule are not found. |
PUT | application/octet-stream |
|
|
| Adds or Creates the package associated with the given KnowledgeModule (KMId) and SupportingData (SupportingDataId).
Returns an error (status code 404) if either the SupportingData or KnowledgeModule are not found. |
DELETE |
|
|
| Deletes the SupportingData package associated with the given KnowledgeModule (KMId) and SupportingData (SupportingDataId). Returns an error (status code 404) if either the SupportingData or KnowledgeModule are not found. |
Semantic Signifiers
/config/v1/semanticsignifiers
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml |
| Returns the list of SemanticSignifiers associated with the service. | ||
POST | application/xml | semanticSignifier |
|
| Adds a new SemanticSignifier. Returns an error (status code 409) if the SemanticSignifier already exists. |
PUT | application/xml | semanticSignifiers | 204 (No Content) | Replaces the entire existing SemanticSignifier collection with the collection provided in the request. |
...
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml | Configuration Front-End API (REST) Version 1.0ssId |
| Returns the SemanticSignifier associated with the given SSId, or returns an error if it is not found. | |
PUT | application/xml |
| Adds or Updates the SemanticSignifier associated with the given SSId. | ||
DELETE | Configuration Front-End API (REST) Version 1.0ssId |
|
| Deletes the SemanticSignifier associated with the given SSId. Returns an error (status code 404) if it is not found. |
...
The following is the ssId for the SemanticSignifier supported by OpenCDS v1.3:
org.opencds.vmr^VMR^1.0
Plugin Packages
/config/v1/pluginpackages
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml |
| Returns the list of PluginPackages associated with the service. | ||
POST | application/xml | pluginPackage |
|
| Adds a new PluginPackage. Returns an error (status code 409) if the PluginPackage already exists. |
PUT | application/xml | pluginPackages | 204 (No Content) | Replaces the entire existing PluginPackage collection with the collection provided in the request. |
...
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/xml | Configuration Front-End API (REST) Version 1.0ppId |
| Returns the PluginPackage associated with the given PPId, or returns an error if it is not found. | |
PUT | application/xml |
| Adds or Updates the PluginPackage associated with the given PPId. | ||
DELETE | Configuration Front-End API (REST) Version 1.0ppId |
|
| Deletes the PluginPackage associated with the given PPId. Returns an error (status code 404) if it is not found. |
...
| Method | Mime Type | Requires | Returns | Status Code(s) | Description |
|---|---|---|---|---|---|
GET | application/octet-stream | Configuration Front-End API (REST) Version 1.0ppId | package content (jar) |
| Returns the jar associated with the PluginPackage (PPId), or returns an error if it is not found. |
PUT | application/octet-stream |
|
| Adds or Updates the jar associated with the PluginPackage (PPId). Returns an error if the PluginPackage is not found. | |
DELETE | Configuration Front-End API (REST) Version 1.0ppId |
|
| Deletes the jar associated with the PluginPackage (PPId). Returns an error (status code 404) if it is not found. |
...