Pan-Canadian FHIR Exchange (CA:FeX) IGuide

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

REST Capabilities Server

Mode	Server
Documentation	This server supports CA:FeX-2A and CA:FeX-3A. It responds to search and read requests for FHIR Document Bundles on the /Bundle endpoint. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it

Security

Description	See the security section of the CA:FeX guide for security requirements and recommendations. 2. A server SHALL reject any unauthorized requests by returning HTTP 401, 403, or 404.

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	token	SHALL
timestamp	date	SHOULD
bundle-composition-type	token	MAY
bundle-composition-author	reference	MAY
bundle-composition-status	token	MAY
bundle-composition-date	date	MAY
bundle-composition-category	token	MAY

CapabilityStatement

id : CaFeX-DataResponder-Option-A

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

status : draft

title : CA:FeX CapabilityStatement - Data Responder - Option A (Search and Retrieve FHIR Document)

description : CA:FeX-2A and CA:FeX-3A – Conformance expectations for a CA:FeX Data Responder implementing the Bundle Option (A). The system must support responding to search and retrieval of FHIR Document Bundles on the /Bundle endpoint.

version : 2.2.0

name : CAFEX_DataResponder_Option_A

date : 2025-04-01

kind : requirements

experimental : False

fhirVersion : 4.0.1

format : json

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

telecom

system : email

value : standards@infoway-inforoute.ca

copyright : Copyright (c) 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-2A and CA:FeX-3A. It responds to search and read requests for FHIR Document Bundles on the /Bundle endpoint. 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. 2. A server SHALL reject any unauthorized requests by returning HTTP 401, 403, or 404.

resource

type : Bundle

extension

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

value : SHALL

referencePolicy : resolves

interaction

code : search-type

extension

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

value : SHALL

interaction

code : read

extension

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

value : SHALL

interaction

code : vread

extension

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

value : MAY

interaction

code : history-instance

extension

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

value : MAY

interaction

code : history-type

extension

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

value : MAY

searchParam

name : bundle-composition-patient

type : reference

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

extension

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

value : SHALL

searchParam

name : bundle-composition-patient-identifier

type : token

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

extension

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

value : SHALL

searchParam

name : timestamp

type : date

definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-timestamp

extension

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

value : SHOULD

searchParam

name : bundle-composition-type

type : token

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

extension

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

value : MAY

searchParam

name : bundle-composition-author

type : reference

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

extension

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

value : MAY

searchParam

name : bundle-composition-status

type : token

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

extension

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

value : MAY

searchParam

name : bundle-composition-date

type : date

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

extension

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

value : MAY

searchParam

name : bundle-composition-category

type : token

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

extension

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

value : MAY

<id value="CaFeX-DataResponder-Option-A" />
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-A" />
<version value="2.2.0" />
<name value="CAFEX_DataResponder_Option_A" />
<title value="CA:FeX CapabilityStatement - Data Responder - 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 Responder implementing the Bundle Option (A). The system must support responding to search and retrieval of FHIR Document Bundles on the /Bundle endpoint." />
<jurisdiction>
<coding>
<system value="urn:iso:std:iso:3166" />
<code value="CA" />
</coding>
</jurisdiction>
<copyright value="Copyright (c) 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-2A and CA:FeX-3A. It responds to search and read requests for FHIR Document Bundles on the /Bundle endpoint. Bundle search is only mandated for systems implementing Transaction CA:FeX 2A; other systems MAY omit it" />
<security>
<description value="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 HTTP 401, 403, or 404." />
</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="token" />
</searchParam>
<searchParam>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHOULD" />
</extension>
<name value="timestamp" />
<definition value="http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-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="token" />
</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="token" />
</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="date" />
</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="token" />
</searchParam>
</resource>
</rest>

</CapabilityStatement>

{

"resourceType": "CapabilityStatement",
"id": "CaFeX-DataResponder-Option-A",
"url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-A",
"status": "draft",
"title": "CA:FeX CapabilityStatement - Data Responder - Option A (Search and Retrieve FHIR Document)",
"description": "CA:FeX-2A and CA:FeX-3A – Conformance expectations for a CA:FeX Data Responder implementing the Bundle Option (A). The system must support responding to search and retrieval of FHIR Document Bundles on the /Bundle endpoint.",
"version": "2.2.0",
"name": "CAFEX_DataResponder_Option_A",
"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 (c) 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-2A and CA:FeX-3A. It responds to search and read requests for FHIR Document Bundles on the /Bundle endpoint. 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. 2. A server SHALL reject any unauthorized requests by returning HTTP 401, 403, or 404."
},
"resource": [
{
"type": "Bundle",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"referencePolicy": [
"resolves"
],
"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": "bundle-composition-patient",
"type": "reference",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
{
"name": "bundle-composition-patient-identifier",
"type": "token",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-patient-identifier",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
]
},
{
"name": "timestamp",
"type": "date",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-timestamp",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHOULD"
}
]
},
{
"name": "bundle-composition-type",
"type": "token",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-type",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
},
{
"name": "bundle-composition-author",
"type": "reference",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-author",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
},
{
"name": "bundle-composition-status",
"type": "token",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-status",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
},
{
"name": "bundle-composition-date",
"type": "date",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-date",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
},
{
"name": "bundle-composition-category",
"type": "token",
"definition": "http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-bundle-composition-category",
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "MAY"
}
]
}
]
}
]
}
]

}