IE (Ireland) Core Implementation Guide
0.3.0 - draft Ireland flag

IE (Ireland) Core Implementation Guide - Local Development build (v0.3.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions

EHDS & EU Conformance

EHDS & EU Conformance

The IE Core Implementation Guide is designed to ensure conformance with the European Health Data Space (EHDS) and enable cross-border interoperability across EU Member States. IE Core provides dedicated profiles for all five EHDS priority data categories.

Layered Architecture

IE Core follows the layered FHIR profile architecture established by HL7 Europe:

┌──────────────────────────────────────────────────────────┐
│         IE Core Profiles (Irish)                         │  ← This IG
│  Irish identifiers, HSE schemes, Eircodes, PCRS         │
├──────────────────────────────────────────────────────────┤
│  HL7 Europe Scoped IGs                                   │
│  MPD, Laboratory, Patient Summary, HDR, Imaging          │
├──────────────────────────────────────────────────────────┤
│  HL7 Europe Core Profiles (EU)            hl7.fhir.eu.base│
│  EHDS-aligned, cross-border constraints                  │
├──────────────────────────────────────────────────────────┤
│  HL7 Europe Base Profiles (EU)            hl7.fhir.eu.base│
│  Loosely constrained European concepts                   │
├──────────────────────────────────────────────────────────┤
│  International Patient Summary (IPS)      hl7.fhir.uv.ips │
│  Universal cross-border patient summary                  │
├──────────────────────────────────────────────────────────┤
│  FHIR R4 Base Resources                                  │
│  HL7 FHIR standard resource definitions                 │
└──────────────────────────────────────────────────────────┘

EU Dependencies

The following EU IGs are formal dependencies of IE Core:

Package Version Status Purpose
hl7.fhir.eu.base 2.0.0 STU 2.0 EU Base and Core profiles
hl7.fhir.eu.laboratory 2.0.0 STU 2.0 EU Laboratory Report
hl7.fhir.uv.ips 1.1.0 STU 1 International Patient Summary
hl7.fhir.uv.extensions.r4 5.1.0 Published FHIR R4 extensions
hl7.fhir.eu.extensions 1.3.0 STU 1.3 Published (Jun 2026) HL7 Europe Extensions
hl7.fhir.eu.hdr 0.1.0-ballot Published ballot Hospital Discharge Report
hl7.fhir.eu.imaging 1.0.0-ballot Ballot (Jun 2026) Imaging Report & Study
hl7.fhir.eu.health-data-api 1.0.0-ballot Ballot (Jun 2026) European Health Data API

The following EU IGs have new QA Preview versions or are in active development:

Package Status Purpose
hl7.fhir.eu.imaging Ballot 1.0.0 (Jun 2026) Imaging Study & Report
hl7.fhir.eu.health-data-api Ballot 1.0.0 (Jun 2026) European Health Data API Specification

For the complete HL7 Europe EHDS IG listing, see the HL7 Europe Confluence page.

HL7 Europe EHDS Implementation Guides Reference

IG FHIR Version Canonical URL GitHub Status
ePrescription / eDispensation (MPD) R4 / R5 https://hl7.eu/fhir/mpd GitHub STU 1.0 Published (Jun 2026)
Laboratory Report R4 https://hl7.eu/fhir/laboratory GitHub STU 2.0 Published (Jun 2026)
Patient Summary R4 https://hl7.eu/fhir/eps GitHub QA Preview 1.0.0-alpha (Xt-EHR Projectathon, Jun 2026)
Hospital Discharge Report (HDR) R4 https://hl7.eu/fhir/hdr GitHub QA Preview 1.0.0-alpha (Xt-EHR Projectathon, Jun 2026)
Imaging Report & Study R4 / R5 https://hl7.eu/fhir/imaging GitHub Ballot 1.0.0 (Jun 2026)
European Base / Core R4 / R5 https://hl7.eu/fhir/base GitHub STU 2.0 Published (Jun 2026)
Extensions R4 / R5 https://hl7.eu/fhir/extensions GitHub STU 1.3 Published (Jun 2026)
Health Data API R4 https://hl7.eu/fhir/health-data-api GitHub Ballot 1.0.0 (Jun 2026)

EHDS Five Priority Categories

The EHDS regulation identifies five priority categories for the European Electronic Health Record Exchange Format (EEHRxF). IE Core provides dedicated profiles for each:

1. Patient Summary

IE Core Profile Xt-EHR Logical Model HL7 Europe IG
IE Core Patient Summary EHDSPatientSummary hl7.fhir.eu.eps (tracked)
IE Core Patient EHDSPatient EU Core Patient
IE Core Condition EHDSCondition EU Core Condition (v2.0)
IE Core AllergyIntolerance EHDSAllergyIntolerance EU Core AllergyIntolerance (v2.0)
IE Core Medication EHDSMedication EU Core Medication (v2.0)
IE Core Immunization EHDSImmunisation EU Core Immunization (v2.0)
IE Core Procedure EHDSProcedure EU Core Procedure (v2.0)

The IE Core Patient Summary profile structures essential clinical information using the IPS section model (medications, allergies, problems, procedures, immunizations, results, vital signs) for both domestic continuity of care and cross-border exchange via MyHealth@EU.

2. ePrescription & eDispensation

Irish ePrescription and eDispensation (the HIQA Draft National Standard for Electronic Prescriptions and Electronic Dispensations, HL7 Europe MPD, cross-border ePrescription) are profiled in IE Medication Events (nostalgic-ie.fhir.medication-events), not in IE Core (ADR-009).

3. Laboratory Results

IE Core Profile Xt-EHR Logical Model HL7 Europe IG
IE Core Laboratory Report EHDSLaboratoryReport hl7.fhir.eu.laboratory (2.0.0 STU)
IE Core Lab Observation EHDSLaboratoryObservation EU Lab Observation
IE Core Specimen EHDSSpecimen EU Lab Specimen
IE Core DiagnosticReport (Lab) EHDSLaboratoryReport EU Core DiagnosticReport (v2.0)

The IE Core Laboratory Report profile is aligned with the published HL7 Europe Laboratory Report IG (STU 2.0, Jun 2026). It supports laboratory reporting workflows for clinical biochemistry, haematology, microbiology, immunology, and other in-vitro diagnostic disciplines.

4. Hospital Discharge Report

IE Core Profile Xt-EHR Logical Model HL7 Europe IG
IE Core Discharge Report EHDSDischargeReport hl7.fhir.eu.hdr (0.1.0-ballot)
IE Core Encounter EHDSEncounter —
IE Core Condition (Encounter Dx) EHDSCondition EU Core Condition (v2.0)

The IE Core Hospital Discharge Report provides a structured Composition with sections for admission details, discharge diagnoses, procedures, medications, allergies, and post-discharge care plans. IE Core now depends on the published hl7.fhir.eu.hdr@0.1.0-ballot package for the current HDR aliases. Full re-parenting follows the next published EU HDR IG update.

5. Medical Images & Reports

IE Core Profile Xt-EHR Logical Model HL7 Europe IG
IE Core DiagnosticReport (Note) EHDSImagingReport hl7.fhir.eu.imaging (ballot, no package yet)

The HL7 Europe Imaging IG (hl7.fhir.eu.imaging) is currently in ballot (Mar–Apr 2026) for both R4 and R5 versions. The ballot covers:

  • ImagingReport — structured radiology/pathology reports
  • ImagingStudy — DICOM study metadata
  • MADO (Manifest-Based Access to DICOM Objects) — imaging manifest for cross-border access

IE Core currently provides the IE Core DiagnosticReport (Note) profile as baseline imaging report support. Full ImagingStudy and ImagingReport profiles will be added as a formal dependency once the HL7 Europe Imaging IG is published.


Xt-EHR Logical Model Alignment Matrix

The following table maps Xt-EHR EHDS logical information models (v1.0.0) to IE Core FHIR profiles. The "R4 Mapping" column notes where the FHIR R4 resource differs from the FHIR R5 resource used in the XT-EHR authoring environment. The "Obligations" column indicates whether IE Core currently satisfies the XT-EHR v1.0.0 Obligations layer for that model.

Note on FHIR version: XT-EHR v1.0.0 logical models are authored in FHIR R5 (fhirVersion: 5.0.0). IE Core uses FHIR R4 (fhirVersion: 4.0.1). The logical models themselves are FHIR-version-agnostic (they use the Logical: keyword and reference abstract types), but the FHIR resource mappings differ for some models. See FHIR R4/R5 Compatibility below.

Xt-EHR Model FHIR R4 Resource FHIR R5 Difference IE Core Profile Status Obligations
EHDSDataSet (abstract base) — (inherited by all) Implemented (inherited) —
EHDSDocument Composition — (inherited by PS/HDR) Implemented (inherited) —
EHDSPatient Patient — IECorePatient Implemented (EU Core) ✅
EHDSHealthProfessional Practitioner / PractitionerRole — IECorePractitioner, IECorePractitionerRole Implemented (EU Core) ✅
EHDSOrganisation Organization — IECoreOrganization Implemented (EU Core) ✅
EHDSLocation Location — IECoreLocation Implemented (EU Core) ✅
EHDSCondition Condition — IECoreCondition Implemented ✅
EHDSAllergyIntolerance AllergyIntolerance — IECoreAllergyIntolerance Implemented ✅
EHDSProcedure Procedure — IECoreProcedure Implemented ✅
EHDSImmunisation Immunization — IECoreImmunization Implemented ✅
EHDSMedication Medication — IECoreMedication Implemented ✅
EHDSMedicationPrescription MedicationRequest — IE Medication Events (ADR-009) Out of scope —
EHDSMedicationDispense MedicationDispense — IE Medication Events (ADR-009) Out of scope —
EHDSMedicationUse MedicationStatement R5: renamed to MedicationUsage; taken removed; adherence added IECoreMedicationStatement Implemented ✅
EHDSMedicationAdministration MedicationAdministration Minor R5 changes — Planned ❌
EHDSDosage Dosage — (used within medication profiles) Implemented ✅
EHDSObservation Observation — IECoreObservation variants Implemented ✅
EHDSLaboratoryObservation Observation — IECoreLaboratoryResultObservation Implemented ✅
EHDSLaboratoryReport DiagnosticReport — IECoreLaboratoryReport Implemented ✅
EHDSImagingReport DiagnosticReport — IECoreDiagnosticReportNote Partial ⚠️ Partial
EHDSImagingStudy ImagingStudy Minor R5 changes — Planned ❌
EHDSDischargeReport Composition — IECoreCompositionDischargeReport Implemented ✅
EHDSPatientSummary Composition — IECoreCompositionPatientSummary Implemented ✅
EHDSCarePlan CarePlan — IECoreCarePlan Implemented ✅
EHDSDevice Device R5: significant Device restructure IECoreImplantableDevice Implemented ✅
EHDSDeviceUse DeviceUseStatement R5: renamed to DeviceUsage; structural changes — Planned ❌
EHDSServiceRequest ServiceRequest — IECoreServiceRequest Implemented ✅
EHDSSpecimen Specimen — IECoreSpecimen Implemented ✅
EHDSRelatedPerson RelatedPerson — IECoreRelatedPerson Implemented ✅
EHDSEncounter Encounter R5: reasonCode removed (use reason.use+reason.value) IECoreEncounter Implemented ✅
EHDSAddress Address — (Irish address within Patient/Organization) Implemented ✅
EHDSHumanName HumanName — (within Patient/Practitioner) Implemented ✅
EHDSTelecom ContactPoint — (within Patient/Practitioner/Organization) Implemented ✅
EHDSAlert Flag — IECoreFlag Implemented ✅
EHDSAdvanceDirective Consent R5: Consent completely restructured IECoreADIDocumentReference Partial ⚠️ Partial
EHDSCurrentPregnancy Observation — IECoreObservation (pregnancy status) Implemented ✅
EHDSPregnancyHistory Observation — IECoreObservation (pregnancy history) Implemented ✅
EHDSTravelHistory Observation — — Planned ❌
EHDSEndpoint Endpoint — — Planned ❌
EHDSBodyStructure BodyStructure — — Planned ❌
EHDSAttachment Attachment (datatype) — (used within DocumentReference) Planned ❌

FHIR R4/R5 Compatibility

XT-EHR v1.0.0 logical models are authored as FHIR R5 artefacts. IE Core is a FHIR R4 IG. The logical models themselves are FHIR-version-agnostic by design — they use the Logical: construct and abstract base types. However, when mapping logical models to concrete FHIR resource profiles, the following R4/R5 differences are relevant:

Logical Model R4 Resource R5 Resource Key Differences IE Core Impact
EHDSMedicationUse MedicationStatement MedicationUsage taken removed; new adherence element; medication changed from [x] to Reference or CodeableReference IE Core R4 profile uses medication[x]; taken not used; adherence not available in R4
EHDSDeviceUse DeviceUseStatement DeviceUsage Resource renamed; timing[x] restructured; status codes changed IE Core will use R4 DeviceUseStatement when this profile is added
EHDSAdvanceDirective Consent Consent R5 Consent is significantly restructured (provision model changed) IE Core uses DocumentReference for advance directives as a pragmatic R4 approach
EHDSEncounter Encounter Encounter R5 removes reasonCode/reasonReference; uses reason backbone with use and value IE Core R4 profile uses reasonCode; cannot directly use R5 reason structure
EHDSDevice Device Device R5 Device substantially restructured — properties, names, versions restructured IE Core R4 profile targets R4 Device structure

Conclusion: All XT-EHR 1.0.0 logical model concepts can be represented in FHIR R4, but implementers targeting FHIR R5 will need to use different resource types for EHDSMedicationUse and EHDSDeviceUse. When IE Core migrates to FHIR R5 (planned for EU Core 3.x alignment), these profiles will need to be re-parented to the R5 resource types.


Obligations Framework (New in XT-EHR v1.0.0)

XT-EHR v1.0.0 introduced a formal Obligations Framework — a separate layer of derived logical models that specify normative obligations (SHALL/SHOULD/MAY) for each actor (creator, repository, consumer) across each use case. This is a significant addition not present in v0.3.0.

The Obligations Framework defines ~30 Obligations models (e.g., EHDSPatientSummaryObligations, EHDSDischargeReportObligations) that reference the parent logical models and add formal requirements per actor per element.

IE Core Obligations Coverage:

Obligations Model IE Core Coverage Notes
EHDSPatientSummaryObligations ✅ Covered PS profile implements all mandatory sections
EHDSDischargeReportObligations ✅ Covered HDR profile implements all mandatory sections
EHDSMedicationPrescriptionObligations — Out of scope IE Medication Events (ADR-009)
EHDSMedicationDispenseObligations — Out of scope IE Medication Events (ADR-009)
EHDSMedicationUseObligations ✅ Covered MedicationStatement profile satisfies obligations; adherence obligation deferred (R4 limitation)
EHDSAlertObligations ✅ Covered Flag profile covers obligations; alert codes aligned with SNOMED CT
EHDSLaboratoryReportObligations ✅ Covered Laboratory report profile meets obligations via HL7 EU Lab IG alignment
EHDSDeviceUseObligations ❌ Not covered DeviceUseStatement profile not yet created
EHDSAdvanceDirectiveObligations ⚠️ Partial ADI DocumentReference covers document-level obligations; formal Consent mapping deferred

What Obligations compliance means for IE Core implementers:

  • Systems implementing IE Core SHOULD consult the XT-EHR Obligations models to understand which elements are mandatory for specific actors
  • Creator systems must populate all SHALL elements before sending; Consumer systems must be able to process all SHALL elements on receipt
  • IE Core profiles set MS (Must Support) flags on elements that correspond to SHALL obligations in the XT-EHR model
  • Where XT-EHR obligations require elements not available in FHIR R4, IE Core documents the limitation and provides the closest R4 equivalent

Profile Derivation Map

Currently Derived from EU Core (v2.0.0)

IE Core Profile EU Core Parent EU Profile ID
IE Core Patient Patient (EU core) patient-eu-core
IE Core Practitioner Practitioner (EU core) practitioner-eu-core
IE Core PractitionerRole PractitionerRole (EU core) practitionerRole-eu-core
IE Core Organization Organization (EU core) organization-eu-core
IE Core Location Location (EU core) location-eu-core

Planned Migration to EU Core (v2.0.0)

IE Core Profile Current Parent Planned EU Core Parent
IE Core AllergyIntolerance FHIR AllergyIntolerance allergyIntolerance-eu-core
IE Core Condition (x2) FHIR Condition condition-eu-core
IE Core Procedure FHIR Procedure procedure-eu-core
IE Core Immunization FHIR Immunization immunization-eu-core
IE Core Medication FHIR Medication medication-eu-core
IE Core DiagnosticReport (x2) FHIR DiagnosticReport diagnosticReport-eu-core

Cross-Border Interoperability (MyHealth@EU)

Ireland participates in the MyHealth@EU infrastructure. IE Core supports the following MyHealth@EU services:

MyHealth@EU Service IE Core Profiles Status
Patient Summary (Country A → Country B) IECoreCompositionPatientSummary Ready
Laboratory Results IECoreLaboratoryReport Ready
Hospital Discharge Report IECoreCompositionDischargeReport Ready
Medical Images & Reports IECoreDiagnosticReportNote Partial

Cross-border ePrescription and eDispensation are covered by IE Medication Events (ADR-009).

EHDS Regulation Alignment

Primary Use (Care Delivery)

  • Patient Summary: Structured IPS-compatible composition for unplanned and planned care
  • ePrescription/eDispensation: profiled in IE Medication Events (ADR-009)
  • Laboratory Results: Structured lab reports with EU Lab IG alignment
  • Hospital Discharge: Composition-based discharge summaries
  • Imaging: Baseline support via DiagnosticReport; full ImagingStudy planned

Secondary Use (Research & Policy)

  • Standardized Coding: SNOMED CT, LOINC, ATC, ICD-10 enable aggregation and research
  • Structured Data: Machine-readable FHIR representation for health data reuse
  • Provenance: IE Core Provenance profile tracks data origin and transformations

Irish-Specific Extensions for Cross-Border

IE Core adds the following Ireland-specific elements on top of the EU profiles:

Extension / Constraint Applicable Profiles Purpose
IHI (Individual Health Identifier) Patient National patient identifier (18 or 10 digits, HIQA EP/PS 1.3.1)
Registration numbers (IMC, PSI, NMBI, Dental Council) Practitioner Prescriber and dispenser registration (HIQA 2.6.2)
PCRS scheme numbers Patient Scheme eligibility, typed by IECorePCRSSchemeType (no format enforced)
NePS prescription identifier NamingSystem only (used by IE Medication Events) Electronic prescription (group) identifier (HIQA EP 3.1)
Eircode Patient, Organization, Location Irish postal code system
Irish county ValueSet Patient address 26 Irish counties
Ethnicity (CSO Data Standard for Ethnicity v1.0) Patient (Patient Summary only; prohibited in the IE Medication Events ePrescription patient) HIQA PS 1.4.10
IMC registration number Practitioner Irish Medical Council number

These extensions ensure that cross-border systems can distinguish Irish-origin data and map identifiers appropriately.

eIDAS 2.0 and EUDI Wallet — FHIR Mapping

eIDAS Cross-Border Patient Identifier

The eIDAS cross-border patient identifier uses the format Origin/Destination/NationalID (e.g. IE/DE/1234567T). In IE Core, this is represented in Patient.identifier with the eHDSI-defined OID system URI:

FHIR Element Value Notes
Patient.identifier.system urn:oid:1.3.6.1.4.1.12559.11.10.1.3.1.42.1 (unverified, OI-026) Cross-border PID system: confirm with the National Contact Point
Patient.identifier.value IE/DE/1234567T Origin/Destination/NationalID
Patient.identifier.use official Cross-border official identifier

EUDI Wallet Person Identification Data (PID)

eIDAS 2.0 (Regulation 2024/1183/EU) introduces the EU Digital Identity (EUDI) Wallet and the Person Identification Data (PID) attestation set, defined in the EUDI Architecture and Reference Framework (ARF). The following table maps EUDI PID attributes to IE Core FHIR elements:

EUDI PID Attribute FHIR R4 Element IE Core Profile Mapping Notes
family_name Patient.name.family IE Core Patient Current family name
given_name Patient.name.given IE Core Patient Current given name(s)
birth_date Patient.birthDate IE Core Patient ISO 8601 date
age_over_18 (derived) — Derived from Patient.birthDate; not stored separately
nationality / nationalities Patient.extension[nationality] EU Core Patient ISO 3166-1 alpha-2 (e.g. IE)
personal_identifier Patient.identifier (eHDSI OID) IE Core Patient Origin/Destination/NationalID format
issuing_country Patient.identifier.extension[country] — ISO 3166-1 alpha-2
resident_address Patient.address IE Core Patient With Irish address guidance (Eircode)
gender Patient.gender IE Core Patient Administrative gender; separate from PID sex attribute

FAPI 2.0 and EHDS Health Data API

The EHDS Regulation 2025/327 and the HL7 Europe Health Data API IG (hl7.fhir.eu.health-data-api) mandate high-assurance API security for EHDS data spaces. IE Core implementations supporting EHDS secondary use data access SHOULD implement:

Standard Purpose Level
FAPI 2.0 (Security Profile) High-assurance OAuth2 profile for financial and healthcare APIs SHALL for EHDS secondary use data spaces
FAPI 2.0 Message Signing (JARM) JWT-based authorization response signing SHOULD for cross-border API responses
OpenID Connect (OIDC) Core Standard identity layer for patient and HCP authentication SHALL
PKCE (RFC 7636) Proof Key for Code Exchange — prevents authorization code interception SHALL for public clients
DPoP (RFC 9449) Demonstrating Proof of Possession — prevents token replay SHOULD for high-assurance scenarios

FAPI 2.0 references:

Future EU Alignment

XT-EHR v1.0.0 was published in 2025. As the EHDS ecosystem evolves towards the March 2027 implementing acts deadline, IE Core will:

  1. Re-parent to EU Core v2.0 for AllergyIntolerance, Condition, Procedure, Immunization, Medication, DiagnosticReport (currently on EU Core v2.0)
  2. Adopt EU Patient Summary IG when hl7.fhir.eu.eps@1.0.0 stabilizes — currently testing QA Preview 1.0.0-alpha (Xt-EHR Projectathon, Jun 2026); full re-parenting planned on STU publication
  3. Adopt EU Hospital Discharge IG when hl7.fhir.eu.hdr@1.0.0 stabilizes — currently testing QA Preview 1.0.0-alpha (Xt-EHR Projectathon, Jun 2026); full re-parenting planned on STU publication
  4. Add Imaging profiles once hl7.fhir.eu.imaging is published (Ballot 1.0.0, Jun 2026); will add ImagingStudy and ImagingReport profiles and formal dependency to v1.0.0
  5. Add Health Data API conformance once hl7.fhir.eu.health-data-api is published (Ballot 1.0.0, Jun 2026); implement FAPI 2.0 requirements for EHDS secondary use
  6. Implement XT-EHR Obligations compliance — formally adopt the Obligations Framework from XT-EHR 1.0.0 as EU IGs incorporate them; near-term milestone is full obligation compliance for PS and HDR
  7. Support FHIR R5 following HL7 Europe's R5 timeline — requires re-mapping MedicationStatement→MedicationUsage, DeviceUseStatement→DeviceUsage, and Consent restructure
  8. Implement EUDI Wallet integration — align cross-border patient authentication with EUDI Wallet PID attestations per eIDAS 2.0 (Regulation 2024/1183/EU) and EUDI ARF v2.x; targeted for 2026 MyHealth@EU integration