FHIR IG Statistics: CapabilityStatement/CaFeX-DataConsumer-Option-A

Resources that use this resource

No resources found

Resources that this resource uses

Narrative

No narrative content found in resource

Source

{
  "resourceType": "CapabilityStatement",
  "id": "CaFeX-DataConsumer-Option-A",
  "url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-A",
  "version": "2.2.0",
  "name": "CAFEX_DataConsumer_Option_A",
  "title": "CA:FeX CapabilityStatement - Data Consumer - Option A (Search and Retrieve FHIR Document)",
  "status": "draft",
  "experimental": false,
  "date": "2025-04-01",
  "publisher": "Canada Health Infoway",
  "contact": [
    {
      "name": "National Standards Release Centre",
      "telecom": [
        {
          "system": "url",
          "value": "http://www.infoway-inforoute.ca"
        },
        {
          "system": "email",
          "value": "standards@infoway-inforoute.ca"
        }
      ]
    }
  ],
  "description": "CA:FeX-2A and CA:FeX-3A – Conformance expectations for a CA:FeX Data Consumer implementing the Bundle Option (A). The system must support search and retrieval of FHIR Document Bundles from a Data Responder's /Bundle endpoint.",
  "jurisdiction": [
    {
      "coding": [
        {
          "system": "urn:iso:std:iso:3166",
          "code": "CA"
        }
      ]
    }
  ],
  "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).",
  "kind": "requirements",
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "rest": [
    {
      "mode": "client",
      "documentation": "This client supports CA:FeX-2A and CA:FeX-3A. It initiates a FHIR Document search and retrieve using HTTP GET to the /Bundle endpoint of a CA:FeX-compliant Data Responder.\nSearch results are returned as a searchset Bundle containing FHIR Document Bundles matching the chained parameters against bundle.composition.",
      "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\""
      },
      "resource": [
        {
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
              "valueCode": "SHALL"
            }
          ],
          "type": "Bundle",
          "interaction": [
            {
              "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": "read"
            },
            {
              "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"
            }
          ],
          "referencePolicy": [
            "resolves"
          ],
          "searchParam": [
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "bundle-composition-patient",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ],
              "name": "bundle-composition-patient-identifier",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient-identifier",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ],
              "name": "timestamp",
              "definition": "http://hl7.org/fhir/SearchParameter/Bundle-timestamp",
              "type": "date"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "bundle-composition-type",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-type",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "bundle-composition-author",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-author",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "bundle-composition-status",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-status",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "bundle-composition-date",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-date",
              "type": "reference"
            },
            {
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ],
              "name": "bundle-composition-category",
              "definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-category",
              "type": "reference"
            }
          ]
        }
      ]
    }
  ]
}