EU Health Data API
0.1.0 - ci-build
150
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
| Official URL: http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-DocumentPublisherAccessProvider | Version: | 0.1.0 | |||
| Computable Name: EEHRxFDocumentPublisherAccessProvider | |||||
Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
|||||
CapabilityStatement for the grouped EEHRxF Document Publisher and Document Access Provider actors. This represents a deployment where document production and access provision are co-located in the same system.
This CapabilityStatement applies when:
In this grouped deployment, document publication is internal to the system and not exposed externally. The external API provides only document discovery (ITI-67) and retrieval (ITI-68) capabilities.
This grouped actor combines:
The underlying IHE actors are:
Note: MHD Document Recipient is not listed because publication is internal.
| 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.
Use this CapabilityStatement when implementing:
For systems that need to receive documents from external sources, use the Document Access Provider with Document Submission Option.
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.
serverThis grouped actor provides document access to external Document Consumers. Document publication is internal and not exposed. The external API supports document discovery (ITI-67), retrieval (ITI-68), and patient lookup (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 access
- Use TLS 1.2 or higher for all communications
Required scopes to accept:
- system/DocumentReference.read, system/DocumentReference.search (read and search DocumentReference - ITI-67)
- system/Binary.read (read Binary - ITI-68)
- system/Bundle.read (read Bundle - ITI-68 for FHIR Documents)
- system/Patient.read, system/Patient.search (read and 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 | patient, type, _id, category, date, status, identifier, period, format | Provenance:target | |||||
| Binary | Y | ||||||||
| Patient | Y | Y | identifier, _id, family, given, birthdate |
resolvesreadRead DocumentReference by logical ID
search-typeSearch for DocumentReference resources (ITI-67)
DocumentReference resources are served via ITI-67 Find Document References. Document creation is internal; no external create operation is supported.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient the document is about. The server SHALL support at least id value and MAY support both Type and id values. |
| SHALL | type | token | Kind of document (LOINC code) - SHALL support for clinical precision filtering |
| SHALL | _id | token | Logical id of this artifact |
| SHOULD | category | token | Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering |
| SHOULD | date | date | When this document reference was created. The date modifiers ge, le, gt, lt SHOULD be supported. |
| SHOULD | status | token | current | superseded | entered-in-error |
| SHOULD | identifier | token | Master Version Specific Identifier |
| MAY | period | date | Time of service that is being documented |
| MAY | format | token | Format/content rules for the document |
readRetrieve document content (ITI-68)
Binary resources contain the actual document content and are served via ITI-68 Retrieve Document. Document content is created internally; no external create operation is supported.
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.eu-health-data-api#0.1.0 based on FHIR 4.0.1.
Generated
2026-02-06
