FHIRsmith: CapabilityStatement/CapabilityStatement-EEHRxF-DocumentProducerAccessProvider.json

FHIR IG analytics

Package	hl7.fhir.eu.euridice-api
Resource Type	CapabilityStatement
Id	CapabilityStatement-EEHRxF-DocumentProducerAccessProvider.json
FHIR Version	R4
Source	https://build.fhir.org/ig/bvdh/jwg-api/CapabilityStatement-EEHRxF-DocumentProducerAccessProvider.html
URL	http://hl7.eu/fhir/euridice-api/CapabilityStatement/EEHRxF-DocumentProducerAccessProvider
Version	0.1.0
Status	active
Date	2026-01-14
Name	EEHRxFDocumentProducerAccessProvider
Title	EEHRxF Grouped Document Producer/Access Provider CapabilityStatement
Realm	eu
Authority	hl7
Description	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.
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

No resources found

Narrative

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

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 Type	R	S	Searches	`_revinclude`
DocumentReference	Y	Y	patient, type, _id, category, date, status, identifier, period, format	`Provenance:target`
Binary	Y
Patient	Y	Y	identifier, _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

Conformance	Parameter	Type	Documentation
SHALL	patient	`reference`	The patient the document is about. The server SHALL support at least id value and MAY support both Type and id values.
SHALL	type	`token`	Kind of document (LOINC code) - SHALL support for clinical precision filtering
SHALL	_id	`token`	Logical id of this artifact
SHOULD	category	`token`	Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering
SHOULD	date	`date`	When this document reference was created. The date modifiers ge, le, gt, lt SHOULD be supported.
SHOULD	status	`token`	current \| superseded \| entered-in-error
SHOULD	identifier	`token`	Master Version Specific Identifier
MAY	period	`date`	Time of service that is being documented
MAY	format	`token`	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

