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 Responder - Option D (Summary Option)

REST Capabilities Server

Mode	Server
Documentation	This server supports CA:FeX-3D – enabling clients to retrieve on-demand patient summaries using the $summary operation on the Patient endpoint. Other interactions on the /Bundle endpoint for summary retrieval are not supported in this option.

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
Patient

Global Operations

Operation	Reference	Documentation	Level
$summary	??	This server responds to the $summary operation on the Patient endpoint. Supports GET and POST invocation: GET [base]/Patient/[id]/$summary POST [base]/Patient/[id]/$summary with Parameters in the body. Optional input parameters include: 'identifier': to specify the patient 'profile': to request a specific document profile Returns a FHIR Document Bundle (Bundle.type = 'document') with appropriate Composition resource representing the patient summary.	SHALL

CapabilityStatement

id : CaFeX-DataResponder-Option-D

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

version : 2.2.0

name : CAFEX_DataResponder_Option_D

title : CA:FeX CapabilityStatement - Data Responder - Option D (Summary Option)

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-3D – Conformance expectations for a CA:FeX Data Responder implementing Summary Option (D). The system must support responding with patient summaries using the $summary operation on the Patient 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 : server

documentation : This server supports CA:FeX-3D – enabling clients to retrieve on-demand patient summaries using the $summary operation on the Patient endpoint. Other interactions on the /Bundle endpoint for summary retrieval are not supported in this option.

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

documentation : This resource serves as the anchor for the $summary operation. No other interactions are claimed on the /Patient endpoint by this server.

operation

extension

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

value : SHALL

name : $summary

definition : http://hl7.org/fhir/uv/ips/OperationDefinition/summary

documentation : This server responds to the $summary operation on the Patient endpoint. - Supports GET and POST invocation: - GET [base]/Patient/[id]/$summary - POST [base]/Patient/[id]/$summary with Parameters in the body. - Optional input parameters include: - 'identifier': to specify the patient - 'profile': to request a specific document profile - Returns a FHIR Document Bundle (Bundle.type = 'document') with appropriate Composition resource representing the patient summary.

<id value="CaFeX-DataResponder-Option-D" />
<url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-D" />
<version value="2.2.0" />
<name value="CAFEX_DataResponder_Option_D" />
<title value="CA:FeX CapabilityStatement - Data Responder - Option D (Summary Option)" />
<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-3D – Conformance expectations for a CA:FeX Data Responder implementing Summary Option (D). The system must support responding with patient summaries using the $summary operation on the Patient 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="server" />
<documentation value="This server supports CA:FeX-3D – enabling clients to retrieve on-demand patient summaries using the $summary operation on the Patient endpoint.\nOther interactions on the /Bundle endpoint for summary retrieval are not supported in this option." />
<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>
<type value="Patient" />
<documentation value="This resource serves as the anchor for the $summary operation.\nNo other interactions are claimed on the /Patient endpoint by this server." />
</resource>
<operation>
<extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation">
<valueCode value="SHALL" />
</extension>
<name value="$summary" />
<definition value="http://hl7.org/fhir/uv/ips/OperationDefinition/summary" />
<documentation value="This server responds to the $summary operation on the Patient endpoint.\n- Supports GET and POST invocation:\n  - GET [base]/Patient/[id]/$summary\n  - POST [base]/Patient/[id]/$summary with Parameters in the body.\n- Optional input parameters include:\n  - 'identifier': to specify the patient\n  - 'profile': to request a specific document profile\n- Returns a FHIR Document Bundle (Bundle.type = 'document') with appropriate Composition resource representing the patient summary." />
</operation>
</rest>

</CapabilityStatement>

{

"resourceType": "CapabilityStatement",
"id": "CaFeX-DataResponder-Option-D",
"url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataResponder-Option-D",
"version": "2.2.0",
"name": "CAFEX_DataResponder_Option_D",
"title": "CA:FeX CapabilityStatement - Data Responder - Option D (Summary Option)",
"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-3D – Conformance expectations for a CA:FeX Data Responder implementing Summary Option (D). The system must support responding with patient summaries using the $summary operation on the Patient 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": "server",
"documentation": "This server supports CA:FeX-3D – enabling clients to retrieve on-demand patient summaries using the $summary operation on the Patient endpoint.\nOther interactions on the /Bundle endpoint for summary retrieval are not supported in this option.",
"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": "Patient",
"documentation": "This resource serves as the anchor for the $summary operation.\nNo other interactions are claimed on the /Patient endpoint by this server."
}
],
"operation": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode": "SHALL"
}
],
"name": "$summary",
"definition": "http://hl7.org/fhir/uv/ips/OperationDefinition/summary",
"documentation": "This server responds to the $summary operation on the Patient endpoint.\n- Supports GET and POST invocation:\n  - GET [base]/Patient/[id]/$summary\n  - POST [base]/Patient/[id]/$summary with Parameters in the body.\n- Optional input parameters include:\n  - 'identifier': to specify the patient\n  - 'profile': to request a specific document profile\n- Returns a FHIR Document Bundle (Bundle.type = 'document') with appropriate Composition resource representing the patient summary."
}
]
}
]

}