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/example-capabilitystatement-document-access-provider | Version: 1.0.0-ballot | ||||
| Draft as of 2026-03-10 | Computable Name: ExampleDocumentAccessProviderEPSLab | ||||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
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.
This CapabilityStatement instantiates the CapabilityStatement EEHRxF Document Access Provider CapabilityStatement
serverThis server provides document exchange for European Patient Summaries and Laboratory Reports. It supports MHD ITI-67 (Find Document References), ITI-68 (Retrieve Document), and PDQm ITI-78 (Patient Demographics Query).
SMART-on-FHIRSMART Backend Services authorization required.
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 | ||||||
| Patient | Supported Profiles Patient (EU core) | y | y | identifier, _id |
DocumentReference resources are served via ITI-67. The response uses base FHIR DocumentReference resources without a required return profile.
| 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 |
Patient lookup via PDQm ITI-78.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | |
| SHALL | _id | token |
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
