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 C (Single Resource Option)
REST Capabilities Client
| Mode | Client |
|---|---|
| Documentation | The Data Consumer supports lookups of FHIR resources that meet provided search parameters. |
Security
| Description |
|
|---|
Resource Interactions
| Resource Type | Supported Profiles | SearchType | Read | Vread |
|---|---|---|---|---|
| Patient | SHALL | SHALL | MAY | |
| Practitioner | SHALL | SHALL | MAY | |
| PractitionerRole | SHALL | SHALL | MAY | |
| AllergyIntolerance | SHALL | SHALL | MAY | |
| Condition | SHALL | SHALL | MAY | |
| DiagnosticReport | SHALL | SHALL | MAY | |
| Immunization | SHALL | SHALL | MAY | |
| Medication | MAY | SHALL | MAY | |
| MedicationRequest | SHALL | SHALL | MAY | |
| MedicationStatement | SHALL | SHALL | MAY | |
| Observation | SHALL | SHALL | MAY | |
| Procedure | SHALL | SHALL | MAY | |
| Provenance | MAY | SHALL | MAY |
Search Parameters per resource type
Patient
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | MAY | |
| birthdate | date | A client SHALL provide a value precise to the day. | MAY |
| name | string | A server SHALL support the :exact modifier on string parameters. | SHOULD |
| family | string | A server SHALL support the :exact modifier on string parameters. | SHOULD |
| given | string | A server SHALL support the :exact modifier on string parameters. | SHOULD |
| gender | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| identifier | token | The client SHALL provide both the code and system values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
Practitioner
| Name | Type | Documentation | Level |
|---|---|---|---|
| _id | token | MAY | |
| name | string | A server SHALL support the :exact modifier on string parameters. | SHALL |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
PractitionerRole
| Name | Type | Documentation | Level |
|---|---|---|---|
| specialty | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | SHALL |
| practitioner | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
Supported Includes:
- PractitionerRole:endpoint
- PractitionerRole:practitioner
AllergyIntolerance
| Name | Type | Documentation | Level |
|---|---|---|---|
| clinical-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
Condition
| Name | Type | Documentation | Level |
|---|---|---|---|
| category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| clinical-status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| patient | reference | The client SHALL provide at least an id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| onset-date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
| code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
DiagnosticReport
| Name | Type | Documentation | Level |
|---|---|---|---|
| status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
Immunization
| Name | Type | Documentation | Level |
|---|---|---|---|
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
Medication
No search parameters are stated for this resource type
MedicationRequest
| Name | Type | Documentation | Level |
|---|---|---|---|
| status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| intent | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| authoredon | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Includes:
- MedicationRequest:medication
Supported Reverse Includes:
- Provenance:target
MedicationStatement
| Name | Type | Documentation | Level |
|---|---|---|---|
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Includes:
- MedicationStatement:medication
Supported Reverse Includes:
- Provenance:target
Observation
| Name | Type | Documentation | Level |
|---|---|---|---|
| status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| category | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
Procedure
| Name | Type | Documentation | Level |
|---|---|---|---|
| status | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| patient | reference | The client SHALL provide at least a id value and MAY provide both the Type and id values. The server SHALL support both. | SHALL |
| date | date | A client SHALL provide a value precise to the second + time offset. A server SHALL support a value precise to the second + time offset. | MAY |
| code | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
| identifier | token | The client SHALL provide at least a code value and MAY provide both the system and code values. The server SHALL support both. | MAY |
Supported Reverse Includes:
- Provenance:target
Provenance
No search parameters are stated for this resource type
| CapabilityStatement |
| id : Cafex-DataConsumer-Option-C |
| url : http://fhir.infoway-inforoute.ca/io/cafex/CapabilityStatement/cafex-DataConsumer-OptionC |
| status : draft |
| version : 2.2.0 |
| name : cafex_DataConsumer_Option_C |
| title : CA:FeX CapabilityStatement - Data Consumer - Option C (Single Resource Option) |
| experimental : False |
| date : 2025-04-03 |
| 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 |
| description : Describes the capabilities of a Data Consumer supporting Option C (Single Resource Option) for the CA:FeX specification. This actor initiates discrete, single-resource FHIR queries (e.g., Immunization, MedicationRequest, AllergyIntolerance, Condition) to Data Responders. |
| 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 : The Data Consumer supports lookups of FHIR resources that meet provided search parameters. |
| resource |
| type : Patient |
| documentation : Supports Patient lookups for the CA:FeX single resource exchange option. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : birthdate |
| extension |
| url : required |
| value : family |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : birthdate |
| extension |
| url : required |
| value : name |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : family |
| extension |
| url : required |
| value : gender |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : gender |
| extension |
| url : required |
| value : name |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : _id |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-id |
| type : token |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : birthdate |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-birthdate |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *day*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : name |
| definition : http://hl7.org/fhir/SearchParameter/Patient-name |
| type : string |
| documentation : A server **SHALL** support the :exact modifier on string parameters. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| searchParam |
| name : family |
| definition : http://hl7.org/fhir/SearchParameter/individual-family |
| type : string |
| documentation : A server **SHALL** support the :exact modifier on string parameters. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| searchParam |
| name : given |
| definition : http://hl7.org/fhir/SearchParameter/individual-given |
| type : string |
| documentation : A server **SHALL** support the :exact modifier on string parameters. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| searchParam |
| name : gender |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-patient-gender |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide both the code and system values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Practitioner |
| documentation : Supports Practitioner lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| 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 |
| referencePolicy : resolves |
| searchParam |
| name : _id |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-id |
| type : token |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : name |
| definition : http://hl7.org/fhir/SearchParameter/Practitioner-name |
| type : string |
| documentation : A server **SHALL** support the :exact modifier on string parameters. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : identifier |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitioner-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : PractitionerRole |
| documentation : Supports PractitionerRole for identifying roles, specialties, and links to endpoints. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| 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 |
| referencePolicy : resolves |
| searchInclude : PractitionerRole:endpoint |
| searchInclude : PractitionerRole:practitioner |
| searchParam |
| name : specialty |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-specialty |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : practitioner |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-practitionerrole-practitioner |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| resource |
| type : AllergyIntolerance |
| documentation : Supports AllergyIntolerance lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : clinical-status |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : clinical-status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-allergyintolerance-clinical-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Condition |
| documentation : Supports Condition lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : code |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : category |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : onset-date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : clinical-status |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : category |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-category |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : clinical-status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-clinical-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least an id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : onset-date |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-onset-date |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : code |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-condition-code |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : DiagnosticReport |
| documentation : Supports DiagnosticReport lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : category |
| extension |
| url : required |
| value : date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : status |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : code |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : code |
| extension |
| url : required |
| value : date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : category |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : category |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-category |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : code |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-code |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : date |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-diagnosticreport-date |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Immunization |
| documentation : Supports Immunization lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : status |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : date |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : date |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-immunization-date |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Medication |
| documentation : Supports retrieval of referenced Medication resources as part of the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| interaction |
| code : search-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| 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 |
| referencePolicy : resolves |
| resource |
| type : MedicationRequest |
| documentation : Supports MedicationRequest lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : intent |
| extension |
| url : required |
| value : status |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : intent |
| extension |
| url : required |
| value : authoredon |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : intent |
| 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 |
| referencePolicy : resolves |
| searchInclude : MedicationRequest:medication |
| searchRevInclude : Provenance:target |
| searchParam |
| name : status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : intent |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-intent |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : authoredon |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-medicationrequest-authoredon |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : MedicationStatement |
| documentation : Supports MedicationStatement lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| 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 |
| referencePolicy : resolves |
| searchInclude : MedicationStatement:medication |
| searchRevInclude : Provenance:target |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Observation |
| documentation : Supports Observation lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : category |
| extension |
| url : required |
| value : date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : code |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : code |
| extension |
| url : required |
| value : date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : category |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : category |
| extension |
| url : required |
| value : status |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : category |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-category |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : code |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-code |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : date |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-observation-date |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Procedure |
| documentation : Supports Procedure lookups for the Single Resource Exchange (Option C) |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : code |
| extension |
| url : required |
| value : date |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : status |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-search-parameter-combination |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| extension |
| url : required |
| value : patient |
| extension |
| url : required |
| value : date |
| 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 |
| referencePolicy : resolves |
| searchRevInclude : Provenance:target |
| searchParam |
| name : status |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-status |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : patient |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-clinical-patient |
| type : reference |
| documentation : The client **SHALL** provide at least a id value and **MAY** provide both the Type and id values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHALL |
| searchParam |
| name : date |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-date |
| type : date |
| documentation : A client **SHALL** provide a value precise to the *second + time offset*. A server **SHALL** support a value precise to the *second + time offset*. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : code |
| definition : http://hl7.org/fhir/us/core/SearchParameter/us-core-procedure-code |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| searchParam |
| name : identifier |
| definition : http://fhir.infoway-inforoute.ca/io/cafex/SearchParameter/cafex-patient-identifier |
| type : token |
| documentation : The client **SHALL** provide at least a code value and **MAY** provide both the system and code values. The server **SHALL** support both. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| resource |
| type : Provenance |
| documentation : Supports Provenance read and optional search for CA:FeX Option C. |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : SHOULD |
| interaction |
| code : search-type |
| extension |
| url : http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation |
| value : MAY |
| 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 |
| referencePolicy : resolves |
| 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" |