FHIR IG analytics| Package | ca.infoway.io.halo |
| Resource Type | OperationDefinition |
| Id | OperationDefinition-offboard.json |
| FHIR Version | R4 |
| Source | https://simplifier.net/resolve?scope=ca.infoway.io.halo@2.0.0-dft-preballot&canonical=http://fhir.infoway-inforoute.ca/io/HALO/OperationDefinition/offboard |
| URL | http://fhir.infoway-inforoute.ca/io/HALO/OperationDefinition/offboard |
| Version | 1.0.0 |
| Status | draft |
| Name | Offboard |
| Title | Offboard |
| Realm | ca |
| Authority | national |
| Description | Allows a Point of Care Solution to notify a Backend Service that it no longer wishes for that Backend Service to continue interacting with it, by providing the context needed to identify and withdraw the previously established backend service relationship. |
| Type | false |
| Kind | operation |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
The $offboard operation is a HALO-defined operation that allows a Point of Care (PoC) system to notify a Backend Service that it no longer wishes for that Backend Service to continue interacting with it. Invoking $offboard signals that the Backend Service SHALL cease requesting access tokens from the PoC's authorization server and SHALL cease attempting to access the PoC's FHIR APIs.
$offboard is the counterpart to $initiate-onboarding. The PoC passes its FHIR server base URL as the iss parameter along with the offboardingVerifier it retained from the original $initiate-onboarding invocation, allowing the Backend Service to confirm that the request originates from the same PoC (or one of its trusted subsystems) that completed onboarding before it withdraws the relationship.
FHIR
FHIRsmith{
"resourceType": "OperationDefinition",
"id": "offboard",
"url": "http://fhir.infoway-inforoute.ca/io/HALO/OperationDefinition/offboard",
"text": {
"status": "additional",
"div": "<!-- snip (see above) -->"
},
"jurisdiction": [
{
"coding": [
{
"code": "CA",
"system": "urn:iso:std:iso:3166",
"display": "Canada"
}
]
}
],
"parameter": [
{
"name": "iss",
"use": "in",
"min": 1,
"max": "1",
"type": "uri",
"documentation": "The base URL of the Point of Care FHIR server. The Backend Service uses this value to identify the corresponding backend service relationship, if any, that was established as a result of a prior `$initiate-onboarding` invocation."
},
{
"name": "offboardingVerifier",
"use": "in",
"min": 1,
"max": "1",
"type": "string",
"documentation": "The secret verifier from which the `offboardingChallenge` supplied during `$initiate-onboarding` was derived. The Backend Service recomputes the challenge from this verifier using a Base64url-encoded SHA-256 hash and compares it against the stored `offboardingChallenge` to confirm continuity with the system that completed onboarding."
},
{
"name": "outcome",
"use": "out",
"min": 1,
"max": "1",
"type": "OperationOutcome",
"documentation": "An OperationOutcome resource detailing the outcome of the operation."
}
],
"version": "1.0.0",
"name": "Offboard",
"title": "Offboard",
"status": "draft",
"kind": "operation",
"experimental": false,
"publisher": "Canada Health Infoway",
"description": "Allows a Point of Care Solution to notify a Backend Service that it no longer wishes for that Backend Service to continue interacting with it, by providing the context needed to identify and withdraw the previously established backend service relationship.",
"code": "offboard",
"system": true,
"type": false,
"instance": false
}