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

Complete a Medical Document

This page describes how to complete the global referral task of a medical document.

Item Value
Business operation Complete a medical document
Endpoint PATCH /Task/{prescriptionId}
Target resource BeReferralTask
Successful response 200 OK

The operation is allowed only when no related BePerformerTask remains in-progress.

Payload

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

The server derives Task.executionPeriod.start from the oldest performer execution start and Task.executionPeriod.end from the most recent performer execution end.

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/{prescriptionId}Verify related performer tasks are not in-progressDerive global execution periodMark BeReferralTask as completed200 OK
Complete Medical Document sequence