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

Create a Medical Document

This page describes how to create a medical document, either as a prescription (intent = order) or as a proposal (intent = proposal).

Item Value
Business operation Create a medical document
Endpoint POST /ServiceRequest
Request resource ServiceRequest
Successful response 201 Created with the new logical id in Location
Server side effect eReferral creates the related BeReferralTask

Independent Professional

Use this variant when the connected healthcare professional is the requester.

{
  "resourceType": "ServiceRequest",
  "meta": {
    "profile": [
      "https://www.riziv-inami.be/standards/fhir/ereferral/StructureDefinition/ereferral-servicerequest-nursing"
    ]
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type",
          "code": "bloodletting"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/urn:be:fgov:pseudo:v2:{SEC1}:{transit-info}"
  },
  "requester": {
    "reference": "PractitionerRole/{SSIN}-{DISCIPLINE}"
  }
}

Internal Professional Represented By An Organization

Use this variant when an organization calls the API with an M2M token and creates the document on behalf of one of its internal professionals.

{
  "resourceType": "ServiceRequest",
  "meta": {
    "profile": [
      "https://www.riziv-inami.be/standards/fhir/ereferral/StructureDefinition/ereferral-servicerequest-nursing"
    ]
  },
  "status": "active",
  "intent": "order",
  "category": [
    {
      "coding": [
        {
          "system": "https://www.ehealth.fgov.be/standards/fhir/terminology/CodeSystem/be-cs-prescription-type",
          "code": "bloodletting"
        }
      ]
    }
  ],
  "subject": {
    "reference": "Patient/urn:be:fgov:pseudo:v2:{SEC1}:{transitInfo}"
  },
  "requester": {
    "reference": "PractitionerRole/{SSIN}-{DISCIPLINE}-NIHII-{nihii11Organization}"
  }
}

Proposal Variant

For an Annex 81 proposal, use the Annex 81 profile and intent = proposal.

{
  "resourceType": "ServiceRequest",
  "meta": {
    "profile": [
      "https://www.riziv-inami.be/standards/fhir/ereferral/StructureDefinition/ereferral-annex-81"
    ]
  },
  "status": "active",
  "intent": "proposal",
  "subject": {
    "reference": "Patient/urn:be:fgov:pseudo:v2:{SEC1}:{transitInfo}"
  },
  "requester": {
    "reference": "PractitionerRole/{SSIN}-{DISCIPLINE}"
  }
}

Allowed Roles

  • Prescription (intent = order): Prescriber, Caregiver (radiology prescriptions only), Organization.
  • Proposal (intent = proposal): 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.

On success, the new logical id is returned in the Location header and in the JSON payload; a six-character short code is also generated and returned at consultation.

Sequence

ClientClientFHIR APIFHIR APIPOST /ServiceRequestRewrite federal profile when neededValidate profile, requester, patient and access rightsPersist ServiceRequestCreate related BeReferralTask201 Created + Location
Create Medical Document sequence