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

CapabilityStatement: EEHRxF Document Consumer CapabilityStatement

0.1.0
Official URL: http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-DocumentConsumer Version:
Computable Name: EEHRxFDocumentConsumer

Copyright/Legal: Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).

CapabilityStatement for the EEHRxF Document Consumer actor. This composite actor consumes EEHRxF FHIR Documents by querying a Document Access Provider.

Actor Grouping

This composite actor groups the following IHE actors:

Transactions

Transaction Description Optionality
ITI-67 Find Document References Query for document metadata from Document Access Provider R
ITI-68 Retrieve Document Retrieve document content from Document Access Provider R
ITI-78 Patient Demographics Query Query for patient demographics to establish patient context R
Get Access Token Obtain authorization token for API access R

Security

Systems SHALL support SMART Backend Services authorization for all transactions.

Raw OpenAPI-Swagger Definition file | Download

Language: en

EEHRxF Document Consumer 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: client

The Document Consumer actor queries for document metadata and retrieves documents from a Document Access Provider. It also queries for patient context using PDQm. 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:

  • Authenticate using JWT client credentials (RFC 7523)
  • Request appropriate scopes for document access
  • Use TLS 1.2 or higher for all communications

Required scopes:

  • system/DocumentReference.read, system/DocumentReference.search (read and search DocumentReference - ITI-67)
  • system/Binary.read (read Binary for document retrieval - ITI-68)
  • system/Patient.read, system/Patient.search (read and search Patient for context - ITI-78)

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 YYpatient, type, _id, category, date, status, identifier
Binary Y
Patient YYidentifier, _id, family, given, birthdate
Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHALL support
    read

    Read DocumentReference by logical ID

    search-type

    Search DocumentReference (ITI-67)

Documentation

DocumentReference resources are queried using the ITI-67 Find Document References transaction to discover available documents for a patient.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLpatientreference

The patient the document is about (SHALL support)

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

SHOULDstatustoken

current | superseded | entered-in-error

SHOULDidentifiertoken

Master Version Specific Identifier

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

    Retrieve document content (ITI-68)

Documentation

Binary resources contain the actual document content and are retrieved using the ITI-68 Retrieve Document transaction.

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

    Read Patient by logical ID

    search-type

    Search for patients (PDQm ITI-78)

Documentation

Patient resources are searched to establish patient context before querying for documents. This uses PDQm [ITI-78] with identifier as a required search parameter.

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