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
This page documents the changes to the eReferral Implementation Guide specification.
This release aligns gateway validation with the NIHDI/RIZIV-INAMI profiles, introduces track-dependent radiology workflow management, and strengthens security and execution traceability. Existing nursing integrations remain compatible, while radiology resources must conform to the latest diagnostic imaging profile.
The FHIR Gateway now aligns validation with the current NIHDI/RIZIV-INAMI profiles. For backward compatibility, it continues to accept the supported legacy eHealth profile URLs and rewrites them to the corresponding NIHDI/RIZIV-INAMI canonical URLs before validation. The mappings cover diagnostic imaging ServiceRequests, nursing ServiceRequests, and Annex 81 resources.
The rewrite is transparent and does not transform resource content. Validation may therefore be stricter than in previous releases, and resources with profile deviations may now produce errors. Existing nursing integrations remain compatible but should progressively adopt the current canonical URLs. Radiology integrations must conform to the latest diagnostic imaging profile. See Profile Rewriting.
Radiology prescriptions now use their required ambulatory, inpatient, or urgency track when
the API applies assignment, validation, substitution, execution, and refusal rules. See
Guidance – Radiology Track Management.
See Technical – Encryption and API Integration – Pseudonymization.
The Implementation Guide remains the single authoritative source for supported workflows, FHIR structures, profiles, validation rules, and integration examples. The retired PDF Cookbook must not be used as the reference for new development. This consolidation was introduced in v2.0.0; v2.1.0 reinforces the migration recommendation without duplicating the Cookbook content.
Heart Failure Medical Orders, Technical Orders, Medical Order consultation, and Heart Failure parameter management are deployed behind feature flags but remain disabled in acceptance and production. They are not part of the public API capabilities in this release and will be documented as available only when activated in a future release.
This release makes the Implementation Guide the single source of truth for eReferral integration. It adds nursing and radiology profiles and mappings, expands machine-to-machine workflows, and documents the API’s security, access-control, and operational requirements.
The legacy eReferral API cookbook (UHMEP_API_cookbook.pdf) has been fully integrated into this Implementation Guide. This IG now supersedes the cookbook and serves as the single source of truth for integrators.
New nursing profiles to add constraints on nursing prescriptions and Annex 81 proposals:
Field-by-field mapping tables have been added for every prescription type, showing exactly how business concepts map to FHIR:
New profiles and operations enable prescription and management of radiology exams:
Three new operations handle specific parts of radiology prescription workflows:
Field-by-field mapping table has been added for radiology prescription, showing exactly how business concepts map to FHIR:
The following operations have been expanded to support M2M workflows:
BeOrganizationTask)BePerformerTask)