FHIR © HL7.org  |  FHIRsmith 4.0.1  |  Server Home  |  XIG Home  |  XIG Stats  | 

FHIR IG analytics

Packageca.infoway.io.cafex
Resource TypeCapabilityStatement
IdCapabilityStatement-CaFeX-DataResponder-Option-B.json
FHIR VersionR4
Sourcehttps://simplifier.net/resolve?scope=ca.infoway.io.cafex@2.2.0-DFT&canonical=http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B
URLhttp://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B
Version2.2.0
Statusdraft
Date2025-04-01
NameCAFEX_DataResponder_Option_B
TitleCA:FeX CapabilityStatement - Data Responder - Option B (Metadata)
Realmca
Authoritynational
DescriptionCA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Responder implementing Metadata Option (B). The system must support document discovery and retrieval using the /DocumentReference and /Binary endpoints.
CopyrightCopyright © 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).
Kindrequirements

Resources that use this resource

No resources found


Resources that this resource uses

No resources found


Narrative

No narrative content found in resource


Source1

{
  "resourceType": "CapabilityStatement",
  "id": "CaFeX-DataResponder-Option-B",
  "url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B",
  "title": "CA:FeX CapabilityStatement - Data Responder - Option B (Metadata)",
  "description": "CA:FeX-2B and CA:FeX-3B – Conformance expectations for a CA:FeX Data Responder implementing Metadata Option (B). The system must support document discovery and retrieval using the /DocumentReference and /Binary endpoints.",
  "status": "draft",
  "version": "2.2.0",
  "name": "CAFEX_DataResponder_Option_B",
  "date": "2025-04-01",
  "kind": "requirements",
  "experimental": false,
  "fhirVersion": "4.0.1",
  "format": [
    "json",
    "xml"
  ],
  "jurisdiction": [
    {
      "coding": [
        {
          "code": "CA",
          "system": "urn:iso:std:iso:3166"
        }
      ]
    }
  ],
  "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"
        }
      ]
    }
  ],
  "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).",
  "rest": [
    {
      "mode": "server",
      "documentation": "This server supports CA:FeX-2B (Search DocumentReference) and CA:FeX-3B (Retrieve Document). It enables clients to search for document metadata using chained parameters and retrieve document content using Binary or Bundle read. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it",
      "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": [
        {
          "type": "DocumentReference",
          "referencePolicy": [
            "resolves"
          ],
          "searchRevInclude": [
            "Provenance:target"
          ],
          "interaction": [
            {
              "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": "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"
                }
              ]
            },
            {
              "name": "type",
              "type": "token",
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ]
            },
            {
              "name": "category",
              "type": "token",
              "definition": "http://hl7.org/fhir/SearchParameter/DocumentReference-category",
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "MAY"
                }
              ]
            },
            {
              "name": "status",
              "type": "token",
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ]
            },
            {
              "name": "period",
              "type": "date",
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHOULD"
                }
              ]
            }
          ],
          "extension": [
            {
              "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination",
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                },
                {
                  "url": "required",
                  "valueString": "patient"
                },
                {
                  "url": "required",
                  "valueString": "type"
                },
                {
                  "url": "required",
                  "valueString": "status"
                }
              ]
            }
          ],
          "operation": [
            {
              "name": "$docref",
              "definition": "http://hl7.org/fhir/OperationDefinition/DocumentReference-docref",
              "extension": [
                {
                  "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                  "valueCode": "SHALL"
                }
              ]
            }
          ]
        },
        {
          "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"
                }
              ]
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        },
        {
          "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"
                }
              ]
            }
          ],
          "referencePolicy": [
            "resolves"
          ]
        }
      ]
    }
  ]
}