<status value="draft" /> <experimental value="false" /> <date value="2024-05-09T08:00:00+00:00" /> <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="This section describes the expected capabilities of the CA:FeX Server actor for FHIR document submission, discovery, and retrieval. It defines the supported FHIR profiles, RESTful interactions, operations, and search parameters." /> <jurisdiction> <coding> <system value="urn:iso:std:iso:3166" /> <code value="CA" /> </coding> </jurisdiction> <copyright value="Copyright © 2021,2022,2023 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="The CaFeX Server **SHALL**: 1. Implement the RESTful behavior according to the FHIR specification. 1. Follow the requirements documented in the CaFeX specification 1. Return the following response classes: - (Status 400): invalid parameter - (Status 401/4xx): unauthorized request - (Status 403): insufficient scopes - (Status 404): unknown resource 1. Support JSON source formats for all CaFeX interactions. The CaFeX Server **SHOULD**: 1. Support XML source formats for all CaFeX interactions." /> <security> <description value="1. See the [General Security Considerations](security.html) section for requirements and recommendations. 1. 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="SHOULD" /> </extension> <type value="Binary" /> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <code value="create" /> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </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="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> <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" /> </resource> <resource> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD" /> </extension> <type value="Bundle" /> <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="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="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> <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="MAY" /> </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="MAY" /> </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="MAY" /> </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> <resource> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD" /> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL" /> </extension> <extension url="required"> <valueString value="patient" /> </extension> <extension url="required"> <valueString value="category" /> </extension> <extension url="required"> <valueString value="date" /> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD" /> </extension> <extension url="required"> <valueString value="patient" /> </extension> <extension url="required"> <valueString value="status" /> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL" /> </extension> <extension url="required"> <valueString value="patient" /> </extension> <extension url="required"> <valueString value="category" /> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD" /> </extension> <extension url="required"> <valueString value="patient" /> </extension> <extension url="required"> <valueString value="type" /> </extension> <extension url="required"> <valueString value="period" /> </extension> </extension> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination"> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL" /> </extension> <extension url="required"> <valueString value="patient" /> </extension> <extension url="required"> <valueString value="type" /> </extension> </extension> <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="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="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> <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" /> <searchRevInclude value="Provenance:target" /> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL" /> </extension> <name value="_id" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-id" /> <type value="token" /> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <name value="status" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-status" /> <type value="token" /> <documentation value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both." /> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHALL" /> </extension> <name value="patient" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-patient" /> <type value="reference" /> <documentation value="The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both." /> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <name value="category" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-category" /> <type value="token" /> <documentation value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both." /> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <name value="type" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-type" /> <type value="token" /> <documentation value="The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both." /> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <name value="date" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-date" /> <type value="date" /> <documentation value="A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*." /> </searchParam> <searchParam> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <name value="period" /> <definition value="http://hl7.org/fhir/us/core/SearchParameter/us-core-documentreference-period" /> <type value="date" /> <documentation value="A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*." /> </searchParam> <operation> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="SHOULD" /> </extension> <name value="docref" /> <definition value="http://hl7.org/fhir/uv/ipa/OperationDefinition/docref" /> <documentation value="A server **SHOULD** be capable of responding to a $docref operation and capable of returning at least a reference to a generated patient-summary document, if available. **MAY** provide references to other 'on-demand' and 'stable' documents (or 'delayed/deferred assembly') that meet the query parameters as well. If a context date range is supplied the server ** SHOULD** provide references to any document that falls within the date range. If no date range is supplied, then the server **SHALL** provide references to last or current document(s). **SHOULD** document what resources, if any, are returned as included resources `GET [base]/DocumentReference/$docref?patient=[id]`" /> </operation> </resource> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <code value="transaction" /> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <code value="batch" /> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <code value="search-system" /> </interaction> <interaction> <extension url="http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation"> <valueCode value="MAY" /> </extension> <code value="history-system" /> </interaction> </rest> </CapabilityStatement>