Conformance	Parameter	Type	Documentation
SHALL	identifier	`token`	Patient identifier (e.g., national ID, MRN) - required for patient lookup
SHALL	_id	`token`	Patient logical ID
SHOULD	family	`string`	Patient family name
SHOULD	given	`string`	Patient given name
SHOULD	birthdate	`date`	Patient date of birth

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "EEHRxF-DocumentProducerAccessProvider",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/euridice-api/CapabilityStatement/EEHRxF-DocumentProducerAccessProvider",
  "version": "0.1.0",
  "name": "EEHRxFDocumentProducerAccessProvider",
  "title": "EEHRxF Grouped Document Producer/Access Provider CapabilityStatement",
  "status": "active",
  "experimental": false,
  "date": "2026-01-14",
  "publisher": "HL7 Europe",
  "contact": [
    {
      "name": "HL7 Europe",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.eu"
        }
      ]
    }
  ],
  "description": "CapabilityStatement for the grouped EEHRxF Document Producer and Document Access Provider\nactors. This represents a deployment where document production and access provision are\nco-located in the same system.\n\n### Deployment Pattern\n\nThis CapabilityStatement applies when:\n- An EHR system both produces documents AND provides access to them\n- Document submission (ITI-65) is handled internally\n- External clients only need to query and retrieve documents\n\nIn this grouped deployment, the ITI-65 Provide Document Bundle transaction is internal\nto the system and not exposed externally. The external API provides only document\ndiscovery (ITI-67) and retrieval (ITI-68) capabilities.\n\n### Actor Grouping\n\nThis grouped actor combines:\n- **Document Producer** (internal) - Produces and stores documents internally\n- **Document Access Provider** (external-facing) - Serves documents to Document Consumers\n\nThe underlying IHE actors are:\n- [IUA Authorization Server](https://profiles.ihe.net/ITI/IUA/index.html#34112-authorization-server)\n- [IUA Resource Server](https://profiles.ihe.net/ITI/IUA/index.html#34113-resource-server)\n- [PDQm Patient Demographics Supplier](https://profiles.ihe.net/ITI/PDQm/volume-1.html)\n- [MHD Document Responder](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html)\n\nNote: MHD Document Recipient is not listed because ITI-65 is internal.\n\n### External Transactions\n\n| Transaction | Description | Optionality |\n|-------------|-------------|-------------|\n| ITI-67 Find Document References | Respond to document metadata queries from Document Consumers | R |\n| ITI-68 Retrieve Document | Serve document content to Document Consumers | R |\n| ITI-78 Patient Demographics Query | Respond to patient demographics queries | R |\n| Get Access Token | Issue authorization tokens to clients | R |\n\n### Security\nSystems SHALL support SMART Backend Services authorization for all transactions.\n\n### When to Use This CapabilityStatement\n\nUse this CapabilityStatement when implementing:\n- Hospital EHR systems that produce and serve their own documents\n- Regional health information exchanges with integrated document repositories\n- Any system where document creation and access are tightly coupled\n\nFor systems that need to receive documents from external sources, use the separate\n[Document Access Provider CapabilityStatement](CapabilityStatement-EEHRxF-DocumentAccessProvider.html)\nwhich includes ITI-65 support.",
  "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": "server",
      "documentation": "This grouped actor provides document access to external Document Consumers.\nDocument production (ITI-65) is internal and not exposed. The external API\nsupports document discovery (ITI-67), retrieval (ITI-68), and patient lookup (ITI-78).\n\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- Validate JWT client credentials (RFC 7523)\n- Verify appropriate scopes for document access\n- Use TLS 1.2 or higher for all communications\n\nRequired scopes to accept:\n- system/DocumentReference.rs (search and read DocumentReference - ITI-67)\n- system/Binary.r (read Binary - ITI-68)\n- system/Patient.rs (search and read Patient - ITI-78)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "documentation": "DocumentReference resources are served via ITI-67 Find Document References.\nDocument creation is internal; no external create operation is supported.",
          "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 for DocumentReference resources (ITI-67)"
            }
          ],
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "referencePolicy": [
            "resolves"
          ],
          "searchRevInclude": [
            "Provenance:target"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "patient",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
              "type": "reference",
              "documentation": "The patient the document is about. The server SHALL support at least id value and MAY support both Type and id values."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "type",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
              "type": "token",
              "documentation": "Kind of document (LOINC code) - SHALL support for clinical precision filtering"
            },
            {
              "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 of this artifact"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "category",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
              "type": "token",
              "documentation": "Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "date",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
              "type": "date",
              "documentation": "When this document reference was created. The date modifiers ge, le, gt, lt SHOULD be supported."
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "status",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
              "type": "token",
              "documentation": "current | superseded | entered-in-error"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "identifier",
              "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
              "type": "token",
              "documentation": "Master Version Specific 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": "Time of service that is being documented"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "format",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
              "type": "token",
              "documentation": "Format/content rules for the document"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Binary",
          "documentation": "Binary resources contain the actual document content and are served via ITI-68\nRetrieve Document. Document content is created internally; no external create\noperation is supported.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "read",
              "documentation": "Retrieve document content (ITI-68)"
            }
          ],
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported"
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "documentation": "Patient resources support patient context lookup per PDQm [ITI-78]. The identifier\nsearch parameter is required; additional demographics parameters are optional.",
          "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)"
            }
          ],
          "updateCreate": false,
          "conditionalCreate": false,
          "conditionalUpdate": false,
          "conditionalDelete": "not-supported",
          "referencePolicy": [
            "resolves"
          ],
          "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": "SHALL"
                }
              ],
              "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": "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": "birthdate",
              "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
              "type": "date",
              "documentation": "Patient date of birth"
            }
          ]
        }
      ],
      "interaction": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "MAY"
            }
          ],
          "code": "search-system",
          "documentation": "System-wide search support"
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

EEHRxF Grouped Document Producer/Access Provider CapabilityStatement

FHIR RESTful Capabilities

Mode: server

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL DocumentReference

Resource Conformance: SHALL Binary

Resource Conformance: SHALL Patient

Source1

Mode: `server`