v2.0.0 draft

eReferral Implementation Guide
2.0.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.0.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

Record Execution End

This page describes how to record the end of execution.

Item Value
Business operation Record execution end
Endpoints POST /Task or PATCH /Task/{executionID}
Target resource BePerformerTask
Successful response 201 Created or 200 OK

Finish Without Existing Assignment

{
  "resourceType": "Task",
  "meta": {
    "profile": [
      "https://www.ehealth.fgov.be/standards/fhir/referral/StructureDefinition/be-performer-task"
    ]
  },
  "status": "completed",
  "intent": "order",
  "focus": {
    "reference": "ServiceRequest/{serviceRequestId}"
  },
  "partOf": [
    {
      "reference": "Task/{referralTaskId}"
    }
  ],
  "owner": {
    "reference": "PractitionerRole/{SSIN}-{DISCIPLINE}"
  },
  "executionPeriod": {
    "start": "2026-07-03T09:00:00+02:00",
    "end": "2026-07-03T10:30:00+02:00"
  }
}

For an internal professional, add basedOn pointing to the organization task and use the organization-scoped PractitionerRole in owner.

Finish Existing Execution

{
  "resourceType": "Parameters",
  "parameter": [
    {
      "name": "operation",
      "part": [
        { "name": "type", "valueCode": "add" },
        { "name": "path", "valueString": "Task.executionPeriod" },
        { "name": "name", "valueString": "end" },
        { "name": "value", "valueDateTime": "2026-07-03T10:30:00+02:00" }
      ]
    }
  ]
}

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 APIalt[No assignment exists]POST /Task with completed statusValidate start and end201 Created[Execution already started]PATCH /Task/{executionID}Add executionPeriod.end200 OK
Record Execution End sequence