FHIR IG analytics| Package | hl7.fhir.eu.eu-health-data-api |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-EEHRxF-DocumentPublisher.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/euridice-org/eu-health-data-api/CapabilityStatement-EEHRxF-DocumentPublisher.html |
| URL | http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-DocumentPublisher |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-01-26 |
| Name | EEHRxFDocumentPublisher |
| Title | EEHRxF Document Publisher CapabilityStatement |
| Realm | eu |
| Authority | hl7 |
| Description | CapabilityStatement 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-EEHRxF-DocumentPublisherAccessProvider.html) for this deployment pattern. |
| Copyright | Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
| Kind | requirements |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement EEHRxF-DocumentPublisher
json, xmlNote 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.
clientThe Document Publisher actor initiates transactions to publish documents and query for patient context. All transactions require SMART Backend Services authorization.
SMART-on-FHIRSMART 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.create (create DocumentReference - ITI-105)
- system/Patient.read, system/Patient.search (read and search Patient for context)
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include_revinclude| Resource Type | Profile | R | S | U | C | Searches | _include | _revinclude | Operations |
|---|---|---|---|---|---|---|---|---|---|
| DocumentReference | Y | ||||||||
| Patient | Y | Y | identifier, _id, family, given, birthdate |
createCreate DocumentReference with embedded document (ITI-105 Simplified Publish)
DocumentReference resources are submitted via ITI-105 Simplified Publish with embedded document content in the attachment to publish documents to the Document Access Provider.
readRead Patient by logical ID
search-typeSearch for patients (PDQm ITI-78)
Patient resources are queried using PDQm [ITI-78] to establish patient context before submitting documents. The identifier search parameter is required.
| 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 |
{
"resourceType": "CapabilityStatement",
"id": "EEHRxF-DocumentPublisher",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.eu/fhir/eu-health-data-api/CapabilityStatement/EEHRxF-DocumentPublisher",
"version": "0.1.0",
"name": "EEHRxFDocumentPublisher",
"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-EEHRxF-DocumentPublisherAccessProvider.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.create (create DocumentReference - ITI-105)\n- system/Patient.read, system/Patient.search (read and search Patient for context)"
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "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.",
"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",
"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"
}
]
}
]
}
]
}