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/document-access-provider-eu-api | Version: 1.0.0-ballot | ||||
| Active as of 2026-01-26 | Computable Name: DocumentAccessProviderEuApi | ||||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
CapabilityStatement for the EEHRxF Document Access Provider actor. This composite actor provides access to EEHRxF FHIR Documents by serving them to Document Consumers via query APIs.
This composite actor groups the following IHE actors:
| Transaction | Description | Optionality |
|---|---|---|
| ITI-67 Find Document References | Respond to document metadata queries from Document Consumers | R |
| ITI-68 Retrieve Document | Serve document content to Document Consumers | R |
| ITI-78 Patient Demographics Query | Respond to patient demographics queries | R |
| Get Access Token | Issue authorization tokens to clients | R |
Systems SHALL support SMART Backend Services authorization for all transactions.
To accept document publication from external Document Publishers, implement the Document Submission Option.
The Document Access Provider may be grouped with Document Publisher, in which case document publication is internal. See the grouped Document Publisher/Access Provider CapabilityStatement for this deployment pattern.
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.
serverThe Document Access Provider actor responds to document queries from Document Consumers (ITI-67, ITI-68) and provides patient lookup services (PDQm ITI-78).
All transactions require SMART Backend Services authorization.
SMART-on-FHIRSMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL:
- Validate JWT client credentials (RFC 7523)
- Verify appropriate scopes for document operations
- Use TLS 1.2 or higher for all communications
Required scopes to accept:
- system/DocumentReference.rs (read + search DocumentReference - ITI-67)
- system/Binary.r (read Binary - ITI-68)
- system/Bundle.r (read Bundle - ITI-68 for FHIR Documents)
- system/Patient.rs (read + search Patient - ITI-78)
search-systeminteraction described as follows:System-wide search support
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 |
|---|---|---|---|---|---|---|---|---|---|
| DocumentReference | Y | Y | _id, _lastUpdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type | Provenance:target | |||||
| Binary | Y | ||||||||
| Patient | Supported Profiles Patient (EU core) | Y | Y | identifier, _id, family, given, birthdate |
resolvesreadRead DocumentReference by logical ID
search-typeSearch for DocumentReference resources (ITI-67)
DocumentReference resources are returned as base FHIR resources. No EU or MHD return profile is required.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id |
| SHALL | category | token | Document category |
| SHALL | creation | date | Document creation time |
| SHALL | patient | reference | Patient reference |
| SHALL | patient.identifier | token | Chained patient identifier |
| SHALL | type | token | Document type |
| SHOULD | date | date | Reference creation time |
| SHOULD | status | token | Document reference status |
| MAY | _lastUpdated | date | Resource version last updated |
| MAY | author.given | string | Author given name |
| MAY | author.family | string | Author family name |
| MAY | event | token | Main clinical acts documented |
| MAY | facility | token | Facility kind |
| MAY | format | token | Document format |
| MAY | identifier | token | Document identifier |
| MAY | period | date | Documented service period |
| MAY | related | reference | Related identifier or resource |
| MAY | security-label | token | Document security label |
| MAY | setting | token | Clinical setting |
readRetrieve document content (ITI-68)
Binary resources contain non-FHIR document content (e.g. DICOM KOS imaging manifests per IHE MADO). Served via ITI-68 Retrieve Document.
resolvesreadRead Patient by logical ID
search-typeSearch for patients (PDQm ITI-78)
Patient resources support patient context lookup per PDQm [ITI-78]. The identifier search parameter is required; additional demographics parameters are optional.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Patient identifier (e.g., national ID, MRN) - required for patient lookup |
| SHALL | _id | token | Patient logical ID |
| SHOULD | family | string | Patient family name |
| SHOULD | given | string | Patient given name |
| SHOULD | birthdate | date | Patient date of birth |
IG © 2025+ HL7 Europe.
Package hl7.fhir.eu.health-data-api#1.0.0-ballot based on FHIR 4.0.1.
Generated
2026-08-05
