fhir-operation-term-cache.4.11.0.source-code.operation-valueset-clear-cache.json Maven / Gradle / Ivy
{
"resourceType": "OperationDefinition",
"id": "ValueSet-clear-cache",
"text": {
"status": "generated",
"div": "clear-cache
OPERATION: ValueSet Clear Cache
The ValueSet-clear-cache operation clears the server's cached copy of the codeset expansion of a ValueSet.
URL: [base]/ValueSet/$clear-cache
Parameters
Use Name Cardinality Type Binding Documentation IN url 0..1 string A canonical reference to a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server.
IN valueSetVersion 0..1 string The identifier that is used to identify a specific version of the value set to be used when generating the expansion. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.
OUT return 1..1 OperationOutcome If the operation outcome is not present or is present but lists no errors, then the operation completed successfully.
"
},
"url": "http://ibm.com/fhir/OperationDefinition/ValueSet-clear-cache",
"name": "clear-cache",
"status": "draft",
"kind": "operation",
"publisher": "IBM FHIR Server",
"date": "2021-04-15",
"description": "The clear-cache operation removes valueset data that has been cached in memory, allowing the terminology subsystem to reload the data fresh on next use. Cache data is not shared between FHIR server instances, so this operation must be called separate for each instance as needed by the application.",
"code": "clear-cache",
"resource": ["ValueSet"],
"system": false,
"type": true,
"instance": true,
"parameter": [{
"name": "url",
"use": "in",
"min": 0,
"max": "1",
"documentation" : "A canonical reference to a value set. The server must know the value set (e.g. it is defined explicitly in the server's value sets, or it is defined implicitly by some code system known to the server",
"type": "uri"
},{
"name": "valueSetVersion",
"use": "in",
"min": 0,
"max": "1",
"documentation": "The identifier that is used to identify a specific version of the value set to be used when generating the expansion. This is an arbitrary value managed by the value set author and is not expected to be globally unique. For example, it might be a timestamp (e.g. yyyymmdd) if a managed version is not available.",
"type": "string"
},{
"name": "return",
"use": "out",
"min": 0,
"max": "1",
"documentation": "If the operation outcome is not present or is present but lists no errors, then the cached data has been cleared.",
"type": "OperationOutcome"
}]
}