FHIRsmith: CapabilityStatement/CapabilityStatement-EEHRxF-DocumentProducer.json

FHIR IG analytics

Package	hl7.fhir.eu.euridice-api
Resource Type	CapabilityStatement
Id	CapabilityStatement-EEHRxF-DocumentProducer.json
FHIR Version	R4
Source	https://build.fhir.org/ig/bvdh/jwg-api/CapabilityStatement-EEHRxF-DocumentProducer.html
URL	http://hl7.eu/fhir/euridice-api/CapabilityStatement/EEHRxF-DocumentProducer
Version	0.1.0
Status	active
Date	2026-01-14
Name	EEHRxFDocumentProducer
Title	EEHRxF Document Producer CapabilityStatement
Realm	eu
Authority	hl7
Description	CapabilityStatement for the EEHRxF Document Producer 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: - [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 Source](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html) ### Transactions \| Transaction \| Description \| Optionality \| \|-------------\|-------------\|-------------\| \| ITI-65 Provide Document Bundle \| Submit documents and metadata 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 Producer may be grouped with Document Access Provider, in which case the ITI-65 transaction becomes internal and is not exposed externally. See the [grouped Document Producer/Access Provider CapabilityStatement](CapabilityStatement-EEHRxF-DocumentProducerAccessProvider.html) for this deployment pattern.
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-DocumentProducer

EEHRxF Document Producer 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: `client`

The Document Producer 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 submission:

system/DocumentReference.c (create DocumentReference)

system/Binary.c (create Binary)

system/Patient.rs (search and read Patient for context)

Summary of System-wide Interactions

SHALL support the transactioninteraction described as follows:
ITI-65 Provide Document Bundle transaction

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	C	Searches
DocumentReference			Y
Binary			Y
List			Y
Patient	Y	Y		identifier, _id, family, given, birthdate

Resource Conformance: SHALL DocumentReference

Core FHIR Resource
DocumentReference

Reference Policy

Interaction summary

SHALL support
create
Create DocumentReference as part of ITI-65 transaction Bundle

Documentation

DocumentReference resources are submitted as part of the ITI-65 Provide Document Bundle transaction to register document metadata with the Document Access Provider.

Resource Conformance: SHALL Binary

Core FHIR Resource
Binary

Reference Policy

Interaction summary

SHALL support
create
Create Binary as part of ITI-65 transaction Bundle

Documentation

Binary resources contain the actual document content and are submitted as part of the ITI-65 Provide Document Bundle transaction.

Resource Conformance: SHOULD List

Core FHIR Resource
List

Reference Policy

Interaction summary

SHOULD support
create
Create List (SubmissionSet) as part of ITI-65 transaction Bundle

Documentation

List resources may be used to represent SubmissionSets as part of the ITI-65 Provide Document Bundle 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)

Documentation

Patient resources are queried using PDQm [ITI-78] to establish patient context before submitting documents. The identifier search parameter is required.

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-DocumentProducer",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/euridice-api/CapabilityStatement/EEHRxF-DocumentProducer",
  "version": "0.1.0",
  "name": "EEHRxFDocumentProducer",
  "title": "EEHRxF Document Producer 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 EEHRxF Document Producer actor. This composite actor produces\nEEHRxF FHIR Documents and publishes them to 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 Source](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html)\n\n### Transactions\n\n| Transaction | Description | Optionality |\n|-------------|-------------|-------------|\n| ITI-65 Provide Document Bundle | Submit documents and metadata to a 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.\n\n### Deployment\nThe Document Producer may be grouped with Document Access Provider, in which case the\nITI-65 transaction becomes internal and is not exposed externally. See the\n[grouped Document Producer/Access Provider CapabilityStatement](CapabilityStatement-EEHRxF-DocumentProducerAccessProvider.html)\nfor this deployment pattern.",
  "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 Producer actor initiates transactions to publish documents and query for\npatient context. All 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 submission and patient lookup\n- Use TLS 1.2 or higher for all communications\n\nRequired scopes for document submission:\n- system/DocumentReference.c (create DocumentReference)\n- system/Binary.c (create Binary)\n- system/Patient.rs (search and read Patient for context)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "documentation": "DocumentReference resources are submitted as part of the ITI-65 Provide Document Bundle\ntransaction to register document metadata with the Document Access Provider.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Create DocumentReference as part of ITI-65 transaction Bundle"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Binary",
          "documentation": "Binary resources contain the actual document content and are submitted as part of\nthe ITI-65 Provide Document Bundle transaction.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Create Binary as part of ITI-65 transaction Bundle"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHOULD"
            }
          ],
          "type": "List",
          "documentation": "List resources may be used to represent SubmissionSets as part of the ITI-65\nProvide Document Bundle transaction.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "code": "create",
              "documentation": "Create List (SubmissionSet) as part of ITI-65 transaction Bundle"
            }
          ]
        },
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Patient",
          "documentation": "Patient resources are queried using PDQm [ITI-78] to establish patient context\nbefore submitting documents. The identifier search parameter is required.",
          "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": "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": "SHALL"
            }
          ],
          "code": "transaction",
          "documentation": "ITI-65 Provide Document Bundle transaction"
        }
      ]
    }
  ]
}

FHIR IG analytics

Resources that use this resource

Resources that this resource uses

Narrative

EEHRxF Document Producer CapabilityStatement

FHIR RESTful Capabilities

Mode: client

Capabilities by Resource/Profile

Summary

Resource Conformance: SHALL DocumentReference

Resource Conformance: SHALL Binary

Resource Conformance: SHOULD List

Resource Conformance: SHALL Patient

Source1

Mode: `client`