Generated Narrative: CapabilityStatement EEHRxF-DocumentProducerAccessProvider

EEHRxF Grouped Document Producer/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

This grouped actor provides document access to external Document Consumers. Document production (ITI-65) is internal and not exposed. The external API supports document discovery (ITI-67), retrieval (ITI-68), and patient lookup (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 access
  • Use TLS 1.2 or higher for all communications

Required scopes to accept:

  • system/DocumentReference.rs (search and read DocumentReference - ITI-67)
  • system/Binary.r (read Binary - ITI-68)
  • system/Patient.rs (search and read Patient - ITI-78)
Summary of System-wide Interactions
  • 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 YYpatient, type, _id, category, date, status, identifier, period, formatProvenance:target
Binary Y
Patient YYidentifier, _id, family, given, birthdate

Resource Conformance: SHALL DocumentReference

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

    Read DocumentReference by logical ID

    search-type

    Search for DocumentReference resources (ITI-67)

Documentation

DocumentReference resources are served via ITI-67 Find Document References. Document creation is internal; no external create operation is supported.

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

 

Resource Conformance: SHALL Binary

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 served via ITI-68 Retrieve Document. Document content is created internally; no external create operation is supported.

Resource Conformance: SHALL Patient

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

 
 <status value="active"/> <experimental value="false"/> <date value="2026-01-14"/> <publisher value="HL7 Europe"/> <contact> <name value="HL7 Europe"/> <telecom> <system value="url"/> <value value="http://hl7.eu"/> </telecom> </contact> <description value="CapabilityStatement for the grouped EEHRxF Document Producer and Document Access Provider actors. This represents a deployment where document production and access provision are co-located in the same system. ### Deployment Pattern This CapabilityStatement applies when: - An EHR system both produces documents AND provides access to them - Document submission (ITI-65) is handled internally - External clients only need to query and retrieve documents In this grouped deployment, the ITI-65 Provide Document Bundle transaction is internal to the system and not exposed externally. The external API provides only document discovery (ITI-67) and retrieval (ITI-68) capabilities. ### Actor Grouping This grouped actor combines: - **Document Producer** (internal) - Produces and stores documents internally - **Document Access Provider** (external-facing) - Serves documents to Document Consumers The underlying IHE actors are: - [IUA Authorization Server](https://profiles.ihe.net/ITI/IUA/index.html#34112-authorization-server) - [IUA Resource Server](https://profiles.ihe.net/ITI/IUA/index.html#34113-resource-server) - [PDQm Patient Demographics Supplier](https://profiles.ihe.net/ITI/PDQm/volume-1.html) - [MHD Document Responder](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html) Note: MHD Document Recipient is not listed because ITI-65 is internal. ### External Transactions | 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 | ### Security Systems SHALL support SMART Backend Services authorization for all transactions. ### When to Use This CapabilityStatement Use this CapabilityStatement when implementing: - Hospital EHR systems that produce and serve their own documents - Regional health information exchanges with integrated document repositories - Any system where document creation and access are tightly coupled For systems that need to receive documents from external sources, use the separate [Document Access Provider CapabilityStatement](CapabilityStatement-EEHRxF-DocumentAccessProvider.html) which includes ITI-65 support."/> <jurisdiction> <coding> <system value="http://unstats.un.org/unsd/methods/m49/m49.htm"/> <code value="150"/> <display value="Europe"/> </coding> </jurisdiction> <copyright value="Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0)."/> <kind value="requirements"/> <fhirVersion value="4.0.1"/> <format value="json"/> <format value="xml"/> <rest> <mode value="server"/> <documentation value="This grouped actor provides document access to external Document Consumers. Document production (ITI-65) is internal and not exposed. The external API supports document discovery (ITI-67), retrieval (ITI-68), and patient lookup (ITI-78). All transactions require SMART Backend Services authorization."/> <security> <cors value="false"/> <service> <coding> <system value="http://hl7.org/fhir/restful-security-service"/> <code value="SMART-on-FHIR"/> </coding> </service> <description value="SMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL: - Validate JWT client credentials (RFC 7523) - Verify appropriate scopes for document access - Use TLS 1.2 or higher for all communications Required scopes to accept: - system/DocumentReference.rs (search and read DocumentReference - ITI-67) - system/Binary.r (read Binary - ITI-68) - system/Patient.rs (search and read Patient - ITI-78)"/> </security> <resource> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <type value="DocumentReference"/> <documentation value="DocumentReference resources are served via ITI-67 Find Document References. Document creation is internal; no external create operation is supported."/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Read DocumentReference by logical ID"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Search for DocumentReference resources (ITI-67)"/> </interaction> <updateCreate value="false"/> <conditionalCreate value="false"/> <conditionalUpdate value="false"/> <conditionalDelete value="not-supported"/> <referencePolicy value="resolves"/> <searchRevInclude value="Provenance:target"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="patient"/> <definition value="http://hl7.org/fhir/SearchParameter/clinical-patient"/> <type value="reference"/> <documentation value="The patient the document is about. The server SHALL support at least id value and MAY support both Type and id values."/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="type"/> <definition value="http://hl7.org/fhir/SearchParameter/clinical-type"/> <type value="token"/> <documentation value="Kind of document (LOINC code) - SHALL support for clinical precision filtering"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="_id"/> <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/> <type value="token"/> <documentation value="Logical id of this artifact"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="category"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-category"/> <type value="token"/> <documentation value="Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="date"/> <definition value="http://hl7.org/fhir/SearchParameter/clinical-date"/> <type value="date"/> <documentation value="When this document reference was created. The date modifiers ge, le, gt, lt SHOULD be supported."/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="status"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-status"/> <type value="token"/> <documentation value="current | superseded | entered-in-error"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/clinical-identifier"/> <type value="token"/> <documentation value="Master Version Specific Identifier"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="period"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-period"/> <type value="date"/> <documentation value="Time of service that is being documented"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <name value="format"/> <definition value="http://hl7.org/fhir/SearchParameter/DocumentReference-format"/> <type value="token"/> <documentation value="Format/content rules for the document"/> </searchParam> </resource> <resource> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <type value="Binary"/> <documentation value="Binary resources contain the actual document content and are served via ITI-68 Retrieve Document. Document content is created internally; no external create operation is supported."/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Retrieve document content (ITI-68)"/> </interaction> <updateCreate value="false"/> <conditionalCreate value="false"/> <conditionalUpdate value="false"/> <conditionalDelete value="not-supported"/> </resource> <resource> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <type value="Patient"/> <documentation value="Patient resources support patient context lookup per PDQm [ITI-78]. The identifier search parameter is required; additional demographics parameters are optional."/> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="read"/> <documentation value="Read Patient by logical ID"/> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <code value="search-type"/> <documentation value="Search for patients (PDQm ITI-78)"/> </interaction> <updateCreate value="false"/> <conditionalCreate value="false"/> <conditionalUpdate value="false"/> <conditionalDelete value="not-supported"/> <referencePolicy value="resolves"/> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="identifier"/> <definition value="http://hl7.org/fhir/SearchParameter/Patient-identifier"/> <type value="token"/> <documentation value="Patient identifier (e.g., national ID, MRN) - required for patient lookup"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL"/> </extension> <name value="_id"/> <definition value="http://hl7.org/fhir/SearchParameter/Resource-id"/> <type value="token"/> <documentation value="Patient logical ID"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="family"/> <definition value="http://hl7.org/fhir/SearchParameter/individual-family"/> <type value="string"/> <documentation value="Patient family name"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="given"/> <definition value="http://hl7.org/fhir/SearchParameter/individual-given"/> <type value="string"/> <documentation value="Patient given name"/> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD"/> </extension> <name value="birthdate"/> <definition value="http://hl7.org/fhir/SearchParameter/individual-birthdate"/> <type value="date"/> <documentation value="Patient date of birth"/> </searchParam> </resource> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY"/> </extension> <code value="search-system"/> <documentation value="System-wide search support"/> </interaction> </rest> </CapabilityStatement>