FHIRsmith: CapabilityStatement/CapabilityStatement-document-consumer-eu-api.json

FHIR IG analytics

Package	hl7.fhir.eu.health-data-api
Resource Type	CapabilityStatement
Id	CapabilityStatement-document-consumer-eu-api.json
FHIR Version	R4
Source	https://build.fhir.org/ig/euridice-org/eu-health-data-api/CapabilityStatement-document-consumer-eu-api.html
URL	http://hl7.eu/fhir/health-data-api/CapabilityStatement/document-consumer-eu-api
Version	1.0.0-ballot
Status	active
Date	2026-01-26
Name	DocumentConsumerEuApi
Title	EEHRxF Document Consumer CapabilityStatement
Realm	eu
Authority	hl7
Description	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: - [IUA Authorization Client](https://profiles.ihe.net/ITI/IUA/index.html#34111-authorization-client) - [PDQm Patient Demographics Consumer](https://profiles.ihe.net/ITI/PDQm/volume-1.html) - [MHD Document Consumer](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html) ### 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.
Copyright	Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).
Kind	requirements

Resources that use this resource

No resources found

Resources that this resource uses

SearchParameter
ihe.iti.mhd#current	DocumentReference-Creation	Creation

StructureDefinition
hl7.fhir.eu.base#current	patient-eu-core	Patient (EU core)

Narrative

Note: links and images are rebased to the (stated) source

Generated Narrative: CapabilityStatement document-consumer-eu-api

EEHRxF Document Consumer CapabilityStatement

Implementation Guide Version: 1.0.0-ballot
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 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.rs (read + search DocumentReference - ITI-67)

system/Binary.r (read Binary for document retrieval - ITI-68)

system/Bundle.r (read Bundle for FHIR Document retrieval - ITI-68)

