v3.0.0 draft

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

Cancel a Medical Document

This page describes how to cancel a prescription or proposal.

Item Value
Business operation Cancel a medical document
Endpoint PATCH /ServiceRequest/{prescriptionId}
Target resource ServiceRequest
Successful response 200 OK

For radiology prescriptions, a Patient may cancel while the prescription is in business state PENDING or READY. This is a radiology-specific rule and should not be inferred for other prescription types.

Payload

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

Allowed Roles

  • Prescription: Prescriber, Patient, Organization.
  • Proposal (Annex 81): Caregiver, Patient, 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 /ServiceRequest/{prescriptionId}Check ownership and visibility rulesReplace ServiceRequest.status by revoked200 OK
Cancel Medical Document sequence