FHIR IG analytics| Package | hl7.fhir.eu.health-data-api |
| Resource Type | CapabilityStatement |
| Id | CapabilityStatement-document-access-provider-eu-api.json |
| FHIR Version | R4 |
| Source | https://build.fhir.org/ig/euridice-org/eu-health-data-api/CapabilityStatement-document-access-provider-eu-api.html |
| URL | http://hl7.eu/fhir/health-data-api/CapabilityStatement/document-access-provider-eu-api |
| Version | 1.0.0-ballot |
| Status | active |
| Date | 2026-01-26 |
| Name | DocumentAccessProviderEuApi |
| 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 serving them to Document Consumers via query APIs. ### 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 Responder](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html) ### 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 | O | | Get Access Token | Issue authorization tokens to clients | R | ### Security Systems SHALL support SMART Backend Services authorization for all transactions. ### Document Submission Option To accept document publication from external Document Publishers, implement the [Document Submission Option](CapabilityStatement-document-access-provider-submission-option-eu-api.html). ### Deployment The Document Access Provider may be grouped with Document Publisher, in which case document publication is internal. See the [grouped Document Publisher/Access Provider CapabilityStatement](CapabilityStatement-document-publisher-access-provider-eu-api.html) for this deployment pattern. |
| Copyright | Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0). |
| Kind | requirements |
| CapabilityStatement | ||
| hl7.fhir.eu.health-data-api#current | example-capabilitystatement-document-access-provider | Example: Document Access Provider Supporting EPS and Laboratory |
| hl7.fhir.eu.health-data-api#current | document-access-provider-submission-option-eu-api | EEHRxF Document Access Provider - Document Submission Option |
| SearchParameter | ||
| ihe.iti.mhd#current | DocumentReference-Creation | Creation |
| StructureDefinition | ||
| hl7.fhir.eu.base#current | patient-eu-core | Patient (EU core) |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement document-access-provider-eu-api
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 responds to document queries from Document Consumers (ITI-67, ITI-68) and optional 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.rs (read + search DocumentReference - ITI-67)
- system/Binary.r (read Binary - ITI-68)
- system/Bundle.r (read Bundle - ITI-68 for FHIR Documents)
- system/Patient.rs (read + search Patient - ITI-78)
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 | _id, _lastUpdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type | Provenance:target | |||||
| Binary | Y | ||||||||
| Patient | Supported Profiles Patient (EU core) | Y | Y | identifier, _id, active, family, given, telecom, birthdate, address, address-city, address-country, address-postalcode, address-state, gender |
resolvesreadRead DocumentReference by logical ID
search-typeSearch for DocumentReference resources (ITI-67)
DocumentReference resources are returned as base FHIR resources. No EU or MHD return profile is required.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | _id | token | Logical id |
| SHALL | category | token | Document category |
| SHALL | creation | date | Document creation time |
| SHALL | patient | reference | Patient reference |
| SHALL | patient.identifier | token | Chained patient identifier |
| SHALL | type | token | Document type |
| SHOULD | date | date | Reference creation time |
| SHOULD | status | token | Document reference status |
| MAY | _lastUpdated | date | Resource version last updated |
| MAY | author.given | string | Author given name |
| MAY | author.family | string | Author family name |
| MAY | event | token | Main clinical acts documented |
| MAY | facility | token | Facility kind |
| MAY | format | token | Document format |
| MAY | identifier | token | Document identifier |
| MAY | period | date | Documented service period |
| MAY | related | reference | Related identifier or resource |
| MAY | security-label | token | Document security label |
| MAY | setting | token | Clinical setting |
readRetrieve document content (ITI-68)
Binary resources contain non-FHIR document content (e.g. DICOM KOS imaging manifests per IHE MADO). Served via ITI-68 Retrieve Document.
resolvesreadRead Patient by logical ID
search-typeSearch for patients (PDQm ITI-78)
Patient resources support patient context lookup per PDQm [ITI-78]. For the provider actor the identifier search parameter is required; furthermore the support of additional demographics parameters is required as well.
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Patient identifier (e.g., national ID, MRN) - required for patient lookup |
| SHALL | _id | token | Patient logical ID |
| SHALL | active | token | Whether the patient record is active |
| SHALL | family | string | Patient family name |
| SHALL | given | string | Patient given name |
| SHALL | telecom | token | Telecom details of the patient |
| SHALL | birthdate | date | Patient date of birth |
| SHALL | address | string | 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 |
| SHALL | address-city | string | A city specified in an address |
| SHALL | address-country | string | A country specified in an address |
| SHALL | address-postalcode | string | A postal code specified in an address |
| SHALL | address-state | string | A state specified in an address |
| SHALL | gender | token | Administrative gender of the patient |
{
"resourceType": "CapabilityStatement",
"id": "document-access-provider-eu-api",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/document-access-provider-eu-api",
"version": "1.0.0-ballot",
"name": "DocumentAccessProviderEuApi",
"title": "EEHRxF Document Access Provider 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 Access Provider actor. This composite actor\nprovides access to EEHRxF FHIR Documents by serving them to Document Consumers via query APIs.\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 Responder](https://profiles.ihe.net/ITI/MHD/1331_actors_and_transactions.html)\n\n### 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 | O |\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### Document Submission Option\nTo accept document publication from external Document Publishers, implement the\n[Document Submission Option](CapabilityStatement-document-access-provider-submission-option-eu-api.html).\n\n### Deployment\nThe Document Access Provider may be grouped with Document Publisher, in which case\ndocument publication is internal. 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": "server",
"documentation": "The Document Access Provider actor responds to document queries from Document Consumers\n(ITI-67, ITI-68) and optional 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.rs (read + search DocumentReference - ITI-67)\n- system/Binary.r (read Binary - ITI-68)\n- system/Bundle.r (read Bundle - ITI-68 for FHIR Documents)\n- system/Patient.rs (read + search Patient - ITI-78)"
},
"resource": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "DocumentReference",
"documentation": "DocumentReference resources are returned as base FHIR resources. No EU or MHD return profile is required.",
"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": "_id",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
"type": "token",
"documentation": "Logical id"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "_lastUpdated",
"definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
"type": "date",
"documentation": "Resource version last updated"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "author.given",
"type": "string",
"documentation": "Author given name"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "author.family",
"type": "string",
"documentation": "Author family name"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "category",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
"type": "token",
"documentation": "Document category"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "creation",
"definition": "https://profiles.ihe.net/ITI/MHD/SearchParameter/DocumentReference-Creation",
"type": "date",
"documentation": "Document creation time"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "date",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-date",
"type": "date",
"documentation": "Reference creation time"
},
{
"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": "facility",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
"type": "token",
"documentation": "Facility kind"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "format",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
"type": "token",
"documentation": "Document format"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "identifier",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
"type": "token",
"documentation": "Document identifier"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
"type": "reference",
"documentation": "Patient reference"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "patient.identifier",
"type": "token",
"documentation": "Chained patient 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": "Documented service period"
},
{
"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 identifier or resource"
},
{
"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 label"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"name": "setting",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
"type": "token",
"documentation": "Clinical setting"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
],
"name": "status",
"definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
"type": "token",
"documentation": "Document reference status"
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "type",
"definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
"type": "token",
"documentation": "Document type"
}
]
},
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"type": "Binary",
"documentation": "Binary resources contain non-FHIR document content (e.g. DICOM KOS imaging manifests per IHE MADO).\nServed via ITI-68 Retrieve Document.",
"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": "SHOULD"
}
],
"type": "Patient",
"supportedProfile": [
"http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core"
],
"documentation": "Patient resources support patient context lookup per PDQm [ITI-78]. For the provider actor the identifier\nsearch parameter is required; furthermore the support of additional demographics parameters is required as well.",
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"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": "SHALL"
}
],
"name": "gender",
"definition": "http://hl7.org/fhir/SearchParameter/individual-gender",
"type": "token",
"documentation": "Administrative gender of the patient"
}
]
}
],
"interaction": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
],
"code": "search-system",
"documentation": "System-wide search support"
}
]
}
]
}