PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.eu.health-data-api@1.0.0-ballot
    http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentAccessProvider
{
  "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 | 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### Document Submission Option\\nTo accept document publication from external Document Publishers, implement the\\n[Document Submission Option](CapabilityStatement-EEHRxF-DocumentAccessProvider-SubmissionOption.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-EEHRxF-DocumentPublisherAccessProvider.html)\\nfor this deployment pattern.",
  "_filename": "CapabilityStatement-EEHRxF-DocumentAccessProvider.json",
  "package_name": "hl7.fhir.eu.health-data-api",
  "format": [ "json", "xml" ],
  "date": "2026-01-26",
  "publisher": "HL7 Europe",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "150",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "Europe"
    } ]
  } ],
  "name": "EEHRxFDocumentAccessProvider",
  "copyright": "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "EEHRxF Document Access Provider CapabilityStatement",
  "package_version": "1.0.0-ballot",
  "status": "active",
  "id": "b485489d-5874-420d-9f87-5da92aff8d69",
  "kind": "requirements",
  "url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentAccessProvider",
  "version": "1.0.0-ballot",
  "contact": [ {
    "name": "HL7 Europe",
    "telecom": [ {
      "value": "http://hl7.eu",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "server",
    "resource": [ {
      "searchRevInclude": [ "Provenance:target" ],
      "searchParam": [ {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient",
        "documentation": "The patient the document is about. The server SHALL support at least id value and MAY support both Type and id values."
      }, {
        "name": "type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-type",
        "documentation": "Kind of document (LOINC code) - SHALL support for clinical precision filtering"
      }, {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
        "documentation": "Logical id of this artifact"
      }, {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
        "documentation": "Categorization of document (XDS ClassCode) - SHOULD support for coarse filtering"
      }, {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date",
        "documentation": "When this document reference was created. The date modifiers ge, le, gt, lt SHOULD be supported."
      }, {
        "name": "status",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-status",
        "documentation": "current | superseded | entered-in-error"
      }, {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-identifier",
        "documentation": "Master Version Specific Identifier"
      }, {
        "name": "period",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-period",
        "documentation": "Time of service that is being documented"
      }, {
        "name": "format",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-format",
        "documentation": "Format/content rules for the document"
      }, {
        "name": "_lastupdated",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-lastUpdated",
        "documentation": "When the resource version last changed"
      }, {
        "name": "setting",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-setting",
        "documentation": "Additional details about where the content was created (e.g. clinical specialty)"
      }, {
        "name": "facility",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-facility",
        "documentation": "Kind of facility where patient was seen"
      }, {
        "name": "event",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-event",
        "documentation": "Main clinical acts documented"
      }, {
        "name": "security-label",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-security-label",
        "documentation": "Document security-tags"
      }, {
        "name": "related",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-related",
        "documentation": "Related identifiers or resources"
      }, {
        "name": "author.given",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "documentation": "Given name of document author"
      }, {
        "name": "author.family",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "documentation": "Family name of document author"
      }, {
        "name": "patient.identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "documentation": "Patient identifier (chained search)"
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "DocumentReference",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Read DocumentReference by logical ID"
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Search for DocumentReference resources (ITI-67)"
      } ],
      "documentation": "DocumentReference resources are served via ITI-67 Find Document References. The server\nindexes document metadata for queries by Document Consumers.",
      "updateCreate": false,
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "conditionalCreate": false,
      "supportedProfile": [ "http://hl7.eu/fhir/health-data-api/StructureDefinition/EehrxfMhdDocumentReference", "https://profiles.ihe.net/ITI/MHD/StructureDefinition/IHE.MHD.Minimal.DocumentReference" ],
      "conditionalDelete": "not-supported"
    }, {
      "type": "Binary",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Retrieve document content (ITI-68)"
      } ],
      "updateCreate": false,
      "documentation": "Binary resources contain non-FHIR document content (e.g. DICOM KOS imaging manifests per IHE MADO).\nServed via ITI-68 Retrieve Document.",
      "conditionalCreate": false,
      "conditionalDelete": "not-supported",
      "conditionalUpdate": false
    }, {
      "searchParam": [ {
        "name": "identifier",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Patient-identifier",
        "documentation": "Patient identifier (e.g., national ID, MRN) - required for patient lookup"
      }, {
        "name": "_id",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/Resource-id",
        "documentation": "Patient logical ID"
      }, {
        "name": "family",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-family",
        "documentation": "Patient family name"
      }, {
        "name": "given",
        "type": "string",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-given",
        "documentation": "Patient given name"
      }, {
        "name": "birthdate",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/individual-birthdate",
        "documentation": "Patient date of birth"
      } ],
      "conditionalUpdate": false,
      "referencePolicy": [ "resolves" ],
      "type": "Patient",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Read Patient by logical ID"
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Search for patients (PDQm ITI-78)"
      } ],
      "documentation": "Patient resources support patient context lookup per PDQm [ITI-78]. The identifier\nsearch parameter is required; additional demographics parameters are optional.",
      "updateCreate": false,
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "conditionalCreate": false,
      "supportedProfile": [ "http://hl7.eu/fhir/base/StructureDefinition/patient-eu-core" ],
      "conditionalDelete": "not-supported"
    } ],
    "security": {
      "cors": false,
      "service": [ {
        "coding": [ {
          "code": "SMART-on-FHIR",
          "system": "http://hl7.org/fhir/restful-security-service"
        } ]
      } ],
      "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.read (read DocumentReference - ITI-67)\n- system/DocumentReference.search (search DocumentReference - ITI-67)\n- system/Binary.read (read Binary - ITI-68)\n- system/Bundle.read (read Bundle - ITI-68 for FHIR Documents)\n- system/Patient.read (read Patient - ITI-78)\n- system/Patient.search (search Patient - ITI-78)"
    },
    "interaction": [ {
      "code": "search-system",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "MAY"
      } ],
      "documentation": "System-wide search support"
    } ],
    "documentation": "The Document Access Provider actor responds to document queries from Document Consumers\n(ITI-67, ITI-68) and provides patient lookup services (PDQm ITI-78).\n\nAll transactions require SMART Backend Services authorization."
  } ]
}