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 Source - Option B (Metadata)

REST Capabilities Client

Mode	Client
Documentation	This client supports CA:FeX-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery.

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	Supported Profiles	Create	Update	Patch	Delete
DocumentReference		SHOULD	MAY	MAY	MAY

Operations per resource type

DocumentReference

Operation	Reference	Level
$generate-metadata		SHALL

CapabilityStatement

id : CaFeX-DataSource-Option-B

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

version : 2.2.0

name : CAFEX_DataSource_Option_B

title : CA:FeX CapabilityStatement - Data Source - 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-1B – Conformance expectations for a CA:FeX Data Source implementing Metadata Option (B). The system must support submission and management of DocumentReference and Binary resources for metadata-based discovery.

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 : client

documentation : This client supports CA:FeX-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery.

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

type : DocumentReference

interaction

extension

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

value : SHOULD

code : create

interaction

extension

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

value : MAY

code : update

interaction

extension

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

value : MAY

code : patch

interaction

extension

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

value : MAY

code : delete

operation

extension

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

value : SHALL

name : $generate-metadata

definition : http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/generate-metadata

<CapabilityStatement xmlns="http://hl7.org/fhir">
    <id value="CaFeX-DataSource-Option-B" />
    <url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataSource-Option-B" />
    <version value="2.2.0" />
    <name value="CAFEX_DataSource_Option_B" />
    <title value="CA:FeX CapabilityStatement - Data Source - 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-1B – Conformance expectations for a CA:FeX Data Source implementing Metadata Option (B). The system must support submission and management of DocumentReference and Binary resources for metadata-based discovery." />
    <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="client" />
        <documentation value="This client supports CA:FeX-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery." />
        <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>
            <type value="DocumentReference" />
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHOULD" />
                </extension>
                <code value="create" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="update" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="patch" />
            </interaction>
            <interaction>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="MAY" />
                </extension>
                <code value="delete" />
            </interaction>
            <operation>
                <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
                    <valueCode value="SHALL" />
                </extension>
                <name value="$generate-metadata" />
                <definition value="http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/generate-metadata" />
            </operation>
        </resource>
    </rest>
</CapabilityStatement>

{
    "resourceType": "CapabilityStatement",
    "id": "CaFeX-DataSource-Option-B",
    "url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataSource-Option-B",
    "version": "2.2.0",
    "name": "CAFEX_DataSource_Option_B",
    "title": "CA:FeX CapabilityStatement - Data Source - 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-1B – Conformance expectations for a CA:FeX Data Source implementing Metadata Option (B). The system must support submission and management of DocumentReference and Binary resources for metadata-based discovery.",
    "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-1B – submission of DocumentReference resources (for searchable metadata) and associated content (such as Binary or Bundle resources) to a Data Recipient to enable metadata-based document discovery.",
            "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",
                    "interaction":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHOULD"
                                }
                            ],
                            "code": "create"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "MAY"
                                }
                            ],
                            "code": "update"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "MAY"
                                }
                            ],
                            "code": "patch"
                        },
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "MAY"
                                }
                            ],
                            "code": "delete"
                        }
                    ],
                    "operation":  [
                        {
                            "extension":  [
                                {
                                    "url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
                                    "valueCode": "SHALL"
                                }
                            ],
                            "name": "$generate-metadata",
                            "definition": "http://fhir.infoway-inforoute.ca/io/cafex/OperationDefinition/generate-metadata"
                        }
                    ]
                }
            ]
        }
    ]
}