PackagesCanonicalsLogsProblems
    Packages
    hl7.fhir.eu.health-data-api@1.0.0-ballot
    http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentPublisherAccessProvider
{
  "description": "CapabilityStatement for the grouped EEHRxF Document Publisher and Document Access Provider\\nactors. This represents a deployment where document production and access provision are\\nco-located in the same system.\\n\\n### Deployment Pattern\\n\\nThis CapabilityStatement applies when:\\n- An EHR system both produces documents AND provides access to them\\n- Document publication is handled internally\\n- External clients only need to query and retrieve documents\\n\\nIn this grouped deployment, document publication is internal to the system and not exposed\\nexternally. The external API provides only document discovery (ITI-67) and retrieval (ITI-68)\\ncapabilities.\\n\\n### Actor Grouping\\n\\nThis grouped actor combines:\\n- **Document Publisher** (internal) - Produces and stores documents internally\\n- **Document Access Provider** (external-facing) - Serves documents to Document Consumers\\n\\nThe underlying IHE actors are:\\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\\nNote: MHD Document Recipient is not listed because publication is internal.\\n\\n### External 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### When to Use This CapabilityStatement\\n\\nUse this CapabilityStatement when implementing:\\n- Hospital EHR systems that produce and serve their own documents\\n- Regional health information exchanges with integrated document repositories\\n- Any system where document creation and access are tightly coupled\\n\\nFor systems that need to receive documents from external sources, use the\\n[Document Access Provider with Document Submission Option](CapabilityStatement-EEHRxF-DocumentAccessProvider-SubmissionOption.html).",
  "_filename": "CapabilityStatement-EEHRxF-DocumentPublisherAccessProvider.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": "EEHRxFDocumentPublisherAccessProvider",
  "copyright": "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "EEHRxF Grouped Document Publisher/Access Provider CapabilityStatement",
  "package_version": "1.0.0-ballot",
  "status": "active",
  "id": "36a09e6f-b025-4acc-9cca-ab0e5eba8827",
  "kind": "requirements",
  "url": "http://hl7.eu/fhir/health-data-api/CapabilityStatement/EEHRxF-DocumentPublisherAccessProvider",
  "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"
      } ],
      "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.\nDocument creation is internal; no external create operation is supported.",
      "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 the actual document content and are served via ITI-68\nRetrieve Document. Document content is created internally; no external create\noperation is supported.",
      "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 access\n- Use TLS 1.2 or higher for all communications\n\nRequired scopes to accept:\n- system/DocumentReference.read, system/DocumentReference.search (read and 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, system/Patient.search (read and 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": "This grouped actor provides document access to external Document Consumers.\nDocument publication is internal and not exposed. The external API\nsupports document discovery (ITI-67), retrieval (ITI-68), and patient lookup (ITI-78).\n\nAll transactions require SMART Backend Services authorization."
  } ]
}