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 Access Provider - Document Submission Option

0.1.0
Official URL: http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-DocumentAccessProvider-SubmissionOption Version:
Computable Name: EEHRxFDocumentAccessProviderSubmissionOption

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

CapabilityStatement for the Document Submission Option on the EEHRxF Document Access Provider.

This option enables the Access Provider to receive documents from external Document Publishers via ITI-105 Simplified Publish.

Systems implementing this option:

  • SHALL also implement the base Document Access Provider capabilities
  • SHALL accept ITI-105 transactions from authorized Document Publishers
  • SHALL make received documents available via ITI-67 and ITI-68
  • SHALL validate documents against EEHRxF content profiles

This option is REQUIRED when acting as a delegated access provider for external Document Publishers (e.g., integration engines, national infrastructure).

Actor Grouping

Adds to base Document Access Provider:

Transaction

Transaction Description Optionality
ITI-105 Simplified Publish Accept document publication from Document Publishers R

Security

Systems SHALL support SMART Backend Services authorization for document submission.

Raw OpenAPI-Swagger Definition file | Download

Language: en

EEHRxF Document Access Provider - Document Submission Option

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

This CapabilityStatement imports the CapabilityStatement EEHRxF Document Access Provider CapabilityStatement

FHIR RESTful Capabilities

Mode: server

The Document Submission Option adds ITI-105 Simplified Publish capability. Document Publishers POST a DocumentReference with embedded document content. The server extracts and persists both the DocumentReference metadata and the embedded document, making them available via ITI-67 and ITI-68.

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

Additional scope required for document submission:

  • system/DocumentReference.create (create DocumentReference via ITI-105)

The Document Publisher must be authorized to submit documents on behalf of the patient's care team.

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
DocumentReferenceSupported Profiles
  MHD DocumentReference Minimalversion: 4.2.3)
Y$validate

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

    Accept DocumentReference with embedded document (ITI-105 Simplified Publish).

    The DocumentReference SHALL include:

    • status (required)
    • type (required - LOINC document type)
    • subject (required - Patient reference)
    • content.attachment.contentType (required)
    • content.attachment.data (required - base64-encoded document content)

    The server SHALL:

    • Validate against EEHRxF DocumentReference profile
    • Extract and persist the document
    • Assign server-generated IDs
    • Return 201 Created with the persisted DocumentReference

Documentation

DocumentReference resources with embedded document content are accepted via ITI-105 Simplified Publish. The server:

  1. Validates the DocumentReference against EEHRxF profiles
  2. Extracts the embedded document from content.attachment.data
  3. Persists both the DocumentReference and the document
  4. Returns the created DocumentReference with server-assigned IDs
Extended Operations
ConformanceOperationDocumentation
MAY$validate

Pre-validation of DocumentReference before submission