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

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 Consumer - Option A (Search and Retrieve FHIR Document)

REST Capabilities Client

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. Search results are returned as a searchset Bundle containing FHIR Document Bundles matching the chained parameters against bundle.composition.

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	SearchType	Read	Vread	HistoryInstance	HistoryType
Bundle		SHALL	SHALL	MAY	MAY	MAY

Search Parameters per resource type

Bundle

Name	Type	Level
bundle-composition-patient	reference	SHALL
bundle-composition-patient-identifier	reference	SHALL
timestamp	date	SHOULD
bundle-composition-type	reference	MAY
bundle-composition-author	reference	MAY
bundle-composition-status	reference	MAY
bundle-composition-date	reference	MAY
bundle-composition-category	reference	MAY

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

telecom

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

format : 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. Search 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. 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

type : Bundle

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

searchParam

extension

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

value : SHALL

name : bundle-composition-patient

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient

type : reference

searchParam

extension

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

value : SHALL

name : bundle-composition-patient-identifier

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient-identifier

type : reference

searchParam

extension

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

value : SHOULD

name : timestamp

definition : http://hl7.org/fhir/SearchParameter/Bundle-timestamp

type : date

searchParam

extension

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

value : MAY

name : bundle-composition-type

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-type

type : reference

searchParam

extension

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

value : MAY

name : bundle-composition-author

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-author

type : reference

searchParam

extension

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

value : MAY

name : bundle-composition-status

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-status

type : reference

searchParam

extension

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

value : MAY

name : bundle-composition-date

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-date

type : reference

searchParam

extension

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

value : MAY

name : bundle-composition-category

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-category

type : reference

<id value="CaFeX-DataConsumer-Option-A" />
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-A" />
<version value="2.2.0" />
<name value="CAFEX_DataConsumer_Option_A" />
<title value="CA:FeX CapabilityStatement - Data Consumer - Option A (Search and Retrieve FHIR Document)" />
<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-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 value="urn:iso:std:iso:3166" />
<code value="CA" />
</coding>
</jurisdiction>
<copyright value="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 value="requirements" />
<fhirVersion value="4.0.1" />
<format value="json" />
<format value="xml" />
<rest>
<mode value="client" />
<documentation value="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 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` "Unauthorized", `HTTP 403` "Forbidden", or `HTTP 404` "Not Found"" />
</security>
<resource>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL" />
</extension>
<type value="Bundle" />
<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" />
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL" />
</extension>
<name value="bundle-composition-patient" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient" />
<type value="reference" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL" />
</extension>
<name value="bundle-composition-patient-identifier" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient-identifier" />
<type value="reference" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD" />
</extension>
<name value="timestamp" />
<definition value="http://hl7.org/fhir/SearchParameter/Bundle-timestamp" />
<type value="date" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY" />
</extension>
<name value="bundle-composition-type" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-type" />
<type value="reference" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY" />
</extension>
<name value="bundle-composition-author" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-author" />
<type value="reference" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY" />
</extension>
<name value="bundle-composition-status" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-status" />
<type value="reference" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY" />
</extension>
<name value="bundle-composition-date" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-date" />
<type value="reference" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="MAY" />
</extension>
<name value="bundle-composition-category" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-category" />
<type value="reference" />
</searchParam>
</resource>
</rest>

</CapabilityStatement>

{

"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"
}
]
}
]
}
]

}