Generated Narrative: CapabilityStatement document-consumer-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.
clientThe Document Consumer actor queries for document metadata and retrieves documents\nfrom a Document Access Provider. It also queries for patient context using PDQm.\nAll transactions require SMART Backend Services authorization.
\nSMART-on-FHIRSMART Backend Services authorization is REQUIRED for all transactions.\nSystems SHALL:
\n\n
\n- Authenticate using JWT client credentials (RFC 7523)
\n- Request appropriate scopes for document access
\n- Use TLS 1.2 or higher for all communications
\nRequired scopes:
\n\n
\n- system/DocumentReference.rs (read + search DocumentReference - ITI-67)
\n- system/Binary.r (read Binary for document retrieval - ITI-68)
\n- system/Bundle.r (read Bundle for FHIR Document retrieval - ITI-68)
\n- system/Patient.rs (read + search Patient for context - ITI-78)
\n
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 | Supported Profiles EEHRxF MHD DocumentReference Profile MHD DocumentReference Minimal | Y | Y | patient, type, _id, category, date, status, identifier | |||||
| Binary | Y | ||||||||
| Patient | Supported Profiles Patient (EU core) | Y | Y | identifier, _id, family, given, birthdate |
readRead DocumentReference by logical ID
\nsearch-typeSearch DocumentReference (ITI-67)
\nEEHRxF MHD DocumentReference Profile
MHD DocumentReference Minimal
DocumentReference resources are queried using the ITI-67 Find Document References\ntransaction to discover available documents for a patient.
\n
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | patient | reference | The patient the document is about (SHALL support) \n |
| SHALL | type | token | Kind of document (LOINC code) - SHALL support for clinical precision filtering \n |
| SHALL | _id | token | Logical id of this artifact \n |
| SHOULD | category | token | Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering \n |
| SHOULD | date | date | When this document reference was created \n |
| SHOULD | status | token | current | superseded | entered-in-error \n |
| SHOULD | identifier | token | Master Version Specific Identifier \n |
readRetrieve document content (ITI-68)
\nBinary resources contain the actual document content and are retrieved using the\nITI-68 Retrieve Document transaction.
\n
readRead Patient by logical ID
\nsearch-typeSearch for patients (PDQm ITI-78)
\nPatient resources are searched to establish patient context before querying for documents.\nThis uses PDQm [ITI-78] with identifier as a required search parameter.
\n
| Conformance | Parameter | Type | Documentation |
|---|---|---|---|
| SHALL | identifier | token | Patient identifier (e.g., national ID, MRN) - required for patient lookup \n |
| SHALL | _id | token | Patient logical ID \n |
| SHOULD | family | string | Patient family name \n |
| SHOULD | given | string | Patient given name \n |
| SHOULD | birthdate | date | Patient date of birth \n |