EU Health Data API
1.0.0-ballot - ballot
150
EU Health Data API
1.0.0-ballot - ballot
150
EU Health Data API, published by HL7 Europe. This guide is not an authorized publication; it is the continuous build for version 1.0.0-ballot 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
| Official URL: http://hl7.eu/fhir/health-data-api/CapabilityStatement/resource-consumer-eu-api | Version: 1.0.0-ballot | ||||
| Active as of 2026-09-28 | Computable Name: ResourceConsumerEuApi | ||||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
Requirements for an EEHRxF Resource Consumer that queries clinical FHIR resources using IPA patterns.
This CapabilityStatement defines the requirements for the EEHRxF Resource Consumer actor. The actor queries clinical data resources using International Patient Access (IPA) patterns for direct resource access beyond document exchange.
Following IPA's approach, clients are not required to consume every clinical resource listed in this CapabilityStatement. Patient lookup is required; clients MAY choose other resources according to their needs and the server's declared capabilities.
Optional resources, requested according to need and server support, are:
Clients should check the server's CapabilityStatement to discover available resources.
This requirements CapabilityStatement supports the IUA or SMART client role selected by the environment and use case. A deployment instance advertises only its selected protocol; see Authorization.
Consumers SHOULD expect resources conforming to EU Core profiles where available.
Raw OpenAPI-Swagger Definition file | Download
Language: en
json, xmlNote to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
clientThe Resource Consumer actor queries for clinical data resources from a Resource Access Provider following IPA patterns. This enables direct resource access complementing document-based exchange via MHD.
It groups with the IUA Authorization Client, SMART App, or SMART Backend Service selected by the environment and use case. The Authorization Server is a separate participant; see Authorization.
This abstract requirements statement does not advertise a fixed security service. A concrete deployment SHALL declare exactly one security-service coding from the EU Health Data API Authorization Security Service ValueSet, selected for its environment. It SHALL NOT advertise both services unless a future profile defines dual conformance.
IHE IUA
The consumer groups with the IUA Authorization Client. The IPA and PDQm interactions in this statement have no IUA MHD transaction scopes; the deployment applies the IUA authorization policy defined for its environment.
SMART Backend Services
For a pre-authorized system-to-system use case, the consumer groups with the SMART Backend Service, uses
client_credentialsandprivate_key_jwt, and requestssystem/scopes for needed resources.Interactive SMART
Where an interactive use case applies, the consumer groups with the SMART App, uses authorization code with PKCE, and requests the applicable
patient/oruser/scopes.All modes use TLS 1.2 or higher.
Resource Flexibility
Following IPA's approach, clients MAY choose which clinical resources to request based on their needs and the server's capabilities (as declared in the server's CapabilityStatement). Patient lookup is required; other resources are requested as needed.
Scopes for Desired Resources
For SMART Backend Services, clients SHALL request scopes for the resources they need:
- system/Patient.rs (REQUIRED - read + search Patient)
- system/Condition.rs (if Condition needed)
- system/AllergyIntolerance.rs (if AllergyIntolerance needed)
- system/Observation.rs (if Observation needed)
- system/DiagnosticReport.rs (if DiagnosticReport needed)
- system/ImagingStudy.rs (if ImagingStudy needed)
- system/MedicationRequest.rs (if MedicationRequest needed)
- system/MedicationDispense.rs (if MedicationDispense needed)
- system/Immunization.rs (if Immunization needed)
- system/MedicationStatement.rs (if MedicationStatement needed)
- system/Encounter.rs (if Encounter needed)
- system/Practitioner.r (if Practitioner needed)
- system/Organization.r (if Organization needed)
These are SMART App Launch 2.2 Backend Services FHIR Resource Scopes, not IUA transaction scopes. Interactive SMART uses the corresponding
patient/oruser/forms. See Authorization.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| Patient | Supported Profiles Patient (EU core) | Y | Y | identifier, _id, active, family, given, telecom, birthdate, address, address-city, address-country, address-postalcode, address-state, gender | |||||
| Practitioner | Y | ||||||||
| Organization | Y | ||||||||
| Condition | Y | Y | patient, clinical-status, category, code | ||||||
| AllergyIntolerance | Y | Y | patient, clinical-status | ||||||
| Observation | Y | Y | patient, category, code, date, status | ||||||
| DiagnosticReport | Y | Y | patient, category, code, date, status | ||||||
| ImagingStudy | Y | Y | patient | ||||||
| MedicationRequest | Y | Y | patient, status, intent, authoredon | ||||||
| MedicationDispense | Y | Y | patient, status, whenhandedover | ||||||
| Immunization | Y | Y | patient, date, status | ||||||
| MedicationStatement | Y | Y | patient, status, effective | ||||||
| Encounter | Y | Y | patient, date, status, class |
readRead Patient by logical ID
search-typeSearch for patients for lookup purposes
Patient resources are queried for patient lookup per PDQm [ITI-78] with identifier as a required search parameter. Note: Patient is used for lookup context, not as a primary clinical data resource in this actor.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Patient identifier (e.g., national ID, MRN) - required for patient lookup |
| SHOULD | _id | token | Patient logical ID |
| SHOULD | active | token | Whether the patient record is active |
| SHOULD | family | string | Patient family name |
| SHOULD | given | string | Patient given name |
| SHOULD | telecom | token | Telecom details of the patient |
| SHOULD | birthdate | date | Patient date of birth |
| SHOULD | address | string | A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text |
| SHOULD | address-city | string | A city specified in an address |
| SHOULD | address-country | string | A country specified in an address |
| SHOULD | address-postalcode | string | A postal code specified in an address |
| SHOULD | address-state | string | A state specified in an address |
| SHOULD | gender | token | Administrative gender of the patient |
readRead Practitioner by logical ID
Practitioner resources are read to resolve clinical context for referenced healthcare providers. Clients SHOULD support this resource but MAY omit it based on their needs.
readRead Organization by logical ID
Organization resources are read to resolve context for referenced healthcare organizations. Clients SHOULD support this resource but MAY omit it based on their needs.
readRead Condition by logical ID
search-typeSearch for Condition resources
Condition resources represent problems, diagnoses, and health concerns. If supported, clients SHALL support search by patient and SHOULD support additional filters. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient who has the condition (SHALL support) |
| SHOULD | clinical-status | token | The clinical status of the condition |
| SHOULD | category | token | The category of condition |
| SHOULD | code | token | Code for the condition |
readRead AllergyIntolerance by logical ID
search-typeSearch for AllergyIntolerance resources
AllergyIntolerance resources represent patient allergies and intolerances. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient who has the allergy or intolerance (SHALL support) |
| SHOULD | clinical-status | token | The clinical status of the allergy or intolerance |
readRead Observation by logical ID
search-typeSearch for Observation resources
Observation resources represent clinical observations including vital signs, laboratory results, and other measurements. If supported, clients SHALL support search by patient and category. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient the observation is about (SHALL support) |
| SHALL | category | token | Category of observation (e.g., vital-signs, laboratory) |
| SHOULD | code | token | The code of the observation type |
| SHOULD | date | date | Obtained date/time. Date modifiers ge, le, gt, lt SHOULD be supported. |
| SHOULD | status | token | The status of the observation |
readRead DiagnosticReport by logical ID
search-typeSearch for DiagnosticReport resources
DiagnosticReport resources represent laboratory results and imaging reports. If supported, clients SHALL support search by patient and category. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient the report is about (SHALL support) |
| SHALL | category | token | Category of report (e.g., LAB, RAD) |
| SHOULD | code | token | The code for the report type |
| SHOULD | date | date | The clinically relevant time of the report |
| SHOULD | status | token | The status of the report |
readRead ImagingStudy by logical ID
search-typeSearch for ImagingStudy resources
ImagingStudy resources represent imaging studies available for a patient. Consumers SHOULD expect resources conforming to the HL7 Europe Imaging ImagingStudy profile (http://hl7.eu/fhir/imaging/StructureDefinition/ImagingStudyEuImaging). If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient the imaging study is about (SHALL support) |
readRead MedicationRequest by logical ID
search-typeSearch for MedicationRequest resources
MedicationRequest resources represent medication orders and prescriptions. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient for whom the medication was ordered (SHALL support) |
| SHOULD | status | token | Status of the prescription |
| SHOULD | intent | token | The intent of the medication request |
| SHOULD | authoredon | date | Return prescriptions written on this date |
readRead MedicationDispense by logical ID
search-typeSearch for MedicationDispense resources
MedicationDispense resources represent medication dispensing events. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient for whom the medication was dispensed (SHALL support) |
| SHOULD | status | token | Status of the dispense |
| SHOULD | whenhandedover | date | When the medication was handed over |
readRead Immunization by logical ID
search-typeSearch for Immunization resources
Immunization resources represent vaccination records. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
readRead MedicationStatement by logical ID
search-typeSearch for MedicationStatement resources
MedicationStatement resources represent a patient's medication usage, including self-reported medications. If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
readRead Encounter by logical ID
search-typeSearch for Encounter resources
Encounter resources represent patient encounters (visits, admissions, etc.). If supported, clients SHALL support search by patient. Clients MAY omit this resource based on their needs.
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.health-data-api#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-11-05
