{
  "description": "CapabilityStatement for the EEHRxF Imaging Report Document Consumer actor. This composite actor\\nconsumes EEHRxF FHIR Imaging Report Documents by querying a Imaging Report Document Access Provider.\\n",
  "_filename": "CapabilityStatement-EehrxfImagingReportDocumentConsumer.json",
  "package_name": "hl7.fhir.eu.imaging",
  "format": [ "json", "xml" ],
  "date": "2026-02-11",
  "publisher": "HL7 Europe",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "150",
      "system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
      "display": "Europe"
    } ]
  } ],
  "name": "EEHRxFImagingReportDocumentConsumer",
  "copyright": "Copyright HL7 Europe. Licensed under Creative Commons public domain (CC0 1.0).",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "EEHRxF ImagingReport Document Consumer CapabilityStatement",
  "package_version": "1.0.0-ballot",
  "status": "active",
  "id": "c2eccd1e-7dce-40b2-9e28-ae2f599c843d",
  "kind": "requirements",
  "url": "http://hl7.eu/fhir/imaging/CapabilityStatement/EehrxfImagingReportDocumentConsumer",
  "version": "1.0.0-ballot",
  "contact": [ {
    "name": "HL7 Europe",
    "telecom": [ {
      "value": "http://hl7.eu",
      "system": "url"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "type": "DocumentReference",
      "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": "Read DocumentReference by logical ID"
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "documentation": "Search DocumentReference (ITI-67)"
      } ],
      "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 (SHALL support)"
      }, {
        "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"
      }, {
        "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": "bodysite",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.eu/fhir/imaging/SearchParameter/SearchParameterDocumentReferenceBodySite",
        "documentation": "Anatomical region of the related imaging study"
      }, {
        "name": "modality",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHOULD"
        } ],
        "definition": "http://hl7.eu/fhir/imaging/SearchParameter/SearchParameterDocumentReferenceModality",
        "documentation": "Modality of the related imaging study"
      } ],
      "documentation": "DocumentReference resources are queried using the ITI-67 Find Document References\ntransaction to discover available documents for a patient."
    }, {
      "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)"
      } ],
      "documentation": "Binary resources contain the actual document content and are retrieved using the\nITI-68 Retrieve Document transaction."
    }, {
      "type": "Patient",
      "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": "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)"
      } ],
      "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"
      } ],
      "documentation": "Patient resources are searched to establish patient context before querying for documents.\nThis uses PDQm [ITI-78] with identifier as a required search parameter."
    } ],
    "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- Authenticate using JWT client credentials (RFC 7523)\n- Request appropriate scopes for document access\n- Use TLS 1.2 or higher for all communications\n\nRequired scopes:\n- system/DocumentReference.read, system/DocumentReference.search (read and search DocumentReference - ITI-67)\n- system/Binary.read (read Binary for document retrieval - ITI-68)\n- system/Patient.read, system/Patient.search (read and search Patient for context - ITI-78)"
    },
    "documentation": "The Imaging Report Document Consumer Actor queries for document metadata and retrieves documents\nfrom a Imaging Report Document Access Provider. It also queries for patient context using PDQm.\nAll transactions require SMART Backend Services authorization."
  } ]
}