EU Health Data API
0.1.0 - ci-build 150

EU Health Data API, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 0.1.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/euridice-org/eu-health-data-api/ and changes regularly. See the Directory of published versions

Patient Matching

Overview

Patient lookup is accomplished using IHE PDQm (Patient Demographics Query for Mobile), which relies on core FHIR Patient.Search [ITI-78] and Patient.$match [ITI-119]. This transaction allows Consumers to locate the correct Patient resource on a Access Provider before querying for health information.

This specification inherits directly from IHE PDQm with one constraint: the identifier search parameter is required for patient search.

Patient.Search [ITI-78] should be used when a patient identifier (e.g. National ID) is available and trusted. If an identifier is not available, Patient.$match [ITI-119] should be used to perform a demographics search operation with available demographics.

Actor Roles

Actor Role
Consumer Find a patient record in the Access Provider system based on identifier or demographics information
Document/Resource Access Provider Return its patient record information based on identifier or demographics queries from a consumer.

Transaction Options

Providers support one or both of the following patient identification mechanisms:

[ITI-78] Mobile Patient Demographics Query Patient.Search - (Required)

Patient search using the IHE PDQm ITI-78 transaction. This specification constrains ITI-78 to require the identifier parameter.

GET [base]/Patient?identifier=[system]|[value]

This approach covers the majority of European use cases where patient identifiers (MRN, national ID) are available.

Required Search Parameters:

Both Provider and Consumer SHALL support the identifier parameter for patient search.

Parameter Type Expectation Description
identifier token SHALL Patient identifier (e.g., national ID, MRN)

Optional Search Parameters:

Providers MAY support additional PDQm search parameters per ITI-78:

Parameter Type Expectation Description
family string SHOULD Patient family name
given string SHOULD Patient given name
birthdate date SHOULD Patient date of birth
_id token SHOULD Patient logical ID

Patient Demographics Match [ITI-119] Patient.$match (Optional)

The Patient Demographics $match option can be used to identify a patient when an identifier-based lookup is not possible (e.g., scenarios where the consumer does not know the patient's local identifier). The Patient $match operation identifies a patient record given demograpics data (Name, Birthdate, …) using IHE PDQm ITI-119:

POST [base]/Patient/$match

The request body contains a Parameters resource with demographic information. The server responds with candidate matches and confidence scores.

Required Search Parameters:

Parameter Type Expectation Description
onlyCertainMatches boolean SHALL This parameter SHALL be set to true

In order to support safe clinical patient matching both Provider and Consumer SHALL support the onlyCertainMatches parameter which SHALL be set to true to indicate that the Consumer would only like matches returned when they are certain to be matches for the subject of the request.

Matching algorithms are product and deployment-specific and may reflect national or region-specific factors (e.g., availability of common demographics, name transliteration, required fields in national patient registries). This specification does not prescribe how matching works, consistent with PDQm ITI-119.

Provider Requirements

Actor Transaction Optionality
Consumer Mobile Patient Demographics Query [ITI-78] O
  Patient Demographics Match [ITI-119] O
Provider Mobile Patient Demographics Query [ITI-78] R
  Patient Demographics Match [ITI-119] O

Providers are RECOMMENDED to implement the $match operation in addition to the patient search for scenarios where identifier is not available.

Authorization

When grouped with IUA actors:

  • Consumer uses Get Access Token [ITI-71] with appropriate scope
  • Provider enforces authorization via Incorporate Access Token [ITI-72]

Example

sequenceDiagram
    participant Consumer
    participant Provider as Access Provider

    Consumer->>Provider: GET /Patient?identifier=urn:oid:...|12345
    Provider-->>Consumer: Bundle with Patient resource(s)

    Note over Consumer: Consumer uses Patient.id<br/>for subsequent queries

Patient lookup applies to both Document Exchange and Resource Access patterns.

FHIR also supports querying resources directly by patient identifier via chained search, avoiding a separate lookup step. This applies to both clinical resource queries and document searches (ITI-67):

GET [base]/AllergyIntolerance?patient.identifier=[system]|[value]
GET [base]/DocumentReference?patient.identifier=[system]|[value]&type=http://loinc.org|60591-5

Chained search can be used to minimize round trips, for example with national aggregating gateways. The Access Provider must support chained search on patient.identifier for this to work.

Design Rationale

In most European exchanges the consumer already holds a trusted patient identifier (national health ID, MRN, or similar). Identifier-based lookup produces an unambiguous match and avoids dependence on demographic data quality, which varies in completeness and localization across member states. The MyHealth@EU cross-border infrastructure already follows this pattern.

Where an identifier is not available, Patient.$match [ITI-119] is safer than demographics-based Patient.Search [ITI-78] for automated resolution. Patient.$match moves resolution to the server, which has richer context (aliases, prior identifiers, phonetic matching) and returns only high-confidence matches when onlyCertainMatches is set to true. Demographics-based Patient.Search may return multiple candidates for common names, miss near-matches from spelling variation (e.g., "Schroeder" vs. "Schröder"), or produce false matches — and clients have no confidence score to guide selection.

References