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 D (Summary Option)
REST Capabilities Client
Mode | Client | Documentation | This client supports CA:FeX-3D. It retrieves patient summaries by invoking the $summary operation on the Patient endpoint. Direct read interactions on the /Bundle endpoint for summary retrieval are not supported. |
Security
Description |
|
Resource Interactions
Resource Type | Supported Profiles |
---|---|
Patient |
Global Operations
Operation | Reference | Documentation | Level |
---|---|---|---|
$summary | This client invokes the $summary operation on the Patient endpoint. - It supports both GET and POST invocation styles: - GET [base]/Patient/[id]/$summary - POST [base]/Patient/[id]/$summary with a... | SHALL |
CapabilityStatement |
id : CaFeX-DataConsumer-Option-D |
url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-D |
version : 2.2.0 |
name : CAFEX_DataConsumer_Option_D |
title : CA:FeX CapabilityStatement - Data Consumer - 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 Consumer implementing Summary Option (D). The system must support retrieval of 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 : client |
documentation : This client supports CA:FeX-3D. It retrieves patient summaries by invoking the $summary operation on the Patient endpoint. Direct read interactions on the /Bundle endpoint for summary retrieval are not supported. |
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 client. |
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 client invokes the $summary operation on the Patient endpoint. - It supports both GET and POST invocation styles: - GET [base]/Patient/[id]/$summary - POST [base]/Patient/[id]/$summary with a Parameters resource in the body. - It supports optional input parameters: - 'identifier' to specify the patient - 'profile' to request a specific document profile - The operation returns a FHIR Document Bundle (Bundle.type = 'document') with the appropriate Composition resource representing the patient summary. |
<CapabilityStatement xmlns="http://hl7.org/fhir"> <id value="CaFeX-DataConsumer-Option-D" /> <url value="http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-D" /> <version value="2.2.0" /> <name value="CAFEX_DataConsumer_Option_D" /> <title value="CA:FeX CapabilityStatement - Data Consumer - 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 Consumer implementing Summary Option (D). The system must support retrieval of 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="client" /> <documentation value="This client supports CA:FeX-3D. It retrieves patient summaries by invoking the $summary operation on the Patient endpoint.\nDirect read interactions on the /Bundle endpoint for summary retrieval are not supported." /> <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 client." /> </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 client invokes the $summary operation on the Patient endpoint.\n- It supports both GET and POST invocation styles:\n - GET [base]/Patient/[id]/$summary\n - POST [base]/Patient/[id]/$summary with a Parameters resource in the body.\n- It supports optional input parameters:\n - 'identifier' to specify the patient\n - 'profile' to request a specific document profile\n- The operation returns a FHIR Document Bundle (Bundle.type = 'document') with the appropriate Composition resource representing the patient summary." /> </operation> </rest> </CapabilityStatement>
{ "resourceType": "CapabilityStatement", "id": "CaFeX-DataConsumer-Option-D", "url": "http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/CaFeX-DataConsumer-Option-D", "version": "2.2.0", "name": "CAFEX_DataConsumer_Option_D", "title": "CA:FeX CapabilityStatement - Data Consumer - 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 Consumer implementing Summary Option (D). The system must support retrieval of 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": "client", "documentation": "This client supports CA:FeX-3D. It retrieves patient summaries by invoking the $summary operation on the Patient endpoint.\nDirect read interactions on the /Bundle endpoint for summary retrieval are not supported.", "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 client." } ], "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 client invokes the $summary operation on the Patient endpoint.\n- It supports both GET and POST invocation styles:\n - GET [base]/Patient/[id]/$summary\n - POST [base]/Patient/[id]/$summary with a Parameters resource in the body.\n- It supports optional input parameters:\n - 'identifier' to specify the patient\n - 'profile' to request a specific document profile\n- The operation returns a FHIR Document Bundle (Bundle.type = 'document') with the appropriate Composition resource representing the patient summary." } ] } ] }