fhir-operation-term-cache.4.11.0.source-code.operation-codesystem-clear-cache.json Maven / Gradle / Ivy

Go to download

{
    "resourceType": "OperationDefinition",
    "id": "ValueSet-clear-cache",
    "text": {
        "status": "generated",
        "div": "clear-cache
OPERATION: CodeSystem Clear Cache
The clear-cache operation removes codesystem expansion 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.
URL: [base][base]/CodeSystem/$clear-cache
Parameters
Use Name Cardinality Type Binding Documentation
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/CodeSystem-clear-cache",
    "name": "clear-cache",
    "status": "draft",
    "kind": "operation",
    "publisher": "IBM FHIR Server",
    "date": "2021-04-15",
    "description": "The clear-cache operation removes codesystem expansion 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": ["CodeSystem"],
    "system": false,
    "type": true,
    "instance": true,
    "parameter": [    {
      "name": "url",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "CodeSystem URL. The server must know the code system (e.g. it is defined explicitly in the server's code systems, or it is known implicitly by the server",
      "type": "uri"
    },
    {
      "name": "codeSystem",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The codeSystem is provided directly as part of the request.",
      "type": "CodeSystem"
    },
    {
      "name": "version",
      "use": "in",
      "min": 0,
      "max": "1",
      "documentation": "The version of the code system, if one was provided in the source data",
      "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"
    }]
}

Use	Name	Cardinality	Type	Binding	Documentation
OUT	return	1..1	OperationOutcome		If the operation outcome is not present or is present but lists no errors, then the operation completed successfully.