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-DocumentAccessProvider | Version: | 0.1.0 | |||
| Computable Name: EEHRxFDocumentAccessProvider | |||||
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.read (read DocumentReference - ITI-67)
- system/DocumentReference.search (search DocumentReference - ITI-67)
- system/Binary.read (read Binary - ITI-68)
- system/Bundle.read (read Bundle - ITI-68 for FHIR Documents)
- system/Patient.read (read Patient - ITI-78)
- system/Patient.search (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, _lastupdated, setting, facility, event, security-label, related, author.given, author.family, patient.identifier | 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. The server indexes document metadata for queries by Document Consumers.
| 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 |
| MAY | _lastupdated | date | When the resource version last changed |
| MAY | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
| MAY | facility | token | Kind of facility where patient was seen |
| MAY | event | token | Main clinical acts documented |
| MAY | security-label | token | Document security-tags |
| MAY | related | reference | Related identifiers or resources |
| MAY | author.given | string | Given name of document author |
| MAY | author.family | string | Family name of document author |
| MAY | patient.identifier | token | Patient identifier (chained search) |
readRetrieve document content (ITI-68)
Binary resources contain the actual document content for non-FHIR documents. They are 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.eu-health-data-api#0.1.0 based on FHIR 4.0.1.
Generated
2026-02-06
