{
  "description": "CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Consumer implementing the Metadata Option (B).\\nThis system must support the use of the $docref operation to retrieve DocumentReference metadata,\\nand subsequent retrieval of referenced documents via the attachment.url.\\nOnly /Bundle and /Binary endpoints are expected in CA:FeX for document retrieval.",
  "_filename": "CapabilityStatement-CaFeX-DataConsumer-Option-B.json",
  "package_name": "ca.infoway.io.cafex",
  "format": [ "json", "xml" ],
  "date": "2025-04-02",
  "publisher": "Canada Health Infoway",
  "fhirVersion": "4.0.1",
  "jurisdiction": [ {
    "coding": [ {
      "code": "CA",
      "system": "urn:iso:std:iso:3166"
    } ]
  } ],
  "name": "CAFEX_DataConsumer_Option_B",
  "copyright": "Copyright © 2021–2025+ Canada Health Infoway. All rights reserved. [Terms of Use and License Agreements](https://ic.infoway-inforoute.ca/en/about/tou). [Privacy Policy](https://www.infoway-inforoute.ca/en/legal/privacy-policy).",
  "type": null,
  "experimental": "false",
  "resourceType": "CapabilityStatement",
  "title": "CA:FeX CapabilityStatement - Data Consumer - Option B (Metadata Option)",
  "package_version": "2.2.0-DFT",
  "status": "draft",
  "id": "6babde17-0020-47ae-8331-fa44519255f1",
  "kind": "requirements",
  "url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-B",
  "version": "2.2.0",
  "contact": [ {
    "name": "National Standards Release Centre",
    "telecom": [ {
      "value": "http://www.infoway-inforoute.ca",
      "system": "url"
    }, {
      "value": "standards@infoway-inforoute.ca",
      "system": "email"
    } ]
  } ],
  "rest": [ {
    "mode": "client",
    "resource": [ {
      "type": "DocumentReference",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "searchParam": [ {
        "name": "patient",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-patient"
      }, {
        "name": "type",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-type"
      }, {
        "name": "category",
        "type": "token",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category"
      }, {
        "name": "date",
        "type": "date",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/clinical-date"
      }, {
        "name": "author",
        "type": "reference",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ],
        "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-author"
      } ]
    }, {
      "type": "Bundle",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "documentation": "This client retrieves Bundle resources as referenced from DocumentReference.attachment.url. These are used when the document is submitted as a FHIR document."
    }, {
      "type": "Binary",
      "interaction": [ {
        "code": "read",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "SHALL"
        } ]
      }, {
        "code": "search-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "vread",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-instance",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      }, {
        "code": "history-type",
        "extension": [ {
          "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
          "valueCode": "MAY"
        } ]
      } ],
      "documentation": "This client retrieves Binary resources as referenced from DocumentReference.attachment.url. These are typically used to return non-structured documents (PDF, CDA)."
    } ],
    "security": {
      "description": "1. See the security section of the CA:FeX guide for security requirements and recommendations.\n2. A server **SHALL** reject any unauthorized requests by returning an `HTTP 401` \"Unauthorized\", `HTTP 403` \"Forbidden\", or `HTTP 404` \"Not Found\""
    },
    "operation": [ {
      "name": "$docref",
      "extension": [ {
        "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
        "valueCode": "SHALL"
      } ],
      "definition": "http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/docref"
    } ],
    "documentation": "This client supports CA:FeX-2B and CA:FeX-3B. The client initiates a $docref operation against a DocumentReference endpoint\nand retrieves documents using the attachment.url found in the response.\nThe client SHALL support reading both Bundle and Binary resources. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it"
  } ]
}