FHIR © HL7.org  |  Server Home  |  XIG Home  |  XIG Stats  |  Server Source  |  FHIR  

FHIR IG Statistics: OperationDefinition/clear-context

Packageca.infoway.io.halo
Resource TypeOperationDefinition
Idclear-context
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=ca.infoway.io.halo@1.0.0-dft-preballot&canonical=http://fhir.infoway-inforoute.ca/io/HALO/OperationDefinition/clear-context
URLhttp://fhir.infoway-inforoute.ca/io/HALO/OperationDefinition/clear-context
Version1.0.0
Statusactive
NameClearContext
TitleClear Context
DescriptionClears the context, specified by the provided launchID, along with any resources that have been created for the current session within the SoFA.
Typefalse
Kindoperation

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

Note: links and images are rebased to the (stated) source

The $clear-context operation allows launching applications, such as Point of Care (PoC) systems, to remove clinical contexts previously established during a SMART on FHIR Accelerator (SoFA) launch. This operation ensures data hygiene and supports compliance with jurisdictional data retention policies by deleting context-related data that is no longer needed.

The operation requires the launchID generated by a prior $set-context invocation to identify and remove associated FHIR resources stored in the SoFA for the specified session. These resources may include those created by the launching application through the $set-context operation or by the SMART application after the launch.

The outcome of the operation is returned in an OperationOutcome resource, which provides details on the success or failure of the context-clearing process.


Source

{
  "resourceType": "OperationDefinition",
  "id": "clear-context",
  "text": {
    "status": "additional",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://fhir.infoway-inforoute.ca/io/HALO/OperationDefinition/clear-context",
  "version": "1.0.0",
  "name": "ClearContext",
  "title": "Clear Context",
  "status": "active",
  "kind": "operation",
  "experimental": false,
  "description": "Clears the context, specified by the provided launchID, along with any resources that have been created for the current session within the SoFA.",
  "code": "clear-context",
  "system": true,
  "type": false,
  "instance": false,
  "parameter": [
    {
      "name": "launchID",
      "use": "in",
      "min": 1,
      "max": "1",
      "documentation": "The launchID is a required parameter. It is returned by the $set-context operation when the context was first established.",
      "type": "string"
    },
    {
      "name": "outcome",
      "use": "out",
      "min": 1,
      "max": "*",
      "documentation": "An OperationOutcome resource detailing the outcome (e.g., success, failure) of the operation.",
      "type": "OperationOutcome"
    }
  ]
}