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-example-capabilitystatement-document-access-provider.json
FHIR VersionR4
Sourcehttps://build.fhir.org/ig/euridice-org/eu-health-data-api/CapabilityStatement-example-capabilitystatement-document-access-provider.html
URLhttp://hl7.eu/fhir/health-data-api/CapabilityStatement/example-capabilitystatement-document-access-provider
Version1.0.0-ballot
Statusdraft
Date2026-03-10
NameExampleDocumentAccessProviderEPSLab
TitleExample: Document Access Provider Supporting EPS and Laboratory
Realmeu
Authorityhl7
CopyrightCopyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).
Kindinstance

Resources that use this resource

No resources found

Resources that this resource uses

CapabilityStatement
hl7.fhir.eu.health-data-api#currentdocument-access-provider-eu-apiEEHRxF Document Access Provider CapabilityStatement
SearchParameter
ihe.iti.mhd#currentDocumentReference-CreationCreation
StructureDefinition
hl7.fhir.eu.base#currentpatient-eu-corePatient (EU core)

Narrative

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

Generated Narrative: CapabilityStatement example-capabilitystatement-document-access-provider

Example: Document Access Provider Supporting EPS and Laboratory

  • Implementation Guide Version: 1.0.0-ballot
  • FHIR Version: 4.0.1
  • Supported Formats: json, xml
  • Published on: 2026-03-10
  • 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.

This CapabilityStatement instantiates the CapabilityStatement EEHRxF Document Access Provider CapabilityStatement

SHALL Support the Following Implementation Guides

  • http://hl7.eu/fhir/eps
  • http://hl7.eu/fhir/laboratory

FHIR RESTful Capabilities

Mode: server

This server provides document exchange for European Patient Summaries and Laboratory Reports. It supports MHD ITI-67 (Find Document References), ITI-68 (Retrieve Document), and PDQm ITI-78 (Patient Demographics Query).

Security
Enable CORS: no
Security services supported: SMART-on-FHIR

SMART Backend Services authorization required.

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
DocumentReference yy_id, _lastUpdated, author.given, author.family, category, creation, date, event, facility, format, identifier, patient, patient.identifier, period, related, security-label, setting, status, type
PatientSupported Profiles
  Patient (EU core)		yyidentifier, _id

Resource Conformance: unspecified DocumentReference

Core FHIR Resource
DocumentReference
Reference Policy
Interaction summary
  • Supports read, search-type.

Documentation

DocumentReference resources are served via ITI-67. The response uses base FHIR DocumentReference resources without a required return profile.

Search Parameters
ConformanceParameterTypeDocumentation
SHALL_idtoken

Logical id

SHALLcategorytoken

Document category

SHALLcreationdate

Document creation time

SHALLpatientreference

Patient reference

SHALLpatient.identifiertoken

Chained patient identifier

SHALLtypetoken

Document type

SHOULDdatedate

Reference creation time

SHOULDstatustoken

Document reference status

MAY_lastUpdateddate

Resource version last updated

MAYauthor.givenstring

Author given name

MAYauthor.familystring

Author family name

MAYeventtoken

Main clinical acts documented

MAYfacilitytoken

Facility kind

MAYformattoken

Document format

MAYidentifiertoken

Document identifier

MAYperioddate

Documented service period

MAYrelatedreference

Related identifier or resource

MAYsecurity-labeltoken

Document security label

MAYsettingtoken

Clinical setting

 

Resource Conformance: unspecified Patient

Core FHIR Resource
Patient
Reference Policy
Interaction summary
  • Supports read, search-type.

Supported Profiles

Patient (EU core)

Documentation

Patient lookup via PDQm ITI-78.

Search Parameters
ConformanceParameterTypeDocumentation
SHALLidentifiertoken
SHALL_idtoken
 

Source1

{
  "resourceType": "CapabilityStatement",
  "id": "example-capabilitystatement-document-access-provider",
  "text": {
    "status": "extensions",
    "div": "<!-- snip (see above) -->"
  },
  "url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/example-capabilitystatement-document-access-provider",
  "version": "1.0.0-ballot",
  "name": "ExampleDocumentAccessProviderEPSLab",
  "title": "Example: Document Access Provider Supporting EPS and Laboratory",
  "status": "draft",
  "experimental": true,
  "date": "2026-03-10",
  "publisher": "HL7 Europe",
  "contact": [
    {
      "name": "HL7 Europe",
      "telecom": [
        {
          "system": "url",
          "value": "http://hl7.eu"
        }
      ]
    }
  ],
  "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": "instance",
  "instantiates": [
    "http://hl7.eu/fhir/health-data-api/CapabilityStatement/document-access-provider-eu-api"
  ],
  "implementation": {
    "description": "Example hospital document access provider",
    "url": "https://example.org/fhir"
  },
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "implementationGuide": [
    "http://hl7.eu/fhir/eps",
    "http://hl7.eu/fhir/laboratory"
  ],
  "rest": [
    {
      "mode": "server",
      "documentation": "This server provides document exchange for European Patient Summaries and\nLaboratory Reports. It supports MHD ITI-67 (Find Document References),\nITI-68 (Retrieve Document), and PDQm ITI-78 (Patient Demographics Query).",
      "security": {
        "service": [
          {
            "coding": [
              {
                "system": "http://hl7.org/fhir/restful-security-service",
                "code": "SMART-on-FHIR"
              }
            ]
          }
        ],
        "description": "SMART Backend Services authorization required."
      },
      "resource": [
        {
          "type": "DocumentReference",
          "documentation": "DocumentReference resources are served via ITI-67. The response uses base FHIR\nDocumentReference resources without a required return profile.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "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"
            }
          ]
        },
        {
          "type": "Patient",
          "supportedProfile": [
            "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core"
          ],
          "documentation": "Patient lookup via PDQm ITI-78.",
          "interaction": [
            {
              "code": "read"
            },
            {
              "code": "search-type"
            }
          ],
          "searchParam": [
            {
              "name": "identifier",
              "type": "token"
            },
            {
              "name": "_id",
              "type": "token"
            }
          ]
        }
      ]
    }
  ]
}