FHIR IG analytics| Package | hl7.fhir.eu.euridice-api |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-EEHRxF-DocumentAccessProvider.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/bvdh/jwg-api/CapabilityStatement-EEHRxF-DocumentAccessProvider.html |
| URL | http://hl7.eu/fhir/euridice-api/CapabilityStatement/EEHRxF-DocumentAccessProvider |
| Version | 0.1.0 |
| Status | active |
| Date | 2026-01-14 |
| Name | EEHRxFDocumentAccessProvider |
| Title | EEHRxF Document Access Provider CapabilityStatement |
| Realm | eu |
| Authority | hl7 |
| Description | CapabilityStatement for the EEHRxF Document Access Provider actor. This composite actor provides access to EEHRxF FHIR Documents by receiving documents from Document Producers and serving them to Document Consumers. ### Actor Grouping This composite actor groups the following IHE actors: - [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 Recipient](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html) - [MHD Document Responder](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html) ### Transactions | Transaction | Description | Optionality | |-------------|-------------|-------------| | ITI-65 Provide Document Bundle | Receive document submissions from Document Producers | R | | 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. ### Deployment The Document Access Provider may be grouped with Document Producer, in which case the ITI-65 transaction becomes internal. 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 |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement EEHRxF-DocumentAccessProvider
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.
serverThe Document Access Provider actor receives document submissions from Document Producers (ITI-65) and responds to document queries from Document Consumers (ITI-67, ITI-68). It also provides patient lookup services (PDQm ITI-78).
All transactions require SMART Backend Services authorization.
SMART-on-FHIRSMART Backend Services authorization is REQUIRED for all transactions. Systems SHALL:
- Validate JWT client credentials (RFC 7523)
- Verify appropriate scopes for document operations
- Use TLS 1.2 or higher for all communications
Required scopes to accept:
- system/DocumentReference.c (create DocumentReference - ITI-65)
- system/DocumentReference.rs (search and read DocumentReference - ITI-67)
- system/Binary.c (create Binary - ITI-65)
- system/Binary.r (read Binary - ITI-68)
- system/Patient.rs (search and read Patient - ITI-78)
transactioninteraction described as follows:Accept and process ITI-65 Provide Document Bundle transaction
search-systeminteraction described as follows:System-wide search support
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 | Y | Y | patient, type, _id, category, date, status, identifier, period, format, _lastupdated, setting, facility, event, security-label, related, author.given, author.family, patient.identifier | Provenance:target | ||||
| Binary | Y | Y | |||||||
| List | Y | ||||||||
| Patient | Y | Y | identifier, _id, family, given, birthdate |
resolvescreateAccept DocumentReference creation as part of ITI-65 transaction Bundle
readRead DocumentReference by logical ID
search-typeSearch for DocumentReference resources (ITI-67)
DocumentReference resources are received via ITI-65 Provide Document Bundle and served via ITI-67 Find Document References. The server validates, stores, and indexes document metadata for subsequent queries.
| 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 |
| MAY | _lastupdated | date | When the resource version last changed |
| MAY | setting | token | Additional details about where the content was created (e.g. clinical specialty) |
| MAY | facility | token | Kind of facility where patient was seen |
| MAY | event | token | Main clinical acts documented |
| MAY | security-label | token | Document security-tags |
| MAY | related | reference | Related identifiers or resources |
| MAY | author.given | string | Given name of document author |
| MAY | author.family | string | Family name of document author |
| MAY | patient.identifier | token | Patient identifier (chained search) |
createAccept Binary creation as part of ITI-65 transaction Bundle
readRetrieve document content (ITI-68)
Binary resources contain the actual document content. They are received via ITI-65 Provide Document Bundle and served via ITI-68 Retrieve Document.
createAccept List (SubmissionSet) creation as part of ITI-65 transaction Bundle
List resources representing SubmissionSets may be received as part of the ITI-65 Provide Document Bundle transaction.
resolvesreadRead Patient by logical ID
search-typeSearch for patients (PDQm ITI-78)
Patient resources support patient context lookup per PDQm [ITI-78]. The identifier search parameter is required; additional demographics parameters are optional.
| 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-DocumentAccessProvider",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.eu/fhir/euridice-api/CapabilityStatement/EEHRxF-DocumentAccessProvider",
"version": "0.1.0",
"name": "EEHRxFDocumentAccessProvider",
"title": "EEHRxF Document 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 EEHRxF Document Access Provider actor. This composite actor\nprovides access to EEHRxF FHIR Documents by receiving documents from Document Producers\nand serving them to Document Consumers.\n\n### Actor Grouping\n\nThis composite actor groups the following IHE actors:\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 Recipient](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html)\n- [MHD Document Responder](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 | Receive document submissions from Document Producers | R |\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### Deployment\nThe Document Access Provider may be grouped with Document Producer, in which case the\nITI-65 transaction becomes internal. 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": "server",
"documentation": "The Document Access Provider actor receives document submissions from Document Producers\n(ITI-65) and responds to document queries from Document Consumers (ITI-67, ITI-68).\nIt also provides patient lookup services (PDQm 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 operations\n- Use TLS 1.2 or higher for all communications\n\nRequired scopes to accept:\n- system/DocumentReference.c (create DocumentReference - ITI-65)\n- system/DocumentReference.rs (search and read DocumentReference - ITI-67)\n- system/Binary.c (create Binary - ITI-65)\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 received via ITI-65 Provide Document Bundle and served\nvia ITI-67 Find Document References. The server validates, stores, and indexes document\nmetadata for subsequent queries.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "Accept DocumentReference creation as part of ITI-65 transaction Bundle"
},
{
"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": "MAY"
}
],
"name": "_lastupdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "When the resource version last changed"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "setting",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type": "token",
"documentation": "Additional details about where the content was created (e.g. clinical specialty)"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type": "token",
"documentation": "Kind of facility where patient was seen"
},
{
"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": "security-label",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
"type": "token",
"documentation": "Document security-tags"
},
{
"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 identifiers or resources"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "author.given",
"type": "string",
"documentation": "Given name of document author"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "author.family",
"type": "string",
"documentation": "Family name of document author"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "patient.identifier",
"type": "token",
"documentation": "Patient identifier (chained search)"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "Binary",
"documentation": "Binary resources contain the actual document content. They are received via ITI-65\nProvide Document Bundle and served via ITI-68 Retrieve Document.",
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"code": "create",
"documentation": "Accept Binary creation as part of ITI-65 transaction Bundle"
},
{
"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": "SHOULD"
}
],
"type": "List",
"documentation": "List resources representing SubmissionSets may be received 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": "Accept List (SubmissionSet) creation as part of ITI-65 transaction Bundle"
}
],
"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": "SHALL"
}
],
"code": "transaction",
"documentation": "Accept and process ITI-65 Provide Document Bundle transaction"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-system",
"documentation": "System-wide search support"
}
]
}
]
}