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

Technical

This page groups the technical, non-clinical information an integrator needs to connect to the eReferral API: entry points, required headers, reference documents, support contacts, and certificates. It consolidates information previously scattered across the eReferral cookbook.

Entry Points

Purpose	Endpoint / location	Notes
Capability statement	GET /metadata	Public endpoint. Returns the FHIR CapabilityStatement for supported resources and operations.
API catalogue	eHealth API Portal	The operational REST/Swagger description is published through the eHealth API Portal.
Acceptance portal	https://portal-acpt.api.ehealth.fgov.be	Use the portal to find the acceptance eReferral API endpoint.
Production portal	https://portal.api.ehealth.fgov.be	Use the portal to find the production eReferral API endpoint.

Required Headers

Every API request must include tracing headers, in addition to the exchanged token in Authorization (see API Integration – Authentication and Headers):

Header	Required content
User-Agent	Software product and technical stack identifier, for example MyCompany/myProduct/62.310.4 eHealth/Technical/3.19.0.
From	Operational contact email address, for example info@mycompany.be.

eHealth and FHIR References

Referenced eHealth platform documents (these versions or any later ones may be used):

Title	Version	Date	Author
eHealth Services – Web Access	2.0	2018-07-12	eHealth platform
Identity & Authorization Management (I.AM) Mobile integration	1.7	2023-03-31	eHealth platform
Pseudonymization REST	1.0	2023-04-04	eHealth platform
Identity & Authorization Management (IAM) eXchange	1.1	2024-06-28	eHealth platform

The FHIR resources used by eReferral are defined in the HL7 Belgium implementation guide artifacts. This IG rewrites the federal Be* referral profiles to local eReferral* profiles (see Profile Rewriting); the federal source profiles are the BeReferralServiceRequest*, BeReferralTask, BePerformerTask, BeOrganizationTask, BePractitionerRole, and BePractitioner structure definitions.

Support

For issues related to the eReferral API:

Environment	Contact
Acceptance (eReferral)	integration-support@ehealth.fgov.be
Production (eReferral)	support@ehealth.fgov.be
Acceptance (eHealth certificates)	acceptance-certificates@ehealth.fgov.be
Production (eHealth certificates)	support@ehealth.fgov.be

Certificates

To access the secured eHealth platform environment, each integrator must obtain an eHealth platform certificate that identifies the initiator of the request. See the eHealth certificate pages:

• eHealth certificates (NL)
• eHealth certificates (FR)

Encryption

Encryption of pseudonymized identifiers and free text is performed through the eHealth Pseudonymization service (see the referenced eHealth “Pseudonymization REST” document above).

Implementation Guide Metadata

This publication includes IP covered under the following statements.

• ISO maintains the copyright on the country codes, and controls its use carefully. For further details see the ISO 3166 web page: https://www.iso.org/iso-3166-country-codes.html
  Show Usage
  • ISO 3166-1 Codes for the representation of names of countries and their subdivisions — Part 1: Country code: BeCSPSSIndication, BeCSPSSQSIDiagnosticImagingProcedure... Show 16 more, BeCSRadiologySupportingInfoRole, BeCSeReferralDesignationUse, BeCSeReferralSnomedDesignation, BeExtCodeableConcept, BeRadiologySupportingInfoRole, BeVSDiagnosticImagingCondition, BeVSDiagnosticImagingProcedure, BeVSPSSQSIIndication, BeVSRadiologySupportingInfoRole, BeVSeReferralSnomedDesignation, EReferral, EReferralAnnex81, EReferralImagingAttentionConditionsResponse, EReferralServiceRequestDiagnosticImaging, EReferralServiceRequestNursing and EReferralVSImagingPatientConditionIndication
• The UCUM codes, UCUM table (regardless of format), and UCUM Specification are copyright 1999-2009, Regenstrief Institute, Inc. and the Unified Codes for Units of Measures (UCUM) Organization. All rights reserved. https://ucum.org/trac/wiki/TermsOfUse
  Show Usage
  • Unified Code for Units of Measure (UCUM): ServiceRequest/example-drp-nursing-bloodletting
• This material contains content that is copyright of SNOMED International. Implementers of these specifications must have the appropriate SNOMED CT Affiliate license - for more information contact https://www.snomed.org/get-snomed or info@snomed.org.
  Show Usage
  • SNOMED Clinical Terms® (SNOMED CT®): BeVSDiagnosticImagingCondition, BeVSDiagnosticImagingProcedure... Show 19 more, BeVSeReferralSnomedDesignation, EReferralAnnex81, EReferralServiceRequestDiagnosticImaging, EReferralServiceRequestNursing, ServiceRequest/example-drp-clinical-imaging, ServiceRequest/example-drp-nursing-bloodletting, ServiceRequest/example-drp-nursing-chronic-dialysis, ServiceRequest/example-drp-nursing-de-convention-center, ServiceRequest/example-drp-nursing-de-within-care-trajectory, ServiceRequest/example-drp-nursing-de-within-start-trajectory, ServiceRequest/example-drp-nursing-de-without-care-trajectory, ServiceRequest/example-drp-nursing-generic, ServiceRequest/example-drp-nursing-glycemic-test, ServiceRequest/example-drp-nursing-hygienic-care, ServiceRequest/example-drp-nursing-med-prep-not-refunded, ServiceRequest/example-drp-nursing-med-preparation-appendix-81, ServiceRequest/example-drp-nursing-parameters, ServiceRequest/example-drp-nursing-sampling and ServiceRequest/example-prior-drp-clinical-imaging

Package hl7.fhir.uv.extensions.r4#5.2.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Mon, Feb 10, 2025 21:45+1100+11:00)

Package hl7.fhir.uv.extensions.r4#5.3.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, May 16, 2026 18:32+1000+10:00)

Package hl7.fhir.be.core#2.2.0 eHealth Platform Federal Core Profiles (built Wed, Aug 19, 2026 10:40+0200+02:00)

Package hl7.fhir.uv.xver-r5.r4#0.1.0 Extensions for Using Data Elements from FHIR R5 in FHIR R4 (built Fri, Mar 20, 2026 15:40+1100+11:00)

Package hl7.fhir.be.core-clinical#1.3.0 HL7 Belgium - Transversal Clinical Core (built Thu, Aug 20, 2026 13:08+0200+02:00)

Package hl7.fhir.uv.extensions.r4#5.1.0 This IG defines the global extensions - the ones defined for everyone. These extensions are always in scope wherever FHIR is being used (built Sat, Apr 27, 2024 18:39+1000+10:00)

Package hl7.fhir.be.core#2.1.2 eHealth Platform Federal Core Profiles (built Fri, Aug 30, 2024 17:07+0200+02:00)

Package hl7.fhir.be.infsec#1.3.0 eHealth Platform Federal infsec Profiles (built Fri, Jun 26, 2026 09:52+0200+02:00)

Package hl7.fhir.be.referral#1.0.0 Referral Prescription Implementation Guide (built Tue, Aug 25, 2026 14:26+0200+02:00)

Package hl7.fhir.uv.tools.r4#1.1.2 This IG defines the extensions that the tools use internally. Some of these extensions are content that are being evaluated for elevation into the main spec, and others are tooling concerns (built Tue, Mar 24, 2026 11:13+1100+11:00)

There are no Global profiles defined

This is an R4 IG. None of the features it uses are changed in R4B, so it can be used as is with R4B systems. Packages for both R4 (inami.fhir.be.ereferral.r4) and R4B (inami.fhir.be.ereferral.r4b) are available.