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/bvdh/jwg-api/ and changes regularly. See the Directory of published versions

CapabilityStatement: EEHRxF Document Access Provider CapabilityStatement

Official URL: http://hl7.eu/fhir/euridice-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 receiving documents from Document Producers and serving them to Document Consumers.

Actor Grouping

This composite actor groups the following IHE actors:

Transactions

Transaction Description Optionality
ITI-65 Provide Document Bundle Receive document submissions from Document Producers R
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

Security

Systems SHALL support SMART Backend Services authorization for all transactions.

Deployment

The Document Access Provider may be grouped with Document Producer, in which case the ITI-65 transaction becomes internal. See the grouped Document Producer/Access Provider CapabilityStatement for this deployment pattern.

Raw OpenAPI-Swagger Definition file | Download

Language: en

EEHRxF Document Access Provider CapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-01-14
  • Published by: HL7 Europe

Note 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.

FHIR RESTful Capabilities

Mode: server

The Document Access Provider actor receives document submissions from Document Producers (ITI-65) and responds to document queries from Document Consumers (ITI-67, ITI-68). It also provides patient lookup services (PDQm ITI-78).

All transactions require SMART Backend Services authorization.

Security
Enable CORS: no
Security services supported: SMART-on-FHIR

SMART 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.c (create DocumentReference - ITI-65)
  • system/DocumentReference.rs (search and read DocumentReference - ITI-67)
  • system/Binary.c (create Binary - ITI-65)
  • system/Binary.r (read Binary - ITI-68)
  • system/Patient.rs (search and read Patient - ITI-78)
Summary of System-wide Interactions
  • SHALL support the transactioninteraction described as follows:

    Accept and process ITI-65 Provide Document Bundle transaction

  • MAY support the search-systeminteraction described as follows:

    System-wide search support

Capabilities by Resource/Profile

Summary

The summary table lists the resources that are part of this configuration, and for each resource it lists:

  • The relevant profiles (if any)
  • The interactions supported by each resource (Read, Search, Update, and Create, are always shown, while VRead, Patch, Delete, History on Instance, or History on Type are only present if at least one of the resources has support for them.
  • The required, recommended, and some optional search parameters (if any).
  • The linked resources enabled for _include
  • The other resources enabled for _revinclude
  • The operations on the resource (if any)
Resource TypeProfileRSUCSearches_include_revincludeOperations
DocumentReference YYYpatient, type, _id, category, date, status, identifier, period, format, _lastupdated, setting, facility, event, security-label, related, author.given, author.family, patient.identifierProvenance:target
Binary YY
List Y
Patient YYidentifier, _id, family, given, birthdate
Core FHIR Resource
DocumentReference
Reference Policy
resolves
Interaction summary
  • SHALL support
    create

    Accept DocumentReference creation as part of ITI-65 transaction Bundle

    read

    Read DocumentReference by logical ID

    search-type

    Search for DocumentReference resources (ITI-67)

Documentation

DocumentReference resources are received via ITI-65 Provide Document Bundle and served via ITI-67 Find Document References. The server validates, stores, and indexes document metadata for subsequent queries.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient the document is about. The server SHALL support at least id value and MAY support both Type and id values.

SHALLtypetoken

Kind of document (LOINC code) - SHALL support for clinical precision filtering

SHALL_idtoken

Logical id of this artifact

SHOULDcategorytoken

Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering

SHOULDdatedate

When this document reference was created. The date modifiers ge, le, gt, lt SHOULD be supported.

SHOULDstatustoken

current | superseded | entered-in-error

SHOULDidentifiertoken

Master Version Specific Identifier

MAYperioddate

Time of service that is being documented

MAYformattoken

Format/content rules for the document

MAY_lastupdateddate

When the resource version last changed

MAYsettingtoken

Additional details about where the content was created (e.g. clinical specialty)

MAYfacilitytoken

Kind of facility where patient was seen

MAYeventtoken

Main clinical acts documented

MAYsecurity-labeltoken

Document security-tags

MAYrelatedreference

Related identifiers or resources

MAYauthor.givenstring

Given name of document author

MAYauthor.familystring

Family name of document author

MAYpatient.identifiertoken

Patient identifier (chained search)

 
Core FHIR Resource
Binary
Reference Policy
Interaction summary
  • SHALL support
    create

    Accept Binary creation as part of ITI-65 transaction Bundle

    read

    Retrieve document content (ITI-68)

Documentation

Binary resources contain the actual document content. They are received via ITI-65 Provide Document Bundle and served via ITI-68 Retrieve Document.

Core FHIR Resource
List
Reference Policy
Interaction summary
  • SHOULD support
    create

    Accept List (SubmissionSet) creation as part of ITI-65 transaction Bundle

Documentation

List resources representing SubmissionSets may be received as part of the ITI-65 Provide Document Bundle transaction.

Core FHIR Resource
Patient
Reference Policy
resolves
Interaction summary
  • SHALL support
    read

    Read Patient by logical ID

    search-type

    Search for patients (PDQm ITI-78)

Documentation

Patient resources support patient context lookup per PDQm [ITI-78]. The identifier search parameter is required; additional demographics parameters are optional.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Patient identifier (e.g., national ID, MRN) - required for patient lookup

SHALL_idtoken

Patient logical ID

SHOULDfamilystring

Patient family name

SHOULDgivenstring

Patient given name

SHOULDbirthdatedate

Patient date of birth