v2.1.0 draft

eReferral Implementation Guide
2.1.0 - Belgium flag

eReferral Implementation Guide, published by Riziv-Inami Platform. This guide is not an authorized publication; it is the continuous build for version 2.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/referral-uhmep/ and changes regularly. See the Directory of published versions

Cancel Execution

This page describes how to cancel an execution task.

Item Value
Business operation Cancel execution
Endpoint PATCH /Task/{executionID}
Target resource BePerformerTask
Successful response 200 OK

Payload

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "operation",
      "part": [
        { "name": "type", "valueCode": "replace" },
        { "name": "path", "valueString": "Task.status" },
        { "name": "value", "valueString": "cancelled" }
      ]
    }
  ]
}

Allowed Roles

Caregiver, Organization.

Possible Error Codes

The errors for this operation are listed in the eReferral API Error Codes workbook. Filter the Business Operations or API endpoint(s) sheet for the relevant operation or endpoint. See Error Codes for workbook guidance.

Sequence

ClientClientFHIR APIFHIR APIPATCH /Task/{executionID}Replace Task.status by cancelled200 OK
Cancel Execution sequence