system/Patient.rs (read + 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 Type	Profile	R	S	Searches
DocumentReference		Y	Y	_id, _lastUpdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type
Binary		Y
Patient	Supported Profiles Patient (EU core)	Y	Y	identifier, _id, active, family, given, telecom, birthdate, address, address-city, address-country, address-postalcode, address-state, gender

Resource Conformance: SHALL DocumentReference

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 ITI-67 and returned as base FHIR resources. No EU or MHD return profile is required.

Search Parameters

Conformance	Parameter	Type	Documentation
SHALL	_id	`token`	Logical id
SHALL	patient	`reference`	Patient reference
SHALL	patient.identifier	`token`	Chained patient identifier
MAY	_lastUpdated	`date`	Resource version last updated
MAY	author.given	`string`	Author given name
MAY	author.family	`string`	Author family name
MAY	category	`token`	Document category
MAY	creation	`date`	Document creation time
MAY	date	`date`	Reference creation time
MAY	event	`token`	Main clinical acts documented
MAY	facility	`token`	Facility kind
MAY	format	`token`	Document format
MAY	identifier	`token`	Document identifier
MAY	period	`date`	Documented service period
MAY	related	`reference`	Related identifier or resource
MAY	security-label	`token`	Document security label
MAY	setting	`token`	Clinical setting
MAY	status	`token`	Document reference status
MAY	type	`token`	Document type

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 retrieved using the ITI-68 Retrieve Document transaction.

Resource Conformance: SHALL Patient

Core FHIR Resource
Patient

Reference Policy

Interaction summary

SHALL support
read
Read Patient by logical ID

search-type
Search for patients (PDQm ITI-78)

Supported Profiles

Patient (EU core)

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

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`	Patient identifier (e.g., national ID, MRN) - required for patient lookup
SHOULD	_id	`token`	Patient logical ID
SHOULD	active	`token`	Whether the patient record is active
SHOULD	family	`string`	Patient family name
SHOULD	given	`string`	Patient given name
SHOULD	telecom	`token`	Telecom details of the patient
SHOULD	birthdate	`date`	Patient date of birth
SHOULD	address	`string`	A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text
SHOULD	address-city	`string`	A city specified in an address
SHOULD	address-country	`string`	A country specified in an address
SHOULD	address-postalcode	`string`	A postal code specified in an address
SHOULD	address-state	`string`	A state specified in an address
SHOULD	gender	`token`	Administrative gender of the patient

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "document-consumer-eu-api",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/document-consumer-eu-api",
  "version": "1.0.0-ballot",
  "name": "DocumentConsumerEuApi",
  "title": "EEHRxF Document Consumer CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2026-01-26",
  "publisher": "HL7 Europe",
  "contact": [
    {
      "name": "HL7 Europe",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.eu"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for the EEHRxF Document Consumer actor. This composite actor\nconsumes EEHRxF FHIR Documents by querying a Document Access Provider.\n\n### Actor Grouping\n\nThis composite actor groups the following IHE actors:\n- [IUA Authorization Client](https://profiles.ihe.net/ITI/IUA/index.html#34111-authorization-client)\n- [PDQm Patient Demographics Consumer](https://profiles.ihe.net/ITI/PDQm/volume-1.html)\n- [MHD Document Consumer](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html)\n\n### Transactions\n\n| Transaction | Description | Optionality |\n|-------------|-------------|-------------|\n| ITI-67 Find Document References | Query for document metadata from Document Access Provider | R |\n| ITI-68 Retrieve Document | Retrieve document content from Document Access Provider | R |\n| ITI-78 Patient Demographics Query | Query for patient demographics to establish patient context | R |\n| Get Access Token | Obtain authorization token for API access | R |\n\n### Security\nSystems SHALL support SMART Backend Services authorization for all transactions.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
          "code": "150",
          "display": "Europe"
        }
      ]
    }
  ],
  "copyright": "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "The Document Consumer actor queries for document metadata and retrieves documents\nfrom a Document Access Provider. It also queries for patient context using PDQm.\nAll transactions require SMART Backend Services authorization.",
      "security": {
        "cors": false,
        "service": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ],
        "description": "SMART Backend Services authorization is REQUIRED for all transactions.\nSystems SHALL:\n- Authenticate using JWT client credentials (RFC 7523)\n- Request appropriate scopes for document access\n- Use TLS 1.2 or higher for all communications\n\nRequired scopes:\n- system/DocumentReference.rs (read + search DocumentReference - ITI-67)\n- system/Binary.r (read Binary for document retrieval - ITI-68)\n- system/Bundle.r (read Bundle for FHIR Document retrieval - ITI-68)\n- system/Patient.rs (read + search Patient for context - ITI-78)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "documentation": "DocumentReference resources are queried using ITI-67 and returned as base FHIR resources. No EU or MHD return profile is required.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read DocumentReference by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search DocumentReference (ITI-67)"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Logical id"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "_lastUpdated",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
              "type": "date",
              "documentation": "Resource version last updated"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "author.given",
              "type": "string",
              "documentation": "Author given name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "author.family",
              "type": "string",
              "documentation": "Author family name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
              "type": "token",
              "documentation": "Document category"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "creation",
              "definition": "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
              "type": "date",
              "documentation": "Document creation time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
              "type": "date",
              "documentation": "Reference creation time"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "event",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
              "type": "token",
              "documentation": "Main clinical acts documented"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "facility",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
              "type": "token",
              "documentation": "Facility kind"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "format",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
              "type": "token",
              "documentation": "Document format"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Document identifier"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "Patient reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient.identifier",
              "type": "token",
              "documentation": "Chained patient identifier"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "period",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
              "type": "date",
              "documentation": "Documented service period"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "related",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
              "type": "reference",
              "documentation": "Related identifier or resource"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "security-label",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
              "type": "token",
              "documentation": "Document security label"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "setting",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
              "type": "token",
              "documentation": "Clinical setting"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
              "type": "token",
              "documentation": "Document reference status"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
              "type": "token",
              "documentation": "Document type"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Binary",
          "documentation": "Binary resources contain the actual document content and are retrieved using the\nITI-68 Retrieve Document transaction.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Retrieve document content (ITI-68)"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core"
          ],
          "documentation": "Patient resources are searched to establish patient context before querying for documents.\nThis uses PDQm [ITI-78] with identifier as a required search parameter.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Read Patient by logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "search-type",
              "documentation": "Search for patients (PDQm ITI-78)"
            }
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
              "type": "token",
              "documentation": "Patient identifier (e.g., national ID, MRN) - required for patient lookup"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "_id",
              "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
              "type": "token",
              "documentation": "Patient logical ID"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "active",
              "definition": "http://hl7.org/fhir/SearchParameter/Patient-active",
              "type": "token",
              "documentation": "Whether the patient record is active"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "family",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-family",
              "type": "string",
              "documentation": "Patient family name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "given",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-given",
              "type": "string",
              "documentation": "Patient given name"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "telecom",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-telecom",
              "type": "token",
              "documentation": "Telecom details of the patient"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "birthdate",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type": "date",
              "documentation": "Patient date of birth"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address",
              "type": "string",
              "documentation": "A server defined search that may match any of the string fields in the Address, including line, city, district, state, country, postalCode, and/or text"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address-city",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-city",
              "type": "string",
              "documentation": "A city specified in an address"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address-country",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-country",
              "type": "string",
              "documentation": "A country specified in an address"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address-postalcode",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-postalcode",
              "type": "string",
              "documentation": "A postal code specified in an address"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "address-state",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-address-state",
              "type": "string",
              "documentation": "A state specified in an address"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "gender",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
              "type": "token",
              "documentation": "Administrative gender of the patient"
            }
          ]
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

EEHRxF Document Consumer CapabilityStatement

FHIR RESTful Capabilities

Mode: client

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL DocumentReference

Resource Conformance: SHALL Binary

Resource Conformance: SHALL Patient

Source1

Mode: `client`