FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packagehl7.fhir.eu.health-data-api
Resource TypeCapabilityStatement
IdCapabilityStatement-document-publisher-eu-api.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/euridice-org/eu-health-data-api/CapabilityStatement-document-publisher-eu-api.html
URLhttp://hl7.eu/fhir/health-data-api/CapabilityStatement/document-publisher-eu-api
Version1.0.0-ballot
Statusactive
Date2026-01-26
NameDocumentPublisherEuApi
TitleEEHRxF Document Publisher CapabilityStatement
Realmeu
Authorityhl7
DescriptionCapabilityStatement for the EEHRxF Document Publisher 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-105 Simplified Publish | Submit document with embedded content 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 Publisher may be grouped with Document Access Provider, in which case the ITI-105 transaction becomes internal and is not exposed externally. See the [grouped Document Publisher/Access Provider CapabilityStatement](CapabilityStatement-document-publisher-access-provider-eu-api.html) for this deployment pattern.
CopyrightCopyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).
Kindrequirements

Resources that use this resource

No resources found

Resources that this resource uses

StructureDefinition
hl7.fhir.eu.base#currentpatient-eu-corePatient (EU core)
ihe.iti.mhd#currentIHE.MHD.Minimal.DocumentReferenceMHD DocumentReference Minimal
ihe.iti.mhd#currentIHE.MHD.SimplifiedPublish.DocumentReferenceMHD DocumentReference for Simplified Publish

Narrative

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

Generated Narrative: CapabilityStatement document-publisher-eu-api

EEHRxF Document Publisher 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 Publisher 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 publication:

  • system/DocumentReference.c (create DocumentReference - ITI-105)
  • system/Patient.rs (read + search Patient for context)

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 for Simplified Publish
  MHD DocumentReference Minimal		Y
PatientSupported Profiles
  Patient (EU core)		YYidentifier, _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
    create

    Create DocumentReference with embedded document (ITI-105 Simplified Publish)

Supported Profiles

MHD DocumentReference for Simplified Publish
MHD DocumentReference Minimal

Documentation

DocumentReference resources are submitted via ITI-105 Simplified Publish with embedded document content in the attachment to publish documents to the Document Access Provider. The SimplifiedPublish profile requires content.attachment.data to be populated.

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 queried using PDQm [ITI-78] to establish patient context before submitting documents. The identifier search parameter is required.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken

Patient identifier (e.g., national ID, MRN) - required for patient lookup

SHOULD_idtoken

Patient logical ID

SHOULDactivetoken

Whether the patient record is active

SHOULDfamilystring

Patient family name

SHOULDgivenstring

Patient given name

SHOULDtelecomtoken

Telecom details of the patient

SHOULDbirthdatedate

Patient date of birth

SHOULDaddressstring

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

SHOULDaddress-citystring

A city specified in an address

SHOULDaddress-countrystring

A country specified in an address

SHOULDaddress-postalcodestring

A postal code specified in an address

SHOULDaddress-statestring

A state specified in an address

SHOULDgendertoken

Administrative gender of the patient

 

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "document-publisher-eu-api",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/document-publisher-eu-api",
  "version": "1.0.0-ballot",
  "name": "DocumentPublisherEuApi",
  "title": "EEHRxF Document Publisher 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 Publisher 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-105 Simplified Publish | Submit document with embedded content 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 Publisher may be grouped with Document Access Provider, in which case the\nITI-105 transaction becomes internal and is not exposed externally. See the\n[grouped Document Publisher/Access Provider CapabilityStatement](CapabilityStatement-document-publisher-access-provider-eu-api.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 Publisher 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 publication:\n- system/DocumentReference.c (create DocumentReference - ITI-105)\n- system/Patient.rs (read + search Patient for context)"
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "DocumentReference",
          "supportedProfile": [
            "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.SimplifiedPublish.DocumentReference",
            "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference"
          ],
          "documentation": "DocumentReference resources are submitted via ITI-105 Simplified Publish with embedded\ndocument content in the attachment to publish documents to the Document Access Provider.\nThe SimplifiedPublish profile requires content.attachment.data to be populated.",
          "interaction": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "code": "create",
              "documentation": "Create DocumentReference with embedded document (ITI-105 Simplified Publish)"
            }
          ]
        },
        {
          "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 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": "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"
            }
          ]
        }
      ]
    }
  ]
}