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 Publisher CapabilityStatement

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

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

CapabilityStatement for the EEHRxF Document Publisher actor. This composite actor produces EEHRxF FHIR Documents and publishes them to a Document Access Provider.

Actor Grouping

This composite actor groups the following IHE actors:

Transactions

Transaction Description Optionality
ITI-105 Simplified Publish Submit document with embedded content to a 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.

Deployment

The Document Publisher may be grouped with Document Access Provider, in which case the ITI-105 transaction becomes internal and is not exposed externally. See the grouped Document Publisher/Access Provider CapabilityStatement for this deployment pattern.

Raw OpenAPI-Swagger Definition file | Download

Language: en

EEHRxF Document Publisher CapabilityStatement

  • Implementation Guide Version: 0.1.0
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-01-26
  • 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 Publisher actor initiates transactions to publish documents and query for patient context. 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 submission and patient lookup
  • Use TLS 1.2 or higher for all communications

Required scopes for document publication:

  • system/DocumentReference.create (create DocumentReference - ITI-105)
  • system/Patient.read, system/Patient.search (read and search Patient for context)

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 Y
Patient YYidentifier, _id, family, given, birthdate
Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • SHALL support
    create

    Create DocumentReference with embedded document (ITI-105 Simplified Publish)

Documentation

DocumentReference resources are submitted via ITI-105 Simplified Publish with embedded document content in the attachment to publish documents to the Document Access Provider.

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 queried using PDQm [ITI-78] to establish patient context before submitting documents. The identifier search parameter is required.

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