Pan-Canadian FHIR Exchange (CA:FeX) IGuide 2.2.0 DFT-Ballot

DFT Ballot - This specification is currently in ballot review and subject to change. It is not ready for limited roll-out or production level use. For a full list of available versions, see the Directory of published versions

CA:FeX CapabilityStatement - Data Responder - Option B (Metadata)

REST Capabilities Server

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.

Security

Description

See the security section of the CA:FeX guide for security requirements and recommendations.
A server SHALL reject any unauthorized requests by returning an HTTP 401 "Unauthorized", HTTP 403 "Forbidden", or HTTP 404 "Not Found"

Resource Interactions

Resource Type	SearchType	Read	Vread	HistoryInstance	HistoryType
DocumentReference	SHALL	SHALL	MAY	MAY	MAY
Binary	MAY	SHALL	MAY	MAY	MAY
Bundle	SHALL	SHALL	MAY	MAY	MAY

Operations per resource type

DocumentReference

Operation	Reference	Level
$docref		SHALL

Binary

No operations are stated for this resource type

Bundle

No operations are stated for this resource type

Search Parameters per resource type

DocumentReference

Name	Type	Level
patient	reference	SHALL
type	token	SHALL
status	token	SHOULD
period	date	SHOULD

Supported Reverse Includes:

Provenance:target

Binary

No search parameters are stated for this resource type

Bundle

No search parameters are stated for this resource type

CapabilityStatement

id : CaFeX-DataResponder-Option-B

url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B

version : 2.2.0

name : CAFEX_DataResponder_Option_B

title : CA:FeX CapabilityStatement - Data Responder - Option B (Metadata)

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

telecom

system : email

value : standards@infoway-inforoute.ca

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.

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

format : xml

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.

security

description : 1. See the security section of the CA:FeX guide for security requirements and recommendations. 2. 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

value : SHALL

extension

url : required

value : patient

extension

url : required

value : type

extension

url : required

value : status

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination

type : DocumentReference

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

code : read

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : vread

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : history-instance

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : history-type

referencePolicy : resolves

searchRevInclude : Provenance:target

searchParam

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

name : patient

type : reference

searchParam

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

name : type

type : token

searchParam

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

name : status

type : token

searchParam

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHOULD

name : period

type : date

operation

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

name : $docref

definition : http://hl7.org/fhir/OperationDefinition/DocumentReference-docref

resource

type : Binary

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

code : read

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : vread

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : history-instance

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : history-type

referencePolicy : resolves

resource

type : Bundle

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

code : read

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : SHALL

code : search-type

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : vread

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : history-instance

interaction

extension

url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation

value : MAY

code : history-type

referencePolicy : resolves

<CapabilityStatement xmlns="http://hl7.org/fhir">
    <id value="CaFeX-DataResponder-Option-B" />
    <url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B" />
    <version value="2.2.0" />
    <name value="CAFEX_DataResponder_Option_B" />
    <title value="CA:FeX CapabilityStatement - Data Responder - Option B (Metadata)" />
    <status value="draft" />
    <experimental value="false" />
    <date value="2025-04-01" />
    <publisher value="Canada Health Infoway" />
    <contact>
        <name value="National Standards Release Centre" />
        <telecom>
            <system value="url" />
            <value value="http://www.infoway-inforoute.ca" />
        </telecom>
        <telecom>
            <system value="email" />
            <value value="standards@infoway-inforoute.ca" />
        </telecom>
    </contact>
    <description value="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." />
    <jurisdiction>
        <coding>
            <system value="urn:iso:std:iso:3166" />
            <code value="CA" />
        </coding>
    </jurisdiction>
    <copyright value="Copyright &#169; 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 value="requirements" />
    <fhirVersion value="4.0.1" />
    <format value="json" />
    <format value="xml" />
    <rest>
        <mode value="server" />
        <documentation value="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." />
        <security>
            <description value="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` &quot;Unauthorized&quot;, `HTTP 403` &quot;Forbidden&quot;, or `HTTP 404` &quot;Not Found&quot;" />
        </security>
        <resource>
            <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination">
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <extension url="required">
                    <valueString value="patient" />
                </extension>
                <extension url="required">
                    <valueString value="type" />
                </extension>
                <extension url="required">
                    <valueString value="status" />
                </extension>
            </extension>
            <type value="DocumentReference" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <code value="read" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="vread" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="history-instance" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="history-type" />
            </interaction>
            <referencePolicy value="resolves" />
            <searchRevInclude value="Provenance:target" />
            <searchParam>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <name value="patient" />
                <type value="reference" />
            </searchParam>
            <searchParam>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <name value="type" />
                <type value="token" />
            </searchParam>
            <searchParam>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <name value="status" />
                <type value="token" />
            </searchParam>
            <searchParam>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <name value="period" />
                <type value="date" />
            </searchParam>
            <operation>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <name value="$docref" />
                <definition value="http://hl7.org/fhir/OperationDefinition/DocumentReference-docref" />
            </operation>
        </resource>
        <resource>
            <type value="Binary" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <code value="read" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="vread" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="history-instance" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="history-type" />
            </interaction>
            <referencePolicy value="resolves" />
        </resource>
        <resource>
            <type value="Bundle" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <code value="read" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <code value="search-type" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="vread" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="history-instance" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="history-type" />
            </interaction>
            <referencePolicy value="resolves" />
        </resource>
    </rest>
</CapabilityStatement>

{
    "resourceType": "CapabilityStatement",
    "id": "CaFeX-DataResponder-Option-B",
    "url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-B",
    "version": "2.2.0",
    "name": "CAFEX_DataResponder_Option_B",
    "title": "CA:FeX CapabilityStatement - Data Responder - Option B (Metadata)",
    "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-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.",
    "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": "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.",
            "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":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHALL"
                                },
                                {
                                    "url": "required",
                                    "valueString": "patient"
                                },
                                {
                                    "url": "required",
                                    "valueString": "type"
                                },
                                {
                                    "url": "required",
                                    "valueString": "status"
                                }
                            ],
                            "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"
                        }
                    ],
                    "type": "DocumentReference",
                    "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"
                    ],
                    "searchRevInclude":  [
                        "Provenance:target"
                    ],
                    "searchParam":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHALL"
                                }
                            ],
                            "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": "SHOULD"
                                }
                            ],
                            "name": "status",
                            "type": "token"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "name": "period",
                            "type": "date"
                        }
                    ],
                    "operation":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHALL"
                                }
                            ],
                            "name": "$docref",
                            "definition": "http://hl7.org/fhir/OperationDefinition/DocumentReference-docref"
                        }
                    ]
                },
                {
                    "type": "Binary",
                    "interaction":  [
                        {
                            "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": "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"
                        }
                    ],
                    "referencePolicy":  [
                        "resolves"
                    ]
                },
                {
                    "type": "Bundle",
                    "interaction":  [
                        {
                            "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": "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"
                        }
                    ],
                    "referencePolicy":  [
                        "resolves"
                    ]
                }
            ]
        }
    ]
}